1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
|
<?php
/*
* $Id: 9635ed3f6605f5ed64b74e85731dbcd3ad43ce0f $
*
* 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>.
*/
require_once 'phing/Task.php';
/**
* Task for resolving relative paths and setting absolute path in property value.
*
* This task was created to address a need for resolving absolute paths of files / directories.
* In many cases a relative directory (e.g. "./build") is specified, but it needs to be treated
* as an absolute path since other build files (e.g. in subdirs) should all be using the same
* path -- and not treating it as a relative path to their own directory.
*
* <code>
* <property name="relative_path" value="./dirname"/>
* <resolvepath propertyName="absolute_path" file="${relative_path}"/>
* <echo>Resolved [absolute] path: ${absolute_path}</echo>
* </code>
*
* TODO:
* - Possibly integrate this with PackageAsPath, for handling/resolving dot-path paths.
*
* @author Hans Lellelid <hans@xmpl.org>
* @version $Id$
* @package phing.tasks.system
*/
class ResolvePathTask extends Task {
/** Name of property to set. */
private $propertyName;
/** The [possibly] relative file/path that needs to be resolved. */
private $file;
/** Base directory used for resolution. */
private $dir;
/**
* Log level
*/
private $logLevel = Project::MSG_VERBOSE;
/**
* Set the name of the property to set.
* @param string $v Property name
* @return void
*/
public function setPropertyName($v) {
$this->propertyName = $v;
}
/**
* Sets a base dir to use for resolution.
* @param PhingFile $d
*/
function setDir(PhingFile $d) {
$this->dir = $d;
}
/**
* Sets a path (file or directory) that we want to resolve.
* This is the same as setFile() -- just more generic name so that it's
* clear that you can also use it to set directory.
* @param string $f
* @see setFile()
*/
function setPath($f) {
$this->file = $f;
}
/**
* Sets a file that we want to resolve.
* @param string $f
*/
function setFile($f) {
$this->file = $f;
}
/**
* Set level of log messages generated (default = verbose)
*
* @param string $level Log level
*
* @return void
*/
public function setLevel($level)
{
switch ($level) {
case 'error':
$this->logLevel = Project::MSG_ERR;
break;
case 'warning':
$this->logLevel = Project::MSG_WARN;
break;
case 'info':
$this->logLevel = Project::MSG_INFO;
break;
case 'verbose':
$this->logLevel = Project::MSG_VERBOSE;
break;
case 'debug':
$this->logLevel = Project::MSG_DEBUG;
break;
default:
throw new BuildException(
sprintf('Unknown log level "%s"', $level)
);
}
}
/**
* Perform the resolution & set property.
*/
public function main() {
if (!$this->propertyName) {
throw new BuildException("You must specify the propertyName attribute", $this->getLocation());
}
// Currently only files are supported
if ($this->file === null) {
throw new BuildException("You must specify a path to resolve", $this->getLocation());
}
$fs = FileSystem::getFileSystem();
// if dir attribute was specified then we should
// use that as basedir to which file was relative.
// -- unless the file specified is an absolute path
if ($this->dir !== null && !$fs->isAbsolute(new PhingFile($this->file))) {
$resolved = new PhingFile($this->dir->getPath(), $this->file);
} else {
// otherwise just resolve it relative to project basedir
$resolved = $this->project->resolveFile($this->file);
}
$this->log("Resolved " . $this->file . " to " . $resolved->getAbsolutePath(), $this->logLevel);
$this->project->setProperty($this->propertyName, $resolved->getAbsolutePath());
}
}
|
