SymlinkTask::symlink() - Code Metrics - Inspection of "Phpstan fixes" - phingofficial/phing - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — main ( fc9dd0...ba819d )

by Michiel

created 2021-02-09 19:32 UTC

SymlinkTask::symlink() B

↳ Parent: SymlinkTask

Complexity

Conditions	9
Paths	10

Size

Total Lines	36
Code Lines	20

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	18
CRAP Score	9.081

Importance

Changes

Metric	Value
eloc	20
dl	0
loc	36
ccs	18
cts	20
cp	0.9
rs	8.0555
c	0
b	0
f	0
cc	9
nc	10
nop	2
crap	9.081

<?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\System;

use Phing\Exception\BuildException;
use Phing\Io\FileSystem;
use Phing\Io\File;
use Phing\Project;
use Phing\Task;
use Phing\Type\FileSet;

/**
 * Generates symlinks based on a target / link combination.
 * Can also symlink contents of a directory, individually
 *
 * Single target symlink example:
 * <code>
 *     <symlink target="/some/shared/file" link="${project.basedir}/htdocs/my_file" />
 * </code>
 *
 * Symlink entire contents of directory
 *
 * This will go through the contents of "/my/shared/library/*"
 * and create a symlink for each entry into ${project.basedir}/library/
 * <code>
 *     <symlink link="${project.basedir}/library">
 *         <fileset dir="/my/shared/library">
 *             <include name="*" />
 *         </fileset>
 *     </symlink>
 * </code>
 *
 * @author  Andrei Serdeliuc <[email protected]>
 */
class SymlinkTask extends Task
{
    /**
     * What we're symlinking from
     *
     * (default value: null)
     *
     * @var string
     */
    private $linkTarget = null;

    /**
     * Symlink location
     *
     * (default value: null)
     *
     * @var string
     */
    private $link = null;

    /**
     * Collection of filesets
     * Used when linking contents of a directory
     *
     * (default value: array())
     *
     * @var array
     */
    private $filesets = [];

    /**
     * Whether to override the symlink if it exists but points
     * to a different location
     *
     * (default value: false)
     *
     * @var boolean
     */
    private $overwrite = false;

    /**
     * Whether to create relative symlinks
     *
     * @var boolean
     */
    private $relative = false;

    /**
     * setter for linkTarget
     *
     * @param string $linkTarget
     * @return void
     */
    public function setTarget($linkTarget)
    {
        $this->linkTarget = $linkTarget;
    }

    /**
     * setter for _link
     *
     * @param string $link
     * @return void
     */
    public function setLink($link)
    {
        $this->link = $link;
    }

    /**
     * creator for _filesets
     *
     * @return FileSet
     */
    public function createFileset()
    {
        $num = array_push($this->filesets, new FileSet());

        return $this->filesets[$num - 1];
    }

    /**
     * setter for _overwrite
     *
     * @param boolean $overwrite
     * @return void
     */
    public function setOverwrite($overwrite)
    {
        $this->overwrite = $overwrite;
    }

    /**
     * @param boolean $relative
     */
    public function setRelative($relative)
    {
        $this->relative = $relative;
    }

    /**
     * getter for linkTarget
     *
     * @return string
     * @throws BuildException
     */
    public function getTarget()
    {
        if ($this->linkTarget === null) {
            throw new BuildException('Target not set');
        }

        return $this->linkTarget;
    }

    /**
     * getter for _link
     *
     * @return string
     * @throws BuildException
     */
    public function getLink()
    {
        if ($this->link === null) {
            throw new BuildException('Link not set');
        }

        return $this->link;
    }

    /**
     * getter for _filesets
     *
     * @return array
     */
    public function getFilesets()
    {
        return $this->filesets;
    }

    /**
     * getter for _overwrite
     *
     * @return boolean
     */
    public function getOverwrite()
    {
        return $this->overwrite;
    }

    /**
     * @return boolean
     */
    public function isRelative()
    {
        return $this->relative;
    }

    /**
     * Given an existing path, convert it to a path relative to a given starting path.
     *
     * @param string $endPath Absolute path of target
     * @param string $startPath Absolute path where traversal begins
     *
     * @return string Path of target relative to starting path
     */
    public function makePathRelative($endPath, $startPath)
    {
        // Normalize separators on Windows
        if ('\\' === DIRECTORY_SEPARATOR) {
            $endPath = str_replace('\\', '/', $endPath);
            $startPath = str_replace('\\', '/', $startPath);
        }

        // Split the paths into arrays
        $startPathArr = explode('/', trim($startPath, '/'));
        $endPathArr = explode('/', trim($endPath, '/'));

        // Find for which directory the common path stops
        $index = 0;
        while (isset($startPathArr[$index]) && isset($endPathArr[$index]) && $startPathArr[$index] === $endPathArr[$index]) {
            ++$index;
        }

        // Determine how deep the start path is relative to the common path (ie, "web/bundles" = 2 levels)
        $depth = count($startPathArr) - $index;

        // Repeated "../" for each level need to reach the common path
        $traverser = str_repeat('../', $depth);

        $endPathRemainder = implode('/', array_slice($endPathArr, $index));

        // Construct $endPath from traversing to the common path, then to the remaining $endPath
        $relativePath = $traverser . ('' !== $endPathRemainder ? $endPathRemainder . '/' : '');

        return '' === $relativePath ? './' : $relativePath;
    }

    /**
     * Generates an array of directories / files to be linked
     * If _filesets is empty, returns getTarget()
     *
     * @return array|string
     * @throws BuildException
     */
    protected function getMap()
    {
        $fileSets = $this->getFilesets();

        // No filesets set
        // We're assuming single file / directory
        if (empty($fileSets)) {
            return $this->getTarget();
        }

        $targets = [];

        foreach ($fileSets as $fs) {
            if (!($fs instanceof FileSet)) {
                continue;
            }

            // We need a directory to store the links
            if (!is_dir($this->getLink())) {
                throw new BuildException('Link must be an existing directory when using fileset');
            }

            $fromDir = $fs->getDir($this->getProject())->getAbsolutePath();

            if (!is_dir($fromDir)) {
                $this->log('Directory doesn\'t exist: ' . $fromDir, Project::MSG_WARN);
                continue;
            }

            $fsTargets = [];

            $ds = $fs->getDirectoryScanner($this->getProject());

            $fsTargets = array_merge(
                $fsTargets,
                $ds->getIncludedDirectories(),
                $ds->getIncludedFiles()
            );

            // Add each target to the map
            foreach ($fsTargets as $target) {
                if (!empty($target)) {
                    $targets[$target] = $fromDir . DIRECTORY_SEPARATOR . $target;
                }
            }
        }

        return $targets;
    }

    /**
     * Main entry point for task
     *
     * @return bool
     */
    public function main()
    {
        $map = $this->getMap();

        // Single file symlink
        if (is_string($map)) {

            return $this->symlink($map, $this->getLink());
        }

        // Multiple symlinks
        foreach ($map as $name => $targetPath) {
            $this->symlink($targetPath, $this->getLink() . DIRECTORY_SEPARATOR . $name);
        }

        return true;
    }

    /**
     * Create the actual link
     *
     * @param string $target
     * @param string $link
     * @return bool
     */
    protected function symlink($target, $link)
    {
        $fs = FileSystem::getFileSystem();

        if ($this->isRelative()) {
            $link = (new File($link))->getAbsolutePath();
            $target = rtrim($this->makePathRelative($target, dirname($link)), '/');
        }

        if (is_link($link) && @readlink($link) == $target) {
            $this->log('Link exists: ' . $link, Project::MSG_INFO);

            return true;
        }

        if (file_exists($link) || is_link($link)) {
            if (!$this->getOverwrite()) {
                $this->log('Not overwriting existing link ' . $link, Project::MSG_ERR);

                return false;
            }

            if (is_link($link) || is_file($link)) {
                $fs->unlink($link);
                $this->log('Link removed: ' . $link, Project::MSG_INFO);
            } else {
                $fs->rmdir($link, true);
                $this->log('Directory removed: ' . $link, Project::MSG_INFO);
            }
        }

        $this->log('Linking: ' . $target . ' to ' . $link, Project::MSG_INFO);

        $fs->symlink($target, $link);

        return true;
    }
}


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		namespace Phing\Task\System;
21
22		use Phing\Exception\BuildException;
23		use Phing\Io\FileSystem;
24		use Phing\Io\File;
25		use Phing\Project;
26		use Phing\Task;
27		use Phing\Type\FileSet;
28
29		/**
30		* Generates symlinks based on a target / link combination.
31		* Can also symlink contents of a directory, individually
32		*
33		* Single target symlink example:
34		* <code>
35		* <symlink target="/some/shared/file" link="${project.basedir}/htdocs/my_file" />
36		* </code>
37		*
38		* Symlink entire contents of directory
39		*
40		* This will go through the contents of "/my/shared/library/*"
41		* and create a symlink for each entry into ${project.basedir}/library/
42		* <code>
43		* <symlink link="${project.basedir}/library">
44		* <fileset dir="/my/shared/library">
45		* <include name="*" />
46		* </fileset>
47		* </symlink>
48		* </code>
49		*
50		* @author Andrei Serdeliuc <[email protected]>
51		*/
52		class SymlinkTask extends Task
53		{
54		/**
55		* What we're symlinking from
56		*
57		* (default value: null)
58		*
59		* @var string
60		*/
61		private $linkTarget = null;
62
63		/**
64		* Symlink location
65		*
66		* (default value: null)
67		*
68		* @var string
69		*/
70		private $link = null;
71
72		/**
73		* Collection of filesets
74		* Used when linking contents of a directory
75		*
76		* (default value: array())
77		*
78		* @var array
79		*/
80		private $filesets = [];
81
82		/**
83		* Whether to override the symlink if it exists but points
84		* to a different location
85		*
86		* (default value: false)
87		*
88		* @var boolean
89		*/
90		private $overwrite = false;
91
92		/**
93		* Whether to create relative symlinks
94		*
95		* @var boolean
96		*/
97		private $relative = false;
98
99		/**
100		* setter for linkTarget
101		*
102		* @param string $linkTarget
103		* @return void
104		*/
105	15	public function setTarget($linkTarget)
106		{
107	15	$this->linkTarget = $linkTarget;
108	15	}
109
110		/**
111		* setter for _link
112		*
113		* @param string $link
114		* @return void
115		*/
116	15	public function setLink($link)
117		{
118	15	$this->link = $link;
119	15	}
120
121		/**
122		* creator for _filesets
123		*
124		* @return FileSet
125		*/
126		public function createFileset()
127		{
128		$num = array_push($this->filesets, new FileSet());
129
130		return $this->filesets[$num - 1];
131		}
132
133		/**
134		* setter for _overwrite
135		*
136		* @param boolean $overwrite
137		* @return void
138		*/
139	3	public function setOverwrite($overwrite)
140		{
141	3	$this->overwrite = $overwrite;
142	3	}
143
144		/**
145		* @param boolean $relative
146		*/
147		public function setRelative($relative)
148		{
149		$this->relative = $relative;
150		}
151
152		/**
153		* getter for linkTarget
154		*
155		* @return string
156		* @throws BuildException
157		*/
158	15	public function getTarget()
159		{
160	15	if ($this->linkTarget === null) {
161		throw new BuildException('Target not set');
162		}
163
164	15	return $this->linkTarget;
165		}
166
167		/**
168		* getter for _link
169		*
170		* @return string
171		* @throws BuildException
172		*/
173	15	public function getLink()
174		{
175	15	if ($this->link === null) {
176		throw new BuildException('Link not set');
177		}
178
179	15	return $this->link;
180		}
181
182		/**
183		* getter for _filesets
184		*
185		* @return array
186		*/
187	15	public function getFilesets()
188		{
189	15	return $this->filesets;
190		}
191
192		/**
193		* getter for _overwrite
194		*
195		* @return boolean
196		*/
197	4	public function getOverwrite()
198		{
199	4	return $this->overwrite;
200		}
201
202		/**
203		* @return boolean
204		*/
205	15	public function isRelative()
206		{
207	15	return $this->relative;
208		}
209
210		/**
211		* Given an existing path, convert it to a path relative to a given starting path.
212		*
213		* @param string $endPath Absolute path of target
214		* @param string $startPath Absolute path where traversal begins
215		*
216		* @return string Path of target relative to starting path
217		*/
218		public function makePathRelative($endPath, $startPath)
219		{
220		// Normalize separators on Windows
221		if ('\\' === DIRECTORY_SEPARATOR) {
222		$endPath = str_replace('\\', '/', $endPath);
223		$startPath = str_replace('\\', '/', $startPath);
224		}
225
226		// Split the paths into arrays
227		$startPathArr = explode('/', trim($startPath, '/'));
228		$endPathArr = explode('/', trim($endPath, '/'));
229
230		// Find for which directory the common path stops
231		$index = 0;
232		while (isset($startPathArr[$index]) && isset($endPathArr[$index]) && $startPathArr[$index] === $endPathArr[$index]) {
233		++$index;
234		}
235
236		// Determine how deep the start path is relative to the common path (ie, "web/bundles" = 2 levels)
237		$depth = count($startPathArr) - $index;
238
239		// Repeated "../" for each level need to reach the common path
240		$traverser = str_repeat('../', $depth);
241
242		$endPathRemainder = implode('/', array_slice($endPathArr, $index));
243
244		// Construct $endPath from traversing to the common path, then to the remaining $endPath
245		$relativePath = $traverser . ('' !== $endPathRemainder ? $endPathRemainder . '/' : '');
246
247		return '' === $relativePath ? './' : $relativePath;
248		}
249
250		/**
251		* Generates an array of directories / files to be linked
252		* If _filesets is empty, returns getTarget()
253		*
254		* @return array\|string
255		* @throws BuildException
256		*/
257	15	protected function getMap()
258		{
259	15	$fileSets = $this->getFilesets();
260
261		// No filesets set
262		// We're assuming single file / directory
263	15	if (empty($fileSets)) {
264	15	return $this->getTarget();
265		}
266
267		$targets = [];
268
269		foreach ($fileSets as $fs) {
270		if (!($fs instanceof FileSet)) {
271		continue;
272		}
273
274		// We need a directory to store the links
275		if (!is_dir($this->getLink())) {
276		throw new BuildException('Link must be an existing directory when using fileset');
277		}
278
279		$fromDir = $fs->getDir($this->getProject())->getAbsolutePath();
280
281		if (!is_dir($fromDir)) {
282		$this->log('Directory doesn\'t exist: ' . $fromDir, Project::MSG_WARN);
283		continue;
284		}
285
286		$fsTargets = [];
287
288		$ds = $fs->getDirectoryScanner($this->getProject());
289
290		$fsTargets = array_merge(
291		$fsTargets,
292		$ds->getIncludedDirectories(),
293		$ds->getIncludedFiles()
294		);
295
296		// Add each target to the map
297		foreach ($fsTargets as $target) {
298		if (!empty($target)) {
299		$targets[$target] = $fromDir . DIRECTORY_SEPARATOR . $target;
300		}
301		}
302		}
303
304		return $targets;
305		}
306
307		/**
308		* Main entry point for task
309		*
310		* @return bool
311		*/
312	15	public function main()
313		{
314	15	$map = $this->getMap();
315
316		// Single file symlink
317	15	if (is_string($map)) {
		0 ignored issues – show introduced 2019-07-31 09:36 UTC by Report Bug Copy Issue Report The condition `is_string($map)` is always `true`. Loading history...
318	15	return $this->symlink($map, $this->getLink());
319		}
320
321		// Multiple symlinks
322		foreach ($map as $name => $targetPath) {
323		$this->symlink($targetPath, $this->getLink() . DIRECTORY_SEPARATOR . $name);
324		}
325
326		return true;
327		}
328
329		/**
330		* Create the actual link
331		*
332		* @param string $target
333		* @param string $link
334		* @return bool
335		*/
336	15	protected function symlink($target, $link)
337		{
338	15	$fs = FileSystem::getFileSystem();
339
340	15	if ($this->isRelative()) {
341		$link = (new File($link))->getAbsolutePath();
342		$target = rtrim($this->makePathRelative($target, dirname($link)), '/');
343		}
344
345	15	if (is_link($link) && @readlink($link) == $target) {
346	1	$this->log('Link exists: ' . $link, Project::MSG_INFO);
347
348	1	return true;
349		}
350
351	15	if (file_exists($link) \|\| is_link($link)) {
352	4	if (!$this->getOverwrite()) {
353	1	$this->log('Not overwriting existing link ' . $link, Project::MSG_ERR);
354
355	1	return false;
356		}
357
358	3	if (is_link($link) \|\| is_file($link)) {
359	2	$fs->unlink($link);
360	2	$this->log('Link removed: ' . $link, Project::MSG_INFO);
361		} else {
362	1	$fs->rmdir($link, true);
363	1	$this->log('Directory removed: ' . $link, Project::MSG_INFO);
364		}
365		}
366
367	15	$this->log('Linking: ' . $target . ' to ' . $link, Project::MSG_INFO);
368
369	15	$fs->symlink($target, $link);
370
371	15	return true;
372		}
373		}
374

phingofficial / phing

Push — main ( fc9dd0...ba819d )

SymlinkTask::symlink() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like