TouchTask::_touch() - Code Metrics - Inspection of "Updated composer lock (#1507)" - phingofficial/phing - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( b5ca42...8fe651 )

by Siad

created 2021-01-23 22:29 UTC

TouchTask::_touch() F

↳ Parent: TouchTask

Complexity

Conditions	16
Paths	961

Size

Total Lines	67
Code Lines	38

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	35
CRAP Score	16.0405

Importance

Changes

Metric	Value
cc	16
eloc	38
nc	961
nop	0
dl	0
loc	67
ccs	35
cts	37
cp	0.9459
crap	16.0405
rs	1.4541
c	0
b	0
f	0

How to fix Long Method Complexity

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

use Phing\Exception\BuildException;
use Phing\Io\FileUtils;
use Phing\Io\IOException;
use Phing\Io\File;
use Phing\Phing;
use Phing\Project;
use Phing\Task;
use Phing\Type\Mapper;

/**
 * Touch a file and/or fileset(s); corresponds to the Unix touch command.
 *
 * If the file to touch doesn't exist, an empty one is created.
 *
 * @package phing.tasks.system
 */
class TouchTask extends Task
{
    use FileListAware;
    use FileSetAware;

    /**
     * @var File $file
     */
    private $file;
    private $seconds = -1;
    private $dateTime;
    private $fileUtils;
    private $mkdirs = false;
    private $verbose = true;

    /** @var Mapper $mapperElement */
    private $mapperElement;

    /**
     *
     */
    public function __construct()
    {
        parent::__construct();
        $this->fileUtils = new FileUtils();
    }

    /**
     * Sets a single source file to touch.  If the file does not exist
     * an empty file will be created.
     *
     * @param  File $file
     * @return void
     */
    public function setFile(File $file)
    {
        $this->file = $file;
    }

    /**
     * The new modification time of the file in milliseconds since midnight
     * Jan 1 1970. Negative values are not accepted nor are values less than
     * 1000. Note that PHP is actually based on seconds so the value passed
     * in will be divided by 1000.
     *
     * Optional, default=now
     *
     * @param  $millis
     * @return void
     */
    public function setMillis($millis)
    {
        if ($millis >= 0) {
            if ($millis >= 1000) {
                $this->seconds = (int) $millis / 1000;
            } else {
                throw new BuildException("Millis less than 1000 would be treated as 0");
            }
        } else {
            throw new BuildException("Millis attribute cannot be negative");
        }
    }

    /**
     * the new modification time of the file
     * in seconds since midnight Jan 1 1970.
     * Optional, default=now
     *
     * @param  $seconds
     * @return void
     */
    public function setSeconds($seconds)
    {
        if ($seconds >= 0) {
            $this->seconds = (int) $seconds;
        } else {
            throw new BuildException("Seconds attribute cannot be negative");
        }
    }

    /**
     * the new modification time of the file
     * in the format MM/DD/YYYY HH:MM AM or PM;
     * Optional, default=now
     *
     * @param  $dateTime
     * @return void
     */
    public function setDatetime($dateTime)
    {
        $timestmap = strtotime($dateTime);
        if (false !== $timestmap) {
            $this->dateTime = (string) $dateTime;
            $this->setSeconds($timestmap);
        } else {
            throw new BuildException("Date of ${dateTime} cannot be parsed correctly. It should be in a format parsable by PHP's strtotime() function." . PHP_EOL);
        }
    }

    /**
     * Set whether nonexistent parent directories should be created
     * when touching new files.
     *
     * @param boolean $mkdirs whether to create parent directories.
     */
    public function setMkdirs($mkdirs)
    {
        $this->mkdirs = $mkdirs;
    }

    /**
     * Set whether the touch task will report every file it creates;
     * defaults to <code>true</code>.
     *
     * @param boolean $verbose flag.
     */
    public function setVerbose($verbose)
    {
        $this->verbose = $verbose;
    }

    /**
     * Execute the touch operation.
     *
     * @throws BuildException
     * @throws IOException
     */
    public function createMapper()
    {
        if ($this->mapperElement !== null) {
            throw new BuildException("Cannot define more than one mapper", $this->getLocation());
        }
        $this->mapperElement = new Mapper($this->project);

        return $this->mapperElement;
    }

    protected function checkConfiguration()
    {
        $savedSeconds = $this->seconds;

        if ($this->file === null && count($this->filesets) === 0 && count($this->filelists) === 0) {
            throw new BuildException("Specify at least one source - a file, a fileset or a filelist.");
        }

        if ($this->file !== null && $this->file->exists() && $this->file->isDirectory()) {
            throw new BuildException("Use a fileset to touch directories.");
        }

        $this->log(
            "Setting seconds to " . $savedSeconds . " from datetime attribute",
            ($this->seconds < 0 ? Project::MSG_DEBUG : Project::MSG_VERBOSE)
        );

        $this->seconds = $savedSeconds;
    }

    /**
     * Execute the touch operation.
     * @throws BuildException
     */
    public function main()
    {
        $this->checkConfiguration();
        $this->_touch();
    }

    /**
     * Does the actual work.
     */
    public function _touch()
    {
        if ($this->file !== null) {
            if (!$this->file->exists()) {
                $this->log(
                    "Creating " . $this->file,
                    $this->verbose ? Project::MSG_INFO : Project::MSG_VERBOSE
                );
                try { // try to create file
                    $this->file->createNewFile($this->mkdirs);
                } catch (IOException  $ioe) {
                    throw new BuildException(
                        "Error creating new file " . $this->file,
                        $ioe,
                        $this->getLocation()
                    );
                }
            }
        }

        $resetSeconds = false;
        if ($this->seconds < 0) {
            $resetSeconds = true;
            // Note: this function actually returns seconds, not milliseconds (e.g. 1606505920.2657)
            $this->seconds = Phing::currentTimeMillis();
        }

        if ($this->file !== null) {
            $this->touchFile($this->file);
        }

        $project = $this->getProject();
        foreach ($this->filesets as $fs) {
            $ds = $fs->getDirectoryScanner($project);
            $fromDir = $fs->getDir($project);

            $srcFiles = $ds->getIncludedFiles();
            $srcDirs = $ds->getIncludedDirectories();

            for ($j = 0, $_j = count($srcFiles); $j < $_j; $j++) {
                foreach ($this->getMappedFileNames((string) $srcFiles[$j]) as $fileName) {
                    $this->touchFile(new File($fromDir, $fileName));
                }
            }

            for ($j = 0, $_j = count($srcDirs); $j < $_j; $j++) {
                foreach ($this->getMappedFileNames((string) $srcDirs[$j]) as $fileName) {
                    $this->touchFile(new File($fromDir, $fileName));
                }
            }
        }

        // deal with the filelists
        foreach ($this->filelists as $fl) {
            $fromDir = $fl->getDir($this->getProject());

            $srcFiles = $fl->getFiles($this->getProject());

            for ($j = 0, $_j = count($srcFiles); $j < $_j; $j++) {
                foreach ($this->getMappedFileNames((string) $srcFiles[$j]) as $fileName) {
                    $this->touchFile(new File($fromDir, $fileName));
                }
            }
        }

        if ($resetSeconds) {
            $this->seconds = -1;
        }
    }

    private function getMappedFileNames($file)
    {
        if ($this->mapperElement !== null) {
            $mapper = $this->mapperElement->getImplementation();
            $results = $mapper->main($file);
            if ($results === null) {

                return '';
            }
            $fileNames = $results;
        } else {
            $fileNames = [$file];
        }

        return $fileNames;
    }

    /**
     * @param $file
     * @throws BuildException
     */
    private function touchFile(File $file)
    {
        if (!$file->canWrite()) {
            throw new BuildException("Can not change modification date of read-only file " . (string) $file);
        }
        $file->setLastModified($this->seconds);
    }
}


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		use Phing\Exception\BuildException;
21		use Phing\Io\FileUtils;
22		use Phing\Io\IOException;
23		use Phing\Io\File;
24		use Phing\Phing;
25		use Phing\Project;
26		use Phing\Task;
27		use Phing\Type\Mapper;
28
29		/**
30		* Touch a file and/or fileset(s); corresponds to the Unix touch command.
31		*
32		* If the file to touch doesn't exist, an empty one is created.
33		*
34		* @package phing.tasks.system
35		*/
36		class TouchTask extends Task
37		{
38		use FileListAware;
39		use FileSetAware;
40
41		/**
42		* @var File $file
43		*/
44		private $file;
45		private $seconds = -1;
46		private $dateTime;
47		private $fileUtils;
48		private $mkdirs = false;
49		private $verbose = true;
50
51		/** @var Mapper $mapperElement */
52		private $mapperElement;
53
54		/**
55		*
56		*/
57	82	public function __construct()
58		{
59	82	parent::__construct();
60	82	$this->fileUtils = new FileUtils();
61	82	}
62
63		/**
64		* Sets a single source file to touch. If the file does not exist
65		* an empty file will be created.
66		*
67		* @param File $file
68		* @return void
69		*/
70	73	public function setFile(File $file)
71		{
72	73	$this->file = $file;
73	73	}
74
75		/**
76		* The new modification time of the file in milliseconds since midnight
77		* Jan 1 1970. Negative values are not accepted nor are values less than
78		* 1000. Note that PHP is actually based on seconds so the value passed
79		* in will be divided by 1000.
80		*
81		* Optional, default=now
82		*
83		* @param $millis
84		* @return void
85		*/
86	6	public function setMillis($millis)
87		{
88	6	if ($millis >= 0) {
89	4	if ($millis >= 1000) {
90	3	$this->seconds = (int) $millis / 1000;
91		} else {
92	4	throw new BuildException("Millis less than 1000 would be treated as 0");
93		}
94		} else {
95	2	throw new BuildException("Millis attribute cannot be negative");
96		}
97	3	}
98
99		/**
100		* the new modification time of the file
101		* in seconds since midnight Jan 1 1970.
102		* Optional, default=now
103		*
104		* @param $seconds
105		* @return void
106		*/
107	9	public function setSeconds($seconds)
108		{
109	9	if ($seconds >= 0) {
110	8	$this->seconds = (int) $seconds;
111		} else {
112	1	throw new BuildException("Seconds attribute cannot be negative");
113		}
114	8	}
115
116		/**
117		* the new modification time of the file
118		* in the format MM/DD/YYYY HH:MM AM or PM;
119		* Optional, default=now
120		*
121		* @param $dateTime
122		* @return void
123		*/
124	9	public function setDatetime($dateTime)
125		{
126	9	$timestmap = strtotime($dateTime);
127	9	if (false !== $timestmap) {
128	8	$this->dateTime = (string) $dateTime;
129	8	$this->setSeconds($timestmap);
130		} else {
131	1	throw new BuildException("Date of ${dateTime} cannot be parsed correctly. It should be in a format parsable by PHP's strtotime() function." . PHP_EOL);
132		}
133	7	}
134
135		/**
136		* Set whether nonexistent parent directories should be created
137		* when touching new files.
138		*
139		* @param boolean $mkdirs whether to create parent directories.
140		*/
141	8	public function setMkdirs($mkdirs)
142		{
143	8	$this->mkdirs = $mkdirs;
144	8	}
145
146		/**
147		* Set whether the touch task will report every file it creates;
148		* defaults to <code>true</code>.
149		*
150		* @param boolean $verbose flag.
151		*/
152		public function setVerbose($verbose)
153		{
154		$this->verbose = $verbose;
155		}
156
157		/**
158		* Execute the touch operation.
159		*
160		* @throws BuildException
161		* @throws IOException
162		*/
163	2	public function createMapper()
164		{
165	2	if ($this->mapperElement !== null) {
166		throw new BuildException("Cannot define more than one mapper", $this->getLocation());
167		}
168	2	$this->mapperElement = new Mapper($this->project);
169
170	2	return $this->mapperElement;
171		}
172
173	77	protected function checkConfiguration()
174		{
175	77	$savedSeconds = $this->seconds;
176
177	77	if ($this->file === null && count($this->filesets) === 0 && count($this->filelists) === 0) {
178	1	throw new BuildException("Specify at least one source - a file, a fileset or a filelist.");
179		}
180
181	76	if ($this->file !== null && $this->file->exists() && $this->file->isDirectory()) {
182	1	throw new BuildException("Use a fileset to touch directories.");
183		}
184
185	75	$this->log(
186	75	"Setting seconds to " . $savedSeconds . " from datetime attribute",
187	75	($this->seconds < 0 ? Project::MSG_DEBUG : Project::MSG_VERBOSE)
188		);
189
190	75	$this->seconds = $savedSeconds;
191	75	}
192
193		/**
194		* Execute the touch operation.
195		* @throws BuildException
196		*/
197	77	public function main()
198		{
199	77	$this->checkConfiguration();
200	75	$this->_touch();
201	73	}
202
203		/**
204		* Does the actual work.
205		*/
206	75	public function _touch()
207		{
208	75	if ($this->file !== null) {
209	67	if (!$this->file->exists()) {
210	59	$this->log(
211	59	"Creating " . $this->file,
212	59	$this->verbose ? Project::MSG_INFO : Project::MSG_VERBOSE
213		);
214		try { // try to create file
215	59	$this->file->createNewFile($this->mkdirs);
216	1	} catch (IOException $ioe) {
217	1	throw new BuildException(
218	1	"Error creating new file " . $this->file,
219		$ioe,
220	1	$this->getLocation()
221		);
222		}
223		}
224		}
225
226	74	$resetSeconds = false;
227	74	if ($this->seconds < 0) {
228	65	$resetSeconds = true;
229		// Note: this function actually returns seconds, not milliseconds (e.g. 1606505920.2657)
230	65	$this->seconds = Phing::currentTimeMillis();
231		}
232
233	74	if ($this->file !== null) {
234	66	$this->touchFile($this->file);
235		}
236
237	73	$project = $this->getProject();
238	73	foreach ($this->filesets as $fs) {
239	2	$ds = $fs->getDirectoryScanner($project);
240	2	$fromDir = $fs->getDir($project);
241
242	2	$srcFiles = $ds->getIncludedFiles();
243	2	$srcDirs = $ds->getIncludedDirectories();
244
245	2	for ($j = 0, $_j = count($srcFiles); $j < $_j; $j++) {
246	2	foreach ($this->getMappedFileNames((string) $srcFiles[$j]) as $fileName) {
247	2	$this->touchFile(new File($fromDir, $fileName));
248		}
249		}
250
251	2	for ($j = 0, $_j = count($srcDirs); $j < $_j; $j++) {
252		foreach ($this->getMappedFileNames((string) $srcDirs[$j]) as $fileName) {
253		$this->touchFile(new File($fromDir, $fileName));
254		}
255		}
256		}
257
258		// deal with the filelists
259	73	foreach ($this->filelists as $fl) {
260	8	$fromDir = $fl->getDir($this->getProject());
261
262	8	$srcFiles = $fl->getFiles($this->getProject());
263
264	8	for ($j = 0, $_j = count($srcFiles); $j < $_j; $j++) {
265	8	foreach ($this->getMappedFileNames((string) $srcFiles[$j]) as $fileName) {
266	8	$this->touchFile(new File($fromDir, $fileName));
267		}
268		}
269		}
270
271	73	if ($resetSeconds) {
272	64	$this->seconds = -1;
273		}
274	73	}
275
276	10	private function getMappedFileNames($file)
277		{
278	10	if ($this->mapperElement !== null) {
279	2	$mapper = $this->mapperElement->getImplementation();
280	2	$results = $mapper->main($file);
281	2	if ($results === null) {
		0 ignored issues – show introduced 2020-02-09 14:40 UTC by Report Bug Copy Issue Report The condition `$results === null` is always `false`. Loading history...
282		return '';
283		}
284	2	$fileNames = $results;
285		} else {
286	8	$fileNames = [$file];
287		}
288
289	10	return $fileNames;
290		}
291
292		/**
293		* @param $file
294		* @throws BuildException
295		*/
296	74	private function touchFile(File $file)
297		{
298	74	if (!$file->canWrite()) {
299	1	throw new BuildException("Can not change modification date of read-only file " . (string) $file);
300		}
301	73	$file->setLastModified($this->seconds);
302	73	}
303		}
304

phingofficial / phing

Push — master ( b5ca42...8fe651 )

TouchTask::_touch() F

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like