ZipTask::areFilesetsUpToDate() - Code Metrics - Inspection of "Merge branch 'main' into SwitchTaskTestRelatedTo18..." - phingofficial/phing - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Push — SwitchTaskTestRelatedTo1889 ( d9cdc2...4e19c3 )

by Michiel

created 2025-07-12 18:22 UTC

ZipTask::areFilesetsUpToDate() A

↳ Parent: ZipTask

Complexity

Conditions	5
Paths	5

Size

Total Lines	17
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	8
c	1
b	0
f	0
dl	0
loc	17
rs	9.6111
cc	5
nc	5
nop	0

<?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>.
 */

namespace Phing\Task\Ext\Archive;

use Exception;
use Phing\Exception\BuildException;
use Phing\Io\IOException;
use Phing\Io\File;
use Phing\Io\SourceFileScanner;
use Phing\Mapper\MergeMapper;
use Phing\Project;
use Phing\Task\System\MatchingTask;
use Phing\Type\FileSet;
use ZipArchive;

/**
 * Creates a zip archive using PHP ZipArchive extension/
 *
 * @author  Michiel Rook <[email protected]>
 * @package phing.tasks.ext
 * @since   2.1.0
 */
class ZipTask extends MatchingTask
{
    /**
     * @var File
     */
    private $zipFile;

    /**
     * @var File
     */
    private $baseDir;

    /**
     * Whether to include empty dirs in the archive.
     */
    private $includeEmpty = true;

    private $filesets = [];

    private $ignoreLinks = false;

    private $saveFileAttributes = false;

    /**
     * File path prefix in zip archive
     *
     * @var string
     */
    private $prefix = null;

    /**
     * Comment for zip archive.
     *
     * @var string $comment
     */
    private $comment = '';
    private string $mtimeDummy;

    /**
     * Removes all external attributes from the Zip archive.
     *
     * @param \ZipArchive $zip The Zip archive
     *
     * @return void
     */
    private static function clearExternalAttributes(\ZipArchive $zip)
    {
        for ($i = 0, $count = $zip->count(); $i < $count; ++$i) {
            $zip->setExternalAttributesIndex($i, \ZipArchive::OPSYS_DOS, 0);
        }
    }

    /**
     * Add a new fileset.
     *
     * @return ZipFileSet
     */
    public function createFileSet()
    {
        $this->fileset = new ZipFileSet();
        $this->filesets[] = $this->fileset;

        return $this->fileset;
    }

    /**
     * Add a new fileset.
     *
     * @param ZipFileSet $fileset
     */
    public function addZipFileSet(ZipFileSet $fileset)
    {
        $this->filesets[] = $fileset;
    }

    /**
     * Set is the name/location of where to create the zip file.
     *
     * @param File $destFile The output of the zip
     */
    public function setDestFile(File $destFile)
    {
        $this->zipFile = $destFile;
    }

    /**
     * This is the base directory to look in for things to zip.
     *
     * @param File $baseDir
     */
    public function setBasedir(File $baseDir)
    {
        $this->baseDir = $baseDir;
    }

    /**
     * Sets the file path prefix for file in the zip file.
     *
     * @param string $prefix Prefix
     *
     * @return void
     */
    public function setPrefix($prefix)
    {
        $this->prefix = $prefix;
    }

    /**
     * Set the include empty dirs flag.
     *
     * @param  boolean  Flag if empty dirs should be tarred too
filter:
    dependency_paths: ["lib/*"]
     * @return void
     */
    public function setIncludeEmptyDirs($bool)
    {
        $this->includeEmpty = (bool) $bool;
    }

    /**
     * Set the ignore symlinks flag.
     *
     * @param  boolean $bool Flag if symlinks should be ignored
     * @return void
     */
    public function setIgnoreLinks($bool)
    {
        $this->ignoreLinks = (bool) $bool;
    }

    /**
     * Set the save file attributes flag.
     *
     * @param  bool $bool Flag if file attributes should be saved
     * @return void
     */
    public function setSaveFileAttributes($bool)
    {
        $this->saveFileAttributes = (bool) $bool;
    }

    /**
     * Add a comment to the zip archive.
     *
     * @param string $text
     *
     * @return void
     */
    public function setComment($text)
    {
        $this->comment = $text;
    }

    /**
     * do the work
     *
     * @throws BuildException
     */
    public function main()
    {
        if (!extension_loaded('zip')) {
            throw new BuildException("Zip extension is required");
        }

        if ($this->zipFile === null) {
            throw new BuildException("zipfile attribute must be set!", $this->getLocation());
        }

        if ($this->zipFile->exists() && $this->zipFile->isDirectory()) {
            throw new BuildException("zipfile is a directory!", $this->getLocation());
        }

        if ($this->zipFile->exists() && !$this->zipFile->canWrite()) {
            throw new BuildException("Can not write to the specified zipfile!", $this->getLocation());
        }

        try {
            if ($this->baseDir !== null) {
                if (!$this->baseDir->exists()) {
                    throw new BuildException(
                        "basedir '" . (string) $this->baseDir . "' does not exist!",
                        $this->getLocation()
                    );
                }

                if (empty($this->filesets)) {
                    // add the main fileset to the list of filesets to process.
                    $mainFileSet = new ZipFileSet($this->fileset);
                    $mainFileSet->setDir($this->baseDir);
                    $this->filesets[] = $mainFileSet;
                }
            }

            if (empty($this->filesets)) {
                throw new BuildException(
                    "You must supply either a basedir "
                    . "attribute or some nested filesets.",
                    $this->getLocation()
                );
            }

            // check if zip is out of date with respect to each
            // fileset
            if ($this->areFilesetsUpToDate()) {
                $this->log("Nothing to do: " . $this->zipFile->__toString() . " is up to date.", Project::MSG_INFO);

                return;
            }

            $this->log("Building zip: " . $this->zipFile->__toString(), Project::MSG_INFO);

            if (false === $this->mtimeDummy = tempnam(sys_get_temp_dir(), 'mtimeDummy')) {
                throw new Exception('Could not create temp file');
            }

            $zip = new ZipArchive();
            $res = $zip->open($this->zipFile->getAbsolutePath(), ZipArchive::CREATE);

            if ($res !== true) {
                throw new Exception("ZipArchive::open() failed with code " . $res);
            }

            if ($this->comment !== '') {
                $isCommented = $zip->setArchiveComment($this->comment);
                if ($isCommented === false) {
                    $this->log("Could not add a comment for the Archive.", Project::MSG_INFO);
                }
            }

            $this->addFilesetsToArchive($zip);

            if (!$this->saveFileAttributes) {
                self::clearExternalAttributes($zip);
            }

            $zip->close();
            unlink($this->mtimeDummy);
        } catch (IOException $ioe) {
            $msg = "Problem creating ZIP: " . $ioe->getMessage();
            throw new BuildException($msg, $ioe, $this->getLocation());
        }
    }

    /**
     * @param  array $files array of filenames
     * @param  File $dir
     * @return boolean
     */
    private function archiveIsUpToDate($files, $dir)
    {
        $sfs = new SourceFileScanner($this);
        $mm = new MergeMapper();
        $mm->setTo($this->zipFile->getAbsolutePath());

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

    /**
     * @return array
     * @throws BuildException
     */
    public function areFilesetsUpToDate()
    {
        /**
         * @var FileSet $fs
         */
        foreach ($this->filesets as $fs) {
            $files = $fs->getIterator($this->includeEmpty);
            if (!$this->archiveIsUpToDate($files, $fs->getDir($this->project))) {
                return false;

            }
            for ($i = 0, $fcount = count($files); $i < $fcount; $i++) {
                if ($this->zipFile->equals(new File($fs->getDir($this->project), $files[$i]))) {
                    throw new BuildException("A zip file cannot include itself", $this->getLocation());
                }
            }
        }
        return true;

    }

    /**
     * @param $zip
     */
    private function addFilesetsToArchive($zip)
    {
        foreach ($this->filesets as $fs) {
            $fsBasedir = (null != $this->baseDir) ? $this->baseDir :
                $fs->getDir($this->project);

            $files = $fs->getIterator($this->includeEmpty);

            foreach ($files as $file) {
                $f = new File($fsBasedir, $file);

                $pathInZip = $this->prefix
                    . $f->getPathWithoutBase($fsBasedir);

                $pathInZip = str_replace('\\', '/', $pathInZip);

                if ($this->ignoreLinks && $f->isLink()) {
                    continue;
                }

                if ($f->isDirectory()) {
                    if ($pathInZip != '.') {
                        $this->addDirToZip($zip, $f->getAbsolutePath(), $pathInZip . '/');
                    }
                } else {
                    $zip->addFile($f->getAbsolutePath(), $pathInZip);
                }
                $this->log("Adding " . $f->getPath() . " as " . $pathInZip . " to archive.", Project::MSG_VERBOSE);
            }
        }
    }

    /**
     * @param \ZipArchive $zip
     * @param string      $dirPath
     * @param string      $entryName
     *
     * @return void
     */
    private function addDirToZip(\ZipArchive $zip, string $dirPath, string $entryName)
    {
        touch($this->mtimeDummy, filemtime($dirPath)); // Save directory's mtime to dummmy
        $zip->addFile($this->mtimeDummy, $entryName); // Add empty dummy as a directory
        if (false !== $filePerms = fileperms($dirPath)) { // filePerms supported
            $zip->setExternalAttributesName($entryName, \ZipArchive::OPSYS_UNIX, $filePerms << 16);
        }
    }
}


1			<?php
2
3			/**
4			* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
5			* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
6			* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
7			* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
8			* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
9			* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
10			* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
11			* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
12			* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
13			* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
14			* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
15			*
16			* This software consists of voluntary contributions made by many individuals
17			* and is licensed under the LGPL. For more information please see
18			* <http://phing.info>.
19			*/
20
21			namespace Phing\Task\Ext\Archive;
22
23			use Exception;
24			use Phing\Exception\BuildException;
25			use Phing\Io\IOException;
26			use Phing\Io\File;
27			use Phing\Io\SourceFileScanner;
28			use Phing\Mapper\MergeMapper;
29			use Phing\Project;
30			use Phing\Task\System\MatchingTask;
31			use Phing\Type\FileSet;
32			use ZipArchive;
33
34			/**
35			* Creates a zip archive using PHP ZipArchive extension/
36			*
37			* @author Michiel Rook <[email protected]>
38			* @package phing.tasks.ext
39			* @since 2.1.0
40			*/
41			class ZipTask extends MatchingTask
42			{
43			/**
44			* @var File
45			*/
46			private $zipFile;
47
48			/**
49			* @var File
50			*/
51			private $baseDir;
52
53			/**
54			* Whether to include empty dirs in the archive.
55			*/
56			private $includeEmpty = true;
57
58			private $filesets = [];
59
60			private $ignoreLinks = false;
61
62			private $saveFileAttributes = false;
63
64			/**
65			* File path prefix in zip archive
66			*
67			* @var string
68			*/
69			private $prefix = null;
70
71			/**
72			* Comment for zip archive.
73			*
74			* @var string $comment
75			*/
76			private $comment = '';
77			private string $mtimeDummy;
78
79			/**
80			* Removes all external attributes from the Zip archive.
81			*
82			* @param \ZipArchive $zip The Zip archive
83			*
84			* @return void
85			*/
86			private static function clearExternalAttributes(\ZipArchive $zip)
87			{
88			for ($i = 0, $count = $zip->count(); $i < $count; ++$i) {
89			$zip->setExternalAttributesIndex($i, \ZipArchive::OPSYS_DOS, 0);
90			}
91			}
92
93			/**
94			* Add a new fileset.
95			*
96			* @return ZipFileSet
97			*/
98			public function createFileSet()
99			{
100			$this->fileset = new ZipFileSet();
101			$this->filesets[] = $this->fileset;
102
103			return $this->fileset;
104			}
105
106			/**
107			* Add a new fileset.
108			*
109			* @param ZipFileSet $fileset
110			*/
111			public function addZipFileSet(ZipFileSet $fileset)
112			{
113			$this->filesets[] = $fileset;
114			}
115
116			/**
117			* Set is the name/location of where to create the zip file.
118			*
119			* @param File $destFile The output of the zip
120			*/
121			public function setDestFile(File $destFile)
122			{
123			$this->zipFile = $destFile;
124			}
125
126			/**
127			* This is the base directory to look in for things to zip.
128			*
129			* @param File $baseDir
130			*/
131			public function setBasedir(File $baseDir)
132			{
133			$this->baseDir = $baseDir;
134			}
135
136			/**
137			* Sets the file path prefix for file in the zip file.
138			*
139			* @param string $prefix Prefix
140			*
141			* @return void
142			*/
143			public function setPrefix($prefix)
144			{
145			$this->prefix = $prefix;
146			}
147
148			/**
149			* Set the include empty dirs flag.
150			*
151			* @param boolean Flag if empty dirs should be tarred too
			0 ignored issues – show Bug introduced 2023-03-31 16:25 UTC by Report Bug Copy Issue Report The type `Phing\Task\Ext\Archive\Flag` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
152			* @return void
153			*/
154			public function setIncludeEmptyDirs($bool)
155			{
156			$this->includeEmpty = (bool) $bool;
157			}
158
159			/**
160			* Set the ignore symlinks flag.
161			*
162			* @param boolean $bool Flag if symlinks should be ignored
163			* @return void
164			*/
165			public function setIgnoreLinks($bool)
166			{
167			$this->ignoreLinks = (bool) $bool;
168			}
169
170			/**
171			* Set the save file attributes flag.
172			*
173			* @param bool $bool Flag if file attributes should be saved
174			* @return void
175			*/
176			public function setSaveFileAttributes($bool)
177			{
178			$this->saveFileAttributes = (bool) $bool;
179			}
180
181			/**
182			* Add a comment to the zip archive.
183			*
184			* @param string $text
185			*
186			* @return void
187			*/
188			public function setComment($text)
189			{
190			$this->comment = $text;
191			}
192
193			/**
194			* do the work
195			*
196			* @throws BuildException
197			*/
198			public function main()
199			{
200			if (!extension_loaded('zip')) {
201			throw new BuildException("Zip extension is required");
202			}
203
204			if ($this->zipFile === null) {
205			throw new BuildException("zipfile attribute must be set!", $this->getLocation());
206			}
207
208			if ($this->zipFile->exists() && $this->zipFile->isDirectory()) {
209			throw new BuildException("zipfile is a directory!", $this->getLocation());
210			}
211
212			if ($this->zipFile->exists() && !$this->zipFile->canWrite()) {
213			throw new BuildException("Can not write to the specified zipfile!", $this->getLocation());
214			}
215
216			try {
217			if ($this->baseDir !== null) {
218			if (!$this->baseDir->exists()) {
219			throw new BuildException(
220			"basedir '" . (string) $this->baseDir . "' does not exist!",
221			$this->getLocation()
222			);
223			}
224
225			if (empty($this->filesets)) {
226			// add the main fileset to the list of filesets to process.
227			$mainFileSet = new ZipFileSet($this->fileset);
228			$mainFileSet->setDir($this->baseDir);
229			$this->filesets[] = $mainFileSet;
230			}
231			}
232
233			if (empty($this->filesets)) {
234			throw new BuildException(
235			"You must supply either a basedir "
236			. "attribute or some nested filesets.",
237			$this->getLocation()
238			);
239			}
240
241			// check if zip is out of date with respect to each
242			// fileset
243			if ($this->areFilesetsUpToDate()) {
244			$this->log("Nothing to do: " . $this->zipFile->__toString() . " is up to date.", Project::MSG_INFO);
245
246			return;
247			}
248
249			$this->log("Building zip: " . $this->zipFile->__toString(), Project::MSG_INFO);
250
251			if (false === $this->mtimeDummy = tempnam(sys_get_temp_dir(), 'mtimeDummy')) {
252			throw new Exception('Could not create temp file');
253			}
254
255			$zip = new ZipArchive();
256			$res = $zip->open($this->zipFile->getAbsolutePath(), ZipArchive::CREATE);
257
258			if ($res !== true) {
259			throw new Exception("ZipArchive::open() failed with code " . $res);
260			}
261
262			if ($this->comment !== '') {
263			$isCommented = $zip->setArchiveComment($this->comment);
264			if ($isCommented === false) {
265			$this->log("Could not add a comment for the Archive.", Project::MSG_INFO);
266			}
267			}
268
269			$this->addFilesetsToArchive($zip);
270
271			if (!$this->saveFileAttributes) {
272			self::clearExternalAttributes($zip);
273			}
274
275			$zip->close();
276			unlink($this->mtimeDummy);
277			} catch (IOException $ioe) {
278			$msg = "Problem creating ZIP: " . $ioe->getMessage();
279			throw new BuildException($msg, $ioe, $this->getLocation());
280			}
281			}
282
283			/**
284			* @param array $files array of filenames
285			* @param File $dir
286			* @return boolean
287			*/
288			private function archiveIsUpToDate($files, $dir)
289			{
290			$sfs = new SourceFileScanner($this);
291			$mm = new MergeMapper();
292			$mm->setTo($this->zipFile->getAbsolutePath());
293
294			return count($sfs->restrict($files, $dir, null, $mm)) == 0;
295			}
296
297			/**
298			* @return array
299			* @throws BuildException
300			*/
301			public function areFilesetsUpToDate()
302			{
303			/**
304			* @var FileSet $fs
305			*/
306			foreach ($this->filesets as $fs) {
307			$files = $fs->getIterator($this->includeEmpty);
308			if (!$this->archiveIsUpToDate($files, $fs->getDir($this->project))) {
309			return false;
			0 ignored issues – show Bug Best Practice introduced 2019-07-31 09:36 UTC by Report Bug Copy Issue Report The expression `return false` returns the type `false` which is incompatible with the documented return type `array`. Loading history...
310			}
311			for ($i = 0, $fcount = count($files); $i < $fcount; $i++) {
312			if ($this->zipFile->equals(new File($fs->getDir($this->project), $files[$i]))) {
313			throw new BuildException("A zip file cannot include itself", $this->getLocation());
314			}
315			}
316			}
317			return true;
			0 ignored issues – show Bug Best Practice introduced 2019-07-31 09:36 UTC by Report Bug Copy Issue Report The expression `return true` returns the type `true` which is incompatible with the documented return type `array`. Loading history...
318			}
319
320			/**
321			* @param $zip
322			*/
323			private function addFilesetsToArchive($zip)
324			{
325			foreach ($this->filesets as $fs) {
326			$fsBasedir = (null != $this->baseDir) ? $this->baseDir :
327			$fs->getDir($this->project);
328
329			$files = $fs->getIterator($this->includeEmpty);
330
331			foreach ($files as $file) {
332			$f = new File($fsBasedir, $file);
333
334			$pathInZip = $this->prefix
335			. $f->getPathWithoutBase($fsBasedir);
336
337			$pathInZip = str_replace('\\', '/', $pathInZip);
338
339			if ($this->ignoreLinks && $f->isLink()) {
340			continue;
341			}
342
343			if ($f->isDirectory()) {
344			if ($pathInZip != '.') {
345			$this->addDirToZip($zip, $f->getAbsolutePath(), $pathInZip . '/');
346			}
347			} else {
348			$zip->addFile($f->getAbsolutePath(), $pathInZip);
349			}
350			$this->log("Adding " . $f->getPath() . " as " . $pathInZip . " to archive.", Project::MSG_VERBOSE);
351			}
352			}
353			}
354
355			/**
356			* @param \ZipArchive $zip
357			* @param string $dirPath
358			* @param string $entryName
359			*
360			* @return void
361			*/
362			private function addDirToZip(\ZipArchive $zip, string $dirPath, string $entryName)
363			{
364			touch($this->mtimeDummy, filemtime($dirPath)); // Save directory's mtime to dummmy
365			$zip->addFile($this->mtimeDummy, $entryName); // Add empty dummy as a directory
366			if (false !== $filePerms = fileperms($dirPath)) { // filePerms supported
367			$zip->setExternalAttributesName($entryName, \ZipArchive::OPSYS_UNIX, $filePerms << 16);
368			}
369			}
370			}
371

phingofficial / phing

Push — SwitchTaskTestRelatedTo1889 ( d9cdc2...4e19c3 )

ZipTask::areFilesetsUpToDate() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like