UpToDateTask.php at 7a90a1f ⋅ phingofficial/phing

<?php
/**
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * This software consists of voluntary contributions made by many individuals
 * and is licensed under the LGPL. For more information please see
 * <http://phing.info>.
 */

/**
 * Sets the given property if the specified target has a timestamp
 * greater than all of the source files.
 *
 * @author  Hans Lellelid <hans@xmpl.org> (Phing)
 * @author  William Ferguson <williamf@mincom.com> (Ant)
 * @author  Hiroaki Nakamura <hnakamur@mc.neweb.ne.jp> (Ant)
 * @author  Stefan Bodewig <stefan.bodewig@epost.de> (Ant)
 * @package phing.tasks.system
 */
class UpToDateTask extends Task implements Condition
{
    use FileListAware;
    use FileSetAware;

    /**
     * @var string
     */
    private $property;

    /**
     * @var string
     */
    private $value;

    /**
     * @var PhingFile
     */
    private $sourceFile;

    /**
     * @var PhingFile
     */
    private $targetFile;

    protected $mapperElement = null;

    /**
     * The property to set if the target file is more up-to-date than
     * (each of) the source file(s).
     *
     * @param string $property the name of the property to set if Target is up-to-date.
     */
    public function setProperty($property)
    {
        $this->property = $property;
    }

    /**
     * Get property name
     *
     * @return string property the name of the property to set if Target is up-to-date.
     */
    public function getProperty()
    {
        return $this->property;
    }

    /**
     * The value to set the named property to if the target file is more
     * up-to-date than (each of) the source file(s). Defaults to 'true'.
     *
     * @param mixed $value the value to set the property to if Target is up-to-date
     */
    public function setValue($value)
    {
        $this->value = $value;
    }

    /**
     * Returns the value, or "true" if a specific value wasn't provided.
     */
    private function getValue()
    {
        return $this->value ?? "true";
    }

    /**
     * The file which must be more up-to-date than (each of) the source file(s)
     * if the property is to be set.
     *
     * @param string|PhingFile $file the file we are checking against.
     */
    public function setTargetFile($file)
    {
        if (is_string($file)) {
            $file = new PhingFile($file);
        }
        $this->targetFile = $file;
    }

    /**
     * The file that must be older than the target file
     * if the property is to be set.
     *
     * @param string|PhingFile $file the file we are checking against the target file.
     */
    public function setSrcfile($file)
    {
        if (is_string($file)) {
            $file = new PhingFile($file);
        }
        $this->sourceFile = $file;
    }

    /**
     * Defines the FileNameMapper to use (nested mapper element).
     */
    public function createMapper()
    {
        if ($this->mapperElement !== null) {
            throw new BuildException(
                "Cannot define more than one mapper",
                $this->getLocation()
            );
        }
        $this->mapperElement = new Mapper($this->getProject());

        return $this->mapperElement;
    }

    /**
     * Evaluate (all) target and source file(s) to
     * see if the target(s) is/are up-to-date.
     *
     * @throws BuildException
     * @return boolean
     */
    public function evaluate()
    {
        if (count($this->filesets) == 0 && count($this->filelists) == 0 && $this->sourceFile === null) {
            throw new BuildException(
                "At least one srcfile or a nested "
                . "<fileset> or <filelist> element must be set."
            );
        }

        if ((count($this->filesets) > 0 || count($this->filelists) > 0) && $this->sourceFile !== null) {
            throw new BuildException(
                "Cannot specify both the srcfile "
                . "attribute and a nested <fileset> "
                . "or <filelist> element."
            );
        }

        if ($this->targetFile === null && $this->mapperElement === null) {
            throw new BuildException(
                "The targetfile attribute or a nested "
                . "mapper element must be set."
            );
        }

        // if the target file is not there, then it can't be up-to-date
        if ($this->targetFile !== null && !$this->targetFile->exists()) {
            return false;
        }

        // if the source file isn't there, throw an exception
        if ($this->sourceFile !== null && !$this->sourceFile->exists()) {
            throw new BuildException(
                $this->sourceFile->getAbsolutePath()
                . " not found."
            );
        }

        $upToDate = true;
        for ($i = 0, $size = count($this->filesets); $i < $size && $upToDate; $i++) {
            $fs = $this->filesets[$i];
            $ds = $fs->getDirectoryScanner($this->project);
            $upToDate = $upToDate && $this->scanDir(
                $fs->getDir($this->project),
                $ds->getIncludedFiles()
            );
        }

        for ($i = 0, $size = count($this->filelists); $i < $size && $upToDate; $i++) {
            $fl = $this->filelists[$i];
            $srcFiles = $fl->getFiles($this->project);
            $upToDate = $upToDate && $this->scanDir(
                $fl->getDir($this->project),
                $srcFiles
            );
        }

        if ($this->sourceFile !== null) {
            if ($this->mapperElement === null) {
                $upToDate = $upToDate &&
                    ($this->targetFile->lastModified() >= $this->sourceFile->lastModified());
            } else {
                $sfs = new SourceFileScanner($this);
                $upToDate = $upToDate &&
                    count(
                        $sfs->restrict(
                            $this->sourceFile->getAbsolutePath(),
                            null,
                            null,
                            $this->mapperElement->getImplementation()
                        )
                    ) === 0;
            }
        }

        return $upToDate;
    }


    /**
     * Sets property to true if target file(s) have a more recent timestamp
     * than (each of) the corresponding source file(s).
     *
     * @throws BuildException
     */
    public function main()
    {
        if ($this->property === null) {
            throw new BuildException(
                "property attribute is required.",
                $this->getLocation()
            );
        }
        $upToDate = $this->evaluate();
        if ($upToDate) {
            $property = $this->project->createTask('property');
            $property->setName($this->getProperty());
            $property->setValue($this->getValue());
            $property->setOverride(true);
            $property->main(); // execute

            if ($this->mapperElement === null) {
                $this->log(
                    "File \"" . $this->targetFile->getAbsolutePath()
                    . "\" is up-to-date.",
                    Project::MSG_VERBOSE
                );
            } else {
                $this->log(
                    "All target files are up-to-date.",
                    Project::MSG_VERBOSE
                );
            }
        }
    }

    /**
     * @param PhingFile $srcDir
     * @param $files
     * @return bool
     */
    protected function scanDir(PhingFile $srcDir, $files)
    {
        $sfs = new SourceFileScanner($this);
        $mapper = null;
        $dir = $srcDir;
        if ($this->mapperElement === null) {
            $mm = new MergeMapper();
            $mm->setTo($this->targetFile->getAbsolutePath());
            $mapper = $mm;
            $dir = null;
        } else {
            $mapper = $this->mapperElement->getImplementation();
        }

        return (count($sfs->restrict($files, $srcDir, $dir, $mapper)) === 0);
    }
}

Read our documentation on viewing source code .

Navigation	Overlay
`t` Navigate files	`h` Toggle hits
`y` Change url to tip of branch	`m` Toggle misses
`b / v` Jump to prev/next hit line	`p` Toggle partial
`z / x` Jump to prev/next missed or partial line	`1..9` Toggle flags
`shift + o` Open current page in GitHub	`a` Toggle all on
`/ or ?` Show keyboard shortcuts dialog	`c` Toggle context lines or commits

1		<?php
2		/**
3		* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
4		* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
5		* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
6		* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
7		* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
8		* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
9		* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
10		* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
11		* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
12		* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
13		* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
14		*
15		* This software consists of voluntary contributions made by many individuals
16		* and is licensed under the LGPL. For more information please see
17		* <http://phing.info>.
18		*/
19
20		/**
21		* Sets the given property if the specified target has a timestamp
22		* greater than all of the source files.
23		*
24		* @author Hans Lellelid <hans@xmpl.org> (Phing)
25		* @author William Ferguson <williamf@mincom.com> (Ant)
26		* @author Hiroaki Nakamura <hnakamur@mc.neweb.ne.jp> (Ant)
27		* @author Stefan Bodewig <stefan.bodewig@epost.de> (Ant)
28		* @package phing.tasks.system
29		*/
30		class UpToDateTask extends Task implements Condition
31		{
32		use FileListAware;
33		use FileSetAware;
34
35		/**
36		* @var string
37		*/
38		private $property;
39
40		/**
41		* @var string
42		*/
43		private $value;
44
45		/**
46		* @var PhingFile
47		*/
48		private $sourceFile;
49
50		/**
51		* @var PhingFile
52		*/
53		private $targetFile;
54
55		protected $mapperElement = null;
56
57		/**
58		* The property to set if the target file is more up-to-date than
59		* (each of) the source file(s).
60		*
61		* @param string $property the name of the property to set if Target is up-to-date.
62		*/
63	1	public function setProperty($property)
64		{
65	1	$this->property = $property;
66		}
67
68		/**
69		* Get property name
70		*
71		* @return string property the name of the property to set if Target is up-to-date.
72		*/
73	1	public function getProperty()
74		{
75	1	return $this->property;
76		}
77
78		/**
79		* The value to set the named property to if the target file is more
80		* up-to-date than (each of) the source file(s). Defaults to 'true'.
81		*
82		* @param mixed $value the value to set the property to if Target is up-to-date
83		*/
84	1	public function setValue($value)
85		{
86	1	$this->value = $value;
87		}
88
89		/**
90		* Returns the value, or "true" if a specific value wasn't provided.
91		*/
92	1	private function getValue()
93		{
94	1	return $this->value ?? "true";
95		}
96
97		/**
98		* The file which must be more up-to-date than (each of) the source file(s)
99		* if the property is to be set.
100		*
101		* @param string\|PhingFile $file the file we are checking against.
102		*/
103	1	public function setTargetFile($file)
104		{
105	1	if (is_string($file)) {
106	1	$file = new PhingFile($file);
107		}
108	1	$this->targetFile = $file;
109		}
110
111		/**
112		* The file that must be older than the target file
113		* if the property is to be set.
114		*
115		* @param string\|PhingFile $file the file we are checking against the target file.
116		*/
117	1	public function setSrcfile($file)
118		{
119	1	if (is_string($file)) {
120	1	$file = new PhingFile($file);
121		}
122	1	$this->sourceFile = $file;
123		}
124
125		/**
126		* Defines the FileNameMapper to use (nested mapper element).
127		*/
128	0	public function createMapper()
129		{
130	0	if ($this->mapperElement !== null) {
131	0	throw new BuildException(
132	0	"Cannot define more than one mapper",
133	0	$this->getLocation()
134		);
135		}
136	0	$this->mapperElement = new Mapper($this->getProject());
137
138	0	return $this->mapperElement;
139		}
140
141		/**
142		* Evaluate (all) target and source file(s) to
143		* see if the target(s) is/are up-to-date.
144		*
145		* @throws BuildException
146		* @return boolean
147		*/
148	1	public function evaluate()
149		{
150	1	if (count($this->filesets) == 0 && count($this->filelists) == 0 && $this->sourceFile === null) {
151	0	throw new BuildException(
152		"At least one srcfile or a nested "
153	0	. "<fileset> or <filelist> element must be set."
154		);
155		}
156
157	1	if ((count($this->filesets) > 0 \|\| count($this->filelists) > 0) && $this->sourceFile !== null) {
158	0	throw new BuildException(
159		"Cannot specify both the srcfile "
160		. "attribute and a nested <fileset> "
161	0	. "or <filelist> element."
162		);
163		}
164
165	1	if ($this->targetFile === null && $this->mapperElement === null) {
166	0	throw new BuildException(
167		"The targetfile attribute or a nested "
168	0	. "mapper element must be set."
169		);
170		}
171
172		// if the target file is not there, then it can't be up-to-date
173	1	if ($this->targetFile !== null && !$this->targetFile->exists()) {
174	0	return false;
175		}
176
177		// if the source file isn't there, throw an exception
178	1	if ($this->sourceFile !== null && !$this->sourceFile->exists()) {
179	0	throw new BuildException(
180	0	$this->sourceFile->getAbsolutePath()
181	0	. " not found."
182		);
183		}
184
185	1	$upToDate = true;
186	1	for ($i = 0, $size = count($this->filesets); $i < $size && $upToDate; $i++) {
187	0	$fs = $this->filesets[$i];
188	0	$ds = $fs->getDirectoryScanner($this->project);
189	0	$upToDate = $upToDate && $this->scanDir(
190	0	$fs->getDir($this->project),
191	0	$ds->getIncludedFiles()
192		);
193		}
194
195	1	for ($i = 0, $size = count($this->filelists); $i < $size && $upToDate; $i++) {
196	0	$fl = $this->filelists[$i];
197	0	$srcFiles = $fl->getFiles($this->project);
198	0	$upToDate = $upToDate && $this->scanDir(
199	0	$fl->getDir($this->project),
200		$srcFiles
201		);
202		}
203
204	1	if ($this->sourceFile !== null) {
205	1	if ($this->mapperElement === null) {
206	1	$upToDate = $upToDate &&
207	1	($this->targetFile->lastModified() >= $this->sourceFile->lastModified());
208		} else {
209	0	$sfs = new SourceFileScanner($this);
210	0	$upToDate = $upToDate &&
211		count(
212	0	$sfs->restrict(
213	0	$this->sourceFile->getAbsolutePath(),
214	0	null,
215	0	null,
216	0	$this->mapperElement->getImplementation()
217		)
218	0	) === 0;
219		}
220		}
221
222	1	return $upToDate;
223		}
224
225
226		/**
227		* Sets property to true if target file(s) have a more recent timestamp
228		* than (each of) the corresponding source file(s).
229		*
230		* @throws BuildException
231		*/
232	1	public function main()
233		{
234	1	if ($this->property === null) {
235	0	throw new BuildException(
236	0	"property attribute is required.",
237	0	$this->getLocation()
238		);
239		}
240	1	$upToDate = $this->evaluate();
241	1	if ($upToDate) {
242	1	$property = $this->project->createTask('property');
243	1	$property->setName($this->getProperty());
244	1	$property->setValue($this->getValue());
245	1	$property->setOverride(true);
246	1	$property->main(); // execute
247
248	1	if ($this->mapperElement === null) {
249	1	$this->log(
250	1	"File \"" . $this->targetFile->getAbsolutePath()
251	1	. "\" is up-to-date.",
252	1	Project::MSG_VERBOSE
253		);
254		} else {
255	0	$this->log(
256	0	"All target files are up-to-date.",
257	0	Project::MSG_VERBOSE
258		);
259		}
260		}
261		}
262
263		/**
264		* @param PhingFile $srcDir
265		* @param $files
266		* @return bool
267		*/
268	0	protected function scanDir(PhingFile $srcDir, $files)
269		{
270	0	$sfs = new SourceFileScanner($this);
271	0	$mapper = null;
272	0	$dir = $srcDir;
273	0	if ($this->mapperElement === null) {
274	0	$mm = new MergeMapper();
275	0	$mm->setTo($this->targetFile->getAbsolutePath());
276	0	$mapper = $mm;
277	0	$dir = null;
278		} else {
279	0	$mapper = $this->mapperElement->getImplementation();
280		}
281
282	0	return (count($sfs->restrict($files, $srcDir, $dir, $mapper)) === 0);
283		}
284		}