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
|
<?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>.
*/
require_once 'phing/tasks/system/MatchingTask.php';
/**
* Base class for extracting tasks such as Unzip and Untar.
*
* @author Joakim Bodin <joakim.bodin+phing@gmail.com>
* @version $Id: 983b68d4a1953a0c393a90bab842f9f2e75d2e90 $
* @package phing.tasks.ext
* @since 2.2.0
*/
abstract class ExtractBaseTask extends MatchingTask {
/**
* @var PhingFile $file
*/
protected $file;
/**
* @var PhingFile $todir
*/
protected $todir;
protected $removepath;
protected $filesets = array(); // all fileset objects assigned to this task
/**
* Set to true to always extract (and possibly overwrite)
* all files from the archive
* @var boolean
*/
protected $forceExtract = false;
/**
* Nested adder, adds a set of files (nested fileset attribute).
*
* @return void
*/
public function addFileSet(FileSet $fs) {
$this->filesets[] = $fs;
}
/**
* Set the name of the zip file to extract.
* @param PhingFile $file zip file to extract
*/
public function setFile(PhingFile $file) {
$this->file = $file;
}
/**
* This is the base directory to look in for things to zip.
* @param PhingFile $baseDir
*/
public function setToDir(PhingFile $todir) {
$this->todir = $todir;
}
public function setRemovePath($removepath)
{
$this->removepath = $removepath;
}
/**
* Sets the forceExtract attribute
* @param boolean $forceExtract
*/
public function setForceExtract($forceExtract)
{
$this->forceExtract = (bool) $forceExtract;
}
/**
* do the work
* @throws BuildException
*/
public function main() {
$this->validateAttributes();
$filesToExtract = array();
if ($this->file !== null) {
if($this->forceExtract || !$this->isDestinationUpToDate($this->file)) {
$filesToExtract[] = $this->file;
} else {
$this->log('Nothing to do: ' . $this->todir->getAbsolutePath() . ' is up to date for ' . $this->file->getCanonicalPath(), Project::MSG_INFO);
}
}
foreach($this->filesets as $compressedArchiveFileset) {
$compressedArchiveDirScanner = $compressedArchiveFileset->getDirectoryScanner($this->project);
$compressedArchiveFiles = $compressedArchiveDirScanner->getIncludedFiles();
$compressedArchiveDir = $compressedArchiveFileset->getDir($this->project);
foreach ($compressedArchiveFiles as $compressedArchiveFilePath) {
$compressedArchiveFile = new PhingFile($compressedArchiveDir, $compressedArchiveFilePath);
if($compressedArchiveFile->isDirectory())
{
throw new BuildException($compressedArchiveFile->getAbsolutePath() . ' compressed archive cannot be a directory.');
}
if ($this->forceExtract || !$this->isDestinationUpToDate($compressedArchiveFile)) {
$filesToExtract[] = $compressedArchiveFile;
} else {
$this->log('Nothing to do: ' . $this->todir->getAbsolutePath() . ' is up to date for ' . $compressedArchiveFile->getCanonicalPath(), Project::MSG_INFO);
}
}
}
foreach ($filesToExtract as $compressedArchiveFile) {
$this->extractArchive($compressedArchiveFile);
}
}
abstract protected function extractArchive(PhingFile $compressedArchiveFile);
/**
* @param array $files array of filenames
* @param PhingFile $dir
* @return boolean
*/
protected function isDestinationUpToDate(PhingFile $compressedArchiveFile) {
if (!$compressedArchiveFile->exists()) {
throw new BuildException("Could not find file " . $compressedArchiveFile->__toString() . " to extract.");
}
$compressedArchiveContent = $this->listArchiveContent($compressedArchiveFile);
if(is_array($compressedArchiveContent)) {
$fileSystem = FileSystem::getFileSystem();
foreach ($compressedArchiveContent as $compressArchivePathInfo) {
$compressArchiveFilename = $compressArchivePathInfo['filename'];
if(!empty($this->removepath) && strlen($compressArchiveFilename) >= strlen($this->removepath))
{
$compressArchiveFilename = preg_replace('/^' . $this->removepath . '/','', $compressArchiveFilename);
}
$compressArchivePath = new PhingFile($this->todir, $compressArchiveFilename);
if(!$compressArchivePath->exists() ||
$fileSystem->compareMTimes($compressedArchiveFile->getCanonicalPath(), $compressArchivePath->getCanonicalPath()) == 1) {
return false;
}
}
}
return true;
}
abstract protected function listArchiveContent(PhingFile $compressedArchiveFile);
/**
* Validates attributes coming in from XML
*
* @access private
* @return void
* @throws BuildException
*/
protected function validateAttributes() {
if ($this->file === null && count($this->filesets) === 0) {
throw new BuildException("Specify at least one source compressed archive - a file or a fileset.");
}
if ($this->todir === null) {
throw new BuildException("todir must be set.");
}
if ($this->todir !== null && $this->todir->exists() && !$this->todir->isDirectory()) {
throw new BuildException("todir must be a directory.");
}
if ($this->file !== null && $this->file->exists() && $this->file->isDirectory()) {
throw new BuildException("Compressed archive file cannot be a directory.");
}
if ($this->file !== null && !$this->file->exists()) {
throw new BuildException("Could not find compressed archive file " . $this->file->__toString() . " to extract.");
}
}
}
|
