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
|
<?php
/*
* $Id: c59aff266a03f0e2cf22dc33143f2decf2d5e05c $
*
* 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';
/**
* fileHash
*
* Calculate either MD5 or SHA hash value of a specified file and retun the
* value in a property
*
* @author Johan Persson <johan162@gmail.com>
* @version $Id: c59aff266a03f0e2cf22dc33143f2decf2d5e05c $
* @package phing.tasks.ext
*/
class FileHashTask extends Task
{
/**
* Property for File
* @var PhingFile file
*/
private $file;
/**
* Property to be set
* @var string $property
*/
private $propertyName = "filehashvalue";
/**
* Specify which hash algorithm to use.
* 0 = MD5
* 1 = SHA1
*
* @var integer $hashtype
*/
private $hashtype=0;
/**
* Specify if MD5 or SHA1 hash should be used
* @param integer $type 0=MD5, 1=SHA1
*/
public function setHashtype($type)
{
$this->hashtype = $type;
}
/**
* Which file to calculate the hash value of
* @param PhingFile $file
*/
public function setFile($file)
{
$this->file = $file;
}
/**
* Set the name of the property to store the hash value in
* @param $property
* @return void
*/
public function setPropertyName($property)
{
$this->propertyName = $property;
}
/**
* Main-Method for the Task
*
* @return void
* @throws BuildException
*/
public function main()
{
$this->checkFile();
$this->checkPropertyName();
// read file
if( (int)$this->hashtype === 0 ) {
$this->log("Calculating MD5 hash from: ".$this->file);
$hashValue = md5_file($this->file,false);
}
elseif( (int)$this->hashtype === 1 ) {
$this->log("Calculating SHA1 hash from: ".$this->file);
$hashValue = sha1_file($this->file,false);
}
else {
throw new BuildException(
sprintf('[FileHash] Unknown hashtype specified %d. Must be either 0 (=MD5) or 1 (=SHA1).',$this->hashtype));
}
// publish hash value
$this->project->setProperty($this->propertyName, $hashValue);
}
/**
* checks file attribute
* @return void
* @throws BuildException
*/
private function checkFile()
{
// check File
if ($this->file === null ||
strlen($this->file) == 0) {
throw new BuildException('[FileHash] You must specify an input file.', $this->file);
}
if( ! is_readable($this->file) ) {
throw new BuildException(sprintf('[FileHash] Input file does not exist or is not readable: %s',$this->file));
}
}
/**
* checks property attribute
* @return void
* @throws BuildException
*/
private function checkPropertyName()
{
if (is_null($this->propertyName) ||
strlen($this->propertyName) === 0) {
throw new BuildException('Property name for publishing hashvalue is not set');
}
}
}
|
