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
|
<?php
/**
* $Id: e47210ed45e9b2e8b92abe87f7d0e667b2ba7707 $
*
* 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/ext/HttpTask.php';
/**
* A HTTP request task.
* Making an HTTP request and try to match the response against an provided
* regular expression.
*
* @package phing.tasks.ext
* @author Benjamin Schultz <bschultz@proqrent.de>
* @version $Id: e47210ed45e9b2e8b92abe87f7d0e667b2ba7707 $
* @since 2.4.1
*/
class HttpRequestTask extends HttpTask
{
/**
* Holds the regular expression that should match the response
*
* @var string
*/
protected $responseRegex = '';
/**
* Whether to enable detailed logging
*
* @var boolean
*/
protected $verbose = false;
/**
* Holds the events that will be logged
*
* @var array<string>
*/
protected $observerEvents = array(
'connect',
'sentHeaders',
'sentBodyPart',
'receivedHeaders',
'receivedBody',
'disconnect',
);
/**
* Holds the request method
*
* @var string
*/
protected $method = null;
/**
* Holds additional post parameters for the request
*
* @var Parameter[]
*/
protected $postParameters = array();
/**
* Sets the response regex
*
* @param string $regex
*/
public function setResponseRegex($regex)
{
$this->responseRegex = $regex;
}
/**
* Sets whether to enable detailed logging
*
* @param boolean $verbose
*/
public function setVerbose($verbose)
{
$this->verbose = StringHelper::booleanValue($verbose);
}
/**
* Sets a list of observer events that will be logged if verbose output is enabled.
*
* @param string $observerEvents List of observer events
*/
public function setObserverEvents($observerEvents)
{
$this->observerEvents = array();
$token = ' ,;';
$ext = strtok($observerEvents, $token);
while ($ext !== false) {
$this->observerEvents[] = $ext;
$ext = strtok($token);
}
}
/**
* The setter for the method
*/
public function setMethod($method)
{
$this->method = $method;
}
/**
* Creates post body parameters for this request
*
* @return Parameter The created post parameter
*/
public function createPostParameter()
{
$num = array_push($this->postParameters, new Parameter());
return $this->postParameters[$num-1];
}
/**
* Load the necessary environment for running this task.
*
* @throws BuildException
*/
public function init()
{
parent::init();
$this->authScheme = HTTP_Request2::AUTH_BASIC;
// Other dependencies that should only be loaded when class is actually used
require_once 'HTTP/Request2/Observer/Log.php';
}
/**
* Creates and configures an instance of HTTP_Request2
*
* @return HTTP_Request2
*/
protected function createRequest()
{
$request = parent::createRequest();
if ($this->method == HTTP_Request2::METHOD_POST) {
$request->setMethod(HTTP_Request2::METHOD_POST);
foreach ($this->postParameters as $postParameter) {
$request->addPostParameter($postParameter->getName(), $postParameter->getValue());
}
}
if ($this->verbose) {
$observer = new HTTP_Request2_Observer_Log();
// set the events we want to log
$observer->events = $this->observerEvents;
$request->attach($observer);
}
return $request;
}
/**
* Checks whether response body matches the given regexp
*
* @param HTTP_Request2_Response $response
* @return void
* @throws BuildException
*/
protected function processResponse(HTTP_Request2_Response $response)
{
if ($this->responseRegex !== '') {
$matches = array();
preg_match($this->responseRegex, $response->getBody(), $matches);
if (count($matches) === 0) {
throw new BuildException('The received response body did not match the given regular expression');
} else {
$this->log('The response body matched the provided regex.');
}
}
}
}
|
