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

/**
 * Imports another build file into the current project.
 *
 * Targets and properties of the imported file can be overrridden
 * by targets and properties of the same name declared in the importing file.
 *
 * The imported file will have a new synthetic property of
 * "phing.file.<projectname>" declared which gives the full path to the
 * imported file. Additionally each target in the imported file will be
 * declared twice: once with the normal name and once with "<projectname>."
 * prepended. The "<projectname>.<targetname>" synthetic targets allow the
 * importing file a mechanism to call the imported files targets as
 * dependencies or via the <phing> or <phingcall> task mechanisms.
 *
 * @author  Bryan Davis <bpd@keynetics.com>
 * @package phing.tasks.system
 */
class ImportTask extends Task
{
    use ResourceAware;

    /**
     * @var FileSystem
     */
    protected $fs;

    /**
     * @var PhingFile
     */
    protected $file;

    /**
     * @var bool
     */
    protected $optional = false;

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

    /**
     * @var string
     */
    private $prefixSeparator = '.';

    /**
     * Initialize task.
     *
     * @return void
     */
    public function init()
    {
        $this->fs = FileSystem::getFileSystem();
    }

    /**
     * Set the file to import.
     *
     * @param  string $f Path to file
     * @return void
     */
    public function setFile($f)
    {
        $this->file = $f;
    }

    /**
     * The prefix to use when prefixing the imported target names.
     *
     * @param string $prefix
     */
    public function setAs(string $prefix)
    {
        $this->targetPrefix = $prefix;
    }

    /**
     * The separator to use between prefix and target name, default is
     * ".".
     *
     * @param string $s
     */
    public function setPrefixSeparator(string $s)
    {
        $this->prefixSeparator = $s;
    }

    /**
     * Is this include optional?
     *
     * @param  bool $opt If true, do not stop the build if the file does not
     *                   exist
     * @return void
     */
    public function setOptional($opt)
    {
        $this->optional = $opt;
    }

    /**
     * Parse a Phing build file and copy the properties, tasks, data types and
     * targets it defines into the current project.
     *
     * @throws BuildException
     * @return void
     */
    public function main()
    {
        if ($this->file === null && count($this->filesets) === 0) {
            throw new BuildException(
                'import requires file attribute or at least one nested fileset'
            );
        }
        if ($this->getOwningTarget() === null || $this->getOwningTarget()->getName() !== '') {
            throw new BuildException('import only allowed as a top-level task');
        }
        if ($this->getLocation() === null || $this->getLocation()->getFileName() === null) {
            throw new BuildException("Unable to get location of import task");
        }

        // Single file.
        if ($this->file !== null) {
            $file = new PhingFile($this->file);
            if (!$file->isAbsolute()) {
                $file = new PhingFile($this->project->getBasedir(), $this->file);
            }
            if (!$file->exists()) {
                $msg = "Unable to find build file: {$file->getPath()}";
                if ($this->optional) {
                    $this->log($msg . '... skipped');
                    return;
                }

                throw new BuildException($msg);
            }
            $this->importFile($file);
        }

        // Filesets.
        $total_files = 0;
        $total_dirs = 0;
        /** @var FileSet $fs */
        foreach ($this->filesets as $fs) {
            $ds = $fs->getDirectoryScanner($this->project);
            $fromDir = $fs->getDir($this->project);

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

            $filecount = count($srcFiles);
            $total_files += $filecount;
            for ($j = 0; $j < $filecount; $j++) {
                $this->importFile(new PhingFile($fromDir, $srcFiles[$j]));
            }

            $dircount = count($srcDirs);
            $total_dirs += $dircount;
            for ($j = 0; $j < $dircount; $j++) {
                $this->importFile(new PhingFile($fromDir, $srcDirs[$j]));
            }
        }
    }

    /**
     * Parse a Phing build file and copy the properties, tasks, data types and
     * targets it defines into the current project.
     *
     * @throws BuildException
     * @return void
     */
    protected function importFile(PhingFile $file)
    {
        /** @var PhingXMLContext $ctx */
        $ctx = $this->project->getReference(ProjectConfigurator::PARSING_CONTEXT_REFERENCE);
        $cfg = $ctx->getConfigurator();
        // Import xml file into current project scope
        // Since this is delayed until after the importing file has been
        // processed, the properties and targets of this new file may not take
        // effect if they have alreday been defined in the outer scope.
        $this->log(
            "Importing file {$file->getAbsolutePath()} from "
            . $this->getLocation()->getFileName(),
            Project::MSG_VERBOSE
        );
        ProjectConfigurator::configureProject($this->project, $file);
    }

    /**
     * Whether the task is in include (as opposed to import) mode.
     *
     * <p>In include mode included targets are only known by their
     * prefixed names and their depends lists get rewritten so that
     * all dependencies get the prefix as well.</p>
     *
     * <p>In import mode imported targets are known by an adorned as
     * well as a prefixed name and the unadorned target may be
     * overwritten in the importing build file.  The depends list of
     * the imported targets is not modified at all.</p>
     *
     * @return bool
     */
    protected function isInIncludeMode(): bool
    {
        return 'include' === $this->getTaskType();
    }
}

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		* Imports another build file into the current project.
22		*
23		* Targets and properties of the imported file can be overrridden
24		* by targets and properties of the same name declared in the importing file.
25		*
26		* The imported file will have a new synthetic property of
27		* "phing.file.<projectname>" declared which gives the full path to the
28		* imported file. Additionally each target in the imported file will be
29		* declared twice: once with the normal name and once with "<projectname>."
30		* prepended. The "<projectname>.<targetname>" synthetic targets allow the
31		* importing file a mechanism to call the imported files targets as
32		* dependencies or via the <phing> or <phingcall> task mechanisms.
33		*
34		* @author Bryan Davis <bpd@keynetics.com>
35		* @package phing.tasks.system
36		*/
37		class ImportTask extends Task
38		{
39		use ResourceAware;
40
41		/**
42		* @var FileSystem
43		*/
44		protected $fs;
45
46		/**
47		* @var PhingFile
48		*/
49		protected $file;
50
51		/**
52		* @var bool
53		*/
54		protected $optional = false;
55
56		/**
57		* @var string
58		*/
59		private $targetPrefix;
60
61		/**
62		* @var string
63		*/
64		private $prefixSeparator = '.';
65
66		/**
67		* Initialize task.
68		*
69		* @return void
70		*/
71	1	public function init()
72		{
73	1	$this->fs = FileSystem::getFileSystem();
74		}
75
76		/**
77		* Set the file to import.
78		*
79		* @param string $f Path to file
80		* @return void
81		*/
82	1	public function setFile($f)
83		{
84	1	$this->file = $f;
85		}
86
87		/**
88		* The prefix to use when prefixing the imported target names.
89		*
90		* @param string $prefix
91		*/
92	0	public function setAs(string $prefix)
93		{
94	0	$this->targetPrefix = $prefix;
95		}
96
97		/**
98		* The separator to use between prefix and target name, default is
99		* ".".
100		*
101		* @param string $s
102		*/
103	0	public function setPrefixSeparator(string $s)
104		{
105	0	$this->prefixSeparator = $s;
106		}
107
108		/**
109		* Is this include optional?
110		*
111		* @param bool $opt If true, do not stop the build if the file does not
112		* exist
113		* @return void
114		*/
115	1	public function setOptional($opt)
116		{
117	1	$this->optional = $opt;
118		}
119
120		/**
121		* Parse a Phing build file and copy the properties, tasks, data types and
122		* targets it defines into the current project.
123		*
124		* @throws BuildException
125		* @return void
126		*/
127	1	public function main()
128		{
129	1	if ($this->file === null && count($this->filesets) === 0) {
130	0	throw new BuildException(
131	0	'import requires file attribute or at least one nested fileset'
132		);
133		}
134	1	if ($this->getOwningTarget() === null \|\| $this->getOwningTarget()->getName() !== '') {
135	1	throw new BuildException('import only allowed as a top-level task');
136		}
137	1	if ($this->getLocation() === null \|\| $this->getLocation()->getFileName() === null) {
138	0	throw new BuildException("Unable to get location of import task");
139		}
140
141		// Single file.
142	1	if ($this->file !== null) {
143	1	$file = new PhingFile($this->file);
144	1	if (!$file->isAbsolute()) {
145	1	$file = new PhingFile($this->project->getBasedir(), $this->file);
146		}
147	1	if (!$file->exists()) {
148	0	$msg = "Unable to find build file: {$file->getPath()}";
149	0	if ($this->optional) {
150	0	$this->log($msg . '... skipped');
151	0	return;
152		}
153
154	0	throw new BuildException($msg);
155		}
156	1	$this->importFile($file);
157		}
158
159		// Filesets.
160	1	$total_files = 0;
161	1	$total_dirs = 0;
162		/** @var FileSet $fs */
163	1	foreach ($this->filesets as $fs) {
164	1	$ds = $fs->getDirectoryScanner($this->project);
165	1	$fromDir = $fs->getDir($this->project);
166
167	1	$srcFiles = $ds->getIncludedFiles();
168	1	$srcDirs = $ds->getIncludedDirectories();
169
170	1	$filecount = count($srcFiles);
171	1	$total_files += $filecount;
172	1	for ($j = 0; $j < $filecount; $j++) {
173	1	$this->importFile(new PhingFile($fromDir, $srcFiles[$j]));
174		}
175
176	1	$dircount = count($srcDirs);
177	1	$total_dirs += $dircount;
178	1	for ($j = 0; $j < $dircount; $j++) {
179	0	$this->importFile(new PhingFile($fromDir, $srcDirs[$j]));
180		}
181		}
182		}
183
184		/**
185		* Parse a Phing build file and copy the properties, tasks, data types and
186		* targets it defines into the current project.
187		*
188		* @throws BuildException
189		* @return void
190		*/
191	1	protected function importFile(PhingFile $file)
192		{
193		/** @var PhingXMLContext $ctx */
194	1	$ctx = $this->project->getReference(ProjectConfigurator::PARSING_CONTEXT_REFERENCE);
195	1	$cfg = $ctx->getConfigurator();
196		// Import xml file into current project scope
197		// Since this is delayed until after the importing file has been
198		// processed, the properties and targets of this new file may not take
199		// effect if they have alreday been defined in the outer scope.
200	1	$this->log(
201	1	"Importing file {$file->getAbsolutePath()} from "
202	1	. $this->getLocation()->getFileName(),
203	1	Project::MSG_VERBOSE
204		);
205	1	ProjectConfigurator::configureProject($this->project, $file);
206		}
207
208		/**
209		* Whether the task is in include (as opposed to import) mode.
210		*
211		* <p>In include mode included targets are only known by their
212		* prefixed names and their depends lists get rewritten so that
213		* all dependencies get the prefix as well.</p>
214		*
215		* <p>In import mode imported targets are known by an adorned as
216		* well as a prefixed name and the unadorned target may be
217		* overwritten in the importing build file. The depends list of
218		* the imported targets is not modified at all.</p>
219		*
220		* @return bool
221		*/
222	0	protected function isInIncludeMode(): bool
223		{
224	0	return 'include' === $this->getTaskType();
225		}
226		}