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
|
<?php
/*
* $Id: db4c8bc8217483d4150b2d9e62d2ef5129038b4e $
*
* 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>.
*/
/**
* Selector that filters files based on whether they appear in another
* directory tree. It can contain a mapper element, so isn't available
* as an ExtendSelector (since those parameters can't hold other
* elements).
*
* @author Hans Lellelid <hans@xmpl.org> (Phing)
* @author Bruce Atherton <bruce@callenish.com> (Ant)
* @package phing.types.selectors
*/
class PresentSelector extends BaseSelector {
private $targetdir = null;
private $mapperElement = null;
private $map = null;
private $destmustexist = true;
private static $filePresence = array("srconly", "both");
public function toString() {
$buf = "{presentselector targetdir: ";
if ($this->targetdir === null) {
$buf .= "NOT YET SET";
} else {
$buf .= $this->targetdir->getName();
}
$buf .= " present: ";
if ($this->destmustexist) {
$buf .= "both";
} else {
$buf .= "srconly";
}
if ($this->map !== null) {
$buf .= $this->map->toString();
} elseif ($this->mapperElement !== null) {
$buf .= $this->mapperElement->toString();
}
$buf .= "}";
return $buf;
}
/**
* The name of the file or directory which is checked for matching
* files.
*
* @param targetdir the directory to scan looking for matching files.
*/
public function setTargetdir(PhingFile $targetdir) {
$this->targetdir = $targetdir;
}
/**
* Defines the FileNameMapper to use (nested mapper element).
* @throws BuildException
*/
public function createMapper() {
if ($this->mapperElement !== null) {
throw new BuildException("Cannot define more than one mapper");
}
$this->mapperElement = new Mapper($this->getProject());
return $this->mapperElement;
}
/**
* This sets whether to select a file if its dest file is present.
* It could be a <code>negate</code> boolean, but by doing things
* this way, we get some documentation on how the system works.
* A user looking at the documentation should clearly understand
* that the ONLY files whose presence is being tested are those
* that already exist in the source directory, hence the lack of
* a <code>destonly</code> option.
*
* @param string $fp An attribute set to either <code>srconly</code> or
* <code>both</code>.
*/
public function setPresent($fp) {
$idx = array_search($fp, self::$filePresence, true);
if ( $idx === 0 ) {
$this->destmustexist = false;
}
}
/**
* Checks to make sure all settings are kosher. In this case, it
* means that the targetdir attribute has been set and we have a mapper.
*/
public function verifySettings() {
if ($this->targetdir === null) {
$this->setError("The targetdir attribute is required.");
}
if ($this->mapperElement === null) {
$this->map = new IdentityMapper();
} else {
$this->map = $this->mapperElement->getImplementation();
}
if ($this->map === null) {
$this->setError("Could not set <mapper> element.");
}
}
/**
* The heart of the matter. This is where the selector gets to decide
* on the inclusion of a file in a particular fileset.
*
* @param basedir the base directory the scan is being done from
* @param filename is the name of the file to check
* @param file is a PhingFile object the selector can use
* @return whether the file should be selected or not
*/
public function isSelected(PhingFile $basedir, $filename, PhingFile $file) {
$this->validate();
// Determine file whose existence is to be checked
$destfiles = $this->map->main($filename);
// If filename does not match the To attribute of the mapper
// then filter it out of the files we are considering
if ($destfiles === null) {
return false;
}
// Sanity check
if (count($destfiles) !== 1 || $destfiles[0] === null) {
throw new BuildException("Invalid destination file results for "
. $this->targetdir . " with filename " . $filename);
}
$destname = $destfiles[0];
$destfile = new PhingFile($this->targetdir, $destname);
return $destfile->exists() === $this->destmustexist;
}
}
|
