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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
|
<?php
/*
* $Id: DateSelector.php,v 1.10 2005/05/26 13:10:53 mrook Exp $
*
* 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/types/selectors/BaseExtendSelector.php';
/**
* Selector that chooses files based on their last modified date. Ant uses
* millisecond precision (thanks to Java); PHP is forced to use only seconds
* precision.
*
* @author Hans Lellelid <hans@xmpl.org> (Phing)
* @author Bruce Atherton <bruce@callenish.com> (Ant)
* @version $Revision: 1.10 $
* @package phing.types.selecctors
*/
class DateSelector extends BaseExtendSelector {
private $seconds = -1; // millis in Ant, but PHP doesn't support that level of precision
private $dateTime = null;
private $includeDirs = false;
private $granularity = 0;
private $cmp = 2;
const MILLIS_KEY = "millis";
const DATETIME_KEY = "datetime";
const CHECKDIRS_KEY = "checkdirs";
const GRANULARITY_KEY = "granularity";
const WHEN_KEY = "when";
private static $timeComparisons = array("before", "after", "equal");
public function __construct() {
//if (Os.isFamily("dos")) {
// granularity = 2000;
//}
}
public function toString() {
$buf = "{dateselector date: ";
$buf .= $this->dateTime;
$buf .= " compare: ";
if ($this->cmp === 0) {
$buf .= "before";
} elseif ($this->cmp === 1) {
$buf .= "after";
} else {
$buf .= "equal";
}
$buf .= " granularity: ";
$buf .= $this->granularity;
$buf .= "}";
return $buf;
}
/**
* For users that prefer to express time in seconds since 1970
*
* @param int $seconds the time to compare file's last modified date to,
* expressed in milliseconds
*/
public function setSeconds($seconds) {
$this->seconds = (int) $seconds;
}
/**
* Returns the seconds value the selector is set for.
*/
public function getSeconds() {
return $this->seconds;
}
/**
* Sets the date. The user must supply it in MM/DD/YYYY HH:MM AM_PM
* format
*
* @param string $dateTime a string in MM/DD/YYYY HH:MM AM_PM format
*/
public function setDatetime($dateTime) {
$dt = strtotime($dateTime);
if ($dt == -1) {
$this->setError("Date of " . $dateTime
. " Cannot be parsed correctly. It should be in"
. " a format parsable by PHP's strtotime() function.");
} else {
$this->dateTime = $dateTime;
$this->setSeconds($dt);
}
}
/**
* Should we be checking dates on directories?
*
* @param boolean $includeDirs whether to check the timestamp on directories
*/
public function setCheckdirs($includeDirs) {
$this->includeDirs = (boolean) $includeDirs;
}
/**
* Sets the number of milliseconds leeway we will give before we consider
* a file not to have matched a date.
* @param int $granularity
*/
public function setGranularity($granularity) {
$this->granularity = (int) $granularity;
}
/**
* Sets the type of comparison to be done on the file's last modified
* date.
*
* @param string $cmp The comparison to perform
*/
public function setWhen($cmp) {
$idx = array_search($cmp, self::$timeComparisons, true);
if ($idx === null) {
$this->setError("Invalid value for ".WHEN_KEY.": ".$cmp);
} else {
$this->cmp = $idx;
}
}
/**
* When using this as a custom selector, this method will be called.
* It translates each parameter into the appropriate setXXX() call.
*
* @param array $parameters the complete set of parameters for this selector
*/
public function setParameters($parameters) {
parent::setParameters($parameters);
if ($parameters !== null) {
for ($i=0,$size=count($parameters); $i < $size; $i++) {
$paramname = $parameters[$i]->getName();
switch(strtolower($paramname)) {
case self::MILLIS_KEY:
$this->setMillis($parameters[$i]->getValue());
break;
case self::DATETIME_KEY:
$this->setDatetime($parameters[$i]->getValue());
break;
case self::CHECKDIRS_KEY:
$this->setCheckdirs($parameters[$i]->getValue());
break;
case self::GRANULARITY_KEY:
$this->setGranularity($parameters[$i]->getValue());
break;
case self::WHEN_KEY:
$this->setWhen($parameters[$i]->getValue());
break;
default:
$this->setError("Invalid parameter " . $paramname);
} // switch
}
}
}
/**
* This is a consistency check to ensure the selector's required
* values have been set.
*/
public function verifySettings() {
if ($this->dateTime === null && $this->seconds < 0) {
$this->setError("You must provide a datetime or the number of "
. "seconds.");
} elseif ($this->seconds < 0) {
$this->setError("Date of " . $this->dateTime
. " results in negative seconds"
. " value relative to epoch (January 1, 1970, 00:00:00 GMT).");
}
}
/**
* The heart of the matter. This is where the selector gets to decide
* on the inclusion of a file in a particular fileset.
*
* @param PhingFile $basedir the base directory the scan is being done from
* @param string $filename is the name of the file to check
* @param PhingFile $file is a PhingFile object the selector can use
* @return boolean Whether the file should be selected or not
*/
public function isSelected(PhingFile $basedir, $filename, PhingFile $file) {
$this->validate();
if ($file->isDirectory() && ($this->includeDirs === false)) {
return true;
}
if ($this->cmp === 0) {
return (($file->lastModified() - $this->granularity) < $this->seconds);
} elseif ($this->cmp === 1) {
return (($file->lastModified() . $this->granularity) > $this->seconds);
} else {
return (abs($file->lastModified() - $this->seconds) <= $this->granularity);
}
}
}
|
