@@ -96,7 +96,7 @@ discard block |
||
96 | 96 | } else { |
97 | 97 | for ($i = 0; $i < count($f['fp']); $i++) { |
98 | 98 | $upload = array( |
99 | - 'name' => ($useBrackets? $fieldName . '[' . $i . ']': $fieldName) |
|
99 | + 'name' => ($useBrackets ? $fieldName . '[' . $i . ']' : $fieldName) |
|
100 | 100 | ); |
101 | 101 | foreach (array('fp', 'filename', 'size', 'type') as $key) { |
102 | 102 | $upload[$key] = $f[$key][$i]; |
@@ -174,7 +174,7 @@ discard block |
||
174 | 174 | $ret .= substr($header, $this->_pos[1], $length); |
175 | 175 | $length -= min(strlen($header) - $this->_pos[1], $length); |
176 | 176 | } |
177 | - $filePos = max(0, $this->_pos[1] - strlen($header)); |
|
177 | + $filePos = max(0, $this->_pos[1] - strlen($header)); |
|
178 | 178 | if ($filePos < $this->_uploads[$pos]['size']) { |
179 | 179 | while ($length > 0 && !feof($this->_uploads[$pos]['fp'])) { |
180 | 180 | if (false === ($chunk = fread($this->_uploads[$pos]['fp'], $length))) { |
@@ -1,22 +1,22 @@ discard block |
||
1 | 1 | <?php |
2 | 2 | /** |
3 | - * Helper class for building multipart/form-data request body |
|
4 | - * |
|
5 | - * PHP version 5 |
|
6 | - * |
|
7 | - * LICENSE |
|
8 | - * |
|
9 | - * This source file is subject to BSD 3-Clause License that is bundled |
|
10 | - * with this package in the file LICENSE and available at the URL |
|
11 | - * https://raw.github.com/pear/HTTP_Request2/trunk/docs/LICENSE |
|
12 | - * |
|
13 | - * @category HTTP |
|
14 | - * @package HTTP_Request2 |
|
15 | - * @author Alexey Borzov <[email protected]> |
|
16 | - * @copyright 2008-2014 Alexey Borzov <[email protected]> |
|
17 | - * @license http://opensource.org/licenses/BSD-3-Clause BSD 3-Clause License |
|
18 | - * @link http://pear.php.net/package/HTTP_Request2 |
|
19 | - */ |
|
3 | + * Helper class for building multipart/form-data request body |
|
4 | + * |
|
5 | + * PHP version 5 |
|
6 | + * |
|
7 | + * LICENSE |
|
8 | + * |
|
9 | + * This source file is subject to BSD 3-Clause License that is bundled |
|
10 | + * with this package in the file LICENSE and available at the URL |
|
11 | + * https://raw.github.com/pear/HTTP_Request2/trunk/docs/LICENSE |
|
12 | + * |
|
13 | + * @category HTTP |
|
14 | + * @package HTTP_Request2 |
|
15 | + * @author Alexey Borzov <[email protected]> |
|
16 | + * @copyright 2008-2014 Alexey Borzov <[email protected]> |
|
17 | + * @license http://opensource.org/licenses/BSD-3-Clause BSD 3-Clause License |
|
18 | + * @link http://pear.php.net/package/HTTP_Request2 |
|
19 | + */ |
|
20 | 20 | |
21 | 21 | /** Exception class for HTTP_Request2 package */ |
22 | 22 | require_once 'HTTP/Request2/Exception.php'; |
@@ -37,232 +37,232 @@ discard block |
||
37 | 37 | */ |
38 | 38 | class HTTP_Request2_MultipartBody |
39 | 39 | { |
40 | - /** |
|
41 | - * MIME boundary |
|
42 | - * @var string |
|
43 | - */ |
|
44 | - private $_boundary; |
|
40 | + /** |
|
41 | + * MIME boundary |
|
42 | + * @var string |
|
43 | + */ |
|
44 | + private $_boundary; |
|
45 | 45 | |
46 | - /** |
|
47 | - * Form parameters added via {@link HTTP_Request2::addPostParameter()} |
|
48 | - * @var array |
|
49 | - */ |
|
50 | - private $_params = array(); |
|
46 | + /** |
|
47 | + * Form parameters added via {@link HTTP_Request2::addPostParameter()} |
|
48 | + * @var array |
|
49 | + */ |
|
50 | + private $_params = array(); |
|
51 | 51 | |
52 | - /** |
|
53 | - * File uploads added via {@link HTTP_Request2::addUpload()} |
|
54 | - * @var array |
|
55 | - */ |
|
56 | - private $_uploads = array(); |
|
52 | + /** |
|
53 | + * File uploads added via {@link HTTP_Request2::addUpload()} |
|
54 | + * @var array |
|
55 | + */ |
|
56 | + private $_uploads = array(); |
|
57 | 57 | |
58 | - /** |
|
59 | - * Header for parts with parameters |
|
60 | - * @var string |
|
61 | - */ |
|
62 | - private $_headerParam = "--%s\r\nContent-Disposition: form-data; name=\"%s\"\r\n\r\n"; |
|
58 | + /** |
|
59 | + * Header for parts with parameters |
|
60 | + * @var string |
|
61 | + */ |
|
62 | + private $_headerParam = "--%s\r\nContent-Disposition: form-data; name=\"%s\"\r\n\r\n"; |
|
63 | 63 | |
64 | - /** |
|
65 | - * Header for parts with uploads |
|
66 | - * @var string |
|
67 | - */ |
|
68 | - private $_headerUpload = "--%s\r\nContent-Disposition: form-data; name=\"%s\"; filename=\"%s\"\r\nContent-Type: %s\r\n\r\n"; |
|
64 | + /** |
|
65 | + * Header for parts with uploads |
|
66 | + * @var string |
|
67 | + */ |
|
68 | + private $_headerUpload = "--%s\r\nContent-Disposition: form-data; name=\"%s\"; filename=\"%s\"\r\nContent-Type: %s\r\n\r\n"; |
|
69 | 69 | |
70 | - /** |
|
71 | - * Current position in parameter and upload arrays |
|
72 | - * |
|
73 | - * First number is index of "current" part, second number is position within |
|
74 | - * "current" part |
|
75 | - * |
|
76 | - * @var array |
|
77 | - */ |
|
78 | - private $_pos = array(0, 0); |
|
70 | + /** |
|
71 | + * Current position in parameter and upload arrays |
|
72 | + * |
|
73 | + * First number is index of "current" part, second number is position within |
|
74 | + * "current" part |
|
75 | + * |
|
76 | + * @var array |
|
77 | + */ |
|
78 | + private $_pos = array(0, 0); |
|
79 | 79 | |
80 | 80 | |
81 | - /** |
|
82 | - * Constructor. Sets the arrays with POST data. |
|
83 | - * |
|
84 | - * @param array $params values of form fields set via |
|
85 | - * {@link HTTP_Request2::addPostParameter()} |
|
86 | - * @param array $uploads file uploads set via |
|
87 | - * {@link HTTP_Request2::addUpload()} |
|
88 | - * @param bool $useBrackets whether to append brackets to array variable names |
|
89 | - */ |
|
90 | - public function __construct(array $params, array $uploads, $useBrackets = true) |
|
91 | - { |
|
92 | - $this->_params = self::_flattenArray('', $params, $useBrackets); |
|
93 | - foreach ($uploads as $fieldName => $f) { |
|
94 | - if (!is_array($f['fp'])) { |
|
95 | - $this->_uploads[] = $f + array('name' => $fieldName); |
|
96 | - } else { |
|
97 | - for ($i = 0; $i < count($f['fp']); $i++) { |
|
98 | - $upload = array( |
|
99 | - 'name' => ($useBrackets? $fieldName . '[' . $i . ']': $fieldName) |
|
100 | - ); |
|
101 | - foreach (array('fp', 'filename', 'size', 'type') as $key) { |
|
102 | - $upload[$key] = $f[$key][$i]; |
|
103 | - } |
|
104 | - $this->_uploads[] = $upload; |
|
105 | - } |
|
106 | - } |
|
107 | - } |
|
108 | - } |
|
81 | + /** |
|
82 | + * Constructor. Sets the arrays with POST data. |
|
83 | + * |
|
84 | + * @param array $params values of form fields set via |
|
85 | + * {@link HTTP_Request2::addPostParameter()} |
|
86 | + * @param array $uploads file uploads set via |
|
87 | + * {@link HTTP_Request2::addUpload()} |
|
88 | + * @param bool $useBrackets whether to append brackets to array variable names |
|
89 | + */ |
|
90 | + public function __construct(array $params, array $uploads, $useBrackets = true) |
|
91 | + { |
|
92 | + $this->_params = self::_flattenArray('', $params, $useBrackets); |
|
93 | + foreach ($uploads as $fieldName => $f) { |
|
94 | + if (!is_array($f['fp'])) { |
|
95 | + $this->_uploads[] = $f + array('name' => $fieldName); |
|
96 | + } else { |
|
97 | + for ($i = 0; $i < count($f['fp']); $i++) { |
|
98 | + $upload = array( |
|
99 | + 'name' => ($useBrackets? $fieldName . '[' . $i . ']': $fieldName) |
|
100 | + ); |
|
101 | + foreach (array('fp', 'filename', 'size', 'type') as $key) { |
|
102 | + $upload[$key] = $f[$key][$i]; |
|
103 | + } |
|
104 | + $this->_uploads[] = $upload; |
|
105 | + } |
|
106 | + } |
|
107 | + } |
|
108 | + } |
|
109 | 109 | |
110 | - /** |
|
111 | - * Returns the length of the body to use in Content-Length header |
|
112 | - * |
|
113 | - * @return integer |
|
114 | - */ |
|
115 | - public function getLength() |
|
116 | - { |
|
117 | - $boundaryLength = strlen($this->getBoundary()); |
|
118 | - $headerParamLength = strlen($this->_headerParam) - 4 + $boundaryLength; |
|
119 | - $headerUploadLength = strlen($this->_headerUpload) - 8 + $boundaryLength; |
|
120 | - $length = $boundaryLength + 6; |
|
121 | - foreach ($this->_params as $p) { |
|
122 | - $length += $headerParamLength + strlen($p[0]) + strlen($p[1]) + 2; |
|
123 | - } |
|
124 | - foreach ($this->_uploads as $u) { |
|
125 | - $length += $headerUploadLength + strlen($u['name']) + strlen($u['type']) + |
|
126 | - strlen($u['filename']) + $u['size'] + 2; |
|
127 | - } |
|
128 | - return $length; |
|
129 | - } |
|
110 | + /** |
|
111 | + * Returns the length of the body to use in Content-Length header |
|
112 | + * |
|
113 | + * @return integer |
|
114 | + */ |
|
115 | + public function getLength() |
|
116 | + { |
|
117 | + $boundaryLength = strlen($this->getBoundary()); |
|
118 | + $headerParamLength = strlen($this->_headerParam) - 4 + $boundaryLength; |
|
119 | + $headerUploadLength = strlen($this->_headerUpload) - 8 + $boundaryLength; |
|
120 | + $length = $boundaryLength + 6; |
|
121 | + foreach ($this->_params as $p) { |
|
122 | + $length += $headerParamLength + strlen($p[0]) + strlen($p[1]) + 2; |
|
123 | + } |
|
124 | + foreach ($this->_uploads as $u) { |
|
125 | + $length += $headerUploadLength + strlen($u['name']) + strlen($u['type']) + |
|
126 | + strlen($u['filename']) + $u['size'] + 2; |
|
127 | + } |
|
128 | + return $length; |
|
129 | + } |
|
130 | 130 | |
131 | - /** |
|
132 | - * Returns the boundary to use in Content-Type header |
|
133 | - * |
|
134 | - * @return string |
|
135 | - */ |
|
136 | - public function getBoundary() |
|
137 | - { |
|
138 | - if (empty($this->_boundary)) { |
|
139 | - $this->_boundary = '--' . md5('PEAR-HTTP_Request2-' . microtime()); |
|
140 | - } |
|
141 | - return $this->_boundary; |
|
142 | - } |
|
131 | + /** |
|
132 | + * Returns the boundary to use in Content-Type header |
|
133 | + * |
|
134 | + * @return string |
|
135 | + */ |
|
136 | + public function getBoundary() |
|
137 | + { |
|
138 | + if (empty($this->_boundary)) { |
|
139 | + $this->_boundary = '--' . md5('PEAR-HTTP_Request2-' . microtime()); |
|
140 | + } |
|
141 | + return $this->_boundary; |
|
142 | + } |
|
143 | 143 | |
144 | - /** |
|
145 | - * Returns next chunk of request body |
|
146 | - * |
|
147 | - * @param integer $length Number of bytes to read |
|
148 | - * |
|
149 | - * @return string Up to $length bytes of data, empty string if at end |
|
150 | - * @throws HTTP_Request2_LogicException |
|
151 | - */ |
|
152 | - public function read($length) |
|
153 | - { |
|
154 | - $ret = ''; |
|
155 | - $boundary = $this->getBoundary(); |
|
156 | - $paramCount = count($this->_params); |
|
157 | - $uploadCount = count($this->_uploads); |
|
158 | - while ($length > 0 && $this->_pos[0] <= $paramCount + $uploadCount) { |
|
159 | - $oldLength = $length; |
|
160 | - if ($this->_pos[0] < $paramCount) { |
|
161 | - $param = sprintf( |
|
162 | - $this->_headerParam, $boundary, $this->_params[$this->_pos[0]][0] |
|
163 | - ) . $this->_params[$this->_pos[0]][1] . "\r\n"; |
|
164 | - $ret .= substr($param, $this->_pos[1], $length); |
|
165 | - $length -= min(strlen($param) - $this->_pos[1], $length); |
|
144 | + /** |
|
145 | + * Returns next chunk of request body |
|
146 | + * |
|
147 | + * @param integer $length Number of bytes to read |
|
148 | + * |
|
149 | + * @return string Up to $length bytes of data, empty string if at end |
|
150 | + * @throws HTTP_Request2_LogicException |
|
151 | + */ |
|
152 | + public function read($length) |
|
153 | + { |
|
154 | + $ret = ''; |
|
155 | + $boundary = $this->getBoundary(); |
|
156 | + $paramCount = count($this->_params); |
|
157 | + $uploadCount = count($this->_uploads); |
|
158 | + while ($length > 0 && $this->_pos[0] <= $paramCount + $uploadCount) { |
|
159 | + $oldLength = $length; |
|
160 | + if ($this->_pos[0] < $paramCount) { |
|
161 | + $param = sprintf( |
|
162 | + $this->_headerParam, $boundary, $this->_params[$this->_pos[0]][0] |
|
163 | + ) . $this->_params[$this->_pos[0]][1] . "\r\n"; |
|
164 | + $ret .= substr($param, $this->_pos[1], $length); |
|
165 | + $length -= min(strlen($param) - $this->_pos[1], $length); |
|
166 | 166 | |
167 | - } elseif ($this->_pos[0] < $paramCount + $uploadCount) { |
|
168 | - $pos = $this->_pos[0] - $paramCount; |
|
169 | - $header = sprintf( |
|
170 | - $this->_headerUpload, $boundary, $this->_uploads[$pos]['name'], |
|
171 | - $this->_uploads[$pos]['filename'], $this->_uploads[$pos]['type'] |
|
172 | - ); |
|
173 | - if ($this->_pos[1] < strlen($header)) { |
|
174 | - $ret .= substr($header, $this->_pos[1], $length); |
|
175 | - $length -= min(strlen($header) - $this->_pos[1], $length); |
|
176 | - } |
|
177 | - $filePos = max(0, $this->_pos[1] - strlen($header)); |
|
178 | - if ($filePos < $this->_uploads[$pos]['size']) { |
|
179 | - while ($length > 0 && !feof($this->_uploads[$pos]['fp'])) { |
|
180 | - if (false === ($chunk = fread($this->_uploads[$pos]['fp'], $length))) { |
|
181 | - throw new HTTP_Request2_LogicException( |
|
182 | - 'Failed reading file upload', HTTP_Request2_Exception::READ_ERROR |
|
183 | - ); |
|
184 | - } |
|
185 | - $ret .= $chunk; |
|
186 | - $length -= strlen($chunk); |
|
187 | - } |
|
188 | - } |
|
189 | - if ($length > 0) { |
|
190 | - $start = $this->_pos[1] + ($oldLength - $length) - |
|
191 | - strlen($header) - $this->_uploads[$pos]['size']; |
|
192 | - $ret .= substr("\r\n", $start, $length); |
|
193 | - $length -= min(2 - $start, $length); |
|
194 | - } |
|
167 | + } elseif ($this->_pos[0] < $paramCount + $uploadCount) { |
|
168 | + $pos = $this->_pos[0] - $paramCount; |
|
169 | + $header = sprintf( |
|
170 | + $this->_headerUpload, $boundary, $this->_uploads[$pos]['name'], |
|
171 | + $this->_uploads[$pos]['filename'], $this->_uploads[$pos]['type'] |
|
172 | + ); |
|
173 | + if ($this->_pos[1] < strlen($header)) { |
|
174 | + $ret .= substr($header, $this->_pos[1], $length); |
|
175 | + $length -= min(strlen($header) - $this->_pos[1], $length); |
|
176 | + } |
|
177 | + $filePos = max(0, $this->_pos[1] - strlen($header)); |
|
178 | + if ($filePos < $this->_uploads[$pos]['size']) { |
|
179 | + while ($length > 0 && !feof($this->_uploads[$pos]['fp'])) { |
|
180 | + if (false === ($chunk = fread($this->_uploads[$pos]['fp'], $length))) { |
|
181 | + throw new HTTP_Request2_LogicException( |
|
182 | + 'Failed reading file upload', HTTP_Request2_Exception::READ_ERROR |
|
183 | + ); |
|
184 | + } |
|
185 | + $ret .= $chunk; |
|
186 | + $length -= strlen($chunk); |
|
187 | + } |
|
188 | + } |
|
189 | + if ($length > 0) { |
|
190 | + $start = $this->_pos[1] + ($oldLength - $length) - |
|
191 | + strlen($header) - $this->_uploads[$pos]['size']; |
|
192 | + $ret .= substr("\r\n", $start, $length); |
|
193 | + $length -= min(2 - $start, $length); |
|
194 | + } |
|
195 | 195 | |
196 | - } else { |
|
197 | - $closing = '--' . $boundary . "--\r\n"; |
|
198 | - $ret .= substr($closing, $this->_pos[1], $length); |
|
199 | - $length -= min(strlen($closing) - $this->_pos[1], $length); |
|
200 | - } |
|
201 | - if ($length > 0) { |
|
202 | - $this->_pos = array($this->_pos[0] + 1, 0); |
|
203 | - } else { |
|
204 | - $this->_pos[1] += $oldLength; |
|
205 | - } |
|
206 | - } |
|
207 | - return $ret; |
|
208 | - } |
|
196 | + } else { |
|
197 | + $closing = '--' . $boundary . "--\r\n"; |
|
198 | + $ret .= substr($closing, $this->_pos[1], $length); |
|
199 | + $length -= min(strlen($closing) - $this->_pos[1], $length); |
|
200 | + } |
|
201 | + if ($length > 0) { |
|
202 | + $this->_pos = array($this->_pos[0] + 1, 0); |
|
203 | + } else { |
|
204 | + $this->_pos[1] += $oldLength; |
|
205 | + } |
|
206 | + } |
|
207 | + return $ret; |
|
208 | + } |
|
209 | 209 | |
210 | - /** |
|
211 | - * Sets the current position to the start of the body |
|
212 | - * |
|
213 | - * This allows reusing the same body in another request |
|
214 | - */ |
|
215 | - public function rewind() |
|
216 | - { |
|
217 | - $this->_pos = array(0, 0); |
|
218 | - foreach ($this->_uploads as $u) { |
|
219 | - rewind($u['fp']); |
|
220 | - } |
|
221 | - } |
|
210 | + /** |
|
211 | + * Sets the current position to the start of the body |
|
212 | + * |
|
213 | + * This allows reusing the same body in another request |
|
214 | + */ |
|
215 | + public function rewind() |
|
216 | + { |
|
217 | + $this->_pos = array(0, 0); |
|
218 | + foreach ($this->_uploads as $u) { |
|
219 | + rewind($u['fp']); |
|
220 | + } |
|
221 | + } |
|
222 | 222 | |
223 | - /** |
|
224 | - * Returns the body as string |
|
225 | - * |
|
226 | - * Note that it reads all file uploads into memory so it is a good idea not |
|
227 | - * to use this method with large file uploads and rely on read() instead. |
|
228 | - * |
|
229 | - * @return string |
|
230 | - */ |
|
231 | - public function __toString() |
|
232 | - { |
|
233 | - $this->rewind(); |
|
234 | - return $this->read($this->getLength()); |
|
235 | - } |
|
223 | + /** |
|
224 | + * Returns the body as string |
|
225 | + * |
|
226 | + * Note that it reads all file uploads into memory so it is a good idea not |
|
227 | + * to use this method with large file uploads and rely on read() instead. |
|
228 | + * |
|
229 | + * @return string |
|
230 | + */ |
|
231 | + public function __toString() |
|
232 | + { |
|
233 | + $this->rewind(); |
|
234 | + return $this->read($this->getLength()); |
|
235 | + } |
|
236 | 236 | |
237 | 237 | |
238 | - /** |
|
239 | - * Helper function to change the (probably multidimensional) associative array |
|
240 | - * into the simple one. |
|
241 | - * |
|
242 | - * @param string $name name for item |
|
243 | - * @param mixed $values item's values |
|
244 | - * @param bool $useBrackets whether to append [] to array variables' names |
|
245 | - * |
|
246 | - * @return array array with the following items: array('item name', 'item value'); |
|
247 | - */ |
|
248 | - private static function _flattenArray($name, $values, $useBrackets) |
|
249 | - { |
|
250 | - if (!is_array($values)) { |
|
251 | - return array(array($name, $values)); |
|
252 | - } else { |
|
253 | - $ret = array(); |
|
254 | - foreach ($values as $k => $v) { |
|
255 | - if (empty($name)) { |
|
256 | - $newName = $k; |
|
257 | - } elseif ($useBrackets) { |
|
258 | - $newName = $name . '[' . $k . ']'; |
|
259 | - } else { |
|
260 | - $newName = $name; |
|
261 | - } |
|
262 | - $ret = array_merge($ret, self::_flattenArray($newName, $v, $useBrackets)); |
|
263 | - } |
|
264 | - return $ret; |
|
265 | - } |
|
266 | - } |
|
238 | + /** |
|
239 | + * Helper function to change the (probably multidimensional) associative array |
|
240 | + * into the simple one. |
|
241 | + * |
|
242 | + * @param string $name name for item |
|
243 | + * @param mixed $values item's values |
|
244 | + * @param bool $useBrackets whether to append [] to array variables' names |
|
245 | + * |
|
246 | + * @return array array with the following items: array('item name', 'item value'); |
|
247 | + */ |
|
248 | + private static function _flattenArray($name, $values, $useBrackets) |
|
249 | + { |
|
250 | + if (!is_array($values)) { |
|
251 | + return array(array($name, $values)); |
|
252 | + } else { |
|
253 | + $ret = array(); |
|
254 | + foreach ($values as $k => $v) { |
|
255 | + if (empty($name)) { |
|
256 | + $newName = $k; |
|
257 | + } elseif ($useBrackets) { |
|
258 | + $newName = $name . '[' . $k . ']'; |
|
259 | + } else { |
|
260 | + $newName = $name; |
|
261 | + } |
|
262 | + $ret = array_merge($ret, self::_flattenArray($newName, $v, $useBrackets)); |
|
263 | + } |
|
264 | + return $ret; |
|
265 | + } |
|
266 | + } |
|
267 | 267 | } |
268 | 268 | ?> |
@@ -1,23 +1,23 @@ discard block |
||
1 | 1 | <?php |
2 | 2 | /** |
3 | - * An observer useful for debugging / testing. |
|
4 | - * |
|
5 | - * PHP version 5 |
|
6 | - * |
|
7 | - * LICENSE |
|
8 | - * |
|
9 | - * This source file is subject to BSD 3-Clause License that is bundled |
|
10 | - * with this package in the file LICENSE and available at the URL |
|
11 | - * https://raw.github.com/pear/HTTP_Request2/trunk/docs/LICENSE |
|
12 | - * |
|
13 | - * @category HTTP |
|
14 | - * @package HTTP_Request2 |
|
15 | - * @author David Jean Louis <[email protected]> |
|
16 | - * @author Alexey Borzov <[email protected]> |
|
17 | - * @copyright 2008-2014 Alexey Borzov <[email protected]> |
|
18 | - * @license http://opensource.org/licenses/BSD-3-Clause BSD 3-Clause License |
|
19 | - * @link http://pear.php.net/package/HTTP_Request2 |
|
20 | - */ |
|
3 | + * An observer useful for debugging / testing. |
|
4 | + * |
|
5 | + * PHP version 5 |
|
6 | + * |
|
7 | + * LICENSE |
|
8 | + * |
|
9 | + * This source file is subject to BSD 3-Clause License that is bundled |
|
10 | + * with this package in the file LICENSE and available at the URL |
|
11 | + * https://raw.github.com/pear/HTTP_Request2/trunk/docs/LICENSE |
|
12 | + * |
|
13 | + * @category HTTP |
|
14 | + * @package HTTP_Request2 |
|
15 | + * @author David Jean Louis <[email protected]> |
|
16 | + * @author Alexey Borzov <[email protected]> |
|
17 | + * @copyright 2008-2014 Alexey Borzov <[email protected]> |
|
18 | + * @license http://opensource.org/licenses/BSD-3-Clause BSD 3-Clause License |
|
19 | + * @link http://pear.php.net/package/HTTP_Request2 |
|
20 | + */ |
|
21 | 21 | |
22 | 22 | /** |
23 | 23 | * Exception class for HTTP_Request2 package |
@@ -69,124 +69,124 @@ discard block |
||
69 | 69 | */ |
70 | 70 | class HTTP_Request2_Observer_Log implements SplObserver |
71 | 71 | { |
72 | - // properties {{{ |
|
72 | + // properties {{{ |
|
73 | 73 | |
74 | - /** |
|
75 | - * The log target, it can be a a resource or a PEAR Log instance. |
|
76 | - * |
|
77 | - * @var resource|Log $target |
|
78 | - */ |
|
79 | - protected $target = null; |
|
74 | + /** |
|
75 | + * The log target, it can be a a resource or a PEAR Log instance. |
|
76 | + * |
|
77 | + * @var resource|Log $target |
|
78 | + */ |
|
79 | + protected $target = null; |
|
80 | 80 | |
81 | - /** |
|
82 | - * The events to log. |
|
83 | - * |
|
84 | - * @var array $events |
|
85 | - */ |
|
86 | - public $events = array( |
|
87 | - 'connect', |
|
88 | - 'sentHeaders', |
|
89 | - 'sentBody', |
|
90 | - 'receivedHeaders', |
|
91 | - 'receivedBody', |
|
92 | - 'disconnect', |
|
93 | - ); |
|
81 | + /** |
|
82 | + * The events to log. |
|
83 | + * |
|
84 | + * @var array $events |
|
85 | + */ |
|
86 | + public $events = array( |
|
87 | + 'connect', |
|
88 | + 'sentHeaders', |
|
89 | + 'sentBody', |
|
90 | + 'receivedHeaders', |
|
91 | + 'receivedBody', |
|
92 | + 'disconnect', |
|
93 | + ); |
|
94 | 94 | |
95 | - // }}} |
|
96 | - // __construct() {{{ |
|
95 | + // }}} |
|
96 | + // __construct() {{{ |
|
97 | 97 | |
98 | - /** |
|
99 | - * Constructor. |
|
100 | - * |
|
101 | - * @param mixed $target Can be a file path (default: php://output), a resource, |
|
102 | - * or an instance of the PEAR Log class. |
|
103 | - * @param array $events Array of events to listen to (default: all events) |
|
104 | - * |
|
105 | - * @return void |
|
106 | - */ |
|
107 | - public function __construct($target = 'php://output', array $events = array()) |
|
108 | - { |
|
109 | - if (!empty($events)) { |
|
110 | - $this->events = $events; |
|
111 | - } |
|
112 | - if (is_resource($target) || $target instanceof Log) { |
|
113 | - $this->target = $target; |
|
114 | - } elseif (false === ($this->target = @fopen($target, 'ab'))) { |
|
115 | - throw new HTTP_Request2_Exception("Unable to open '{$target}'"); |
|
116 | - } |
|
117 | - } |
|
98 | + /** |
|
99 | + * Constructor. |
|
100 | + * |
|
101 | + * @param mixed $target Can be a file path (default: php://output), a resource, |
|
102 | + * or an instance of the PEAR Log class. |
|
103 | + * @param array $events Array of events to listen to (default: all events) |
|
104 | + * |
|
105 | + * @return void |
|
106 | + */ |
|
107 | + public function __construct($target = 'php://output', array $events = array()) |
|
108 | + { |
|
109 | + if (!empty($events)) { |
|
110 | + $this->events = $events; |
|
111 | + } |
|
112 | + if (is_resource($target) || $target instanceof Log) { |
|
113 | + $this->target = $target; |
|
114 | + } elseif (false === ($this->target = @fopen($target, 'ab'))) { |
|
115 | + throw new HTTP_Request2_Exception("Unable to open '{$target}'"); |
|
116 | + } |
|
117 | + } |
|
118 | 118 | |
119 | - // }}} |
|
120 | - // update() {{{ |
|
119 | + // }}} |
|
120 | + // update() {{{ |
|
121 | 121 | |
122 | - /** |
|
123 | - * Called when the request notifies us of an event. |
|
124 | - * |
|
125 | - * @param HTTP_Request2 $subject The HTTP_Request2 instance |
|
126 | - * |
|
127 | - * @return void |
|
128 | - */ |
|
129 | - public function update(SplSubject $subject) |
|
130 | - { |
|
131 | - $event = $subject->getLastEvent(); |
|
132 | - if (!in_array($event['name'], $this->events)) { |
|
133 | - return; |
|
134 | - } |
|
122 | + /** |
|
123 | + * Called when the request notifies us of an event. |
|
124 | + * |
|
125 | + * @param HTTP_Request2 $subject The HTTP_Request2 instance |
|
126 | + * |
|
127 | + * @return void |
|
128 | + */ |
|
129 | + public function update(SplSubject $subject) |
|
130 | + { |
|
131 | + $event = $subject->getLastEvent(); |
|
132 | + if (!in_array($event['name'], $this->events)) { |
|
133 | + return; |
|
134 | + } |
|
135 | 135 | |
136 | - switch ($event['name']) { |
|
137 | - case 'connect': |
|
138 | - $this->log('* Connected to ' . $event['data']); |
|
139 | - break; |
|
140 | - case 'sentHeaders': |
|
141 | - $headers = explode("\r\n", $event['data']); |
|
142 | - array_pop($headers); |
|
143 | - foreach ($headers as $header) { |
|
144 | - $this->log('> ' . $header); |
|
145 | - } |
|
146 | - break; |
|
147 | - case 'sentBody': |
|
148 | - $this->log('> ' . $event['data'] . ' byte(s) sent'); |
|
149 | - break; |
|
150 | - case 'receivedHeaders': |
|
151 | - $this->log(sprintf( |
|
152 | - '< HTTP/%s %s %s', $event['data']->getVersion(), |
|
153 | - $event['data']->getStatus(), $event['data']->getReasonPhrase() |
|
154 | - )); |
|
155 | - $headers = $event['data']->getHeader(); |
|
156 | - foreach ($headers as $key => $val) { |
|
157 | - $this->log('< ' . $key . ': ' . $val); |
|
158 | - } |
|
159 | - $this->log('< '); |
|
160 | - break; |
|
161 | - case 'receivedBody': |
|
162 | - $this->log($event['data']->getBody()); |
|
163 | - break; |
|
164 | - case 'disconnect': |
|
165 | - $this->log('* Disconnected'); |
|
166 | - break; |
|
167 | - } |
|
168 | - } |
|
136 | + switch ($event['name']) { |
|
137 | + case 'connect': |
|
138 | + $this->log('* Connected to ' . $event['data']); |
|
139 | + break; |
|
140 | + case 'sentHeaders': |
|
141 | + $headers = explode("\r\n", $event['data']); |
|
142 | + array_pop($headers); |
|
143 | + foreach ($headers as $header) { |
|
144 | + $this->log('> ' . $header); |
|
145 | + } |
|
146 | + break; |
|
147 | + case 'sentBody': |
|
148 | + $this->log('> ' . $event['data'] . ' byte(s) sent'); |
|
149 | + break; |
|
150 | + case 'receivedHeaders': |
|
151 | + $this->log(sprintf( |
|
152 | + '< HTTP/%s %s %s', $event['data']->getVersion(), |
|
153 | + $event['data']->getStatus(), $event['data']->getReasonPhrase() |
|
154 | + )); |
|
155 | + $headers = $event['data']->getHeader(); |
|
156 | + foreach ($headers as $key => $val) { |
|
157 | + $this->log('< ' . $key . ': ' . $val); |
|
158 | + } |
|
159 | + $this->log('< '); |
|
160 | + break; |
|
161 | + case 'receivedBody': |
|
162 | + $this->log($event['data']->getBody()); |
|
163 | + break; |
|
164 | + case 'disconnect': |
|
165 | + $this->log('* Disconnected'); |
|
166 | + break; |
|
167 | + } |
|
168 | + } |
|
169 | 169 | |
170 | - // }}} |
|
171 | - // log() {{{ |
|
170 | + // }}} |
|
171 | + // log() {{{ |
|
172 | 172 | |
173 | - /** |
|
174 | - * Logs the given message to the configured target. |
|
175 | - * |
|
176 | - * @param string $message Message to display |
|
177 | - * |
|
178 | - * @return void |
|
179 | - */ |
|
180 | - protected function log($message) |
|
181 | - { |
|
182 | - if ($this->target instanceof Log) { |
|
183 | - $this->target->debug($message); |
|
184 | - } elseif (is_resource($this->target)) { |
|
185 | - fwrite($this->target, $message . "\r\n"); |
|
186 | - } |
|
187 | - } |
|
173 | + /** |
|
174 | + * Logs the given message to the configured target. |
|
175 | + * |
|
176 | + * @param string $message Message to display |
|
177 | + * |
|
178 | + * @return void |
|
179 | + */ |
|
180 | + protected function log($message) |
|
181 | + { |
|
182 | + if ($this->target instanceof Log) { |
|
183 | + $this->target->debug($message); |
|
184 | + } elseif (is_resource($this->target)) { |
|
185 | + fwrite($this->target, $message . "\r\n"); |
|
186 | + } |
|
187 | + } |
|
188 | 188 | |
189 | - // }}} |
|
189 | + // }}} |
|
190 | 190 | } |
191 | 191 | |
192 | 192 | ?> |
193 | 193 | \ No newline at end of file |
@@ -134,36 +134,36 @@ |
||
134 | 134 | } |
135 | 135 | |
136 | 136 | switch ($event['name']) { |
137 | - case 'connect': |
|
138 | - $this->log('* Connected to ' . $event['data']); |
|
139 | - break; |
|
140 | - case 'sentHeaders': |
|
141 | - $headers = explode("\r\n", $event['data']); |
|
142 | - array_pop($headers); |
|
143 | - foreach ($headers as $header) { |
|
144 | - $this->log('> ' . $header); |
|
145 | - } |
|
146 | - break; |
|
147 | - case 'sentBody': |
|
148 | - $this->log('> ' . $event['data'] . ' byte(s) sent'); |
|
149 | - break; |
|
150 | - case 'receivedHeaders': |
|
151 | - $this->log(sprintf( |
|
152 | - '< HTTP/%s %s %s', $event['data']->getVersion(), |
|
153 | - $event['data']->getStatus(), $event['data']->getReasonPhrase() |
|
154 | - )); |
|
155 | - $headers = $event['data']->getHeader(); |
|
156 | - foreach ($headers as $key => $val) { |
|
157 | - $this->log('< ' . $key . ': ' . $val); |
|
158 | - } |
|
159 | - $this->log('< '); |
|
160 | - break; |
|
161 | - case 'receivedBody': |
|
162 | - $this->log($event['data']->getBody()); |
|
163 | - break; |
|
164 | - case 'disconnect': |
|
165 | - $this->log('* Disconnected'); |
|
166 | - break; |
|
137 | + case 'connect': |
|
138 | + $this->log('* Connected to ' . $event['data']); |
|
139 | + break; |
|
140 | + case 'sentHeaders': |
|
141 | + $headers = explode("\r\n", $event['data']); |
|
142 | + array_pop($headers); |
|
143 | + foreach ($headers as $header) { |
|
144 | + $this->log('> ' . $header); |
|
145 | + } |
|
146 | + break; |
|
147 | + case 'sentBody': |
|
148 | + $this->log('> ' . $event['data'] . ' byte(s) sent'); |
|
149 | + break; |
|
150 | + case 'receivedHeaders': |
|
151 | + $this->log(sprintf( |
|
152 | + '< HTTP/%s %s %s', $event['data']->getVersion(), |
|
153 | + $event['data']->getStatus(), $event['data']->getReasonPhrase() |
|
154 | + )); |
|
155 | + $headers = $event['data']->getHeader(); |
|
156 | + foreach ($headers as $key => $val) { |
|
157 | + $this->log('< ' . $key . ': ' . $val); |
|
158 | + } |
|
159 | + $this->log('< '); |
|
160 | + break; |
|
161 | + case 'receivedBody': |
|
162 | + $this->log($event['data']->getBody()); |
|
163 | + break; |
|
164 | + case 'disconnect': |
|
165 | + $this->log('* Disconnected'); |
|
166 | + break; |
|
167 | 167 | } |
168 | 168 | } |
169 | 169 |
@@ -435,11 +435,11 @@ |
||
435 | 435 | |
436 | 436 | try { |
437 | 437 | switch (strtolower($this->getHeader('content-encoding'))) { |
438 | - case 'gzip': |
|
439 | - $decoded = self::decodeGzip($this->body); |
|
440 | - break; |
|
441 | - case 'deflate': |
|
442 | - $decoded = self::decodeDeflate($this->body); |
|
438 | + case 'gzip': |
|
439 | + $decoded = self::decodeGzip($this->body); |
|
440 | + break; |
|
441 | + case 'deflate': |
|
442 | + $decoded = self::decodeDeflate($this->body); |
|
443 | 443 | } |
444 | 444 | } catch (Exception $e) { |
445 | 445 | } |
@@ -142,7 +142,7 @@ discard block |
||
142 | 142 | // the request |
143 | 143 | 300 => 'Multiple Choices', |
144 | 144 | 301 => 'Moved Permanently', |
145 | - 302 => 'Found', // 1.1 |
|
145 | + 302 => 'Found', // 1.1 |
|
146 | 146 | 303 => 'See Other', |
147 | 147 | 304 => 'Not Modified', |
148 | 148 | 305 => 'Use Proxy', |
@@ -220,8 +220,8 @@ discard block |
||
220 | 220 | $this->version = $m[1]; |
221 | 221 | $this->code = intval($m[2]); |
222 | 222 | $this->reasonPhrase = !empty($m[3]) ? trim($m[3]) : self::getDefaultReasonPhrase($this->code); |
223 | - $this->bodyEncoded = (bool)$bodyEncoded; |
|
224 | - $this->effectiveUrl = (string)$effectiveUrl; |
|
223 | + $this->bodyEncoded = (bool) $bodyEncoded; |
|
224 | + $this->effectiveUrl = (string) $effectiveUrl; |
|
225 | 225 | } |
226 | 226 | |
227 | 227 | /** |
@@ -241,9 +241,8 @@ discard block |
||
241 | 241 | if ('' == $headerLine) { |
242 | 242 | // empty string signals the end of headers, process the received ones |
243 | 243 | if (!empty($this->headers['set-cookie'])) { |
244 | - $cookies = is_array($this->headers['set-cookie'])? |
|
245 | - $this->headers['set-cookie']: |
|
246 | - array($this->headers['set-cookie']); |
|
244 | + $cookies = is_array($this->headers['set-cookie']) ? |
|
245 | + $this->headers['set-cookie'] : array($this->headers['set-cookie']); |
|
247 | 246 | foreach ($cookies as $cookieString) { |
248 | 247 | $this->parseCookie($cookieString); |
249 | 248 | } |
@@ -400,7 +399,7 @@ discard block |
||
400 | 399 | return $this->headers; |
401 | 400 | } else { |
402 | 401 | $headerName = strtolower($headerName); |
403 | - return isset($this->headers[$headerName])? $this->headers[$headerName]: null; |
|
402 | + return isset($this->headers[$headerName]) ? $this->headers[$headerName] : null; |
|
404 | 403 | } |
405 | 404 | } |
406 | 405 | |
@@ -625,7 +624,7 @@ discard block |
||
625 | 624 | // We should check for presence of zlib header and use gzuncompress() or |
626 | 625 | // gzinflate() as needed. See bug #15305 |
627 | 626 | $header = unpack('n', substr($data, 0, 2)); |
628 | - return (0 == $header[1] % 31)? gzuncompress($data): gzinflate($data); |
|
627 | + return (0 == $header[1] % 31) ? gzuncompress($data) : gzinflate($data); |
|
629 | 628 | } |
630 | 629 | } |
631 | 630 | ?> |
632 | 631 | \ No newline at end of file |
@@ -1,22 +1,22 @@ discard block |
||
1 | 1 | <?php |
2 | 2 | /** |
3 | - * Class representing a HTTP response |
|
4 | - * |
|
5 | - * PHP version 5 |
|
6 | - * |
|
7 | - * LICENSE |
|
8 | - * |
|
9 | - * This source file is subject to BSD 3-Clause License that is bundled |
|
10 | - * with this package in the file LICENSE and available at the URL |
|
11 | - * https://raw.github.com/pear/HTTP_Request2/trunk/docs/LICENSE |
|
12 | - * |
|
13 | - * @category HTTP |
|
14 | - * @package HTTP_Request2 |
|
15 | - * @author Alexey Borzov <[email protected]> |
|
16 | - * @copyright 2008-2014 Alexey Borzov <[email protected]> |
|
17 | - * @license http://opensource.org/licenses/BSD-3-Clause BSD 3-Clause License |
|
18 | - * @link http://pear.php.net/package/HTTP_Request2 |
|
19 | - */ |
|
3 | + * Class representing a HTTP response |
|
4 | + * |
|
5 | + * PHP version 5 |
|
6 | + * |
|
7 | + * LICENSE |
|
8 | + * |
|
9 | + * This source file is subject to BSD 3-Clause License that is bundled |
|
10 | + * with this package in the file LICENSE and available at the URL |
|
11 | + * https://raw.github.com/pear/HTTP_Request2/trunk/docs/LICENSE |
|
12 | + * |
|
13 | + * @category HTTP |
|
14 | + * @package HTTP_Request2 |
|
15 | + * @author Alexey Borzov <[email protected]> |
|
16 | + * @copyright 2008-2014 Alexey Borzov <[email protected]> |
|
17 | + * @license http://opensource.org/licenses/BSD-3-Clause BSD 3-Clause License |
|
18 | + * @link http://pear.php.net/package/HTTP_Request2 |
|
19 | + */ |
|
20 | 20 | |
21 | 21 | /** |
22 | 22 | * Exception class for HTTP_Request2 package |
@@ -53,579 +53,579 @@ discard block |
||
53 | 53 | */ |
54 | 54 | class HTTP_Request2_Response |
55 | 55 | { |
56 | - /** |
|
57 | - * HTTP protocol version (e.g. 1.0, 1.1) |
|
58 | - * @var string |
|
59 | - */ |
|
60 | - protected $version; |
|
61 | - |
|
62 | - /** |
|
63 | - * Status code |
|
64 | - * @var integer |
|
65 | - * @link http://tools.ietf.org/html/rfc2616#section-6.1.1 |
|
66 | - */ |
|
67 | - protected $code; |
|
68 | - |
|
69 | - /** |
|
70 | - * Reason phrase |
|
71 | - * @var string |
|
72 | - * @link http://tools.ietf.org/html/rfc2616#section-6.1.1 |
|
73 | - */ |
|
74 | - protected $reasonPhrase; |
|
75 | - |
|
76 | - /** |
|
77 | - * Effective URL (may be different from original request URL in case of redirects) |
|
78 | - * @var string |
|
79 | - */ |
|
80 | - protected $effectiveUrl; |
|
81 | - |
|
82 | - /** |
|
83 | - * Associative array of response headers |
|
84 | - * @var array |
|
85 | - */ |
|
86 | - protected $headers = array(); |
|
87 | - |
|
88 | - /** |
|
89 | - * Cookies set in the response |
|
90 | - * @var array |
|
91 | - */ |
|
92 | - protected $cookies = array(); |
|
93 | - |
|
94 | - /** |
|
95 | - * Name of last header processed by parseHederLine() |
|
96 | - * |
|
97 | - * Used to handle the headers that span multiple lines |
|
98 | - * |
|
99 | - * @var string |
|
100 | - */ |
|
101 | - protected $lastHeader = null; |
|
102 | - |
|
103 | - /** |
|
104 | - * Response body |
|
105 | - * @var string |
|
106 | - */ |
|
107 | - protected $body = ''; |
|
108 | - |
|
109 | - /** |
|
110 | - * Whether the body is still encoded by Content-Encoding |
|
111 | - * |
|
112 | - * cURL provides the decoded body to the callback; if we are reading from |
|
113 | - * socket the body is still gzipped / deflated |
|
114 | - * |
|
115 | - * @var bool |
|
116 | - */ |
|
117 | - protected $bodyEncoded; |
|
118 | - |
|
119 | - /** |
|
120 | - * Associative array of HTTP status code / reason phrase. |
|
121 | - * |
|
122 | - * @var array |
|
123 | - * @link http://tools.ietf.org/html/rfc2616#section-10 |
|
124 | - */ |
|
125 | - protected static $phrases = array( |
|
126 | - |
|
127 | - // 1xx: Informational - Request received, continuing process |
|
128 | - 100 => 'Continue', |
|
129 | - 101 => 'Switching Protocols', |
|
130 | - |
|
131 | - // 2xx: Success - The action was successfully received, understood and |
|
132 | - // accepted |
|
133 | - 200 => 'OK', |
|
134 | - 201 => 'Created', |
|
135 | - 202 => 'Accepted', |
|
136 | - 203 => 'Non-Authoritative Information', |
|
137 | - 204 => 'No Content', |
|
138 | - 205 => 'Reset Content', |
|
139 | - 206 => 'Partial Content', |
|
140 | - |
|
141 | - // 3xx: Redirection - Further action must be taken in order to complete |
|
142 | - // the request |
|
143 | - 300 => 'Multiple Choices', |
|
144 | - 301 => 'Moved Permanently', |
|
145 | - 302 => 'Found', // 1.1 |
|
146 | - 303 => 'See Other', |
|
147 | - 304 => 'Not Modified', |
|
148 | - 305 => 'Use Proxy', |
|
149 | - 307 => 'Temporary Redirect', |
|
150 | - |
|
151 | - // 4xx: Client Error - The request contains bad syntax or cannot be |
|
152 | - // fulfilled |
|
153 | - 400 => 'Bad Request', |
|
154 | - 401 => 'Unauthorized', |
|
155 | - 402 => 'Payment Required', |
|
156 | - 403 => 'Forbidden', |
|
157 | - 404 => 'Not Found', |
|
158 | - 405 => 'Method Not Allowed', |
|
159 | - 406 => 'Not Acceptable', |
|
160 | - 407 => 'Proxy Authentication Required', |
|
161 | - 408 => 'Request Timeout', |
|
162 | - 409 => 'Conflict', |
|
163 | - 410 => 'Gone', |
|
164 | - 411 => 'Length Required', |
|
165 | - 412 => 'Precondition Failed', |
|
166 | - 413 => 'Request Entity Too Large', |
|
167 | - 414 => 'Request-URI Too Long', |
|
168 | - 415 => 'Unsupported Media Type', |
|
169 | - 416 => 'Requested Range Not Satisfiable', |
|
170 | - 417 => 'Expectation Failed', |
|
171 | - |
|
172 | - // 5xx: Server Error - The server failed to fulfill an apparently |
|
173 | - // valid request |
|
174 | - 500 => 'Internal Server Error', |
|
175 | - 501 => 'Not Implemented', |
|
176 | - 502 => 'Bad Gateway', |
|
177 | - 503 => 'Service Unavailable', |
|
178 | - 504 => 'Gateway Timeout', |
|
179 | - 505 => 'HTTP Version Not Supported', |
|
180 | - 509 => 'Bandwidth Limit Exceeded', |
|
181 | - |
|
182 | - ); |
|
183 | - |
|
184 | - /** |
|
185 | - * Returns the default reason phrase for the given code or all reason phrases |
|
186 | - * |
|
187 | - * @param int $code Response code |
|
188 | - * |
|
189 | - * @return string|array|null Default reason phrase for $code if $code is given |
|
190 | - * (null if no phrase is available), array of all |
|
191 | - * reason phrases if $code is null |
|
192 | - * @link http://pear.php.net/bugs/18716 |
|
193 | - */ |
|
194 | - public static function getDefaultReasonPhrase($code = null) |
|
195 | - { |
|
196 | - if (null === $code) { |
|
197 | - return self::$phrases; |
|
198 | - } else { |
|
199 | - return isset(self::$phrases[$code]) ? self::$phrases[$code] : null; |
|
200 | - } |
|
201 | - } |
|
202 | - |
|
203 | - /** |
|
204 | - * Constructor, parses the response status line |
|
205 | - * |
|
206 | - * @param string $statusLine Response status line (e.g. "HTTP/1.1 200 OK") |
|
207 | - * @param bool $bodyEncoded Whether body is still encoded by Content-Encoding |
|
208 | - * @param string $effectiveUrl Effective URL of the response |
|
209 | - * |
|
210 | - * @throws HTTP_Request2_MessageException if status line is invalid according to spec |
|
211 | - */ |
|
212 | - public function __construct($statusLine, $bodyEncoded = true, $effectiveUrl = null) |
|
213 | - { |
|
214 | - if (!preg_match('!^HTTP/(\d\.\d) (\d{3})(?: (.+))?!', $statusLine, $m)) { |
|
215 | - throw new HTTP_Request2_MessageException( |
|
216 | - "Malformed response: {$statusLine}", |
|
217 | - HTTP_Request2_Exception::MALFORMED_RESPONSE |
|
218 | - ); |
|
219 | - } |
|
220 | - $this->version = $m[1]; |
|
221 | - $this->code = intval($m[2]); |
|
222 | - $this->reasonPhrase = !empty($m[3]) ? trim($m[3]) : self::getDefaultReasonPhrase($this->code); |
|
223 | - $this->bodyEncoded = (bool)$bodyEncoded; |
|
224 | - $this->effectiveUrl = (string)$effectiveUrl; |
|
225 | - } |
|
226 | - |
|
227 | - /** |
|
228 | - * Parses the line from HTTP response filling $headers array |
|
229 | - * |
|
230 | - * The method should be called after reading the line from socket or receiving |
|
231 | - * it into cURL callback. Passing an empty string here indicates the end of |
|
232 | - * response headers and triggers additional processing, so be sure to pass an |
|
233 | - * empty string in the end. |
|
234 | - * |
|
235 | - * @param string $headerLine Line from HTTP response |
|
236 | - */ |
|
237 | - public function parseHeaderLine($headerLine) |
|
238 | - { |
|
239 | - $headerLine = trim($headerLine, "\r\n"); |
|
240 | - |
|
241 | - if ('' == $headerLine) { |
|
242 | - // empty string signals the end of headers, process the received ones |
|
243 | - if (!empty($this->headers['set-cookie'])) { |
|
244 | - $cookies = is_array($this->headers['set-cookie'])? |
|
245 | - $this->headers['set-cookie']: |
|
246 | - array($this->headers['set-cookie']); |
|
247 | - foreach ($cookies as $cookieString) { |
|
248 | - $this->parseCookie($cookieString); |
|
249 | - } |
|
250 | - unset($this->headers['set-cookie']); |
|
251 | - } |
|
252 | - foreach (array_keys($this->headers) as $k) { |
|
253 | - if (is_array($this->headers[$k])) { |
|
254 | - $this->headers[$k] = implode(', ', $this->headers[$k]); |
|
255 | - } |
|
256 | - } |
|
257 | - |
|
258 | - } elseif (preg_match('!^([^\x00-\x1f\x7f-\xff()<>@,;:\\\\"/\[\]?={}\s]+):(.+)$!', $headerLine, $m)) { |
|
259 | - // string of the form header-name: header value |
|
260 | - $name = strtolower($m[1]); |
|
261 | - $value = trim($m[2]); |
|
262 | - if (empty($this->headers[$name])) { |
|
263 | - $this->headers[$name] = $value; |
|
264 | - } else { |
|
265 | - if (!is_array($this->headers[$name])) { |
|
266 | - $this->headers[$name] = array($this->headers[$name]); |
|
267 | - } |
|
268 | - $this->headers[$name][] = $value; |
|
269 | - } |
|
270 | - $this->lastHeader = $name; |
|
271 | - |
|
272 | - } elseif (preg_match('!^\s+(.+)$!', $headerLine, $m) && $this->lastHeader) { |
|
273 | - // continuation of a previous header |
|
274 | - if (!is_array($this->headers[$this->lastHeader])) { |
|
275 | - $this->headers[$this->lastHeader] .= ' ' . trim($m[1]); |
|
276 | - } else { |
|
277 | - $key = count($this->headers[$this->lastHeader]) - 1; |
|
278 | - $this->headers[$this->lastHeader][$key] .= ' ' . trim($m[1]); |
|
279 | - } |
|
280 | - } |
|
281 | - } |
|
282 | - |
|
283 | - /** |
|
284 | - * Parses a Set-Cookie header to fill $cookies array |
|
285 | - * |
|
286 | - * @param string $cookieString value of Set-Cookie header |
|
287 | - * |
|
288 | - * @link http://web.archive.org/web/20080331104521/http://cgi.netscape.com/newsref/std/cookie_spec.html |
|
289 | - */ |
|
290 | - protected function parseCookie($cookieString) |
|
291 | - { |
|
292 | - $cookie = array( |
|
293 | - 'expires' => null, |
|
294 | - 'domain' => null, |
|
295 | - 'path' => null, |
|
296 | - 'secure' => false |
|
297 | - ); |
|
298 | - |
|
299 | - if (!strpos($cookieString, ';')) { |
|
300 | - // Only a name=value pair |
|
301 | - $pos = strpos($cookieString, '='); |
|
302 | - $cookie['name'] = trim(substr($cookieString, 0, $pos)); |
|
303 | - $cookie['value'] = trim(substr($cookieString, $pos + 1)); |
|
304 | - |
|
305 | - } else { |
|
306 | - // Some optional parameters are supplied |
|
307 | - $elements = explode(';', $cookieString); |
|
308 | - $pos = strpos($elements[0], '='); |
|
309 | - $cookie['name'] = trim(substr($elements[0], 0, $pos)); |
|
310 | - $cookie['value'] = trim(substr($elements[0], $pos + 1)); |
|
311 | - |
|
312 | - for ($i = 1; $i < count($elements); $i++) { |
|
313 | - if (false === strpos($elements[$i], '=')) { |
|
314 | - $elName = trim($elements[$i]); |
|
315 | - $elValue = null; |
|
316 | - } else { |
|
317 | - list ($elName, $elValue) = array_map('trim', explode('=', $elements[$i])); |
|
318 | - } |
|
319 | - $elName = strtolower($elName); |
|
320 | - if ('secure' == $elName) { |
|
321 | - $cookie['secure'] = true; |
|
322 | - } elseif ('expires' == $elName) { |
|
323 | - $cookie['expires'] = str_replace('"', '', $elValue); |
|
324 | - } elseif ('path' == $elName || 'domain' == $elName) { |
|
325 | - $cookie[$elName] = urldecode($elValue); |
|
326 | - } else { |
|
327 | - $cookie[$elName] = $elValue; |
|
328 | - } |
|
329 | - } |
|
330 | - } |
|
331 | - $this->cookies[] = $cookie; |
|
332 | - } |
|
333 | - |
|
334 | - /** |
|
335 | - * Appends a string to the response body |
|
336 | - * |
|
337 | - * @param string $bodyChunk part of response body |
|
338 | - */ |
|
339 | - public function appendBody($bodyChunk) |
|
340 | - { |
|
341 | - $this->body .= $bodyChunk; |
|
342 | - } |
|
343 | - |
|
344 | - /** |
|
345 | - * Returns the effective URL of the response |
|
346 | - * |
|
347 | - * This may be different from the request URL if redirects were followed. |
|
348 | - * |
|
349 | - * @return string |
|
350 | - * @link http://pear.php.net/bugs/bug.php?id=18412 |
|
351 | - */ |
|
352 | - public function getEffectiveUrl() |
|
353 | - { |
|
354 | - return $this->effectiveUrl; |
|
355 | - } |
|
356 | - |
|
357 | - /** |
|
358 | - * Returns the status code |
|
359 | - * |
|
360 | - * @return integer |
|
361 | - */ |
|
362 | - public function getStatus() |
|
363 | - { |
|
364 | - return $this->code; |
|
365 | - } |
|
366 | - |
|
367 | - /** |
|
368 | - * Returns the reason phrase |
|
369 | - * |
|
370 | - * @return string |
|
371 | - */ |
|
372 | - public function getReasonPhrase() |
|
373 | - { |
|
374 | - return $this->reasonPhrase; |
|
375 | - } |
|
376 | - |
|
377 | - /** |
|
378 | - * Whether response is a redirect that can be automatically handled by HTTP_Request2 |
|
379 | - * |
|
380 | - * @return bool |
|
381 | - */ |
|
382 | - public function isRedirect() |
|
383 | - { |
|
384 | - return in_array($this->code, array(300, 301, 302, 303, 307)) |
|
385 | - && isset($this->headers['location']); |
|
386 | - } |
|
387 | - |
|
388 | - /** |
|
389 | - * Returns either the named header or all response headers |
|
390 | - * |
|
391 | - * @param string $headerName Name of header to return |
|
392 | - * |
|
393 | - * @return string|array Value of $headerName header (null if header is |
|
394 | - * not present), array of all response headers if |
|
395 | - * $headerName is null |
|
396 | - */ |
|
397 | - public function getHeader($headerName = null) |
|
398 | - { |
|
399 | - if (null === $headerName) { |
|
400 | - return $this->headers; |
|
401 | - } else { |
|
402 | - $headerName = strtolower($headerName); |
|
403 | - return isset($this->headers[$headerName])? $this->headers[$headerName]: null; |
|
404 | - } |
|
405 | - } |
|
406 | - |
|
407 | - /** |
|
408 | - * Returns cookies set in response |
|
409 | - * |
|
410 | - * @return array |
|
411 | - */ |
|
412 | - public function getCookies() |
|
413 | - { |
|
414 | - return $this->cookies; |
|
415 | - } |
|
416 | - |
|
417 | - /** |
|
418 | - * Returns the body of the response |
|
419 | - * |
|
420 | - * @return string |
|
421 | - * @throws HTTP_Request2_Exception if body cannot be decoded |
|
422 | - */ |
|
423 | - public function getBody() |
|
424 | - { |
|
425 | - if (0 == strlen($this->body) || !$this->bodyEncoded |
|
426 | - || !in_array(strtolower($this->getHeader('content-encoding')), array('gzip', 'deflate')) |
|
427 | - ) { |
|
428 | - return $this->body; |
|
429 | - |
|
430 | - } else { |
|
431 | - if (extension_loaded('mbstring') && (2 & ini_get('mbstring.func_overload'))) { |
|
432 | - $oldEncoding = mb_internal_encoding(); |
|
433 | - mb_internal_encoding('8bit'); |
|
434 | - } |
|
435 | - |
|
436 | - try { |
|
437 | - switch (strtolower($this->getHeader('content-encoding'))) { |
|
438 | - case 'gzip': |
|
439 | - $decoded = self::decodeGzip($this->body); |
|
440 | - break; |
|
441 | - case 'deflate': |
|
442 | - $decoded = self::decodeDeflate($this->body); |
|
443 | - } |
|
444 | - } catch (Exception $e) { |
|
445 | - } |
|
446 | - |
|
447 | - if (!empty($oldEncoding)) { |
|
448 | - mb_internal_encoding($oldEncoding); |
|
449 | - } |
|
450 | - if (!empty($e)) { |
|
451 | - throw $e; |
|
452 | - } |
|
453 | - return $decoded; |
|
454 | - } |
|
455 | - } |
|
456 | - |
|
457 | - /** |
|
458 | - * Get the HTTP version of the response |
|
459 | - * |
|
460 | - * @return string |
|
461 | - */ |
|
462 | - public function getVersion() |
|
463 | - { |
|
464 | - return $this->version; |
|
465 | - } |
|
466 | - |
|
467 | - /** |
|
468 | - * Decodes the message-body encoded by gzip |
|
469 | - * |
|
470 | - * The real decoding work is done by gzinflate() built-in function, this |
|
471 | - * method only parses the header and checks data for compliance with |
|
472 | - * RFC 1952 |
|
473 | - * |
|
474 | - * @param string $data gzip-encoded data |
|
475 | - * |
|
476 | - * @return string decoded data |
|
477 | - * @throws HTTP_Request2_LogicException |
|
478 | - * @throws HTTP_Request2_MessageException |
|
479 | - * @link http://tools.ietf.org/html/rfc1952 |
|
480 | - */ |
|
481 | - public static function decodeGzip($data) |
|
482 | - { |
|
483 | - $length = strlen($data); |
|
484 | - // If it doesn't look like gzip-encoded data, don't bother |
|
485 | - if (18 > $length || strcmp(substr($data, 0, 2), "\x1f\x8b")) { |
|
486 | - return $data; |
|
487 | - } |
|
488 | - if (!function_exists('gzinflate')) { |
|
489 | - throw new HTTP_Request2_LogicException( |
|
490 | - 'Unable to decode body: gzip extension not available', |
|
491 | - HTTP_Request2_Exception::MISCONFIGURATION |
|
492 | - ); |
|
493 | - } |
|
494 | - $method = ord(substr($data, 2, 1)); |
|
495 | - if (8 != $method) { |
|
496 | - throw new HTTP_Request2_MessageException( |
|
497 | - 'Error parsing gzip header: unknown compression method', |
|
498 | - HTTP_Request2_Exception::DECODE_ERROR |
|
499 | - ); |
|
500 | - } |
|
501 | - $flags = ord(substr($data, 3, 1)); |
|
502 | - if ($flags & 224) { |
|
503 | - throw new HTTP_Request2_MessageException( |
|
504 | - 'Error parsing gzip header: reserved bits are set', |
|
505 | - HTTP_Request2_Exception::DECODE_ERROR |
|
506 | - ); |
|
507 | - } |
|
508 | - |
|
509 | - // header is 10 bytes minimum. may be longer, though. |
|
510 | - $headerLength = 10; |
|
511 | - // extra fields, need to skip 'em |
|
512 | - if ($flags & 4) { |
|
513 | - if ($length - $headerLength - 2 < 8) { |
|
514 | - throw new HTTP_Request2_MessageException( |
|
515 | - 'Error parsing gzip header: data too short', |
|
516 | - HTTP_Request2_Exception::DECODE_ERROR |
|
517 | - ); |
|
518 | - } |
|
519 | - $extraLength = unpack('v', substr($data, 10, 2)); |
|
520 | - if ($length - $headerLength - 2 - $extraLength[1] < 8) { |
|
521 | - throw new HTTP_Request2_MessageException( |
|
522 | - 'Error parsing gzip header: data too short', |
|
523 | - HTTP_Request2_Exception::DECODE_ERROR |
|
524 | - ); |
|
525 | - } |
|
526 | - $headerLength += $extraLength[1] + 2; |
|
527 | - } |
|
528 | - // file name, need to skip that |
|
529 | - if ($flags & 8) { |
|
530 | - if ($length - $headerLength - 1 < 8) { |
|
531 | - throw new HTTP_Request2_MessageException( |
|
532 | - 'Error parsing gzip header: data too short', |
|
533 | - HTTP_Request2_Exception::DECODE_ERROR |
|
534 | - ); |
|
535 | - } |
|
536 | - $filenameLength = strpos(substr($data, $headerLength), chr(0)); |
|
537 | - if (false === $filenameLength || $length - $headerLength - $filenameLength - 1 < 8) { |
|
538 | - throw new HTTP_Request2_MessageException( |
|
539 | - 'Error parsing gzip header: data too short', |
|
540 | - HTTP_Request2_Exception::DECODE_ERROR |
|
541 | - ); |
|
542 | - } |
|
543 | - $headerLength += $filenameLength + 1; |
|
544 | - } |
|
545 | - // comment, need to skip that also |
|
546 | - if ($flags & 16) { |
|
547 | - if ($length - $headerLength - 1 < 8) { |
|
548 | - throw new HTTP_Request2_MessageException( |
|
549 | - 'Error parsing gzip header: data too short', |
|
550 | - HTTP_Request2_Exception::DECODE_ERROR |
|
551 | - ); |
|
552 | - } |
|
553 | - $commentLength = strpos(substr($data, $headerLength), chr(0)); |
|
554 | - if (false === $commentLength || $length - $headerLength - $commentLength - 1 < 8) { |
|
555 | - throw new HTTP_Request2_MessageException( |
|
556 | - 'Error parsing gzip header: data too short', |
|
557 | - HTTP_Request2_Exception::DECODE_ERROR |
|
558 | - ); |
|
559 | - } |
|
560 | - $headerLength += $commentLength + 1; |
|
561 | - } |
|
562 | - // have a CRC for header. let's check |
|
563 | - if ($flags & 2) { |
|
564 | - if ($length - $headerLength - 2 < 8) { |
|
565 | - throw new HTTP_Request2_MessageException( |
|
566 | - 'Error parsing gzip header: data too short', |
|
567 | - HTTP_Request2_Exception::DECODE_ERROR |
|
568 | - ); |
|
569 | - } |
|
570 | - $crcReal = 0xffff & crc32(substr($data, 0, $headerLength)); |
|
571 | - $crcStored = unpack('v', substr($data, $headerLength, 2)); |
|
572 | - if ($crcReal != $crcStored[1]) { |
|
573 | - throw new HTTP_Request2_MessageException( |
|
574 | - 'Header CRC check failed', |
|
575 | - HTTP_Request2_Exception::DECODE_ERROR |
|
576 | - ); |
|
577 | - } |
|
578 | - $headerLength += 2; |
|
579 | - } |
|
580 | - // unpacked data CRC and size at the end of encoded data |
|
581 | - $tmp = unpack('V2', substr($data, -8)); |
|
582 | - $dataCrc = $tmp[1]; |
|
583 | - $dataSize = $tmp[2]; |
|
584 | - |
|
585 | - // finally, call the gzinflate() function |
|
586 | - // don't pass $dataSize to gzinflate, see bugs #13135, #14370 |
|
587 | - $unpacked = gzinflate(substr($data, $headerLength, -8)); |
|
588 | - if (false === $unpacked) { |
|
589 | - throw new HTTP_Request2_MessageException( |
|
590 | - 'gzinflate() call failed', |
|
591 | - HTTP_Request2_Exception::DECODE_ERROR |
|
592 | - ); |
|
593 | - } elseif ($dataSize != strlen($unpacked)) { |
|
594 | - throw new HTTP_Request2_MessageException( |
|
595 | - 'Data size check failed', |
|
596 | - HTTP_Request2_Exception::DECODE_ERROR |
|
597 | - ); |
|
598 | - } elseif ((0xffffffff & $dataCrc) != (0xffffffff & crc32($unpacked))) { |
|
599 | - throw new HTTP_Request2_Exception( |
|
600 | - 'Data CRC check failed', |
|
601 | - HTTP_Request2_Exception::DECODE_ERROR |
|
602 | - ); |
|
603 | - } |
|
604 | - return $unpacked; |
|
605 | - } |
|
606 | - |
|
607 | - /** |
|
608 | - * Decodes the message-body encoded by deflate |
|
609 | - * |
|
610 | - * @param string $data deflate-encoded data |
|
611 | - * |
|
612 | - * @return string decoded data |
|
613 | - * @throws HTTP_Request2_LogicException |
|
614 | - */ |
|
615 | - public static function decodeDeflate($data) |
|
616 | - { |
|
617 | - if (!function_exists('gzuncompress')) { |
|
618 | - throw new HTTP_Request2_LogicException( |
|
619 | - 'Unable to decode body: gzip extension not available', |
|
620 | - HTTP_Request2_Exception::MISCONFIGURATION |
|
621 | - ); |
|
622 | - } |
|
623 | - // RFC 2616 defines 'deflate' encoding as zlib format from RFC 1950, |
|
624 | - // while many applications send raw deflate stream from RFC 1951. |
|
625 | - // We should check for presence of zlib header and use gzuncompress() or |
|
626 | - // gzinflate() as needed. See bug #15305 |
|
627 | - $header = unpack('n', substr($data, 0, 2)); |
|
628 | - return (0 == $header[1] % 31)? gzuncompress($data): gzinflate($data); |
|
629 | - } |
|
56 | + /** |
|
57 | + * HTTP protocol version (e.g. 1.0, 1.1) |
|
58 | + * @var string |
|
59 | + */ |
|
60 | + protected $version; |
|
61 | + |
|
62 | + /** |
|
63 | + * Status code |
|
64 | + * @var integer |
|
65 | + * @link http://tools.ietf.org/html/rfc2616#section-6.1.1 |
|
66 | + */ |
|
67 | + protected $code; |
|
68 | + |
|
69 | + /** |
|
70 | + * Reason phrase |
|
71 | + * @var string |
|
72 | + * @link http://tools.ietf.org/html/rfc2616#section-6.1.1 |
|
73 | + */ |
|
74 | + protected $reasonPhrase; |
|
75 | + |
|
76 | + /** |
|
77 | + * Effective URL (may be different from original request URL in case of redirects) |
|
78 | + * @var string |
|
79 | + */ |
|
80 | + protected $effectiveUrl; |
|
81 | + |
|
82 | + /** |
|
83 | + * Associative array of response headers |
|
84 | + * @var array |
|
85 | + */ |
|
86 | + protected $headers = array(); |
|
87 | + |
|
88 | + /** |
|
89 | + * Cookies set in the response |
|
90 | + * @var array |
|
91 | + */ |
|
92 | + protected $cookies = array(); |
|
93 | + |
|
94 | + /** |
|
95 | + * Name of last header processed by parseHederLine() |
|
96 | + * |
|
97 | + * Used to handle the headers that span multiple lines |
|
98 | + * |
|
99 | + * @var string |
|
100 | + */ |
|
101 | + protected $lastHeader = null; |
|
102 | + |
|
103 | + /** |
|
104 | + * Response body |
|
105 | + * @var string |
|
106 | + */ |
|
107 | + protected $body = ''; |
|
108 | + |
|
109 | + /** |
|
110 | + * Whether the body is still encoded by Content-Encoding |
|
111 | + * |
|
112 | + * cURL provides the decoded body to the callback; if we are reading from |
|
113 | + * socket the body is still gzipped / deflated |
|
114 | + * |
|
115 | + * @var bool |
|
116 | + */ |
|
117 | + protected $bodyEncoded; |
|
118 | + |
|
119 | + /** |
|
120 | + * Associative array of HTTP status code / reason phrase. |
|
121 | + * |
|
122 | + * @var array |
|
123 | + * @link http://tools.ietf.org/html/rfc2616#section-10 |
|
124 | + */ |
|
125 | + protected static $phrases = array( |
|
126 | + |
|
127 | + // 1xx: Informational - Request received, continuing process |
|
128 | + 100 => 'Continue', |
|
129 | + 101 => 'Switching Protocols', |
|
130 | + |
|
131 | + // 2xx: Success - The action was successfully received, understood and |
|
132 | + // accepted |
|
133 | + 200 => 'OK', |
|
134 | + 201 => 'Created', |
|
135 | + 202 => 'Accepted', |
|
136 | + 203 => 'Non-Authoritative Information', |
|
137 | + 204 => 'No Content', |
|
138 | + 205 => 'Reset Content', |
|
139 | + 206 => 'Partial Content', |
|
140 | + |
|
141 | + // 3xx: Redirection - Further action must be taken in order to complete |
|
142 | + // the request |
|
143 | + 300 => 'Multiple Choices', |
|
144 | + 301 => 'Moved Permanently', |
|
145 | + 302 => 'Found', // 1.1 |
|
146 | + 303 => 'See Other', |
|
147 | + 304 => 'Not Modified', |
|
148 | + 305 => 'Use Proxy', |
|
149 | + 307 => 'Temporary Redirect', |
|
150 | + |
|
151 | + // 4xx: Client Error - The request contains bad syntax or cannot be |
|
152 | + // fulfilled |
|
153 | + 400 => 'Bad Request', |
|
154 | + 401 => 'Unauthorized', |
|
155 | + 402 => 'Payment Required', |
|
156 | + 403 => 'Forbidden', |
|
157 | + 404 => 'Not Found', |
|
158 | + 405 => 'Method Not Allowed', |
|
159 | + 406 => 'Not Acceptable', |
|
160 | + 407 => 'Proxy Authentication Required', |
|
161 | + 408 => 'Request Timeout', |
|
162 | + 409 => 'Conflict', |
|
163 | + 410 => 'Gone', |
|
164 | + 411 => 'Length Required', |
|
165 | + 412 => 'Precondition Failed', |
|
166 | + 413 => 'Request Entity Too Large', |
|
167 | + 414 => 'Request-URI Too Long', |
|
168 | + 415 => 'Unsupported Media Type', |
|
169 | + 416 => 'Requested Range Not Satisfiable', |
|
170 | + 417 => 'Expectation Failed', |
|
171 | + |
|
172 | + // 5xx: Server Error - The server failed to fulfill an apparently |
|
173 | + // valid request |
|
174 | + 500 => 'Internal Server Error', |
|
175 | + 501 => 'Not Implemented', |
|
176 | + 502 => 'Bad Gateway', |
|
177 | + 503 => 'Service Unavailable', |
|
178 | + 504 => 'Gateway Timeout', |
|
179 | + 505 => 'HTTP Version Not Supported', |
|
180 | + 509 => 'Bandwidth Limit Exceeded', |
|
181 | + |
|
182 | + ); |
|
183 | + |
|
184 | + /** |
|
185 | + * Returns the default reason phrase for the given code or all reason phrases |
|
186 | + * |
|
187 | + * @param int $code Response code |
|
188 | + * |
|
189 | + * @return string|array|null Default reason phrase for $code if $code is given |
|
190 | + * (null if no phrase is available), array of all |
|
191 | + * reason phrases if $code is null |
|
192 | + * @link http://pear.php.net/bugs/18716 |
|
193 | + */ |
|
194 | + public static function getDefaultReasonPhrase($code = null) |
|
195 | + { |
|
196 | + if (null === $code) { |
|
197 | + return self::$phrases; |
|
198 | + } else { |
|
199 | + return isset(self::$phrases[$code]) ? self::$phrases[$code] : null; |
|
200 | + } |
|
201 | + } |
|
202 | + |
|
203 | + /** |
|
204 | + * Constructor, parses the response status line |
|
205 | + * |
|
206 | + * @param string $statusLine Response status line (e.g. "HTTP/1.1 200 OK") |
|
207 | + * @param bool $bodyEncoded Whether body is still encoded by Content-Encoding |
|
208 | + * @param string $effectiveUrl Effective URL of the response |
|
209 | + * |
|
210 | + * @throws HTTP_Request2_MessageException if status line is invalid according to spec |
|
211 | + */ |
|
212 | + public function __construct($statusLine, $bodyEncoded = true, $effectiveUrl = null) |
|
213 | + { |
|
214 | + if (!preg_match('!^HTTP/(\d\.\d) (\d{3})(?: (.+))?!', $statusLine, $m)) { |
|
215 | + throw new HTTP_Request2_MessageException( |
|
216 | + "Malformed response: {$statusLine}", |
|
217 | + HTTP_Request2_Exception::MALFORMED_RESPONSE |
|
218 | + ); |
|
219 | + } |
|
220 | + $this->version = $m[1]; |
|
221 | + $this->code = intval($m[2]); |
|
222 | + $this->reasonPhrase = !empty($m[3]) ? trim($m[3]) : self::getDefaultReasonPhrase($this->code); |
|
223 | + $this->bodyEncoded = (bool)$bodyEncoded; |
|
224 | + $this->effectiveUrl = (string)$effectiveUrl; |
|
225 | + } |
|
226 | + |
|
227 | + /** |
|
228 | + * Parses the line from HTTP response filling $headers array |
|
229 | + * |
|
230 | + * The method should be called after reading the line from socket or receiving |
|
231 | + * it into cURL callback. Passing an empty string here indicates the end of |
|
232 | + * response headers and triggers additional processing, so be sure to pass an |
|
233 | + * empty string in the end. |
|
234 | + * |
|
235 | + * @param string $headerLine Line from HTTP response |
|
236 | + */ |
|
237 | + public function parseHeaderLine($headerLine) |
|
238 | + { |
|
239 | + $headerLine = trim($headerLine, "\r\n"); |
|
240 | + |
|
241 | + if ('' == $headerLine) { |
|
242 | + // empty string signals the end of headers, process the received ones |
|
243 | + if (!empty($this->headers['set-cookie'])) { |
|
244 | + $cookies = is_array($this->headers['set-cookie'])? |
|
245 | + $this->headers['set-cookie']: |
|
246 | + array($this->headers['set-cookie']); |
|
247 | + foreach ($cookies as $cookieString) { |
|
248 | + $this->parseCookie($cookieString); |
|
249 | + } |
|
250 | + unset($this->headers['set-cookie']); |
|
251 | + } |
|
252 | + foreach (array_keys($this->headers) as $k) { |
|
253 | + if (is_array($this->headers[$k])) { |
|
254 | + $this->headers[$k] = implode(', ', $this->headers[$k]); |
|
255 | + } |
|
256 | + } |
|
257 | + |
|
258 | + } elseif (preg_match('!^([^\x00-\x1f\x7f-\xff()<>@,;:\\\\"/\[\]?={}\s]+):(.+)$!', $headerLine, $m)) { |
|
259 | + // string of the form header-name: header value |
|
260 | + $name = strtolower($m[1]); |
|
261 | + $value = trim($m[2]); |
|
262 | + if (empty($this->headers[$name])) { |
|
263 | + $this->headers[$name] = $value; |
|
264 | + } else { |
|
265 | + if (!is_array($this->headers[$name])) { |
|
266 | + $this->headers[$name] = array($this->headers[$name]); |
|
267 | + } |
|
268 | + $this->headers[$name][] = $value; |
|
269 | + } |
|
270 | + $this->lastHeader = $name; |
|
271 | + |
|
272 | + } elseif (preg_match('!^\s+(.+)$!', $headerLine, $m) && $this->lastHeader) { |
|
273 | + // continuation of a previous header |
|
274 | + if (!is_array($this->headers[$this->lastHeader])) { |
|
275 | + $this->headers[$this->lastHeader] .= ' ' . trim($m[1]); |
|
276 | + } else { |
|
277 | + $key = count($this->headers[$this->lastHeader]) - 1; |
|
278 | + $this->headers[$this->lastHeader][$key] .= ' ' . trim($m[1]); |
|
279 | + } |
|
280 | + } |
|
281 | + } |
|
282 | + |
|
283 | + /** |
|
284 | + * Parses a Set-Cookie header to fill $cookies array |
|
285 | + * |
|
286 | + * @param string $cookieString value of Set-Cookie header |
|
287 | + * |
|
288 | + * @link http://web.archive.org/web/20080331104521/http://cgi.netscape.com/newsref/std/cookie_spec.html |
|
289 | + */ |
|
290 | + protected function parseCookie($cookieString) |
|
291 | + { |
|
292 | + $cookie = array( |
|
293 | + 'expires' => null, |
|
294 | + 'domain' => null, |
|
295 | + 'path' => null, |
|
296 | + 'secure' => false |
|
297 | + ); |
|
298 | + |
|
299 | + if (!strpos($cookieString, ';')) { |
|
300 | + // Only a name=value pair |
|
301 | + $pos = strpos($cookieString, '='); |
|
302 | + $cookie['name'] = trim(substr($cookieString, 0, $pos)); |
|
303 | + $cookie['value'] = trim(substr($cookieString, $pos + 1)); |
|
304 | + |
|
305 | + } else { |
|
306 | + // Some optional parameters are supplied |
|
307 | + $elements = explode(';', $cookieString); |
|
308 | + $pos = strpos($elements[0], '='); |
|
309 | + $cookie['name'] = trim(substr($elements[0], 0, $pos)); |
|
310 | + $cookie['value'] = trim(substr($elements[0], $pos + 1)); |
|
311 | + |
|
312 | + for ($i = 1; $i < count($elements); $i++) { |
|
313 | + if (false === strpos($elements[$i], '=')) { |
|
314 | + $elName = trim($elements[$i]); |
|
315 | + $elValue = null; |
|
316 | + } else { |
|
317 | + list ($elName, $elValue) = array_map('trim', explode('=', $elements[$i])); |
|
318 | + } |
|
319 | + $elName = strtolower($elName); |
|
320 | + if ('secure' == $elName) { |
|
321 | + $cookie['secure'] = true; |
|
322 | + } elseif ('expires' == $elName) { |
|
323 | + $cookie['expires'] = str_replace('"', '', $elValue); |
|
324 | + } elseif ('path' == $elName || 'domain' == $elName) { |
|
325 | + $cookie[$elName] = urldecode($elValue); |
|
326 | + } else { |
|
327 | + $cookie[$elName] = $elValue; |
|
328 | + } |
|
329 | + } |
|
330 | + } |
|
331 | + $this->cookies[] = $cookie; |
|
332 | + } |
|
333 | + |
|
334 | + /** |
|
335 | + * Appends a string to the response body |
|
336 | + * |
|
337 | + * @param string $bodyChunk part of response body |
|
338 | + */ |
|
339 | + public function appendBody($bodyChunk) |
|
340 | + { |
|
341 | + $this->body .= $bodyChunk; |
|
342 | + } |
|
343 | + |
|
344 | + /** |
|
345 | + * Returns the effective URL of the response |
|
346 | + * |
|
347 | + * This may be different from the request URL if redirects were followed. |
|
348 | + * |
|
349 | + * @return string |
|
350 | + * @link http://pear.php.net/bugs/bug.php?id=18412 |
|
351 | + */ |
|
352 | + public function getEffectiveUrl() |
|
353 | + { |
|
354 | + return $this->effectiveUrl; |
|
355 | + } |
|
356 | + |
|
357 | + /** |
|
358 | + * Returns the status code |
|
359 | + * |
|
360 | + * @return integer |
|
361 | + */ |
|
362 | + public function getStatus() |
|
363 | + { |
|
364 | + return $this->code; |
|
365 | + } |
|
366 | + |
|
367 | + /** |
|
368 | + * Returns the reason phrase |
|
369 | + * |
|
370 | + * @return string |
|
371 | + */ |
|
372 | + public function getReasonPhrase() |
|
373 | + { |
|
374 | + return $this->reasonPhrase; |
|
375 | + } |
|
376 | + |
|
377 | + /** |
|
378 | + * Whether response is a redirect that can be automatically handled by HTTP_Request2 |
|
379 | + * |
|
380 | + * @return bool |
|
381 | + */ |
|
382 | + public function isRedirect() |
|
383 | + { |
|
384 | + return in_array($this->code, array(300, 301, 302, 303, 307)) |
|
385 | + && isset($this->headers['location']); |
|
386 | + } |
|
387 | + |
|
388 | + /** |
|
389 | + * Returns either the named header or all response headers |
|
390 | + * |
|
391 | + * @param string $headerName Name of header to return |
|
392 | + * |
|
393 | + * @return string|array Value of $headerName header (null if header is |
|
394 | + * not present), array of all response headers if |
|
395 | + * $headerName is null |
|
396 | + */ |
|
397 | + public function getHeader($headerName = null) |
|
398 | + { |
|
399 | + if (null === $headerName) { |
|
400 | + return $this->headers; |
|
401 | + } else { |
|
402 | + $headerName = strtolower($headerName); |
|
403 | + return isset($this->headers[$headerName])? $this->headers[$headerName]: null; |
|
404 | + } |
|
405 | + } |
|
406 | + |
|
407 | + /** |
|
408 | + * Returns cookies set in response |
|
409 | + * |
|
410 | + * @return array |
|
411 | + */ |
|
412 | + public function getCookies() |
|
413 | + { |
|
414 | + return $this->cookies; |
|
415 | + } |
|
416 | + |
|
417 | + /** |
|
418 | + * Returns the body of the response |
|
419 | + * |
|
420 | + * @return string |
|
421 | + * @throws HTTP_Request2_Exception if body cannot be decoded |
|
422 | + */ |
|
423 | + public function getBody() |
|
424 | + { |
|
425 | + if (0 == strlen($this->body) || !$this->bodyEncoded |
|
426 | + || !in_array(strtolower($this->getHeader('content-encoding')), array('gzip', 'deflate')) |
|
427 | + ) { |
|
428 | + return $this->body; |
|
429 | + |
|
430 | + } else { |
|
431 | + if (extension_loaded('mbstring') && (2 & ini_get('mbstring.func_overload'))) { |
|
432 | + $oldEncoding = mb_internal_encoding(); |
|
433 | + mb_internal_encoding('8bit'); |
|
434 | + } |
|
435 | + |
|
436 | + try { |
|
437 | + switch (strtolower($this->getHeader('content-encoding'))) { |
|
438 | + case 'gzip': |
|
439 | + $decoded = self::decodeGzip($this->body); |
|
440 | + break; |
|
441 | + case 'deflate': |
|
442 | + $decoded = self::decodeDeflate($this->body); |
|
443 | + } |
|
444 | + } catch (Exception $e) { |
|
445 | + } |
|
446 | + |
|
447 | + if (!empty($oldEncoding)) { |
|
448 | + mb_internal_encoding($oldEncoding); |
|
449 | + } |
|
450 | + if (!empty($e)) { |
|
451 | + throw $e; |
|
452 | + } |
|
453 | + return $decoded; |
|
454 | + } |
|
455 | + } |
|
456 | + |
|
457 | + /** |
|
458 | + * Get the HTTP version of the response |
|
459 | + * |
|
460 | + * @return string |
|
461 | + */ |
|
462 | + public function getVersion() |
|
463 | + { |
|
464 | + return $this->version; |
|
465 | + } |
|
466 | + |
|
467 | + /** |
|
468 | + * Decodes the message-body encoded by gzip |
|
469 | + * |
|
470 | + * The real decoding work is done by gzinflate() built-in function, this |
|
471 | + * method only parses the header and checks data for compliance with |
|
472 | + * RFC 1952 |
|
473 | + * |
|
474 | + * @param string $data gzip-encoded data |
|
475 | + * |
|
476 | + * @return string decoded data |
|
477 | + * @throws HTTP_Request2_LogicException |
|
478 | + * @throws HTTP_Request2_MessageException |
|
479 | + * @link http://tools.ietf.org/html/rfc1952 |
|
480 | + */ |
|
481 | + public static function decodeGzip($data) |
|
482 | + { |
|
483 | + $length = strlen($data); |
|
484 | + // If it doesn't look like gzip-encoded data, don't bother |
|
485 | + if (18 > $length || strcmp(substr($data, 0, 2), "\x1f\x8b")) { |
|
486 | + return $data; |
|
487 | + } |
|
488 | + if (!function_exists('gzinflate')) { |
|
489 | + throw new HTTP_Request2_LogicException( |
|
490 | + 'Unable to decode body: gzip extension not available', |
|
491 | + HTTP_Request2_Exception::MISCONFIGURATION |
|
492 | + ); |
|
493 | + } |
|
494 | + $method = ord(substr($data, 2, 1)); |
|
495 | + if (8 != $method) { |
|
496 | + throw new HTTP_Request2_MessageException( |
|
497 | + 'Error parsing gzip header: unknown compression method', |
|
498 | + HTTP_Request2_Exception::DECODE_ERROR |
|
499 | + ); |
|
500 | + } |
|
501 | + $flags = ord(substr($data, 3, 1)); |
|
502 | + if ($flags & 224) { |
|
503 | + throw new HTTP_Request2_MessageException( |
|
504 | + 'Error parsing gzip header: reserved bits are set', |
|
505 | + HTTP_Request2_Exception::DECODE_ERROR |
|
506 | + ); |
|
507 | + } |
|
508 | + |
|
509 | + // header is 10 bytes minimum. may be longer, though. |
|
510 | + $headerLength = 10; |
|
511 | + // extra fields, need to skip 'em |
|
512 | + if ($flags & 4) { |
|
513 | + if ($length - $headerLength - 2 < 8) { |
|
514 | + throw new HTTP_Request2_MessageException( |
|
515 | + 'Error parsing gzip header: data too short', |
|
516 | + HTTP_Request2_Exception::DECODE_ERROR |
|
517 | + ); |
|
518 | + } |
|
519 | + $extraLength = unpack('v', substr($data, 10, 2)); |
|
520 | + if ($length - $headerLength - 2 - $extraLength[1] < 8) { |
|
521 | + throw new HTTP_Request2_MessageException( |
|
522 | + 'Error parsing gzip header: data too short', |
|
523 | + HTTP_Request2_Exception::DECODE_ERROR |
|
524 | + ); |
|
525 | + } |
|
526 | + $headerLength += $extraLength[1] + 2; |
|
527 | + } |
|
528 | + // file name, need to skip that |
|
529 | + if ($flags & 8) { |
|
530 | + if ($length - $headerLength - 1 < 8) { |
|
531 | + throw new HTTP_Request2_MessageException( |
|
532 | + 'Error parsing gzip header: data too short', |
|
533 | + HTTP_Request2_Exception::DECODE_ERROR |
|
534 | + ); |
|
535 | + } |
|
536 | + $filenameLength = strpos(substr($data, $headerLength), chr(0)); |
|
537 | + if (false === $filenameLength || $length - $headerLength - $filenameLength - 1 < 8) { |
|
538 | + throw new HTTP_Request2_MessageException( |
|
539 | + 'Error parsing gzip header: data too short', |
|
540 | + HTTP_Request2_Exception::DECODE_ERROR |
|
541 | + ); |
|
542 | + } |
|
543 | + $headerLength += $filenameLength + 1; |
|
544 | + } |
|
545 | + // comment, need to skip that also |
|
546 | + if ($flags & 16) { |
|
547 | + if ($length - $headerLength - 1 < 8) { |
|
548 | + throw new HTTP_Request2_MessageException( |
|
549 | + 'Error parsing gzip header: data too short', |
|
550 | + HTTP_Request2_Exception::DECODE_ERROR |
|
551 | + ); |
|
552 | + } |
|
553 | + $commentLength = strpos(substr($data, $headerLength), chr(0)); |
|
554 | + if (false === $commentLength || $length - $headerLength - $commentLength - 1 < 8) { |
|
555 | + throw new HTTP_Request2_MessageException( |
|
556 | + 'Error parsing gzip header: data too short', |
|
557 | + HTTP_Request2_Exception::DECODE_ERROR |
|
558 | + ); |
|
559 | + } |
|
560 | + $headerLength += $commentLength + 1; |
|
561 | + } |
|
562 | + // have a CRC for header. let's check |
|
563 | + if ($flags & 2) { |
|
564 | + if ($length - $headerLength - 2 < 8) { |
|
565 | + throw new HTTP_Request2_MessageException( |
|
566 | + 'Error parsing gzip header: data too short', |
|
567 | + HTTP_Request2_Exception::DECODE_ERROR |
|
568 | + ); |
|
569 | + } |
|
570 | + $crcReal = 0xffff & crc32(substr($data, 0, $headerLength)); |
|
571 | + $crcStored = unpack('v', substr($data, $headerLength, 2)); |
|
572 | + if ($crcReal != $crcStored[1]) { |
|
573 | + throw new HTTP_Request2_MessageException( |
|
574 | + 'Header CRC check failed', |
|
575 | + HTTP_Request2_Exception::DECODE_ERROR |
|
576 | + ); |
|
577 | + } |
|
578 | + $headerLength += 2; |
|
579 | + } |
|
580 | + // unpacked data CRC and size at the end of encoded data |
|
581 | + $tmp = unpack('V2', substr($data, -8)); |
|
582 | + $dataCrc = $tmp[1]; |
|
583 | + $dataSize = $tmp[2]; |
|
584 | + |
|
585 | + // finally, call the gzinflate() function |
|
586 | + // don't pass $dataSize to gzinflate, see bugs #13135, #14370 |
|
587 | + $unpacked = gzinflate(substr($data, $headerLength, -8)); |
|
588 | + if (false === $unpacked) { |
|
589 | + throw new HTTP_Request2_MessageException( |
|
590 | + 'gzinflate() call failed', |
|
591 | + HTTP_Request2_Exception::DECODE_ERROR |
|
592 | + ); |
|
593 | + } elseif ($dataSize != strlen($unpacked)) { |
|
594 | + throw new HTTP_Request2_MessageException( |
|
595 | + 'Data size check failed', |
|
596 | + HTTP_Request2_Exception::DECODE_ERROR |
|
597 | + ); |
|
598 | + } elseif ((0xffffffff & $dataCrc) != (0xffffffff & crc32($unpacked))) { |
|
599 | + throw new HTTP_Request2_Exception( |
|
600 | + 'Data CRC check failed', |
|
601 | + HTTP_Request2_Exception::DECODE_ERROR |
|
602 | + ); |
|
603 | + } |
|
604 | + return $unpacked; |
|
605 | + } |
|
606 | + |
|
607 | + /** |
|
608 | + * Decodes the message-body encoded by deflate |
|
609 | + * |
|
610 | + * @param string $data deflate-encoded data |
|
611 | + * |
|
612 | + * @return string decoded data |
|
613 | + * @throws HTTP_Request2_LogicException |
|
614 | + */ |
|
615 | + public static function decodeDeflate($data) |
|
616 | + { |
|
617 | + if (!function_exists('gzuncompress')) { |
|
618 | + throw new HTTP_Request2_LogicException( |
|
619 | + 'Unable to decode body: gzip extension not available', |
|
620 | + HTTP_Request2_Exception::MISCONFIGURATION |
|
621 | + ); |
|
622 | + } |
|
623 | + // RFC 2616 defines 'deflate' encoding as zlib format from RFC 1950, |
|
624 | + // while many applications send raw deflate stream from RFC 1951. |
|
625 | + // We should check for presence of zlib header and use gzuncompress() or |
|
626 | + // gzinflate() as needed. See bug #15305 |
|
627 | + $header = unpack('n', substr($data, 0, 2)); |
|
628 | + return (0 == $header[1] % 31)? gzuncompress($data): gzinflate($data); |
|
629 | + } |
|
630 | 630 | } |
631 | 631 | ?> |
632 | 632 | \ No newline at end of file |
@@ -1,22 +1,22 @@ discard block |
||
1 | 1 | <?php |
2 | 2 | /** |
3 | - * SOCKS5 proxy connection class |
|
4 | - * |
|
5 | - * PHP version 5 |
|
6 | - * |
|
7 | - * LICENSE |
|
8 | - * |
|
9 | - * This source file is subject to BSD 3-Clause License that is bundled |
|
10 | - * with this package in the file LICENSE and available at the URL |
|
11 | - * https://raw.github.com/pear/HTTP_Request2/trunk/docs/LICENSE |
|
12 | - * |
|
13 | - * @category HTTP |
|
14 | - * @package HTTP_Request2 |
|
15 | - * @author Alexey Borzov <[email protected]> |
|
16 | - * @copyright 2008-2014 Alexey Borzov <[email protected]> |
|
17 | - * @license http://opensource.org/licenses/BSD-3-Clause BSD 3-Clause License |
|
18 | - * @link http://pear.php.net/package/HTTP_Request2 |
|
19 | - */ |
|
3 | + * SOCKS5 proxy connection class |
|
4 | + * |
|
5 | + * PHP version 5 |
|
6 | + * |
|
7 | + * LICENSE |
|
8 | + * |
|
9 | + * This source file is subject to BSD 3-Clause License that is bundled |
|
10 | + * with this package in the file LICENSE and available at the URL |
|
11 | + * https://raw.github.com/pear/HTTP_Request2/trunk/docs/LICENSE |
|
12 | + * |
|
13 | + * @category HTTP |
|
14 | + * @package HTTP_Request2 |
|
15 | + * @author Alexey Borzov <[email protected]> |
|
16 | + * @copyright 2008-2014 Alexey Borzov <[email protected]> |
|
17 | + * @license http://opensource.org/licenses/BSD-3-Clause BSD 3-Clause License |
|
18 | + * @link http://pear.php.net/package/HTTP_Request2 |
|
19 | + */ |
|
20 | 20 | |
21 | 21 | /** Socket wrapper class used by Socket Adapter */ |
22 | 22 | require_once 'HTTP/Request2/SocketWrapper.php'; |
@@ -35,101 +35,101 @@ discard block |
||
35 | 35 | */ |
36 | 36 | class HTTP_Request2_SOCKS5 extends HTTP_Request2_SocketWrapper |
37 | 37 | { |
38 | - /** |
|
39 | - * Constructor, tries to connect and authenticate to a SOCKS5 proxy |
|
40 | - * |
|
41 | - * @param string $address Proxy address, e.g. 'tcp://localhost:1080' |
|
42 | - * @param int $timeout Connection timeout (seconds) |
|
43 | - * @param array $contextOptions Stream context options |
|
44 | - * @param string $username Proxy user name |
|
45 | - * @param string $password Proxy password |
|
46 | - * |
|
47 | - * @throws HTTP_Request2_LogicException |
|
48 | - * @throws HTTP_Request2_ConnectionException |
|
49 | - * @throws HTTP_Request2_MessageException |
|
50 | - */ |
|
51 | - public function __construct( |
|
52 | - $address, $timeout = 10, array $contextOptions = array(), |
|
53 | - $username = null, $password = null |
|
54 | - ) { |
|
55 | - parent::__construct($address, $timeout, $contextOptions); |
|
38 | + /** |
|
39 | + * Constructor, tries to connect and authenticate to a SOCKS5 proxy |
|
40 | + * |
|
41 | + * @param string $address Proxy address, e.g. 'tcp://localhost:1080' |
|
42 | + * @param int $timeout Connection timeout (seconds) |
|
43 | + * @param array $contextOptions Stream context options |
|
44 | + * @param string $username Proxy user name |
|
45 | + * @param string $password Proxy password |
|
46 | + * |
|
47 | + * @throws HTTP_Request2_LogicException |
|
48 | + * @throws HTTP_Request2_ConnectionException |
|
49 | + * @throws HTTP_Request2_MessageException |
|
50 | + */ |
|
51 | + public function __construct( |
|
52 | + $address, $timeout = 10, array $contextOptions = array(), |
|
53 | + $username = null, $password = null |
|
54 | + ) { |
|
55 | + parent::__construct($address, $timeout, $contextOptions); |
|
56 | 56 | |
57 | - if (strlen($username)) { |
|
58 | - $request = pack('C4', 5, 2, 0, 2); |
|
59 | - } else { |
|
60 | - $request = pack('C3', 5, 1, 0); |
|
61 | - } |
|
62 | - $this->write($request); |
|
63 | - $response = unpack('Cversion/Cmethod', $this->read(3)); |
|
64 | - if (5 != $response['version']) { |
|
65 | - throw new HTTP_Request2_MessageException( |
|
66 | - 'Invalid version received from SOCKS5 proxy: ' . $response['version'], |
|
67 | - HTTP_Request2_Exception::MALFORMED_RESPONSE |
|
68 | - ); |
|
69 | - } |
|
70 | - switch ($response['method']) { |
|
71 | - case 2: |
|
72 | - $this->performAuthentication($username, $password); |
|
73 | - case 0: |
|
74 | - break; |
|
75 | - default: |
|
76 | - throw new HTTP_Request2_ConnectionException( |
|
77 | - "Connection rejected by proxy due to unsupported auth method" |
|
78 | - ); |
|
79 | - } |
|
80 | - } |
|
57 | + if (strlen($username)) { |
|
58 | + $request = pack('C4', 5, 2, 0, 2); |
|
59 | + } else { |
|
60 | + $request = pack('C3', 5, 1, 0); |
|
61 | + } |
|
62 | + $this->write($request); |
|
63 | + $response = unpack('Cversion/Cmethod', $this->read(3)); |
|
64 | + if (5 != $response['version']) { |
|
65 | + throw new HTTP_Request2_MessageException( |
|
66 | + 'Invalid version received from SOCKS5 proxy: ' . $response['version'], |
|
67 | + HTTP_Request2_Exception::MALFORMED_RESPONSE |
|
68 | + ); |
|
69 | + } |
|
70 | + switch ($response['method']) { |
|
71 | + case 2: |
|
72 | + $this->performAuthentication($username, $password); |
|
73 | + case 0: |
|
74 | + break; |
|
75 | + default: |
|
76 | + throw new HTTP_Request2_ConnectionException( |
|
77 | + "Connection rejected by proxy due to unsupported auth method" |
|
78 | + ); |
|
79 | + } |
|
80 | + } |
|
81 | 81 | |
82 | - /** |
|
83 | - * Performs username/password authentication for SOCKS5 |
|
84 | - * |
|
85 | - * @param string $username Proxy user name |
|
86 | - * @param string $password Proxy password |
|
87 | - * |
|
88 | - * @throws HTTP_Request2_ConnectionException |
|
89 | - * @throws HTTP_Request2_MessageException |
|
90 | - * @link http://tools.ietf.org/html/rfc1929 |
|
91 | - */ |
|
92 | - protected function performAuthentication($username, $password) |
|
93 | - { |
|
94 | - $request = pack('C2', 1, strlen($username)) . $username |
|
95 | - . pack('C', strlen($password)) . $password; |
|
82 | + /** |
|
83 | + * Performs username/password authentication for SOCKS5 |
|
84 | + * |
|
85 | + * @param string $username Proxy user name |
|
86 | + * @param string $password Proxy password |
|
87 | + * |
|
88 | + * @throws HTTP_Request2_ConnectionException |
|
89 | + * @throws HTTP_Request2_MessageException |
|
90 | + * @link http://tools.ietf.org/html/rfc1929 |
|
91 | + */ |
|
92 | + protected function performAuthentication($username, $password) |
|
93 | + { |
|
94 | + $request = pack('C2', 1, strlen($username)) . $username |
|
95 | + . pack('C', strlen($password)) . $password; |
|
96 | 96 | |
97 | - $this->write($request); |
|
98 | - $response = unpack('Cvn/Cstatus', $this->read(3)); |
|
99 | - if (1 != $response['vn'] || 0 != $response['status']) { |
|
100 | - throw new HTTP_Request2_ConnectionException( |
|
101 | - 'Connection rejected by proxy due to invalid username and/or password' |
|
102 | - ); |
|
103 | - } |
|
104 | - } |
|
97 | + $this->write($request); |
|
98 | + $response = unpack('Cvn/Cstatus', $this->read(3)); |
|
99 | + if (1 != $response['vn'] || 0 != $response['status']) { |
|
100 | + throw new HTTP_Request2_ConnectionException( |
|
101 | + 'Connection rejected by proxy due to invalid username and/or password' |
|
102 | + ); |
|
103 | + } |
|
104 | + } |
|
105 | 105 | |
106 | - /** |
|
107 | - * Connects to a remote host via proxy |
|
108 | - * |
|
109 | - * @param string $remoteHost Remote host |
|
110 | - * @param int $remotePort Remote port |
|
111 | - * |
|
112 | - * @throws HTTP_Request2_ConnectionException |
|
113 | - * @throws HTTP_Request2_MessageException |
|
114 | - */ |
|
115 | - public function connect($remoteHost, $remotePort) |
|
116 | - { |
|
117 | - $request = pack('C5', 0x05, 0x01, 0x00, 0x03, strlen($remoteHost)) |
|
118 | - . $remoteHost . pack('n', $remotePort); |
|
106 | + /** |
|
107 | + * Connects to a remote host via proxy |
|
108 | + * |
|
109 | + * @param string $remoteHost Remote host |
|
110 | + * @param int $remotePort Remote port |
|
111 | + * |
|
112 | + * @throws HTTP_Request2_ConnectionException |
|
113 | + * @throws HTTP_Request2_MessageException |
|
114 | + */ |
|
115 | + public function connect($remoteHost, $remotePort) |
|
116 | + { |
|
117 | + $request = pack('C5', 0x05, 0x01, 0x00, 0x03, strlen($remoteHost)) |
|
118 | + . $remoteHost . pack('n', $remotePort); |
|
119 | 119 | |
120 | - $this->write($request); |
|
121 | - $response = unpack('Cversion/Creply/Creserved', $this->read(1024)); |
|
122 | - if (5 != $response['version'] || 0 != $response['reserved']) { |
|
123 | - throw new HTTP_Request2_MessageException( |
|
124 | - 'Invalid response received from SOCKS5 proxy', |
|
125 | - HTTP_Request2_Exception::MALFORMED_RESPONSE |
|
126 | - ); |
|
127 | - } elseif (0 != $response['reply']) { |
|
128 | - throw new HTTP_Request2_ConnectionException( |
|
129 | - "Unable to connect to {$remoteHost}:{$remotePort} through SOCKS5 proxy", |
|
130 | - 0, $response['reply'] |
|
131 | - ); |
|
132 | - } |
|
133 | - } |
|
120 | + $this->write($request); |
|
121 | + $response = unpack('Cversion/Creply/Creserved', $this->read(1024)); |
|
122 | + if (5 != $response['version'] || 0 != $response['reserved']) { |
|
123 | + throw new HTTP_Request2_MessageException( |
|
124 | + 'Invalid response received from SOCKS5 proxy', |
|
125 | + HTTP_Request2_Exception::MALFORMED_RESPONSE |
|
126 | + ); |
|
127 | + } elseif (0 != $response['reply']) { |
|
128 | + throw new HTTP_Request2_ConnectionException( |
|
129 | + "Unable to connect to {$remoteHost}:{$remotePort} through SOCKS5 proxy", |
|
130 | + 0, $response['reply'] |
|
131 | + ); |
|
132 | + } |
|
133 | + } |
|
134 | 134 | } |
135 | 135 | ?> |
136 | 136 | \ No newline at end of file |
@@ -68,14 +68,14 @@ |
||
68 | 68 | ); |
69 | 69 | } |
70 | 70 | switch ($response['method']) { |
71 | - case 2: |
|
72 | - $this->performAuthentication($username, $password); |
|
73 | - case 0: |
|
74 | - break; |
|
75 | - default: |
|
76 | - throw new HTTP_Request2_ConnectionException( |
|
77 | - "Connection rejected by proxy due to unsupported auth method" |
|
78 | - ); |
|
71 | + case 2: |
|
72 | + $this->performAuthentication($username, $password); |
|
73 | + case 0: |
|
74 | + break; |
|
75 | + default: |
|
76 | + throw new HTTP_Request2_ConnectionException( |
|
77 | + "Connection rejected by proxy due to unsupported auth method" |
|
78 | + ); |
|
79 | 79 | } |
80 | 80 | } |
81 | 81 |
@@ -91,7 +91,7 @@ |
||
91 | 91 | */ |
92 | 92 | protected function performAuthentication($username, $password) |
93 | 93 | { |
94 | - $request = pack('C2', 1, strlen($username)) . $username |
|
94 | + $request = pack('C2', 1, strlen($username)) . $username |
|
95 | 95 | . pack('C', strlen($password)) . $password; |
96 | 96 | |
97 | 97 | $this->write($request); |
@@ -170,7 +170,7 @@ |
||
170 | 170 | // reset socket timeout if we don't have request timeout specified, |
171 | 171 | // prevents further calls failing with a bogus Exception |
172 | 172 | if (!$this->deadline) { |
173 | - $default = (int)@ini_get('default_socket_timeout'); |
|
173 | + $default = (int) @ini_get('default_socket_timeout'); |
|
174 | 174 | stream_set_timeout($this->socket, $default > 0 ? $default : PHP_INT_MAX); |
175 | 175 | } |
176 | 176 | if ($info['timed_out']) { |
@@ -38,260 +38,260 @@ |
||
38 | 38 | */ |
39 | 39 | class HTTP_Request2_SocketWrapper |
40 | 40 | { |
41 | - /** |
|
42 | - * PHP warning messages raised during stream_socket_client() call |
|
43 | - * @var array |
|
44 | - */ |
|
45 | - protected $connectionWarnings = array(); |
|
41 | + /** |
|
42 | + * PHP warning messages raised during stream_socket_client() call |
|
43 | + * @var array |
|
44 | + */ |
|
45 | + protected $connectionWarnings = array(); |
|
46 | 46 | |
47 | - /** |
|
48 | - * Connected socket |
|
49 | - * @var resource |
|
50 | - */ |
|
51 | - protected $socket; |
|
47 | + /** |
|
48 | + * Connected socket |
|
49 | + * @var resource |
|
50 | + */ |
|
51 | + protected $socket; |
|
52 | 52 | |
53 | - /** |
|
54 | - * Sum of start time and global timeout, exception will be thrown if request continues past this time |
|
55 | - * @var integer |
|
56 | - */ |
|
57 | - protected $deadline; |
|
53 | + /** |
|
54 | + * Sum of start time and global timeout, exception will be thrown if request continues past this time |
|
55 | + * @var integer |
|
56 | + */ |
|
57 | + protected $deadline; |
|
58 | 58 | |
59 | - /** |
|
60 | - * Global timeout value, mostly for exception messages |
|
61 | - * @var integer |
|
62 | - */ |
|
63 | - protected $timeout; |
|
59 | + /** |
|
60 | + * Global timeout value, mostly for exception messages |
|
61 | + * @var integer |
|
62 | + */ |
|
63 | + protected $timeout; |
|
64 | 64 | |
65 | - /** |
|
66 | - * Class constructor, tries to establish connection |
|
67 | - * |
|
68 | - * @param string $address Address for stream_socket_client() call, |
|
69 | - * e.g. 'tcp://localhost:80' |
|
70 | - * @param int $timeout Connection timeout (seconds) |
|
71 | - * @param array $contextOptions Context options |
|
72 | - * |
|
73 | - * @throws HTTP_Request2_LogicException |
|
74 | - * @throws HTTP_Request2_ConnectionException |
|
75 | - */ |
|
76 | - public function __construct($address, $timeout, array $contextOptions = array()) |
|
77 | - { |
|
78 | - if (!empty($contextOptions) |
|
79 | - && !isset($contextOptions['socket']) && !isset($contextOptions['ssl']) |
|
80 | - ) { |
|
81 | - // Backwards compatibility with 2.1.0 and 2.1.1 releases |
|
82 | - $contextOptions = array('ssl' => $contextOptions); |
|
83 | - } |
|
84 | - $context = stream_context_create(); |
|
85 | - foreach ($contextOptions as $wrapper => $options) { |
|
86 | - foreach ($options as $name => $value) { |
|
87 | - if (!stream_context_set_option($context, $wrapper, $name, $value)) { |
|
88 | - throw new HTTP_Request2_LogicException( |
|
89 | - "Error setting '{$wrapper}' wrapper context option '{$name}'" |
|
90 | - ); |
|
91 | - } |
|
92 | - } |
|
93 | - } |
|
94 | - set_error_handler(array($this, 'connectionWarningsHandler')); |
|
95 | - $this->socket = stream_socket_client( |
|
96 | - $address, $errno, $errstr, $timeout, STREAM_CLIENT_CONNECT, $context |
|
97 | - ); |
|
98 | - restore_error_handler(); |
|
99 | - // if we fail to bind to a specified local address (see request #19515), |
|
100 | - // connection still succeeds, albeit with a warning. Throw an Exception |
|
101 | - // with the warning text in this case as that connection is unlikely |
|
102 | - // to be what user wants and as Curl throws an error in similar case. |
|
103 | - if ($this->connectionWarnings) { |
|
104 | - if ($this->socket) { |
|
105 | - fclose($this->socket); |
|
106 | - } |
|
107 | - $error = $errstr ? $errstr : implode("\n", $this->connectionWarnings); |
|
108 | - throw new HTTP_Request2_ConnectionException( |
|
109 | - "Unable to connect to {$address}. Error: {$error}", 0, $errno |
|
110 | - ); |
|
111 | - } |
|
112 | - } |
|
65 | + /** |
|
66 | + * Class constructor, tries to establish connection |
|
67 | + * |
|
68 | + * @param string $address Address for stream_socket_client() call, |
|
69 | + * e.g. 'tcp://localhost:80' |
|
70 | + * @param int $timeout Connection timeout (seconds) |
|
71 | + * @param array $contextOptions Context options |
|
72 | + * |
|
73 | + * @throws HTTP_Request2_LogicException |
|
74 | + * @throws HTTP_Request2_ConnectionException |
|
75 | + */ |
|
76 | + public function __construct($address, $timeout, array $contextOptions = array()) |
|
77 | + { |
|
78 | + if (!empty($contextOptions) |
|
79 | + && !isset($contextOptions['socket']) && !isset($contextOptions['ssl']) |
|
80 | + ) { |
|
81 | + // Backwards compatibility with 2.1.0 and 2.1.1 releases |
|
82 | + $contextOptions = array('ssl' => $contextOptions); |
|
83 | + } |
|
84 | + $context = stream_context_create(); |
|
85 | + foreach ($contextOptions as $wrapper => $options) { |
|
86 | + foreach ($options as $name => $value) { |
|
87 | + if (!stream_context_set_option($context, $wrapper, $name, $value)) { |
|
88 | + throw new HTTP_Request2_LogicException( |
|
89 | + "Error setting '{$wrapper}' wrapper context option '{$name}'" |
|
90 | + ); |
|
91 | + } |
|
92 | + } |
|
93 | + } |
|
94 | + set_error_handler(array($this, 'connectionWarningsHandler')); |
|
95 | + $this->socket = stream_socket_client( |
|
96 | + $address, $errno, $errstr, $timeout, STREAM_CLIENT_CONNECT, $context |
|
97 | + ); |
|
98 | + restore_error_handler(); |
|
99 | + // if we fail to bind to a specified local address (see request #19515), |
|
100 | + // connection still succeeds, albeit with a warning. Throw an Exception |
|
101 | + // with the warning text in this case as that connection is unlikely |
|
102 | + // to be what user wants and as Curl throws an error in similar case. |
|
103 | + if ($this->connectionWarnings) { |
|
104 | + if ($this->socket) { |
|
105 | + fclose($this->socket); |
|
106 | + } |
|
107 | + $error = $errstr ? $errstr : implode("\n", $this->connectionWarnings); |
|
108 | + throw new HTTP_Request2_ConnectionException( |
|
109 | + "Unable to connect to {$address}. Error: {$error}", 0, $errno |
|
110 | + ); |
|
111 | + } |
|
112 | + } |
|
113 | 113 | |
114 | - /** |
|
115 | - * Destructor, disconnects socket |
|
116 | - */ |
|
117 | - public function __destruct() |
|
118 | - { |
|
119 | - fclose($this->socket); |
|
120 | - } |
|
114 | + /** |
|
115 | + * Destructor, disconnects socket |
|
116 | + */ |
|
117 | + public function __destruct() |
|
118 | + { |
|
119 | + fclose($this->socket); |
|
120 | + } |
|
121 | 121 | |
122 | - /** |
|
123 | - * Wrapper around fread(), handles global request timeout |
|
124 | - * |
|
125 | - * @param int $length Reads up to this number of bytes |
|
126 | - * |
|
127 | - * @return string Data read from socket |
|
128 | - * @throws HTTP_Request2_MessageException In case of timeout |
|
129 | - */ |
|
130 | - public function read($length) |
|
131 | - { |
|
132 | - if ($this->deadline) { |
|
133 | - stream_set_timeout($this->socket, max($this->deadline - time(), 1)); |
|
134 | - } |
|
135 | - $data = fread($this->socket, $length); |
|
136 | - $this->checkTimeout(); |
|
137 | - return $data; |
|
138 | - } |
|
122 | + /** |
|
123 | + * Wrapper around fread(), handles global request timeout |
|
124 | + * |
|
125 | + * @param int $length Reads up to this number of bytes |
|
126 | + * |
|
127 | + * @return string Data read from socket |
|
128 | + * @throws HTTP_Request2_MessageException In case of timeout |
|
129 | + */ |
|
130 | + public function read($length) |
|
131 | + { |
|
132 | + if ($this->deadline) { |
|
133 | + stream_set_timeout($this->socket, max($this->deadline - time(), 1)); |
|
134 | + } |
|
135 | + $data = fread($this->socket, $length); |
|
136 | + $this->checkTimeout(); |
|
137 | + return $data; |
|
138 | + } |
|
139 | 139 | |
140 | - /** |
|
141 | - * Reads until either the end of the socket or a newline, whichever comes first |
|
142 | - * |
|
143 | - * Strips the trailing newline from the returned data, handles global |
|
144 | - * request timeout. Method idea borrowed from Net_Socket PEAR package. |
|
145 | - * |
|
146 | - * @param int $bufferSize buffer size to use for reading |
|
147 | - * @param int $localTimeout timeout value to use just for this call |
|
148 | - * (used when waiting for "100 Continue" response) |
|
149 | - * |
|
150 | - * @return string Available data up to the newline (not including newline) |
|
151 | - * @throws HTTP_Request2_MessageException In case of timeout |
|
152 | - */ |
|
153 | - public function readLine($bufferSize, $localTimeout = null) |
|
154 | - { |
|
155 | - $line = ''; |
|
156 | - while (!feof($this->socket)) { |
|
157 | - if (null !== $localTimeout) { |
|
158 | - stream_set_timeout($this->socket, $localTimeout); |
|
159 | - } elseif ($this->deadline) { |
|
160 | - stream_set_timeout($this->socket, max($this->deadline - time(), 1)); |
|
161 | - } |
|
140 | + /** |
|
141 | + * Reads until either the end of the socket or a newline, whichever comes first |
|
142 | + * |
|
143 | + * Strips the trailing newline from the returned data, handles global |
|
144 | + * request timeout. Method idea borrowed from Net_Socket PEAR package. |
|
145 | + * |
|
146 | + * @param int $bufferSize buffer size to use for reading |
|
147 | + * @param int $localTimeout timeout value to use just for this call |
|
148 | + * (used when waiting for "100 Continue" response) |
|
149 | + * |
|
150 | + * @return string Available data up to the newline (not including newline) |
|
151 | + * @throws HTTP_Request2_MessageException In case of timeout |
|
152 | + */ |
|
153 | + public function readLine($bufferSize, $localTimeout = null) |
|
154 | + { |
|
155 | + $line = ''; |
|
156 | + while (!feof($this->socket)) { |
|
157 | + if (null !== $localTimeout) { |
|
158 | + stream_set_timeout($this->socket, $localTimeout); |
|
159 | + } elseif ($this->deadline) { |
|
160 | + stream_set_timeout($this->socket, max($this->deadline - time(), 1)); |
|
161 | + } |
|
162 | 162 | |
163 | - $line .= @fgets($this->socket, $bufferSize); |
|
163 | + $line .= @fgets($this->socket, $bufferSize); |
|
164 | 164 | |
165 | - if (null === $localTimeout) { |
|
166 | - $this->checkTimeout(); |
|
165 | + if (null === $localTimeout) { |
|
166 | + $this->checkTimeout(); |
|
167 | 167 | |
168 | - } else { |
|
169 | - $info = stream_get_meta_data($this->socket); |
|
170 | - // reset socket timeout if we don't have request timeout specified, |
|
171 | - // prevents further calls failing with a bogus Exception |
|
172 | - if (!$this->deadline) { |
|
173 | - $default = (int)@ini_get('default_socket_timeout'); |
|
174 | - stream_set_timeout($this->socket, $default > 0 ? $default : PHP_INT_MAX); |
|
175 | - } |
|
176 | - if ($info['timed_out']) { |
|
177 | - throw new HTTP_Request2_MessageException( |
|
178 | - "readLine() call timed out", HTTP_Request2_Exception::TIMEOUT |
|
179 | - ); |
|
180 | - } |
|
181 | - } |
|
182 | - if (substr($line, -1) == "\n") { |
|
183 | - return rtrim($line, "\r\n"); |
|
184 | - } |
|
185 | - } |
|
186 | - return $line; |
|
187 | - } |
|
168 | + } else { |
|
169 | + $info = stream_get_meta_data($this->socket); |
|
170 | + // reset socket timeout if we don't have request timeout specified, |
|
171 | + // prevents further calls failing with a bogus Exception |
|
172 | + if (!$this->deadline) { |
|
173 | + $default = (int)@ini_get('default_socket_timeout'); |
|
174 | + stream_set_timeout($this->socket, $default > 0 ? $default : PHP_INT_MAX); |
|
175 | + } |
|
176 | + if ($info['timed_out']) { |
|
177 | + throw new HTTP_Request2_MessageException( |
|
178 | + "readLine() call timed out", HTTP_Request2_Exception::TIMEOUT |
|
179 | + ); |
|
180 | + } |
|
181 | + } |
|
182 | + if (substr($line, -1) == "\n") { |
|
183 | + return rtrim($line, "\r\n"); |
|
184 | + } |
|
185 | + } |
|
186 | + return $line; |
|
187 | + } |
|
188 | 188 | |
189 | - /** |
|
190 | - * Wrapper around fwrite(), handles global request timeout |
|
191 | - * |
|
192 | - * @param string $data String to be written |
|
193 | - * |
|
194 | - * @return int |
|
195 | - * @throws HTTP_Request2_MessageException |
|
196 | - */ |
|
197 | - public function write($data) |
|
198 | - { |
|
199 | - if ($this->deadline) { |
|
200 | - stream_set_timeout($this->socket, max($this->deadline - time(), 1)); |
|
201 | - } |
|
202 | - $written = fwrite($this->socket, $data); |
|
203 | - $this->checkTimeout(); |
|
204 | - // http://www.php.net/manual/en/function.fwrite.php#96951 |
|
205 | - if ($written < strlen($data)) { |
|
206 | - throw new HTTP_Request2_MessageException('Error writing request'); |
|
207 | - } |
|
208 | - return $written; |
|
209 | - } |
|
189 | + /** |
|
190 | + * Wrapper around fwrite(), handles global request timeout |
|
191 | + * |
|
192 | + * @param string $data String to be written |
|
193 | + * |
|
194 | + * @return int |
|
195 | + * @throws HTTP_Request2_MessageException |
|
196 | + */ |
|
197 | + public function write($data) |
|
198 | + { |
|
199 | + if ($this->deadline) { |
|
200 | + stream_set_timeout($this->socket, max($this->deadline - time(), 1)); |
|
201 | + } |
|
202 | + $written = fwrite($this->socket, $data); |
|
203 | + $this->checkTimeout(); |
|
204 | + // http://www.php.net/manual/en/function.fwrite.php#96951 |
|
205 | + if ($written < strlen($data)) { |
|
206 | + throw new HTTP_Request2_MessageException('Error writing request'); |
|
207 | + } |
|
208 | + return $written; |
|
209 | + } |
|
210 | 210 | |
211 | - /** |
|
212 | - * Tests for end-of-file on a socket |
|
213 | - * |
|
214 | - * @return bool |
|
215 | - */ |
|
216 | - public function eof() |
|
217 | - { |
|
218 | - return feof($this->socket); |
|
219 | - } |
|
211 | + /** |
|
212 | + * Tests for end-of-file on a socket |
|
213 | + * |
|
214 | + * @return bool |
|
215 | + */ |
|
216 | + public function eof() |
|
217 | + { |
|
218 | + return feof($this->socket); |
|
219 | + } |
|
220 | 220 | |
221 | - /** |
|
222 | - * Sets request deadline |
|
223 | - * |
|
224 | - * @param int $deadline Exception will be thrown if request continues |
|
225 | - * past this time |
|
226 | - * @param int $timeout Original request timeout value, to use in |
|
227 | - * Exception message |
|
228 | - */ |
|
229 | - public function setDeadline($deadline, $timeout) |
|
230 | - { |
|
231 | - $this->deadline = $deadline; |
|
232 | - $this->timeout = $timeout; |
|
233 | - } |
|
221 | + /** |
|
222 | + * Sets request deadline |
|
223 | + * |
|
224 | + * @param int $deadline Exception will be thrown if request continues |
|
225 | + * past this time |
|
226 | + * @param int $timeout Original request timeout value, to use in |
|
227 | + * Exception message |
|
228 | + */ |
|
229 | + public function setDeadline($deadline, $timeout) |
|
230 | + { |
|
231 | + $this->deadline = $deadline; |
|
232 | + $this->timeout = $timeout; |
|
233 | + } |
|
234 | 234 | |
235 | - /** |
|
236 | - * Turns on encryption on a socket |
|
237 | - * |
|
238 | - * @throws HTTP_Request2_ConnectionException |
|
239 | - */ |
|
240 | - public function enableCrypto() |
|
241 | - { |
|
242 | - $modes = array( |
|
243 | - STREAM_CRYPTO_METHOD_TLS_CLIENT, |
|
244 | - STREAM_CRYPTO_METHOD_SSLv3_CLIENT, |
|
245 | - STREAM_CRYPTO_METHOD_SSLv23_CLIENT, |
|
246 | - STREAM_CRYPTO_METHOD_SSLv2_CLIENT |
|
247 | - ); |
|
235 | + /** |
|
236 | + * Turns on encryption on a socket |
|
237 | + * |
|
238 | + * @throws HTTP_Request2_ConnectionException |
|
239 | + */ |
|
240 | + public function enableCrypto() |
|
241 | + { |
|
242 | + $modes = array( |
|
243 | + STREAM_CRYPTO_METHOD_TLS_CLIENT, |
|
244 | + STREAM_CRYPTO_METHOD_SSLv3_CLIENT, |
|
245 | + STREAM_CRYPTO_METHOD_SSLv23_CLIENT, |
|
246 | + STREAM_CRYPTO_METHOD_SSLv2_CLIENT |
|
247 | + ); |
|
248 | 248 | |
249 | - foreach ($modes as $mode) { |
|
250 | - if (stream_socket_enable_crypto($this->socket, true, $mode)) { |
|
251 | - return; |
|
252 | - } |
|
253 | - } |
|
254 | - throw new HTTP_Request2_ConnectionException( |
|
255 | - 'Failed to enable secure connection when connecting through proxy' |
|
256 | - ); |
|
257 | - } |
|
249 | + foreach ($modes as $mode) { |
|
250 | + if (stream_socket_enable_crypto($this->socket, true, $mode)) { |
|
251 | + return; |
|
252 | + } |
|
253 | + } |
|
254 | + throw new HTTP_Request2_ConnectionException( |
|
255 | + 'Failed to enable secure connection when connecting through proxy' |
|
256 | + ); |
|
257 | + } |
|
258 | 258 | |
259 | - /** |
|
260 | - * Throws an Exception if stream timed out |
|
261 | - * |
|
262 | - * @throws HTTP_Request2_MessageException |
|
263 | - */ |
|
264 | - protected function checkTimeout() |
|
265 | - { |
|
266 | - $info = stream_get_meta_data($this->socket); |
|
267 | - if ($info['timed_out'] || $this->deadline && time() > $this->deadline) { |
|
268 | - $reason = $this->deadline |
|
269 | - ? "after {$this->timeout} second(s)" |
|
270 | - : 'due to default_socket_timeout php.ini setting'; |
|
271 | - throw new HTTP_Request2_MessageException( |
|
272 | - "Request timed out {$reason}", HTTP_Request2_Exception::TIMEOUT |
|
273 | - ); |
|
274 | - } |
|
275 | - } |
|
259 | + /** |
|
260 | + * Throws an Exception if stream timed out |
|
261 | + * |
|
262 | + * @throws HTTP_Request2_MessageException |
|
263 | + */ |
|
264 | + protected function checkTimeout() |
|
265 | + { |
|
266 | + $info = stream_get_meta_data($this->socket); |
|
267 | + if ($info['timed_out'] || $this->deadline && time() > $this->deadline) { |
|
268 | + $reason = $this->deadline |
|
269 | + ? "after {$this->timeout} second(s)" |
|
270 | + : 'due to default_socket_timeout php.ini setting'; |
|
271 | + throw new HTTP_Request2_MessageException( |
|
272 | + "Request timed out {$reason}", HTTP_Request2_Exception::TIMEOUT |
|
273 | + ); |
|
274 | + } |
|
275 | + } |
|
276 | 276 | |
277 | - /** |
|
278 | - * Error handler to use during stream_socket_client() call |
|
279 | - * |
|
280 | - * One stream_socket_client() call may produce *multiple* PHP warnings |
|
281 | - * (especially OpenSSL-related), we keep them in an array to later use for |
|
282 | - * the message of HTTP_Request2_ConnectionException |
|
283 | - * |
|
284 | - * @param int $errno error level |
|
285 | - * @param string $errstr error message |
|
286 | - * |
|
287 | - * @return bool |
|
288 | - */ |
|
289 | - protected function connectionWarningsHandler($errno, $errstr) |
|
290 | - { |
|
291 | - if ($errno & E_WARNING) { |
|
292 | - array_unshift($this->connectionWarnings, $errstr); |
|
293 | - } |
|
294 | - return true; |
|
295 | - } |
|
277 | + /** |
|
278 | + * Error handler to use during stream_socket_client() call |
|
279 | + * |
|
280 | + * One stream_socket_client() call may produce *multiple* PHP warnings |
|
281 | + * (especially OpenSSL-related), we keep them in an array to later use for |
|
282 | + * the message of HTTP_Request2_ConnectionException |
|
283 | + * |
|
284 | + * @param int $errno error level |
|
285 | + * @param string $errstr error message |
|
286 | + * |
|
287 | + * @return bool |
|
288 | + */ |
|
289 | + protected function connectionWarningsHandler($errno, $errstr) |
|
290 | + { |
|
291 | + if ($errno & E_WARNING) { |
|
292 | + array_unshift($this->connectionWarnings, $errstr); |
|
293 | + } |
|
294 | + return true; |
|
295 | + } |
|
296 | 296 | } |
297 | 297 | ?> |
@@ -1,23 +1,23 @@ discard block |
||
1 | 1 | <?php |
2 | 2 | /** |
3 | - * PEAR, the PHP Extension and Application Repository |
|
4 | - * |
|
5 | - * PEAR class and PEAR_Error class |
|
6 | - * |
|
7 | - * PHP versions 4 and 5 |
|
8 | - * |
|
9 | - * @category pear |
|
10 | - * @package PEAR |
|
11 | - * @author Sterling Hughes <[email protected]> |
|
12 | - * @author Stig Bakken <[email protected]> |
|
13 | - * @author Tomas V.V.Cox <[email protected]> |
|
14 | - * @author Greg Beaver <[email protected]> |
|
15 | - * @copyright 1997-2010 The Authors |
|
16 | - * @license http://opensource.org/licenses/bsd-license.php New BSD License |
|
17 | - * @version CVS: $Id$ |
|
18 | - * @link http://pear.php.net/package/PEAR |
|
19 | - * @since File available since Release 0.1 |
|
20 | - */ |
|
3 | + * PEAR, the PHP Extension and Application Repository |
|
4 | + * |
|
5 | + * PEAR class and PEAR_Error class |
|
6 | + * |
|
7 | + * PHP versions 4 and 5 |
|
8 | + * |
|
9 | + * @category pear |
|
10 | + * @package PEAR |
|
11 | + * @author Sterling Hughes <[email protected]> |
|
12 | + * @author Stig Bakken <[email protected]> |
|
13 | + * @author Tomas V.V.Cox <[email protected]> |
|
14 | + * @author Greg Beaver <[email protected]> |
|
15 | + * @copyright 1997-2010 The Authors |
|
16 | + * @license http://opensource.org/licenses/bsd-license.php New BSD License |
|
17 | + * @version CVS: $Id$ |
|
18 | + * @link http://pear.php.net/package/PEAR |
|
19 | + * @since File available since Release 0.1 |
|
20 | + */ |
|
21 | 21 | |
22 | 22 | /**#@+ |
23 | 23 | * ERROR constants |
@@ -34,16 +34,16 @@ discard block |
||
34 | 34 | define('PEAR_ERROR_EXCEPTION', 32); |
35 | 35 | /**#@-*/ |
36 | 36 | define('PEAR_ZE2', (function_exists('version_compare') && |
37 | - version_compare(zend_version(), "2-dev", "ge"))); |
|
37 | + version_compare(zend_version(), "2-dev", "ge"))); |
|
38 | 38 | |
39 | 39 | if (substr(PHP_OS, 0, 3) == 'WIN') { |
40 | - define('OS_WINDOWS', true); |
|
41 | - define('OS_UNIX', false); |
|
42 | - define('PEAR_OS', 'Windows'); |
|
40 | + define('OS_WINDOWS', true); |
|
41 | + define('OS_UNIX', false); |
|
42 | + define('PEAR_OS', 'Windows'); |
|
43 | 43 | } else { |
44 | - define('OS_WINDOWS', false); |
|
45 | - define('OS_UNIX', true); |
|
46 | - define('PEAR_OS', 'Unix'); // blatant assumption |
|
44 | + define('OS_WINDOWS', false); |
|
45 | + define('OS_UNIX', true); |
|
46 | + define('PEAR_OS', 'Unix'); // blatant assumption |
|
47 | 47 | } |
48 | 48 | |
49 | 49 | $GLOBALS['_PEAR_default_error_mode'] = PEAR_ERROR_RETURN; |
@@ -86,694 +86,694 @@ discard block |
||
86 | 86 | */ |
87 | 87 | class PEAR |
88 | 88 | { |
89 | - /** |
|
90 | - * Whether to enable internal debug messages. |
|
91 | - * |
|
92 | - * @var bool |
|
93 | - * @access private |
|
94 | - */ |
|
95 | - var $_debug = false; |
|
96 | - |
|
97 | - /** |
|
98 | - * Default error mode for this object. |
|
99 | - * |
|
100 | - * @var int |
|
101 | - * @access private |
|
102 | - */ |
|
103 | - var $_default_error_mode = null; |
|
104 | - |
|
105 | - /** |
|
106 | - * Default error options used for this object when error mode |
|
107 | - * is PEAR_ERROR_TRIGGER. |
|
108 | - * |
|
109 | - * @var int |
|
110 | - * @access private |
|
111 | - */ |
|
112 | - var $_default_error_options = null; |
|
113 | - |
|
114 | - /** |
|
115 | - * Default error handler (callback) for this object, if error mode is |
|
116 | - * PEAR_ERROR_CALLBACK. |
|
117 | - * |
|
118 | - * @var string |
|
119 | - * @access private |
|
120 | - */ |
|
121 | - var $_default_error_handler = ''; |
|
122 | - |
|
123 | - /** |
|
124 | - * Which class to use for error objects. |
|
125 | - * |
|
126 | - * @var string |
|
127 | - * @access private |
|
128 | - */ |
|
129 | - var $_error_class = 'PEAR_Error'; |
|
130 | - |
|
131 | - /** |
|
132 | - * An array of expected errors. |
|
133 | - * |
|
134 | - * @var array |
|
135 | - * @access private |
|
136 | - */ |
|
137 | - var $_expected_errors = array(); |
|
138 | - |
|
139 | - /** |
|
140 | - * Constructor. Registers this object in |
|
141 | - * $_PEAR_destructor_object_list for destructor emulation if a |
|
142 | - * destructor object exists. |
|
143 | - * |
|
144 | - * @param string $error_class (optional) which class to use for |
|
145 | - * error objects, defaults to PEAR_Error. |
|
146 | - * @access public |
|
147 | - * @return void |
|
148 | - */ |
|
149 | - function PEAR($error_class = null) |
|
150 | - { |
|
151 | - $classname = strtolower(get_class($this)); |
|
152 | - if ($this->_debug) { |
|
153 | - print "PEAR constructor called, class=$classname\n"; |
|
154 | - } |
|
155 | - |
|
156 | - if ($error_class !== null) { |
|
157 | - $this->_error_class = $error_class; |
|
158 | - } |
|
159 | - |
|
160 | - while ($classname && strcasecmp($classname, "pear")) { |
|
161 | - $destructor = "_$classname"; |
|
162 | - if (method_exists($this, $destructor)) { |
|
163 | - global $_PEAR_destructor_object_list; |
|
164 | - $_PEAR_destructor_object_list[] = &$this; |
|
165 | - if (!isset($GLOBALS['_PEAR_SHUTDOWN_REGISTERED'])) { |
|
166 | - register_shutdown_function("_PEAR_call_destructors"); |
|
167 | - $GLOBALS['_PEAR_SHUTDOWN_REGISTERED'] = true; |
|
168 | - } |
|
169 | - break; |
|
170 | - } else { |
|
171 | - $classname = get_parent_class($classname); |
|
172 | - } |
|
173 | - } |
|
174 | - } |
|
175 | - |
|
176 | - /** |
|
177 | - * Destructor (the emulated type of...). Does nothing right now, |
|
178 | - * but is included for forward compatibility, so subclass |
|
179 | - * destructors should always call it. |
|
180 | - * |
|
181 | - * See the note in the class desciption about output from |
|
182 | - * destructors. |
|
183 | - * |
|
184 | - * @access public |
|
185 | - * @return void |
|
186 | - */ |
|
187 | - function _PEAR() { |
|
188 | - if ($this->_debug) { |
|
189 | - printf("PEAR destructor called, class=%s\n", strtolower(get_class($this))); |
|
190 | - } |
|
191 | - } |
|
192 | - |
|
193 | - /** |
|
194 | - * If you have a class that's mostly/entirely static, and you need static |
|
195 | - * properties, you can use this method to simulate them. Eg. in your method(s) |
|
196 | - * do this: $myVar = &PEAR::getStaticProperty('myclass', 'myVar'); |
|
197 | - * You MUST use a reference, or they will not persist! |
|
198 | - * |
|
199 | - * @access public |
|
200 | - * @param string $class The calling classname, to prevent clashes |
|
201 | - * @param string $var The variable to retrieve. |
|
202 | - * @return mixed A reference to the variable. If not set it will be |
|
203 | - * auto initialised to NULL. |
|
204 | - */ |
|
205 | - function &getStaticProperty($class, $var) |
|
206 | - { |
|
207 | - static $properties; |
|
208 | - if (!isset($properties[$class])) { |
|
209 | - $properties[$class] = array(); |
|
210 | - } |
|
211 | - |
|
212 | - if (!array_key_exists($var, $properties[$class])) { |
|
213 | - $properties[$class][$var] = null; |
|
214 | - } |
|
215 | - |
|
216 | - return $properties[$class][$var]; |
|
217 | - } |
|
218 | - |
|
219 | - /** |
|
220 | - * Use this function to register a shutdown method for static |
|
221 | - * classes. |
|
222 | - * |
|
223 | - * @access public |
|
224 | - * @param mixed $func The function name (or array of class/method) to call |
|
225 | - * @param mixed $args The arguments to pass to the function |
|
226 | - * @return void |
|
227 | - */ |
|
228 | - function registerShutdownFunc($func, $args = array()) |
|
229 | - { |
|
230 | - // if we are called statically, there is a potential |
|
231 | - // that no shutdown func is registered. Bug #6445 |
|
232 | - if (!isset($GLOBALS['_PEAR_SHUTDOWN_REGISTERED'])) { |
|
233 | - register_shutdown_function("_PEAR_call_destructors"); |
|
234 | - $GLOBALS['_PEAR_SHUTDOWN_REGISTERED'] = true; |
|
235 | - } |
|
236 | - $GLOBALS['_PEAR_shutdown_funcs'][] = array($func, $args); |
|
237 | - } |
|
238 | - |
|
239 | - /** |
|
240 | - * Tell whether a value is a PEAR error. |
|
241 | - * |
|
242 | - * @param mixed $data the value to test |
|
243 | - * @param int $code if $data is an error object, return true |
|
244 | - * only if $code is a string and |
|
245 | - * $obj->getMessage() == $code or |
|
246 | - * $code is an integer and $obj->getCode() == $code |
|
247 | - * @access public |
|
248 | - * @return bool true if parameter is an error |
|
249 | - */ |
|
250 | - function isError($data, $code = null) |
|
251 | - { |
|
252 | - if (!is_a($data, 'PEAR_Error')) { |
|
253 | - return false; |
|
254 | - } |
|
255 | - |
|
256 | - if (is_null($code)) { |
|
257 | - return true; |
|
258 | - } elseif (is_string($code)) { |
|
259 | - return $data->getMessage() == $code; |
|
260 | - } |
|
261 | - |
|
262 | - return $data->getCode() == $code; |
|
263 | - } |
|
264 | - |
|
265 | - /** |
|
266 | - * Sets how errors generated by this object should be handled. |
|
267 | - * Can be invoked both in objects and statically. If called |
|
268 | - * statically, setErrorHandling sets the default behaviour for all |
|
269 | - * PEAR objects. If called in an object, setErrorHandling sets |
|
270 | - * the default behaviour for that object. |
|
271 | - * |
|
272 | - * @param int $mode |
|
273 | - * One of PEAR_ERROR_RETURN, PEAR_ERROR_PRINT, |
|
274 | - * PEAR_ERROR_TRIGGER, PEAR_ERROR_DIE, |
|
275 | - * PEAR_ERROR_CALLBACK or PEAR_ERROR_EXCEPTION. |
|
276 | - * |
|
277 | - * @param mixed $options |
|
278 | - * When $mode is PEAR_ERROR_TRIGGER, this is the error level (one |
|
279 | - * of E_USER_NOTICE, E_USER_WARNING or E_USER_ERROR). |
|
280 | - * |
|
281 | - * When $mode is PEAR_ERROR_CALLBACK, this parameter is expected |
|
282 | - * to be the callback function or method. A callback |
|
283 | - * function is a string with the name of the function, a |
|
284 | - * callback method is an array of two elements: the element |
|
285 | - * at index 0 is the object, and the element at index 1 is |
|
286 | - * the name of the method to call in the object. |
|
287 | - * |
|
288 | - * When $mode is PEAR_ERROR_PRINT or PEAR_ERROR_DIE, this is |
|
289 | - * a printf format string used when printing the error |
|
290 | - * message. |
|
291 | - * |
|
292 | - * @access public |
|
293 | - * @return void |
|
294 | - * @see PEAR_ERROR_RETURN |
|
295 | - * @see PEAR_ERROR_PRINT |
|
296 | - * @see PEAR_ERROR_TRIGGER |
|
297 | - * @see PEAR_ERROR_DIE |
|
298 | - * @see PEAR_ERROR_CALLBACK |
|
299 | - * @see PEAR_ERROR_EXCEPTION |
|
300 | - * |
|
301 | - * @since PHP 4.0.5 |
|
302 | - */ |
|
303 | - function setErrorHandling($mode = null, $options = null) |
|
304 | - { |
|
305 | - if (isset($this) && is_a($this, 'PEAR')) { |
|
306 | - $setmode = &$this->_default_error_mode; |
|
307 | - $setoptions = &$this->_default_error_options; |
|
308 | - } else { |
|
309 | - $setmode = &$GLOBALS['_PEAR_default_error_mode']; |
|
310 | - $setoptions = &$GLOBALS['_PEAR_default_error_options']; |
|
311 | - } |
|
312 | - |
|
313 | - switch ($mode) { |
|
314 | - case PEAR_ERROR_EXCEPTION: |
|
315 | - case PEAR_ERROR_RETURN: |
|
316 | - case PEAR_ERROR_PRINT: |
|
317 | - case PEAR_ERROR_TRIGGER: |
|
318 | - case PEAR_ERROR_DIE: |
|
319 | - case null: |
|
320 | - $setmode = $mode; |
|
321 | - $setoptions = $options; |
|
322 | - break; |
|
323 | - |
|
324 | - case PEAR_ERROR_CALLBACK: |
|
325 | - $setmode = $mode; |
|
326 | - // class/object method callback |
|
327 | - if (is_callable($options)) { |
|
328 | - $setoptions = $options; |
|
329 | - } else { |
|
330 | - trigger_error("invalid error callback", E_USER_WARNING); |
|
331 | - } |
|
332 | - break; |
|
333 | - |
|
334 | - default: |
|
335 | - trigger_error("invalid error mode", E_USER_WARNING); |
|
336 | - break; |
|
337 | - } |
|
338 | - } |
|
339 | - |
|
340 | - /** |
|
341 | - * This method is used to tell which errors you expect to get. |
|
342 | - * Expected errors are always returned with error mode |
|
343 | - * PEAR_ERROR_RETURN. Expected error codes are stored in a stack, |
|
344 | - * and this method pushes a new element onto it. The list of |
|
345 | - * expected errors are in effect until they are popped off the |
|
346 | - * stack with the popExpect() method. |
|
347 | - * |
|
348 | - * Note that this method can not be called statically |
|
349 | - * |
|
350 | - * @param mixed $code a single error code or an array of error codes to expect |
|
351 | - * |
|
352 | - * @return int the new depth of the "expected errors" stack |
|
353 | - * @access public |
|
354 | - */ |
|
355 | - function expectError($code = '*') |
|
356 | - { |
|
357 | - if (is_array($code)) { |
|
358 | - array_push($this->_expected_errors, $code); |
|
359 | - } else { |
|
360 | - array_push($this->_expected_errors, array($code)); |
|
361 | - } |
|
362 | - return count($this->_expected_errors); |
|
363 | - } |
|
364 | - |
|
365 | - /** |
|
366 | - * This method pops one element off the expected error codes |
|
367 | - * stack. |
|
368 | - * |
|
369 | - * @return array the list of error codes that were popped |
|
370 | - */ |
|
371 | - function popExpect() |
|
372 | - { |
|
373 | - return array_pop($this->_expected_errors); |
|
374 | - } |
|
375 | - |
|
376 | - /** |
|
377 | - * This method checks unsets an error code if available |
|
378 | - * |
|
379 | - * @param mixed error code |
|
380 | - * @return bool true if the error code was unset, false otherwise |
|
381 | - * @access private |
|
382 | - * @since PHP 4.3.0 |
|
383 | - */ |
|
384 | - function _checkDelExpect($error_code) |
|
385 | - { |
|
386 | - $deleted = false; |
|
387 | - foreach ($this->_expected_errors as $key => $error_array) { |
|
388 | - if (in_array($error_code, $error_array)) { |
|
389 | - unset($this->_expected_errors[$key][array_search($error_code, $error_array)]); |
|
390 | - $deleted = true; |
|
391 | - } |
|
392 | - |
|
393 | - // clean up empty arrays |
|
394 | - if (0 == count($this->_expected_errors[$key])) { |
|
395 | - unset($this->_expected_errors[$key]); |
|
396 | - } |
|
397 | - } |
|
398 | - |
|
399 | - return $deleted; |
|
400 | - } |
|
401 | - |
|
402 | - /** |
|
403 | - * This method deletes all occurences of the specified element from |
|
404 | - * the expected error codes stack. |
|
405 | - * |
|
406 | - * @param mixed $error_code error code that should be deleted |
|
407 | - * @return mixed list of error codes that were deleted or error |
|
408 | - * @access public |
|
409 | - * @since PHP 4.3.0 |
|
410 | - */ |
|
411 | - function delExpect($error_code) |
|
412 | - { |
|
413 | - $deleted = false; |
|
414 | - if ((is_array($error_code) && (0 != count($error_code)))) { |
|
415 | - // $error_code is a non-empty array here; we walk through it trying |
|
416 | - // to unset all values |
|
417 | - foreach ($error_code as $key => $error) { |
|
418 | - $deleted = $this->_checkDelExpect($error) ? true : false; |
|
419 | - } |
|
420 | - |
|
421 | - return $deleted ? true : PEAR::raiseError("The expected error you submitted does not exist"); // IMPROVE ME |
|
422 | - } elseif (!empty($error_code)) { |
|
423 | - // $error_code comes alone, trying to unset it |
|
424 | - if ($this->_checkDelExpect($error_code)) { |
|
425 | - return true; |
|
426 | - } |
|
427 | - |
|
428 | - return PEAR::raiseError("The expected error you submitted does not exist"); // IMPROVE ME |
|
429 | - } |
|
430 | - |
|
431 | - // $error_code is empty |
|
432 | - return PEAR::raiseError("The expected error you submitted is empty"); // IMPROVE ME |
|
433 | - } |
|
434 | - |
|
435 | - /** |
|
436 | - * This method is a wrapper that returns an instance of the |
|
437 | - * configured error class with this object's default error |
|
438 | - * handling applied. If the $mode and $options parameters are not |
|
439 | - * specified, the object's defaults are used. |
|
440 | - * |
|
441 | - * @param mixed $message a text error message or a PEAR error object |
|
442 | - * |
|
443 | - * @param int $code a numeric error code (it is up to your class |
|
444 | - * to define these if you want to use codes) |
|
445 | - * |
|
446 | - * @param int $mode One of PEAR_ERROR_RETURN, PEAR_ERROR_PRINT, |
|
447 | - * PEAR_ERROR_TRIGGER, PEAR_ERROR_DIE, |
|
448 | - * PEAR_ERROR_CALLBACK, PEAR_ERROR_EXCEPTION. |
|
449 | - * |
|
450 | - * @param mixed $options If $mode is PEAR_ERROR_TRIGGER, this parameter |
|
451 | - * specifies the PHP-internal error level (one of |
|
452 | - * E_USER_NOTICE, E_USER_WARNING or E_USER_ERROR). |
|
453 | - * If $mode is PEAR_ERROR_CALLBACK, this |
|
454 | - * parameter specifies the callback function or |
|
455 | - * method. In other error modes this parameter |
|
456 | - * is ignored. |
|
457 | - * |
|
458 | - * @param string $userinfo If you need to pass along for example debug |
|
459 | - * information, this parameter is meant for that. |
|
460 | - * |
|
461 | - * @param string $error_class The returned error object will be |
|
462 | - * instantiated from this class, if specified. |
|
463 | - * |
|
464 | - * @param bool $skipmsg If true, raiseError will only pass error codes, |
|
465 | - * the error message parameter will be dropped. |
|
466 | - * |
|
467 | - * @access public |
|
468 | - * @return object a PEAR error object |
|
469 | - * @see PEAR::setErrorHandling |
|
470 | - * @since PHP 4.0.5 |
|
471 | - */ |
|
472 | - function &raiseError($message = null, |
|
473 | - $code = null, |
|
474 | - $mode = null, |
|
475 | - $options = null, |
|
476 | - $userinfo = null, |
|
477 | - $error_class = null, |
|
478 | - $skipmsg = false) |
|
479 | - { |
|
480 | - // The error is yet a PEAR error object |
|
481 | - if (is_object($message)) { |
|
482 | - $code = $message->getCode(); |
|
483 | - $userinfo = $message->getUserInfo(); |
|
484 | - $error_class = $message->getType(); |
|
485 | - $message->error_message_prefix = ''; |
|
486 | - $message = $message->getMessage(); |
|
487 | - } |
|
488 | - |
|
489 | - if ( |
|
490 | - isset($this) && |
|
491 | - isset($this->_expected_errors) && |
|
492 | - count($this->_expected_errors) > 0 && |
|
493 | - count($exp = end($this->_expected_errors)) |
|
494 | - ) { |
|
495 | - if ($exp[0] == "*" || |
|
496 | - (is_int(reset($exp)) && in_array($code, $exp)) || |
|
497 | - (is_string(reset($exp)) && in_array($message, $exp)) |
|
498 | - ) { |
|
499 | - $mode = PEAR_ERROR_RETURN; |
|
500 | - } |
|
501 | - } |
|
502 | - |
|
503 | - // No mode given, try global ones |
|
504 | - if ($mode === null) { |
|
505 | - // Class error handler |
|
506 | - if (isset($this) && isset($this->_default_error_mode)) { |
|
507 | - $mode = $this->_default_error_mode; |
|
508 | - $options = $this->_default_error_options; |
|
509 | - // Global error handler |
|
510 | - } elseif (isset($GLOBALS['_PEAR_default_error_mode'])) { |
|
511 | - $mode = $GLOBALS['_PEAR_default_error_mode']; |
|
512 | - $options = $GLOBALS['_PEAR_default_error_options']; |
|
513 | - } |
|
514 | - } |
|
515 | - |
|
516 | - if ($error_class !== null) { |
|
517 | - $ec = $error_class; |
|
518 | - } elseif (isset($this) && isset($this->_error_class)) { |
|
519 | - $ec = $this->_error_class; |
|
520 | - } else { |
|
521 | - $ec = 'PEAR_Error'; |
|
522 | - } |
|
523 | - |
|
524 | - if (intval(PHP_VERSION) < 5) { |
|
525 | - // little non-eval hack to fix bug #12147 |
|
526 | - include 'PEAR/FixPHP5PEARWarnings.php'; |
|
527 | - return $a; |
|
528 | - } |
|
529 | - |
|
530 | - if ($skipmsg) { |
|
531 | - $a = new $ec($code, $mode, $options, $userinfo); |
|
532 | - } else { |
|
533 | - $a = new $ec($message, $code, $mode, $options, $userinfo); |
|
534 | - } |
|
535 | - |
|
536 | - return $a; |
|
537 | - } |
|
538 | - |
|
539 | - /** |
|
540 | - * Simpler form of raiseError with fewer options. In most cases |
|
541 | - * message, code and userinfo are enough. |
|
542 | - * |
|
543 | - * @param mixed $message a text error message or a PEAR error object |
|
544 | - * |
|
545 | - * @param int $code a numeric error code (it is up to your class |
|
546 | - * to define these if you want to use codes) |
|
547 | - * |
|
548 | - * @param string $userinfo If you need to pass along for example debug |
|
549 | - * information, this parameter is meant for that. |
|
550 | - * |
|
551 | - * @access public |
|
552 | - * @return object a PEAR error object |
|
553 | - * @see PEAR::raiseError |
|
554 | - */ |
|
555 | - function &throwError($message = null, $code = null, $userinfo = null) |
|
556 | - { |
|
557 | - if (isset($this) && is_a($this, 'PEAR')) { |
|
558 | - $a = &$this->raiseError($message, $code, null, null, $userinfo); |
|
559 | - return $a; |
|
560 | - } |
|
561 | - |
|
562 | - $a = &PEAR::raiseError($message, $code, null, null, $userinfo); |
|
563 | - return $a; |
|
564 | - } |
|
565 | - |
|
566 | - function staticPushErrorHandling($mode, $options = null) |
|
567 | - { |
|
568 | - $stack = &$GLOBALS['_PEAR_error_handler_stack']; |
|
569 | - $def_mode = &$GLOBALS['_PEAR_default_error_mode']; |
|
570 | - $def_options = &$GLOBALS['_PEAR_default_error_options']; |
|
571 | - $stack[] = array($def_mode, $def_options); |
|
572 | - switch ($mode) { |
|
573 | - case PEAR_ERROR_EXCEPTION: |
|
574 | - case PEAR_ERROR_RETURN: |
|
575 | - case PEAR_ERROR_PRINT: |
|
576 | - case PEAR_ERROR_TRIGGER: |
|
577 | - case PEAR_ERROR_DIE: |
|
578 | - case null: |
|
579 | - $def_mode = $mode; |
|
580 | - $def_options = $options; |
|
581 | - break; |
|
582 | - |
|
583 | - case PEAR_ERROR_CALLBACK: |
|
584 | - $def_mode = $mode; |
|
585 | - // class/object method callback |
|
586 | - if (is_callable($options)) { |
|
587 | - $def_options = $options; |
|
588 | - } else { |
|
589 | - trigger_error("invalid error callback", E_USER_WARNING); |
|
590 | - } |
|
591 | - break; |
|
592 | - |
|
593 | - default: |
|
594 | - trigger_error("invalid error mode", E_USER_WARNING); |
|
595 | - break; |
|
596 | - } |
|
597 | - $stack[] = array($mode, $options); |
|
598 | - return true; |
|
599 | - } |
|
600 | - |
|
601 | - function staticPopErrorHandling() |
|
602 | - { |
|
603 | - $stack = &$GLOBALS['_PEAR_error_handler_stack']; |
|
604 | - $setmode = &$GLOBALS['_PEAR_default_error_mode']; |
|
605 | - $setoptions = &$GLOBALS['_PEAR_default_error_options']; |
|
606 | - array_pop($stack); |
|
607 | - list($mode, $options) = $stack[sizeof($stack) - 1]; |
|
608 | - array_pop($stack); |
|
609 | - switch ($mode) { |
|
610 | - case PEAR_ERROR_EXCEPTION: |
|
611 | - case PEAR_ERROR_RETURN: |
|
612 | - case PEAR_ERROR_PRINT: |
|
613 | - case PEAR_ERROR_TRIGGER: |
|
614 | - case PEAR_ERROR_DIE: |
|
615 | - case null: |
|
616 | - $setmode = $mode; |
|
617 | - $setoptions = $options; |
|
618 | - break; |
|
619 | - |
|
620 | - case PEAR_ERROR_CALLBACK: |
|
621 | - $setmode = $mode; |
|
622 | - // class/object method callback |
|
623 | - if (is_callable($options)) { |
|
624 | - $setoptions = $options; |
|
625 | - } else { |
|
626 | - trigger_error("invalid error callback", E_USER_WARNING); |
|
627 | - } |
|
628 | - break; |
|
629 | - |
|
630 | - default: |
|
631 | - trigger_error("invalid error mode", E_USER_WARNING); |
|
632 | - break; |
|
633 | - } |
|
634 | - return true; |
|
635 | - } |
|
636 | - |
|
637 | - /** |
|
638 | - * Push a new error handler on top of the error handler options stack. With this |
|
639 | - * you can easily override the actual error handler for some code and restore |
|
640 | - * it later with popErrorHandling. |
|
641 | - * |
|
642 | - * @param mixed $mode (same as setErrorHandling) |
|
643 | - * @param mixed $options (same as setErrorHandling) |
|
644 | - * |
|
645 | - * @return bool Always true |
|
646 | - * |
|
647 | - * @see PEAR::setErrorHandling |
|
648 | - */ |
|
649 | - function pushErrorHandling($mode, $options = null) |
|
650 | - { |
|
651 | - $stack = &$GLOBALS['_PEAR_error_handler_stack']; |
|
652 | - if (isset($this) && is_a($this, 'PEAR')) { |
|
653 | - $def_mode = &$this->_default_error_mode; |
|
654 | - $def_options = &$this->_default_error_options; |
|
655 | - } else { |
|
656 | - $def_mode = &$GLOBALS['_PEAR_default_error_mode']; |
|
657 | - $def_options = &$GLOBALS['_PEAR_default_error_options']; |
|
658 | - } |
|
659 | - $stack[] = array($def_mode, $def_options); |
|
660 | - |
|
661 | - if (isset($this) && is_a($this, 'PEAR')) { |
|
662 | - $this->setErrorHandling($mode, $options); |
|
663 | - } else { |
|
664 | - PEAR::setErrorHandling($mode, $options); |
|
665 | - } |
|
666 | - $stack[] = array($mode, $options); |
|
667 | - return true; |
|
668 | - } |
|
669 | - |
|
670 | - /** |
|
671 | - * Pop the last error handler used |
|
672 | - * |
|
673 | - * @return bool Always true |
|
674 | - * |
|
675 | - * @see PEAR::pushErrorHandling |
|
676 | - */ |
|
677 | - function popErrorHandling() |
|
678 | - { |
|
679 | - $stack = &$GLOBALS['_PEAR_error_handler_stack']; |
|
680 | - array_pop($stack); |
|
681 | - list($mode, $options) = $stack[sizeof($stack) - 1]; |
|
682 | - array_pop($stack); |
|
683 | - if (isset($this) && is_a($this, 'PEAR')) { |
|
684 | - $this->setErrorHandling($mode, $options); |
|
685 | - } else { |
|
686 | - PEAR::setErrorHandling($mode, $options); |
|
687 | - } |
|
688 | - return true; |
|
689 | - } |
|
690 | - |
|
691 | - /** |
|
692 | - * OS independent PHP extension load. Remember to take care |
|
693 | - * on the correct extension name for case sensitive OSes. |
|
694 | - * |
|
695 | - * @param string $ext The extension name |
|
696 | - * @return bool Success or not on the dl() call |
|
697 | - */ |
|
698 | - function loadExtension($ext) |
|
699 | - { |
|
700 | - if (extension_loaded($ext)) { |
|
701 | - return true; |
|
702 | - } |
|
703 | - |
|
704 | - // if either returns true dl() will produce a FATAL error, stop that |
|
705 | - if ( |
|
706 | - function_exists('dl') === false || |
|
707 | - ini_get('enable_dl') != 1 || |
|
708 | - ini_get('safe_mode') == 1 |
|
709 | - ) { |
|
710 | - return false; |
|
711 | - } |
|
712 | - |
|
713 | - if (OS_WINDOWS) { |
|
714 | - $suffix = '.dll'; |
|
715 | - } elseif (PHP_OS == 'HP-UX') { |
|
716 | - $suffix = '.sl'; |
|
717 | - } elseif (PHP_OS == 'AIX') { |
|
718 | - $suffix = '.a'; |
|
719 | - } elseif (PHP_OS == 'OSX') { |
|
720 | - $suffix = '.bundle'; |
|
721 | - } else { |
|
722 | - $suffix = '.so'; |
|
723 | - } |
|
724 | - |
|
725 | - return @dl('php_'.$ext.$suffix) || @dl($ext.$suffix); |
|
726 | - } |
|
89 | + /** |
|
90 | + * Whether to enable internal debug messages. |
|
91 | + * |
|
92 | + * @var bool |
|
93 | + * @access private |
|
94 | + */ |
|
95 | + var $_debug = false; |
|
96 | + |
|
97 | + /** |
|
98 | + * Default error mode for this object. |
|
99 | + * |
|
100 | + * @var int |
|
101 | + * @access private |
|
102 | + */ |
|
103 | + var $_default_error_mode = null; |
|
104 | + |
|
105 | + /** |
|
106 | + * Default error options used for this object when error mode |
|
107 | + * is PEAR_ERROR_TRIGGER. |
|
108 | + * |
|
109 | + * @var int |
|
110 | + * @access private |
|
111 | + */ |
|
112 | + var $_default_error_options = null; |
|
113 | + |
|
114 | + /** |
|
115 | + * Default error handler (callback) for this object, if error mode is |
|
116 | + * PEAR_ERROR_CALLBACK. |
|
117 | + * |
|
118 | + * @var string |
|
119 | + * @access private |
|
120 | + */ |
|
121 | + var $_default_error_handler = ''; |
|
122 | + |
|
123 | + /** |
|
124 | + * Which class to use for error objects. |
|
125 | + * |
|
126 | + * @var string |
|
127 | + * @access private |
|
128 | + */ |
|
129 | + var $_error_class = 'PEAR_Error'; |
|
130 | + |
|
131 | + /** |
|
132 | + * An array of expected errors. |
|
133 | + * |
|
134 | + * @var array |
|
135 | + * @access private |
|
136 | + */ |
|
137 | + var $_expected_errors = array(); |
|
138 | + |
|
139 | + /** |
|
140 | + * Constructor. Registers this object in |
|
141 | + * $_PEAR_destructor_object_list for destructor emulation if a |
|
142 | + * destructor object exists. |
|
143 | + * |
|
144 | + * @param string $error_class (optional) which class to use for |
|
145 | + * error objects, defaults to PEAR_Error. |
|
146 | + * @access public |
|
147 | + * @return void |
|
148 | + */ |
|
149 | + function PEAR($error_class = null) |
|
150 | + { |
|
151 | + $classname = strtolower(get_class($this)); |
|
152 | + if ($this->_debug) { |
|
153 | + print "PEAR constructor called, class=$classname\n"; |
|
154 | + } |
|
155 | + |
|
156 | + if ($error_class !== null) { |
|
157 | + $this->_error_class = $error_class; |
|
158 | + } |
|
159 | + |
|
160 | + while ($classname && strcasecmp($classname, "pear")) { |
|
161 | + $destructor = "_$classname"; |
|
162 | + if (method_exists($this, $destructor)) { |
|
163 | + global $_PEAR_destructor_object_list; |
|
164 | + $_PEAR_destructor_object_list[] = &$this; |
|
165 | + if (!isset($GLOBALS['_PEAR_SHUTDOWN_REGISTERED'])) { |
|
166 | + register_shutdown_function("_PEAR_call_destructors"); |
|
167 | + $GLOBALS['_PEAR_SHUTDOWN_REGISTERED'] = true; |
|
168 | + } |
|
169 | + break; |
|
170 | + } else { |
|
171 | + $classname = get_parent_class($classname); |
|
172 | + } |
|
173 | + } |
|
174 | + } |
|
175 | + |
|
176 | + /** |
|
177 | + * Destructor (the emulated type of...). Does nothing right now, |
|
178 | + * but is included for forward compatibility, so subclass |
|
179 | + * destructors should always call it. |
|
180 | + * |
|
181 | + * See the note in the class desciption about output from |
|
182 | + * destructors. |
|
183 | + * |
|
184 | + * @access public |
|
185 | + * @return void |
|
186 | + */ |
|
187 | + function _PEAR() { |
|
188 | + if ($this->_debug) { |
|
189 | + printf("PEAR destructor called, class=%s\n", strtolower(get_class($this))); |
|
190 | + } |
|
191 | + } |
|
192 | + |
|
193 | + /** |
|
194 | + * If you have a class that's mostly/entirely static, and you need static |
|
195 | + * properties, you can use this method to simulate them. Eg. in your method(s) |
|
196 | + * do this: $myVar = &PEAR::getStaticProperty('myclass', 'myVar'); |
|
197 | + * You MUST use a reference, or they will not persist! |
|
198 | + * |
|
199 | + * @access public |
|
200 | + * @param string $class The calling classname, to prevent clashes |
|
201 | + * @param string $var The variable to retrieve. |
|
202 | + * @return mixed A reference to the variable. If not set it will be |
|
203 | + * auto initialised to NULL. |
|
204 | + */ |
|
205 | + function &getStaticProperty($class, $var) |
|
206 | + { |
|
207 | + static $properties; |
|
208 | + if (!isset($properties[$class])) { |
|
209 | + $properties[$class] = array(); |
|
210 | + } |
|
211 | + |
|
212 | + if (!array_key_exists($var, $properties[$class])) { |
|
213 | + $properties[$class][$var] = null; |
|
214 | + } |
|
215 | + |
|
216 | + return $properties[$class][$var]; |
|
217 | + } |
|
218 | + |
|
219 | + /** |
|
220 | + * Use this function to register a shutdown method for static |
|
221 | + * classes. |
|
222 | + * |
|
223 | + * @access public |
|
224 | + * @param mixed $func The function name (or array of class/method) to call |
|
225 | + * @param mixed $args The arguments to pass to the function |
|
226 | + * @return void |
|
227 | + */ |
|
228 | + function registerShutdownFunc($func, $args = array()) |
|
229 | + { |
|
230 | + // if we are called statically, there is a potential |
|
231 | + // that no shutdown func is registered. Bug #6445 |
|
232 | + if (!isset($GLOBALS['_PEAR_SHUTDOWN_REGISTERED'])) { |
|
233 | + register_shutdown_function("_PEAR_call_destructors"); |
|
234 | + $GLOBALS['_PEAR_SHUTDOWN_REGISTERED'] = true; |
|
235 | + } |
|
236 | + $GLOBALS['_PEAR_shutdown_funcs'][] = array($func, $args); |
|
237 | + } |
|
238 | + |
|
239 | + /** |
|
240 | + * Tell whether a value is a PEAR error. |
|
241 | + * |
|
242 | + * @param mixed $data the value to test |
|
243 | + * @param int $code if $data is an error object, return true |
|
244 | + * only if $code is a string and |
|
245 | + * $obj->getMessage() == $code or |
|
246 | + * $code is an integer and $obj->getCode() == $code |
|
247 | + * @access public |
|
248 | + * @return bool true if parameter is an error |
|
249 | + */ |
|
250 | + function isError($data, $code = null) |
|
251 | + { |
|
252 | + if (!is_a($data, 'PEAR_Error')) { |
|
253 | + return false; |
|
254 | + } |
|
255 | + |
|
256 | + if (is_null($code)) { |
|
257 | + return true; |
|
258 | + } elseif (is_string($code)) { |
|
259 | + return $data->getMessage() == $code; |
|
260 | + } |
|
261 | + |
|
262 | + return $data->getCode() == $code; |
|
263 | + } |
|
264 | + |
|
265 | + /** |
|
266 | + * Sets how errors generated by this object should be handled. |
|
267 | + * Can be invoked both in objects and statically. If called |
|
268 | + * statically, setErrorHandling sets the default behaviour for all |
|
269 | + * PEAR objects. If called in an object, setErrorHandling sets |
|
270 | + * the default behaviour for that object. |
|
271 | + * |
|
272 | + * @param int $mode |
|
273 | + * One of PEAR_ERROR_RETURN, PEAR_ERROR_PRINT, |
|
274 | + * PEAR_ERROR_TRIGGER, PEAR_ERROR_DIE, |
|
275 | + * PEAR_ERROR_CALLBACK or PEAR_ERROR_EXCEPTION. |
|
276 | + * |
|
277 | + * @param mixed $options |
|
278 | + * When $mode is PEAR_ERROR_TRIGGER, this is the error level (one |
|
279 | + * of E_USER_NOTICE, E_USER_WARNING or E_USER_ERROR). |
|
280 | + * |
|
281 | + * When $mode is PEAR_ERROR_CALLBACK, this parameter is expected |
|
282 | + * to be the callback function or method. A callback |
|
283 | + * function is a string with the name of the function, a |
|
284 | + * callback method is an array of two elements: the element |
|
285 | + * at index 0 is the object, and the element at index 1 is |
|
286 | + * the name of the method to call in the object. |
|
287 | + * |
|
288 | + * When $mode is PEAR_ERROR_PRINT or PEAR_ERROR_DIE, this is |
|
289 | + * a printf format string used when printing the error |
|
290 | + * message. |
|
291 | + * |
|
292 | + * @access public |
|
293 | + * @return void |
|
294 | + * @see PEAR_ERROR_RETURN |
|
295 | + * @see PEAR_ERROR_PRINT |
|
296 | + * @see PEAR_ERROR_TRIGGER |
|
297 | + * @see PEAR_ERROR_DIE |
|
298 | + * @see PEAR_ERROR_CALLBACK |
|
299 | + * @see PEAR_ERROR_EXCEPTION |
|
300 | + * |
|
301 | + * @since PHP 4.0.5 |
|
302 | + */ |
|
303 | + function setErrorHandling($mode = null, $options = null) |
|
304 | + { |
|
305 | + if (isset($this) && is_a($this, 'PEAR')) { |
|
306 | + $setmode = &$this->_default_error_mode; |
|
307 | + $setoptions = &$this->_default_error_options; |
|
308 | + } else { |
|
309 | + $setmode = &$GLOBALS['_PEAR_default_error_mode']; |
|
310 | + $setoptions = &$GLOBALS['_PEAR_default_error_options']; |
|
311 | + } |
|
312 | + |
|
313 | + switch ($mode) { |
|
314 | + case PEAR_ERROR_EXCEPTION: |
|
315 | + case PEAR_ERROR_RETURN: |
|
316 | + case PEAR_ERROR_PRINT: |
|
317 | + case PEAR_ERROR_TRIGGER: |
|
318 | + case PEAR_ERROR_DIE: |
|
319 | + case null: |
|
320 | + $setmode = $mode; |
|
321 | + $setoptions = $options; |
|
322 | + break; |
|
323 | + |
|
324 | + case PEAR_ERROR_CALLBACK: |
|
325 | + $setmode = $mode; |
|
326 | + // class/object method callback |
|
327 | + if (is_callable($options)) { |
|
328 | + $setoptions = $options; |
|
329 | + } else { |
|
330 | + trigger_error("invalid error callback", E_USER_WARNING); |
|
331 | + } |
|
332 | + break; |
|
333 | + |
|
334 | + default: |
|
335 | + trigger_error("invalid error mode", E_USER_WARNING); |
|
336 | + break; |
|
337 | + } |
|
338 | + } |
|
339 | + |
|
340 | + /** |
|
341 | + * This method is used to tell which errors you expect to get. |
|
342 | + * Expected errors are always returned with error mode |
|
343 | + * PEAR_ERROR_RETURN. Expected error codes are stored in a stack, |
|
344 | + * and this method pushes a new element onto it. The list of |
|
345 | + * expected errors are in effect until they are popped off the |
|
346 | + * stack with the popExpect() method. |
|
347 | + * |
|
348 | + * Note that this method can not be called statically |
|
349 | + * |
|
350 | + * @param mixed $code a single error code or an array of error codes to expect |
|
351 | + * |
|
352 | + * @return int the new depth of the "expected errors" stack |
|
353 | + * @access public |
|
354 | + */ |
|
355 | + function expectError($code = '*') |
|
356 | + { |
|
357 | + if (is_array($code)) { |
|
358 | + array_push($this->_expected_errors, $code); |
|
359 | + } else { |
|
360 | + array_push($this->_expected_errors, array($code)); |
|
361 | + } |
|
362 | + return count($this->_expected_errors); |
|
363 | + } |
|
364 | + |
|
365 | + /** |
|
366 | + * This method pops one element off the expected error codes |
|
367 | + * stack. |
|
368 | + * |
|
369 | + * @return array the list of error codes that were popped |
|
370 | + */ |
|
371 | + function popExpect() |
|
372 | + { |
|
373 | + return array_pop($this->_expected_errors); |
|
374 | + } |
|
375 | + |
|
376 | + /** |
|
377 | + * This method checks unsets an error code if available |
|
378 | + * |
|
379 | + * @param mixed error code |
|
380 | + * @return bool true if the error code was unset, false otherwise |
|
381 | + * @access private |
|
382 | + * @since PHP 4.3.0 |
|
383 | + */ |
|
384 | + function _checkDelExpect($error_code) |
|
385 | + { |
|
386 | + $deleted = false; |
|
387 | + foreach ($this->_expected_errors as $key => $error_array) { |
|
388 | + if (in_array($error_code, $error_array)) { |
|
389 | + unset($this->_expected_errors[$key][array_search($error_code, $error_array)]); |
|
390 | + $deleted = true; |
|
391 | + } |
|
392 | + |
|
393 | + // clean up empty arrays |
|
394 | + if (0 == count($this->_expected_errors[$key])) { |
|
395 | + unset($this->_expected_errors[$key]); |
|
396 | + } |
|
397 | + } |
|
398 | + |
|
399 | + return $deleted; |
|
400 | + } |
|
401 | + |
|
402 | + /** |
|
403 | + * This method deletes all occurences of the specified element from |
|
404 | + * the expected error codes stack. |
|
405 | + * |
|
406 | + * @param mixed $error_code error code that should be deleted |
|
407 | + * @return mixed list of error codes that were deleted or error |
|
408 | + * @access public |
|
409 | + * @since PHP 4.3.0 |
|
410 | + */ |
|
411 | + function delExpect($error_code) |
|
412 | + { |
|
413 | + $deleted = false; |
|
414 | + if ((is_array($error_code) && (0 != count($error_code)))) { |
|
415 | + // $error_code is a non-empty array here; we walk through it trying |
|
416 | + // to unset all values |
|
417 | + foreach ($error_code as $key => $error) { |
|
418 | + $deleted = $this->_checkDelExpect($error) ? true : false; |
|
419 | + } |
|
420 | + |
|
421 | + return $deleted ? true : PEAR::raiseError("The expected error you submitted does not exist"); // IMPROVE ME |
|
422 | + } elseif (!empty($error_code)) { |
|
423 | + // $error_code comes alone, trying to unset it |
|
424 | + if ($this->_checkDelExpect($error_code)) { |
|
425 | + return true; |
|
426 | + } |
|
427 | + |
|
428 | + return PEAR::raiseError("The expected error you submitted does not exist"); // IMPROVE ME |
|
429 | + } |
|
430 | + |
|
431 | + // $error_code is empty |
|
432 | + return PEAR::raiseError("The expected error you submitted is empty"); // IMPROVE ME |
|
433 | + } |
|
434 | + |
|
435 | + /** |
|
436 | + * This method is a wrapper that returns an instance of the |
|
437 | + * configured error class with this object's default error |
|
438 | + * handling applied. If the $mode and $options parameters are not |
|
439 | + * specified, the object's defaults are used. |
|
440 | + * |
|
441 | + * @param mixed $message a text error message or a PEAR error object |
|
442 | + * |
|
443 | + * @param int $code a numeric error code (it is up to your class |
|
444 | + * to define these if you want to use codes) |
|
445 | + * |
|
446 | + * @param int $mode One of PEAR_ERROR_RETURN, PEAR_ERROR_PRINT, |
|
447 | + * PEAR_ERROR_TRIGGER, PEAR_ERROR_DIE, |
|
448 | + * PEAR_ERROR_CALLBACK, PEAR_ERROR_EXCEPTION. |
|
449 | + * |
|
450 | + * @param mixed $options If $mode is PEAR_ERROR_TRIGGER, this parameter |
|
451 | + * specifies the PHP-internal error level (one of |
|
452 | + * E_USER_NOTICE, E_USER_WARNING or E_USER_ERROR). |
|
453 | + * If $mode is PEAR_ERROR_CALLBACK, this |
|
454 | + * parameter specifies the callback function or |
|
455 | + * method. In other error modes this parameter |
|
456 | + * is ignored. |
|
457 | + * |
|
458 | + * @param string $userinfo If you need to pass along for example debug |
|
459 | + * information, this parameter is meant for that. |
|
460 | + * |
|
461 | + * @param string $error_class The returned error object will be |
|
462 | + * instantiated from this class, if specified. |
|
463 | + * |
|
464 | + * @param bool $skipmsg If true, raiseError will only pass error codes, |
|
465 | + * the error message parameter will be dropped. |
|
466 | + * |
|
467 | + * @access public |
|
468 | + * @return object a PEAR error object |
|
469 | + * @see PEAR::setErrorHandling |
|
470 | + * @since PHP 4.0.5 |
|
471 | + */ |
|
472 | + function &raiseError($message = null, |
|
473 | + $code = null, |
|
474 | + $mode = null, |
|
475 | + $options = null, |
|
476 | + $userinfo = null, |
|
477 | + $error_class = null, |
|
478 | + $skipmsg = false) |
|
479 | + { |
|
480 | + // The error is yet a PEAR error object |
|
481 | + if (is_object($message)) { |
|
482 | + $code = $message->getCode(); |
|
483 | + $userinfo = $message->getUserInfo(); |
|
484 | + $error_class = $message->getType(); |
|
485 | + $message->error_message_prefix = ''; |
|
486 | + $message = $message->getMessage(); |
|
487 | + } |
|
488 | + |
|
489 | + if ( |
|
490 | + isset($this) && |
|
491 | + isset($this->_expected_errors) && |
|
492 | + count($this->_expected_errors) > 0 && |
|
493 | + count($exp = end($this->_expected_errors)) |
|
494 | + ) { |
|
495 | + if ($exp[0] == "*" || |
|
496 | + (is_int(reset($exp)) && in_array($code, $exp)) || |
|
497 | + (is_string(reset($exp)) && in_array($message, $exp)) |
|
498 | + ) { |
|
499 | + $mode = PEAR_ERROR_RETURN; |
|
500 | + } |
|
501 | + } |
|
502 | + |
|
503 | + // No mode given, try global ones |
|
504 | + if ($mode === null) { |
|
505 | + // Class error handler |
|
506 | + if (isset($this) && isset($this->_default_error_mode)) { |
|
507 | + $mode = $this->_default_error_mode; |
|
508 | + $options = $this->_default_error_options; |
|
509 | + // Global error handler |
|
510 | + } elseif (isset($GLOBALS['_PEAR_default_error_mode'])) { |
|
511 | + $mode = $GLOBALS['_PEAR_default_error_mode']; |
|
512 | + $options = $GLOBALS['_PEAR_default_error_options']; |
|
513 | + } |
|
514 | + } |
|
515 | + |
|
516 | + if ($error_class !== null) { |
|
517 | + $ec = $error_class; |
|
518 | + } elseif (isset($this) && isset($this->_error_class)) { |
|
519 | + $ec = $this->_error_class; |
|
520 | + } else { |
|
521 | + $ec = 'PEAR_Error'; |
|
522 | + } |
|
523 | + |
|
524 | + if (intval(PHP_VERSION) < 5) { |
|
525 | + // little non-eval hack to fix bug #12147 |
|
526 | + include 'PEAR/FixPHP5PEARWarnings.php'; |
|
527 | + return $a; |
|
528 | + } |
|
529 | + |
|
530 | + if ($skipmsg) { |
|
531 | + $a = new $ec($code, $mode, $options, $userinfo); |
|
532 | + } else { |
|
533 | + $a = new $ec($message, $code, $mode, $options, $userinfo); |
|
534 | + } |
|
535 | + |
|
536 | + return $a; |
|
537 | + } |
|
538 | + |
|
539 | + /** |
|
540 | + * Simpler form of raiseError with fewer options. In most cases |
|
541 | + * message, code and userinfo are enough. |
|
542 | + * |
|
543 | + * @param mixed $message a text error message or a PEAR error object |
|
544 | + * |
|
545 | + * @param int $code a numeric error code (it is up to your class |
|
546 | + * to define these if you want to use codes) |
|
547 | + * |
|
548 | + * @param string $userinfo If you need to pass along for example debug |
|
549 | + * information, this parameter is meant for that. |
|
550 | + * |
|
551 | + * @access public |
|
552 | + * @return object a PEAR error object |
|
553 | + * @see PEAR::raiseError |
|
554 | + */ |
|
555 | + function &throwError($message = null, $code = null, $userinfo = null) |
|
556 | + { |
|
557 | + if (isset($this) && is_a($this, 'PEAR')) { |
|
558 | + $a = &$this->raiseError($message, $code, null, null, $userinfo); |
|
559 | + return $a; |
|
560 | + } |
|
561 | + |
|
562 | + $a = &PEAR::raiseError($message, $code, null, null, $userinfo); |
|
563 | + return $a; |
|
564 | + } |
|
565 | + |
|
566 | + function staticPushErrorHandling($mode, $options = null) |
|
567 | + { |
|
568 | + $stack = &$GLOBALS['_PEAR_error_handler_stack']; |
|
569 | + $def_mode = &$GLOBALS['_PEAR_default_error_mode']; |
|
570 | + $def_options = &$GLOBALS['_PEAR_default_error_options']; |
|
571 | + $stack[] = array($def_mode, $def_options); |
|
572 | + switch ($mode) { |
|
573 | + case PEAR_ERROR_EXCEPTION: |
|
574 | + case PEAR_ERROR_RETURN: |
|
575 | + case PEAR_ERROR_PRINT: |
|
576 | + case PEAR_ERROR_TRIGGER: |
|
577 | + case PEAR_ERROR_DIE: |
|
578 | + case null: |
|
579 | + $def_mode = $mode; |
|
580 | + $def_options = $options; |
|
581 | + break; |
|
582 | + |
|
583 | + case PEAR_ERROR_CALLBACK: |
|
584 | + $def_mode = $mode; |
|
585 | + // class/object method callback |
|
586 | + if (is_callable($options)) { |
|
587 | + $def_options = $options; |
|
588 | + } else { |
|
589 | + trigger_error("invalid error callback", E_USER_WARNING); |
|
590 | + } |
|
591 | + break; |
|
592 | + |
|
593 | + default: |
|
594 | + trigger_error("invalid error mode", E_USER_WARNING); |
|
595 | + break; |
|
596 | + } |
|
597 | + $stack[] = array($mode, $options); |
|
598 | + return true; |
|
599 | + } |
|
600 | + |
|
601 | + function staticPopErrorHandling() |
|
602 | + { |
|
603 | + $stack = &$GLOBALS['_PEAR_error_handler_stack']; |
|
604 | + $setmode = &$GLOBALS['_PEAR_default_error_mode']; |
|
605 | + $setoptions = &$GLOBALS['_PEAR_default_error_options']; |
|
606 | + array_pop($stack); |
|
607 | + list($mode, $options) = $stack[sizeof($stack) - 1]; |
|
608 | + array_pop($stack); |
|
609 | + switch ($mode) { |
|
610 | + case PEAR_ERROR_EXCEPTION: |
|
611 | + case PEAR_ERROR_RETURN: |
|
612 | + case PEAR_ERROR_PRINT: |
|
613 | + case PEAR_ERROR_TRIGGER: |
|
614 | + case PEAR_ERROR_DIE: |
|
615 | + case null: |
|
616 | + $setmode = $mode; |
|
617 | + $setoptions = $options; |
|
618 | + break; |
|
619 | + |
|
620 | + case PEAR_ERROR_CALLBACK: |
|
621 | + $setmode = $mode; |
|
622 | + // class/object method callback |
|
623 | + if (is_callable($options)) { |
|
624 | + $setoptions = $options; |
|
625 | + } else { |
|
626 | + trigger_error("invalid error callback", E_USER_WARNING); |
|
627 | + } |
|
628 | + break; |
|
629 | + |
|
630 | + default: |
|
631 | + trigger_error("invalid error mode", E_USER_WARNING); |
|
632 | + break; |
|
633 | + } |
|
634 | + return true; |
|
635 | + } |
|
636 | + |
|
637 | + /** |
|
638 | + * Push a new error handler on top of the error handler options stack. With this |
|
639 | + * you can easily override the actual error handler for some code and restore |
|
640 | + * it later with popErrorHandling. |
|
641 | + * |
|
642 | + * @param mixed $mode (same as setErrorHandling) |
|
643 | + * @param mixed $options (same as setErrorHandling) |
|
644 | + * |
|
645 | + * @return bool Always true |
|
646 | + * |
|
647 | + * @see PEAR::setErrorHandling |
|
648 | + */ |
|
649 | + function pushErrorHandling($mode, $options = null) |
|
650 | + { |
|
651 | + $stack = &$GLOBALS['_PEAR_error_handler_stack']; |
|
652 | + if (isset($this) && is_a($this, 'PEAR')) { |
|
653 | + $def_mode = &$this->_default_error_mode; |
|
654 | + $def_options = &$this->_default_error_options; |
|
655 | + } else { |
|
656 | + $def_mode = &$GLOBALS['_PEAR_default_error_mode']; |
|
657 | + $def_options = &$GLOBALS['_PEAR_default_error_options']; |
|
658 | + } |
|
659 | + $stack[] = array($def_mode, $def_options); |
|
660 | + |
|
661 | + if (isset($this) && is_a($this, 'PEAR')) { |
|
662 | + $this->setErrorHandling($mode, $options); |
|
663 | + } else { |
|
664 | + PEAR::setErrorHandling($mode, $options); |
|
665 | + } |
|
666 | + $stack[] = array($mode, $options); |
|
667 | + return true; |
|
668 | + } |
|
669 | + |
|
670 | + /** |
|
671 | + * Pop the last error handler used |
|
672 | + * |
|
673 | + * @return bool Always true |
|
674 | + * |
|
675 | + * @see PEAR::pushErrorHandling |
|
676 | + */ |
|
677 | + function popErrorHandling() |
|
678 | + { |
|
679 | + $stack = &$GLOBALS['_PEAR_error_handler_stack']; |
|
680 | + array_pop($stack); |
|
681 | + list($mode, $options) = $stack[sizeof($stack) - 1]; |
|
682 | + array_pop($stack); |
|
683 | + if (isset($this) && is_a($this, 'PEAR')) { |
|
684 | + $this->setErrorHandling($mode, $options); |
|
685 | + } else { |
|
686 | + PEAR::setErrorHandling($mode, $options); |
|
687 | + } |
|
688 | + return true; |
|
689 | + } |
|
690 | + |
|
691 | + /** |
|
692 | + * OS independent PHP extension load. Remember to take care |
|
693 | + * on the correct extension name for case sensitive OSes. |
|
694 | + * |
|
695 | + * @param string $ext The extension name |
|
696 | + * @return bool Success or not on the dl() call |
|
697 | + */ |
|
698 | + function loadExtension($ext) |
|
699 | + { |
|
700 | + if (extension_loaded($ext)) { |
|
701 | + return true; |
|
702 | + } |
|
703 | + |
|
704 | + // if either returns true dl() will produce a FATAL error, stop that |
|
705 | + if ( |
|
706 | + function_exists('dl') === false || |
|
707 | + ini_get('enable_dl') != 1 || |
|
708 | + ini_get('safe_mode') == 1 |
|
709 | + ) { |
|
710 | + return false; |
|
711 | + } |
|
712 | + |
|
713 | + if (OS_WINDOWS) { |
|
714 | + $suffix = '.dll'; |
|
715 | + } elseif (PHP_OS == 'HP-UX') { |
|
716 | + $suffix = '.sl'; |
|
717 | + } elseif (PHP_OS == 'AIX') { |
|
718 | + $suffix = '.a'; |
|
719 | + } elseif (PHP_OS == 'OSX') { |
|
720 | + $suffix = '.bundle'; |
|
721 | + } else { |
|
722 | + $suffix = '.so'; |
|
723 | + } |
|
724 | + |
|
725 | + return @dl('php_'.$ext.$suffix) || @dl($ext.$suffix); |
|
726 | + } |
|
727 | 727 | } |
728 | 728 | |
729 | 729 | if (PEAR_ZE2) { |
730 | - include_once 'PEAR5.php'; |
|
730 | + include_once 'PEAR5.php'; |
|
731 | 731 | } |
732 | 732 | |
733 | 733 | function _PEAR_call_destructors() |
734 | 734 | { |
735 | - global $_PEAR_destructor_object_list; |
|
736 | - if (is_array($_PEAR_destructor_object_list) && |
|
737 | - sizeof($_PEAR_destructor_object_list)) |
|
738 | - { |
|
739 | - reset($_PEAR_destructor_object_list); |
|
740 | - if (PEAR_ZE2) { |
|
741 | - $destructLifoExists = PEAR5::getStaticProperty('PEAR', 'destructlifo'); |
|
742 | - } else { |
|
743 | - $destructLifoExists = PEAR::getStaticProperty('PEAR', 'destructlifo'); |
|
744 | - } |
|
745 | - |
|
746 | - if ($destructLifoExists) { |
|
747 | - $_PEAR_destructor_object_list = array_reverse($_PEAR_destructor_object_list); |
|
748 | - } |
|
749 | - |
|
750 | - while (list($k, $objref) = each($_PEAR_destructor_object_list)) { |
|
751 | - $classname = get_class($objref); |
|
752 | - while ($classname) { |
|
753 | - $destructor = "_$classname"; |
|
754 | - if (method_exists($objref, $destructor)) { |
|
755 | - $objref->$destructor(); |
|
756 | - break; |
|
757 | - } else { |
|
758 | - $classname = get_parent_class($classname); |
|
759 | - } |
|
760 | - } |
|
761 | - } |
|
762 | - // Empty the object list to ensure that destructors are |
|
763 | - // not called more than once. |
|
764 | - $_PEAR_destructor_object_list = array(); |
|
765 | - } |
|
766 | - |
|
767 | - // Now call the shutdown functions |
|
768 | - if ( |
|
769 | - isset($GLOBALS['_PEAR_shutdown_funcs']) && |
|
770 | - is_array($GLOBALS['_PEAR_shutdown_funcs']) && |
|
771 | - !empty($GLOBALS['_PEAR_shutdown_funcs']) |
|
772 | - ) { |
|
773 | - foreach ($GLOBALS['_PEAR_shutdown_funcs'] as $value) { |
|
774 | - call_user_func_array($value[0], $value[1]); |
|
775 | - } |
|
776 | - } |
|
735 | + global $_PEAR_destructor_object_list; |
|
736 | + if (is_array($_PEAR_destructor_object_list) && |
|
737 | + sizeof($_PEAR_destructor_object_list)) |
|
738 | + { |
|
739 | + reset($_PEAR_destructor_object_list); |
|
740 | + if (PEAR_ZE2) { |
|
741 | + $destructLifoExists = PEAR5::getStaticProperty('PEAR', 'destructlifo'); |
|
742 | + } else { |
|
743 | + $destructLifoExists = PEAR::getStaticProperty('PEAR', 'destructlifo'); |
|
744 | + } |
|
745 | + |
|
746 | + if ($destructLifoExists) { |
|
747 | + $_PEAR_destructor_object_list = array_reverse($_PEAR_destructor_object_list); |
|
748 | + } |
|
749 | + |
|
750 | + while (list($k, $objref) = each($_PEAR_destructor_object_list)) { |
|
751 | + $classname = get_class($objref); |
|
752 | + while ($classname) { |
|
753 | + $destructor = "_$classname"; |
|
754 | + if (method_exists($objref, $destructor)) { |
|
755 | + $objref->$destructor(); |
|
756 | + break; |
|
757 | + } else { |
|
758 | + $classname = get_parent_class($classname); |
|
759 | + } |
|
760 | + } |
|
761 | + } |
|
762 | + // Empty the object list to ensure that destructors are |
|
763 | + // not called more than once. |
|
764 | + $_PEAR_destructor_object_list = array(); |
|
765 | + } |
|
766 | + |
|
767 | + // Now call the shutdown functions |
|
768 | + if ( |
|
769 | + isset($GLOBALS['_PEAR_shutdown_funcs']) && |
|
770 | + is_array($GLOBALS['_PEAR_shutdown_funcs']) && |
|
771 | + !empty($GLOBALS['_PEAR_shutdown_funcs']) |
|
772 | + ) { |
|
773 | + foreach ($GLOBALS['_PEAR_shutdown_funcs'] as $value) { |
|
774 | + call_user_func_array($value[0], $value[1]); |
|
775 | + } |
|
776 | + } |
|
777 | 777 | } |
778 | 778 | |
779 | 779 | /** |
@@ -795,263 +795,263 @@ discard block |
||
795 | 795 | */ |
796 | 796 | class PEAR_Error |
797 | 797 | { |
798 | - var $error_message_prefix = ''; |
|
799 | - var $mode = PEAR_ERROR_RETURN; |
|
800 | - var $level = E_USER_NOTICE; |
|
801 | - var $code = -1; |
|
802 | - var $message = ''; |
|
803 | - var $userinfo = ''; |
|
804 | - var $backtrace = null; |
|
805 | - |
|
806 | - /** |
|
807 | - * PEAR_Error constructor |
|
808 | - * |
|
809 | - * @param string $message message |
|
810 | - * |
|
811 | - * @param int $code (optional) error code |
|
812 | - * |
|
813 | - * @param int $mode (optional) error mode, one of: PEAR_ERROR_RETURN, |
|
814 | - * PEAR_ERROR_PRINT, PEAR_ERROR_DIE, PEAR_ERROR_TRIGGER, |
|
815 | - * PEAR_ERROR_CALLBACK or PEAR_ERROR_EXCEPTION |
|
816 | - * |
|
817 | - * @param mixed $options (optional) error level, _OR_ in the case of |
|
818 | - * PEAR_ERROR_CALLBACK, the callback function or object/method |
|
819 | - * tuple. |
|
820 | - * |
|
821 | - * @param string $userinfo (optional) additional user/debug info |
|
822 | - * |
|
823 | - * @access public |
|
824 | - * |
|
825 | - */ |
|
826 | - function PEAR_Error($message = 'unknown error', $code = null, |
|
827 | - $mode = null, $options = null, $userinfo = null) |
|
828 | - { |
|
829 | - if ($mode === null) { |
|
830 | - $mode = PEAR_ERROR_RETURN; |
|
831 | - } |
|
832 | - $this->message = $message; |
|
833 | - $this->code = $code; |
|
834 | - $this->mode = $mode; |
|
835 | - $this->userinfo = $userinfo; |
|
836 | - |
|
837 | - if (PEAR_ZE2) { |
|
838 | - $skiptrace = PEAR5::getStaticProperty('PEAR_Error', 'skiptrace'); |
|
839 | - } else { |
|
840 | - $skiptrace = PEAR::getStaticProperty('PEAR_Error', 'skiptrace'); |
|
841 | - } |
|
842 | - |
|
843 | - if (!$skiptrace) { |
|
844 | - $this->backtrace = debug_backtrace(); |
|
845 | - if (isset($this->backtrace[0]) && isset($this->backtrace[0]['object'])) { |
|
846 | - unset($this->backtrace[0]['object']); |
|
847 | - } |
|
848 | - } |
|
849 | - |
|
850 | - if ($mode & PEAR_ERROR_CALLBACK) { |
|
851 | - $this->level = E_USER_NOTICE; |
|
852 | - $this->callback = $options; |
|
853 | - } else { |
|
854 | - if ($options === null) { |
|
855 | - $options = E_USER_NOTICE; |
|
856 | - } |
|
857 | - |
|
858 | - $this->level = $options; |
|
859 | - $this->callback = null; |
|
860 | - } |
|
861 | - |
|
862 | - if ($this->mode & PEAR_ERROR_PRINT) { |
|
863 | - if (is_null($options) || is_int($options)) { |
|
864 | - $format = "%s"; |
|
865 | - } else { |
|
866 | - $format = $options; |
|
867 | - } |
|
868 | - |
|
869 | - printf($format, $this->getMessage()); |
|
870 | - } |
|
871 | - |
|
872 | - if ($this->mode & PEAR_ERROR_TRIGGER) { |
|
873 | - trigger_error($this->getMessage(), $this->level); |
|
874 | - } |
|
875 | - |
|
876 | - if ($this->mode & PEAR_ERROR_DIE) { |
|
877 | - $msg = $this->getMessage(); |
|
878 | - if (is_null($options) || is_int($options)) { |
|
879 | - $format = "%s"; |
|
880 | - if (substr($msg, -1) != "\n") { |
|
881 | - $msg .= "\n"; |
|
882 | - } |
|
883 | - } else { |
|
884 | - $format = $options; |
|
885 | - } |
|
886 | - die(sprintf($format, $msg)); |
|
887 | - } |
|
888 | - |
|
889 | - if ($this->mode & PEAR_ERROR_CALLBACK && is_callable($this->callback)) { |
|
890 | - call_user_func($this->callback, $this); |
|
891 | - } |
|
892 | - |
|
893 | - if ($this->mode & PEAR_ERROR_EXCEPTION) { |
|
894 | - trigger_error("PEAR_ERROR_EXCEPTION is obsolete, use class PEAR_Exception for exceptions", E_USER_WARNING); |
|
895 | - eval('$e = new Exception($this->message, $this->code);throw($e);'); |
|
896 | - } |
|
897 | - } |
|
898 | - |
|
899 | - /** |
|
900 | - * Get the error mode from an error object. |
|
901 | - * |
|
902 | - * @return int error mode |
|
903 | - * @access public |
|
904 | - */ |
|
905 | - function getMode() |
|
906 | - { |
|
907 | - return $this->mode; |
|
908 | - } |
|
909 | - |
|
910 | - /** |
|
911 | - * Get the callback function/method from an error object. |
|
912 | - * |
|
913 | - * @return mixed callback function or object/method array |
|
914 | - * @access public |
|
915 | - */ |
|
916 | - function getCallback() |
|
917 | - { |
|
918 | - return $this->callback; |
|
919 | - } |
|
920 | - |
|
921 | - /** |
|
922 | - * Get the error message from an error object. |
|
923 | - * |
|
924 | - * @return string full error message |
|
925 | - * @access public |
|
926 | - */ |
|
927 | - function getMessage() |
|
928 | - { |
|
929 | - return ($this->error_message_prefix . $this->message); |
|
930 | - } |
|
931 | - |
|
932 | - /** |
|
933 | - * Get error code from an error object |
|
934 | - * |
|
935 | - * @return int error code |
|
936 | - * @access public |
|
937 | - */ |
|
938 | - function getCode() |
|
939 | - { |
|
940 | - return $this->code; |
|
941 | - } |
|
942 | - |
|
943 | - /** |
|
944 | - * Get the name of this error/exception. |
|
945 | - * |
|
946 | - * @return string error/exception name (type) |
|
947 | - * @access public |
|
948 | - */ |
|
949 | - function getType() |
|
950 | - { |
|
951 | - return get_class($this); |
|
952 | - } |
|
953 | - |
|
954 | - /** |
|
955 | - * Get additional user-supplied information. |
|
956 | - * |
|
957 | - * @return string user-supplied information |
|
958 | - * @access public |
|
959 | - */ |
|
960 | - function getUserInfo() |
|
961 | - { |
|
962 | - return $this->userinfo; |
|
963 | - } |
|
964 | - |
|
965 | - /** |
|
966 | - * Get additional debug information supplied by the application. |
|
967 | - * |
|
968 | - * @return string debug information |
|
969 | - * @access public |
|
970 | - */ |
|
971 | - function getDebugInfo() |
|
972 | - { |
|
973 | - return $this->getUserInfo(); |
|
974 | - } |
|
975 | - |
|
976 | - /** |
|
977 | - * Get the call backtrace from where the error was generated. |
|
978 | - * Supported with PHP 4.3.0 or newer. |
|
979 | - * |
|
980 | - * @param int $frame (optional) what frame to fetch |
|
981 | - * @return array Backtrace, or NULL if not available. |
|
982 | - * @access public |
|
983 | - */ |
|
984 | - function getBacktrace($frame = null) |
|
985 | - { |
|
986 | - if (defined('PEAR_IGNORE_BACKTRACE')) { |
|
987 | - return null; |
|
988 | - } |
|
989 | - if ($frame === null) { |
|
990 | - return $this->backtrace; |
|
991 | - } |
|
992 | - return $this->backtrace[$frame]; |
|
993 | - } |
|
994 | - |
|
995 | - function addUserInfo($info) |
|
996 | - { |
|
997 | - if (empty($this->userinfo)) { |
|
998 | - $this->userinfo = $info; |
|
999 | - } else { |
|
1000 | - $this->userinfo .= " ** $info"; |
|
1001 | - } |
|
1002 | - } |
|
1003 | - |
|
1004 | - function __toString() |
|
1005 | - { |
|
1006 | - return $this->getMessage(); |
|
1007 | - } |
|
1008 | - |
|
1009 | - /** |
|
1010 | - * Make a string representation of this object. |
|
1011 | - * |
|
1012 | - * @return string a string with an object summary |
|
1013 | - * @access public |
|
1014 | - */ |
|
1015 | - function toString() |
|
1016 | - { |
|
1017 | - $modes = array(); |
|
1018 | - $levels = array(E_USER_NOTICE => 'notice', |
|
1019 | - E_USER_WARNING => 'warning', |
|
1020 | - E_USER_ERROR => 'error'); |
|
1021 | - if ($this->mode & PEAR_ERROR_CALLBACK) { |
|
1022 | - if (is_array($this->callback)) { |
|
1023 | - $callback = (is_object($this->callback[0]) ? |
|
1024 | - strtolower(get_class($this->callback[0])) : |
|
1025 | - $this->callback[0]) . '::' . |
|
1026 | - $this->callback[1]; |
|
1027 | - } else { |
|
1028 | - $callback = $this->callback; |
|
1029 | - } |
|
1030 | - return sprintf('[%s: message="%s" code=%d mode=callback '. |
|
1031 | - 'callback=%s prefix="%s" info="%s"]', |
|
1032 | - strtolower(get_class($this)), $this->message, $this->code, |
|
1033 | - $callback, $this->error_message_prefix, |
|
1034 | - $this->userinfo); |
|
1035 | - } |
|
1036 | - if ($this->mode & PEAR_ERROR_PRINT) { |
|
1037 | - $modes[] = 'print'; |
|
1038 | - } |
|
1039 | - if ($this->mode & PEAR_ERROR_TRIGGER) { |
|
1040 | - $modes[] = 'trigger'; |
|
1041 | - } |
|
1042 | - if ($this->mode & PEAR_ERROR_DIE) { |
|
1043 | - $modes[] = 'die'; |
|
1044 | - } |
|
1045 | - if ($this->mode & PEAR_ERROR_RETURN) { |
|
1046 | - $modes[] = 'return'; |
|
1047 | - } |
|
1048 | - return sprintf('[%s: message="%s" code=%d mode=%s level=%s '. |
|
1049 | - 'prefix="%s" info="%s"]', |
|
1050 | - strtolower(get_class($this)), $this->message, $this->code, |
|
1051 | - implode("|", $modes), $levels[$this->level], |
|
1052 | - $this->error_message_prefix, |
|
1053 | - $this->userinfo); |
|
1054 | - } |
|
798 | + var $error_message_prefix = ''; |
|
799 | + var $mode = PEAR_ERROR_RETURN; |
|
800 | + var $level = E_USER_NOTICE; |
|
801 | + var $code = -1; |
|
802 | + var $message = ''; |
|
803 | + var $userinfo = ''; |
|
804 | + var $backtrace = null; |
|
805 | + |
|
806 | + /** |
|
807 | + * PEAR_Error constructor |
|
808 | + * |
|
809 | + * @param string $message message |
|
810 | + * |
|
811 | + * @param int $code (optional) error code |
|
812 | + * |
|
813 | + * @param int $mode (optional) error mode, one of: PEAR_ERROR_RETURN, |
|
814 | + * PEAR_ERROR_PRINT, PEAR_ERROR_DIE, PEAR_ERROR_TRIGGER, |
|
815 | + * PEAR_ERROR_CALLBACK or PEAR_ERROR_EXCEPTION |
|
816 | + * |
|
817 | + * @param mixed $options (optional) error level, _OR_ in the case of |
|
818 | + * PEAR_ERROR_CALLBACK, the callback function or object/method |
|
819 | + * tuple. |
|
820 | + * |
|
821 | + * @param string $userinfo (optional) additional user/debug info |
|
822 | + * |
|
823 | + * @access public |
|
824 | + * |
|
825 | + */ |
|
826 | + function PEAR_Error($message = 'unknown error', $code = null, |
|
827 | + $mode = null, $options = null, $userinfo = null) |
|
828 | + { |
|
829 | + if ($mode === null) { |
|
830 | + $mode = PEAR_ERROR_RETURN; |
|
831 | + } |
|
832 | + $this->message = $message; |
|
833 | + $this->code = $code; |
|
834 | + $this->mode = $mode; |
|
835 | + $this->userinfo = $userinfo; |
|
836 | + |
|
837 | + if (PEAR_ZE2) { |
|
838 | + $skiptrace = PEAR5::getStaticProperty('PEAR_Error', 'skiptrace'); |
|
839 | + } else { |
|
840 | + $skiptrace = PEAR::getStaticProperty('PEAR_Error', 'skiptrace'); |
|
841 | + } |
|
842 | + |
|
843 | + if (!$skiptrace) { |
|
844 | + $this->backtrace = debug_backtrace(); |
|
845 | + if (isset($this->backtrace[0]) && isset($this->backtrace[0]['object'])) { |
|
846 | + unset($this->backtrace[0]['object']); |
|
847 | + } |
|
848 | + } |
|
849 | + |
|
850 | + if ($mode & PEAR_ERROR_CALLBACK) { |
|
851 | + $this->level = E_USER_NOTICE; |
|
852 | + $this->callback = $options; |
|
853 | + } else { |
|
854 | + if ($options === null) { |
|
855 | + $options = E_USER_NOTICE; |
|
856 | + } |
|
857 | + |
|
858 | + $this->level = $options; |
|
859 | + $this->callback = null; |
|
860 | + } |
|
861 | + |
|
862 | + if ($this->mode & PEAR_ERROR_PRINT) { |
|
863 | + if (is_null($options) || is_int($options)) { |
|
864 | + $format = "%s"; |
|
865 | + } else { |
|
866 | + $format = $options; |
|
867 | + } |
|
868 | + |
|
869 | + printf($format, $this->getMessage()); |
|
870 | + } |
|
871 | + |
|
872 | + if ($this->mode & PEAR_ERROR_TRIGGER) { |
|
873 | + trigger_error($this->getMessage(), $this->level); |
|
874 | + } |
|
875 | + |
|
876 | + if ($this->mode & PEAR_ERROR_DIE) { |
|
877 | + $msg = $this->getMessage(); |
|
878 | + if (is_null($options) || is_int($options)) { |
|
879 | + $format = "%s"; |
|
880 | + if (substr($msg, -1) != "\n") { |
|
881 | + $msg .= "\n"; |
|
882 | + } |
|
883 | + } else { |
|
884 | + $format = $options; |
|
885 | + } |
|
886 | + die(sprintf($format, $msg)); |
|
887 | + } |
|
888 | + |
|
889 | + if ($this->mode & PEAR_ERROR_CALLBACK && is_callable($this->callback)) { |
|
890 | + call_user_func($this->callback, $this); |
|
891 | + } |
|
892 | + |
|
893 | + if ($this->mode & PEAR_ERROR_EXCEPTION) { |
|
894 | + trigger_error("PEAR_ERROR_EXCEPTION is obsolete, use class PEAR_Exception for exceptions", E_USER_WARNING); |
|
895 | + eval('$e = new Exception($this->message, $this->code);throw($e);'); |
|
896 | + } |
|
897 | + } |
|
898 | + |
|
899 | + /** |
|
900 | + * Get the error mode from an error object. |
|
901 | + * |
|
902 | + * @return int error mode |
|
903 | + * @access public |
|
904 | + */ |
|
905 | + function getMode() |
|
906 | + { |
|
907 | + return $this->mode; |
|
908 | + } |
|
909 | + |
|
910 | + /** |
|
911 | + * Get the callback function/method from an error object. |
|
912 | + * |
|
913 | + * @return mixed callback function or object/method array |
|
914 | + * @access public |
|
915 | + */ |
|
916 | + function getCallback() |
|
917 | + { |
|
918 | + return $this->callback; |
|
919 | + } |
|
920 | + |
|
921 | + /** |
|
922 | + * Get the error message from an error object. |
|
923 | + * |
|
924 | + * @return string full error message |
|
925 | + * @access public |
|
926 | + */ |
|
927 | + function getMessage() |
|
928 | + { |
|
929 | + return ($this->error_message_prefix . $this->message); |
|
930 | + } |
|
931 | + |
|
932 | + /** |
|
933 | + * Get error code from an error object |
|
934 | + * |
|
935 | + * @return int error code |
|
936 | + * @access public |
|
937 | + */ |
|
938 | + function getCode() |
|
939 | + { |
|
940 | + return $this->code; |
|
941 | + } |
|
942 | + |
|
943 | + /** |
|
944 | + * Get the name of this error/exception. |
|
945 | + * |
|
946 | + * @return string error/exception name (type) |
|
947 | + * @access public |
|
948 | + */ |
|
949 | + function getType() |
|
950 | + { |
|
951 | + return get_class($this); |
|
952 | + } |
|
953 | + |
|
954 | + /** |
|
955 | + * Get additional user-supplied information. |
|
956 | + * |
|
957 | + * @return string user-supplied information |
|
958 | + * @access public |
|
959 | + */ |
|
960 | + function getUserInfo() |
|
961 | + { |
|
962 | + return $this->userinfo; |
|
963 | + } |
|
964 | + |
|
965 | + /** |
|
966 | + * Get additional debug information supplied by the application. |
|
967 | + * |
|
968 | + * @return string debug information |
|
969 | + * @access public |
|
970 | + */ |
|
971 | + function getDebugInfo() |
|
972 | + { |
|
973 | + return $this->getUserInfo(); |
|
974 | + } |
|
975 | + |
|
976 | + /** |
|
977 | + * Get the call backtrace from where the error was generated. |
|
978 | + * Supported with PHP 4.3.0 or newer. |
|
979 | + * |
|
980 | + * @param int $frame (optional) what frame to fetch |
|
981 | + * @return array Backtrace, or NULL if not available. |
|
982 | + * @access public |
|
983 | + */ |
|
984 | + function getBacktrace($frame = null) |
|
985 | + { |
|
986 | + if (defined('PEAR_IGNORE_BACKTRACE')) { |
|
987 | + return null; |
|
988 | + } |
|
989 | + if ($frame === null) { |
|
990 | + return $this->backtrace; |
|
991 | + } |
|
992 | + return $this->backtrace[$frame]; |
|
993 | + } |
|
994 | + |
|
995 | + function addUserInfo($info) |
|
996 | + { |
|
997 | + if (empty($this->userinfo)) { |
|
998 | + $this->userinfo = $info; |
|
999 | + } else { |
|
1000 | + $this->userinfo .= " ** $info"; |
|
1001 | + } |
|
1002 | + } |
|
1003 | + |
|
1004 | + function __toString() |
|
1005 | + { |
|
1006 | + return $this->getMessage(); |
|
1007 | + } |
|
1008 | + |
|
1009 | + /** |
|
1010 | + * Make a string representation of this object. |
|
1011 | + * |
|
1012 | + * @return string a string with an object summary |
|
1013 | + * @access public |
|
1014 | + */ |
|
1015 | + function toString() |
|
1016 | + { |
|
1017 | + $modes = array(); |
|
1018 | + $levels = array(E_USER_NOTICE => 'notice', |
|
1019 | + E_USER_WARNING => 'warning', |
|
1020 | + E_USER_ERROR => 'error'); |
|
1021 | + if ($this->mode & PEAR_ERROR_CALLBACK) { |
|
1022 | + if (is_array($this->callback)) { |
|
1023 | + $callback = (is_object($this->callback[0]) ? |
|
1024 | + strtolower(get_class($this->callback[0])) : |
|
1025 | + $this->callback[0]) . '::' . |
|
1026 | + $this->callback[1]; |
|
1027 | + } else { |
|
1028 | + $callback = $this->callback; |
|
1029 | + } |
|
1030 | + return sprintf('[%s: message="%s" code=%d mode=callback '. |
|
1031 | + 'callback=%s prefix="%s" info="%s"]', |
|
1032 | + strtolower(get_class($this)), $this->message, $this->code, |
|
1033 | + $callback, $this->error_message_prefix, |
|
1034 | + $this->userinfo); |
|
1035 | + } |
|
1036 | + if ($this->mode & PEAR_ERROR_PRINT) { |
|
1037 | + $modes[] = 'print'; |
|
1038 | + } |
|
1039 | + if ($this->mode & PEAR_ERROR_TRIGGER) { |
|
1040 | + $modes[] = 'trigger'; |
|
1041 | + } |
|
1042 | + if ($this->mode & PEAR_ERROR_DIE) { |
|
1043 | + $modes[] = 'die'; |
|
1044 | + } |
|
1045 | + if ($this->mode & PEAR_ERROR_RETURN) { |
|
1046 | + $modes[] = 'return'; |
|
1047 | + } |
|
1048 | + return sprintf('[%s: message="%s" code=%d mode=%s level=%s '. |
|
1049 | + 'prefix="%s" info="%s"]', |
|
1050 | + strtolower(get_class($this)), $this->message, $this->code, |
|
1051 | + implode("|", $modes), $levels[$this->level], |
|
1052 | + $this->error_message_prefix, |
|
1053 | + $this->userinfo); |
|
1054 | + } |
|
1055 | 1055 | } |
1056 | 1056 | |
1057 | 1057 | /* |
@@ -22,11 +22,11 @@ discard block |
||
22 | 22 | /**#@+ |
23 | 23 | * ERROR constants |
24 | 24 | */ |
25 | -define('PEAR_ERROR_RETURN', 1); |
|
26 | -define('PEAR_ERROR_PRINT', 2); |
|
27 | -define('PEAR_ERROR_TRIGGER', 4); |
|
28 | -define('PEAR_ERROR_DIE', 8); |
|
29 | -define('PEAR_ERROR_CALLBACK', 16); |
|
25 | +define('PEAR_ERROR_RETURN', 1); |
|
26 | +define('PEAR_ERROR_PRINT', 2); |
|
27 | +define('PEAR_ERROR_TRIGGER', 4); |
|
28 | +define('PEAR_ERROR_DIE', 8); |
|
29 | +define('PEAR_ERROR_CALLBACK', 16); |
|
30 | 30 | /** |
31 | 31 | * WARNING: obsolete |
32 | 32 | * @deprecated |
@@ -38,12 +38,12 @@ discard block |
||
38 | 38 | |
39 | 39 | if (substr(PHP_OS, 0, 3) == 'WIN') { |
40 | 40 | define('OS_WINDOWS', true); |
41 | - define('OS_UNIX', false); |
|
42 | - define('PEAR_OS', 'Windows'); |
|
41 | + define('OS_UNIX', false); |
|
42 | + define('PEAR_OS', 'Windows'); |
|
43 | 43 | } else { |
44 | 44 | define('OS_WINDOWS', false); |
45 | - define('OS_UNIX', true); |
|
46 | - define('PEAR_OS', 'Unix'); // blatant assumption |
|
45 | + define('OS_UNIX', true); |
|
46 | + define('PEAR_OS', 'Unix'); // blatant assumption |
|
47 | 47 | } |
48 | 48 | |
49 | 49 | $GLOBALS['_PEAR_default_error_mode'] = PEAR_ERROR_RETURN; |
@@ -415,7 +415,7 @@ discard block |
||
415 | 415 | // $error_code is a non-empty array here; we walk through it trying |
416 | 416 | // to unset all values |
417 | 417 | foreach ($error_code as $key => $error) { |
418 | - $deleted = $this->_checkDelExpect($error) ? true : false; |
|
418 | + $deleted = $this->_checkDelExpect($error) ? true : false; |
|
419 | 419 | } |
420 | 420 | |
421 | 421 | return $deleted ? true : PEAR::raiseError("The expected error you submitted does not exist"); // IMPROVE ME |
@@ -722,7 +722,7 @@ discard block |
||
722 | 722 | $suffix = '.so'; |
723 | 723 | } |
724 | 724 | |
725 | - return @dl('php_'.$ext.$suffix) || @dl($ext.$suffix); |
|
725 | + return @dl('php_' . $ext . $suffix) || @dl($ext . $suffix); |
|
726 | 726 | } |
727 | 727 | } |
728 | 728 | |
@@ -1021,13 +1021,12 @@ discard block |
||
1021 | 1021 | if ($this->mode & PEAR_ERROR_CALLBACK) { |
1022 | 1022 | if (is_array($this->callback)) { |
1023 | 1023 | $callback = (is_object($this->callback[0]) ? |
1024 | - strtolower(get_class($this->callback[0])) : |
|
1025 | - $this->callback[0]) . '::' . |
|
1024 | + strtolower(get_class($this->callback[0])) : $this->callback[0]) . '::' . |
|
1026 | 1025 | $this->callback[1]; |
1027 | 1026 | } else { |
1028 | 1027 | $callback = $this->callback; |
1029 | 1028 | } |
1030 | - return sprintf('[%s: message="%s" code=%d mode=callback '. |
|
1029 | + return sprintf('[%s: message="%s" code=%d mode=callback ' . |
|
1031 | 1030 | 'callback=%s prefix="%s" info="%s"]', |
1032 | 1031 | strtolower(get_class($this)), $this->message, $this->code, |
1033 | 1032 | $callback, $this->error_message_prefix, |
@@ -1045,7 +1044,7 @@ discard block |
||
1045 | 1044 | if ($this->mode & PEAR_ERROR_RETURN) { |
1046 | 1045 | $modes[] = 'return'; |
1047 | 1046 | } |
1048 | - return sprintf('[%s: message="%s" code=%d mode=%s level=%s '. |
|
1047 | + return sprintf('[%s: message="%s" code=%d mode=%s level=%s ' . |
|
1049 | 1048 | 'prefix="%s" info="%s"]', |
1050 | 1049 | strtolower(get_class($this)), $this->message, $this->code, |
1051 | 1050 | implode("|", $modes), $levels[$this->level], |
@@ -277,11 +277,9 @@ discard block |
||
277 | 277 | 'class' => $cause['package'], |
278 | 278 | 'message' => $cause['message'], |
279 | 279 | 'file' => isset($cause['context']['file']) ? |
280 | - $cause['context']['file'] : |
|
281 | - 'unknown', |
|
280 | + $cause['context']['file'] : 'unknown', |
|
282 | 281 | 'line' => isset($cause['context']['line']) ? |
283 | - $cause['context']['line'] : |
|
284 | - 'unknown', |
|
282 | + $cause['context']['line'] : 'unknown', |
|
285 | 283 | ); |
286 | 284 | } |
287 | 285 | } |
@@ -294,7 +292,7 @@ discard block |
||
294 | 292 | $this->_trace = $this->getTrace(); |
295 | 293 | if (empty($this->_trace)) { |
296 | 294 | $backtrace = debug_backtrace(); |
297 | - $this->_trace = array($backtrace[count($backtrace)-1]); |
|
295 | + $this->_trace = array($backtrace[count($backtrace) - 1]); |
|
298 | 296 | } |
299 | 297 | } |
300 | 298 | return $this->_trace; |
@@ -325,7 +323,7 @@ discard block |
||
325 | 323 | $trace = $this->getTraceSafe(); |
326 | 324 | $causes = array(); |
327 | 325 | $this->getCauseMessage($causes); |
328 | - $html = '<table style="border: 1px" cellspacing="0">' . "\n"; |
|
326 | + $html = '<table style="border: 1px" cellspacing="0">' . "\n"; |
|
329 | 327 | foreach ($causes as $i => $cause) { |
330 | 328 | $html .= '<tr><td colspan="3" style="background: #ff9999">' |
331 | 329 | . str_repeat('-', $i) . ' <b>' . $cause['class'] . '</b>: ' |
@@ -350,24 +348,24 @@ discard block |
||
350 | 348 | foreach ($v['args'] as $arg) { |
351 | 349 | if (is_null($arg)) $args[] = 'null'; |
352 | 350 | elseif (is_array($arg)) $args[] = 'Array'; |
353 | - elseif (is_object($arg)) $args[] = 'Object('.get_class($arg).')'; |
|
351 | + elseif (is_object($arg)) $args[] = 'Object(' . get_class($arg) . ')'; |
|
354 | 352 | elseif (is_bool($arg)) $args[] = $arg ? 'true' : 'false'; |
355 | 353 | elseif (is_int($arg) || is_double($arg)) $args[] = $arg; |
356 | 354 | else { |
357 | - $arg = (string)$arg; |
|
355 | + $arg = (string) $arg; |
|
358 | 356 | $str = htmlspecialchars(substr($arg, 0, 16)); |
359 | 357 | if (strlen($arg) > 16) $str .= '…'; |
360 | 358 | $args[] = "'" . $str . "'"; |
361 | 359 | } |
362 | 360 | } |
363 | 361 | } |
364 | - $html .= '(' . implode(', ',$args) . ')' |
|
362 | + $html .= '(' . implode(', ', $args) . ')' |
|
365 | 363 | . '</td>' |
366 | 364 | . '<td>' . (isset($v['file']) ? $v['file'] : 'unknown') |
367 | 365 | . ':' . (isset($v['line']) ? $v['line'] : 'unknown') |
368 | 366 | . '</td></tr>' . "\n"; |
369 | 367 | } |
370 | - $html .= '<tr><td style="text-align: center;">' . ($k+1) . '</td>' |
|
368 | + $html .= '<tr><td style="text-align: center;">' . ($k + 1) . '</td>' |
|
371 | 369 | . '<td>{main}</td>' |
372 | 370 | . '<td> </td></tr>' . "\n" |
373 | 371 | . '</table>'; |
@@ -117,6 +117,8 @@ |
||
117 | 117 | * @param string exception message |
118 | 118 | * @param int|Exception|PEAR_Error|array|null exception cause |
119 | 119 | * @param int|null exception code or null |
120 | + * @param string|null $message |
|
121 | + * @param integer $p2 |
|
120 | 122 | */ |
121 | 123 | public function __construct($message, $p2 = null, $p3 = null) |
122 | 124 | { |
@@ -348,15 +348,22 @@ |
||
348 | 348 | $args = array(); |
349 | 349 | if (!empty($v['args'])) { |
350 | 350 | foreach ($v['args'] as $arg) { |
351 | - if (is_null($arg)) $args[] = 'null'; |
|
352 | - elseif (is_array($arg)) $args[] = 'Array'; |
|
353 | - elseif (is_object($arg)) $args[] = 'Object('.get_class($arg).')'; |
|
354 | - elseif (is_bool($arg)) $args[] = $arg ? 'true' : 'false'; |
|
355 | - elseif (is_int($arg) || is_double($arg)) $args[] = $arg; |
|
356 | - else { |
|
351 | + if (is_null($arg)) { |
|
352 | + $args[] = 'null'; |
|
353 | + } elseif (is_array($arg)) { |
|
354 | + $args[] = 'Array'; |
|
355 | + } elseif (is_object($arg)) { |
|
356 | + $args[] = 'Object('.get_class($arg).')'; |
|
357 | + } elseif (is_bool($arg)) { |
|
358 | + $args[] = $arg ? 'true' : 'false'; |
|
359 | + } elseif (is_int($arg) || is_double($arg)) { |
|
360 | + $args[] = $arg; |
|
361 | + } else { |
|
357 | 362 | $arg = (string)$arg; |
358 | 363 | $str = htmlspecialchars(substr($arg, 0, 16), ENT_COMPAT | ENT_HTML401, 'UTF-8', false); |
359 | - if (strlen($arg) > 16) $str .= '…'; |
|
364 | + if (strlen($arg) > 16) { |
|
365 | + $str .= '…'; |
|
366 | + } |
|
360 | 367 | $args[] = "'" . $str . "'"; |
361 | 368 | } |
362 | 369 | } |
@@ -1,22 +1,22 @@ discard block |
||
1 | 1 | <?php |
2 | 2 | /* vim: set expandtab tabstop=4 shiftwidth=4 foldmethod=marker: */ |
3 | 3 | /** |
4 | - * PEAR_Exception |
|
5 | - * |
|
6 | - * PHP versions 4 and 5 |
|
7 | - * |
|
8 | - * @category pear |
|
9 | - * @package PEAR |
|
10 | - * @author Tomas V. V. Cox <[email protected]> |
|
11 | - * @author Hans Lellelid <[email protected]> |
|
12 | - * @author Bertrand Mansion <[email protected]> |
|
13 | - * @author Greg Beaver <[email protected]> |
|
14 | - * @copyright 1997-2009 The Authors |
|
15 | - * @license http://opensource.org/licenses/bsd-license.php New BSD License |
|
16 | - * @version CVS: $Id$ |
|
17 | - * @link http://pear.php.net/package/PEAR |
|
18 | - * @since File available since Release 1.3.3 |
|
19 | - */ |
|
4 | + * PEAR_Exception |
|
5 | + * |
|
6 | + * PHP versions 4 and 5 |
|
7 | + * |
|
8 | + * @category pear |
|
9 | + * @package PEAR |
|
10 | + * @author Tomas V. V. Cox <[email protected]> |
|
11 | + * @author Hans Lellelid <[email protected]> |
|
12 | + * @author Bertrand Mansion <[email protected]> |
|
13 | + * @author Greg Beaver <[email protected]> |
|
14 | + * @copyright 1997-2009 The Authors |
|
15 | + * @license http://opensource.org/licenses/bsd-license.php New BSD License |
|
16 | + * @version CVS: $Id$ |
|
17 | + * @link http://pear.php.net/package/PEAR |
|
18 | + * @since File available since Release 1.3.3 |
|
19 | + */ |
|
20 | 20 | |
21 | 21 | |
22 | 22 | /** |
@@ -96,294 +96,294 @@ discard block |
||
96 | 96 | */ |
97 | 97 | class PEAR_Exception extends Exception |
98 | 98 | { |
99 | - const OBSERVER_PRINT = -2; |
|
100 | - const OBSERVER_TRIGGER = -4; |
|
101 | - const OBSERVER_DIE = -8; |
|
102 | - protected $cause; |
|
103 | - private static $_observers = array(); |
|
104 | - private static $_uniqueid = 0; |
|
105 | - private $_trace; |
|
99 | + const OBSERVER_PRINT = -2; |
|
100 | + const OBSERVER_TRIGGER = -4; |
|
101 | + const OBSERVER_DIE = -8; |
|
102 | + protected $cause; |
|
103 | + private static $_observers = array(); |
|
104 | + private static $_uniqueid = 0; |
|
105 | + private $_trace; |
|
106 | 106 | |
107 | - /** |
|
108 | - * Supported signatures: |
|
109 | - * - PEAR_Exception(string $message); |
|
110 | - * - PEAR_Exception(string $message, int $code); |
|
111 | - * - PEAR_Exception(string $message, Exception $cause); |
|
112 | - * - PEAR_Exception(string $message, Exception $cause, int $code); |
|
113 | - * - PEAR_Exception(string $message, PEAR_Error $cause); |
|
114 | - * - PEAR_Exception(string $message, PEAR_Error $cause, int $code); |
|
115 | - * - PEAR_Exception(string $message, array $causes); |
|
116 | - * - PEAR_Exception(string $message, array $causes, int $code); |
|
117 | - * @param string exception message |
|
118 | - * @param int|Exception|PEAR_Error|array|null exception cause |
|
119 | - * @param int|null exception code or null |
|
120 | - */ |
|
121 | - public function __construct($message, $p2 = null, $p3 = null) |
|
122 | - { |
|
123 | - if (is_int($p2)) { |
|
124 | - $code = $p2; |
|
125 | - $this->cause = null; |
|
126 | - } elseif (is_object($p2) || is_array($p2)) { |
|
127 | - // using is_object allows both Exception and PEAR_Error |
|
128 | - if (is_object($p2) && !($p2 instanceof Exception)) { |
|
129 | - if (!class_exists('PEAR_Error') || !($p2 instanceof PEAR_Error)) { |
|
130 | - throw new PEAR_Exception('exception cause must be Exception, ' . |
|
131 | - 'array, or PEAR_Error'); |
|
132 | - } |
|
133 | - } |
|
134 | - $code = $p3; |
|
135 | - if (is_array($p2) && isset($p2['message'])) { |
|
136 | - // fix potential problem of passing in a single warning |
|
137 | - $p2 = array($p2); |
|
138 | - } |
|
139 | - $this->cause = $p2; |
|
140 | - } else { |
|
141 | - $code = null; |
|
142 | - $this->cause = null; |
|
143 | - } |
|
144 | - parent::__construct($message, $code); |
|
145 | - $this->signal(); |
|
146 | - } |
|
107 | + /** |
|
108 | + * Supported signatures: |
|
109 | + * - PEAR_Exception(string $message); |
|
110 | + * - PEAR_Exception(string $message, int $code); |
|
111 | + * - PEAR_Exception(string $message, Exception $cause); |
|
112 | + * - PEAR_Exception(string $message, Exception $cause, int $code); |
|
113 | + * - PEAR_Exception(string $message, PEAR_Error $cause); |
|
114 | + * - PEAR_Exception(string $message, PEAR_Error $cause, int $code); |
|
115 | + * - PEAR_Exception(string $message, array $causes); |
|
116 | + * - PEAR_Exception(string $message, array $causes, int $code); |
|
117 | + * @param string exception message |
|
118 | + * @param int|Exception|PEAR_Error|array|null exception cause |
|
119 | + * @param int|null exception code or null |
|
120 | + */ |
|
121 | + public function __construct($message, $p2 = null, $p3 = null) |
|
122 | + { |
|
123 | + if (is_int($p2)) { |
|
124 | + $code = $p2; |
|
125 | + $this->cause = null; |
|
126 | + } elseif (is_object($p2) || is_array($p2)) { |
|
127 | + // using is_object allows both Exception and PEAR_Error |
|
128 | + if (is_object($p2) && !($p2 instanceof Exception)) { |
|
129 | + if (!class_exists('PEAR_Error') || !($p2 instanceof PEAR_Error)) { |
|
130 | + throw new PEAR_Exception('exception cause must be Exception, ' . |
|
131 | + 'array, or PEAR_Error'); |
|
132 | + } |
|
133 | + } |
|
134 | + $code = $p3; |
|
135 | + if (is_array($p2) && isset($p2['message'])) { |
|
136 | + // fix potential problem of passing in a single warning |
|
137 | + $p2 = array($p2); |
|
138 | + } |
|
139 | + $this->cause = $p2; |
|
140 | + } else { |
|
141 | + $code = null; |
|
142 | + $this->cause = null; |
|
143 | + } |
|
144 | + parent::__construct($message, $code); |
|
145 | + $this->signal(); |
|
146 | + } |
|
147 | 147 | |
148 | - /** |
|
149 | - * @param mixed $callback - A valid php callback, see php func is_callable() |
|
150 | - * - A PEAR_Exception::OBSERVER_* constant |
|
151 | - * - An array(const PEAR_Exception::OBSERVER_*, |
|
152 | - * mixed $options) |
|
153 | - * @param string $label The name of the observer. Use this if you want |
|
154 | - * to remove it later with removeObserver() |
|
155 | - */ |
|
156 | - public static function addObserver($callback, $label = 'default') |
|
157 | - { |
|
158 | - self::$_observers[$label] = $callback; |
|
159 | - } |
|
148 | + /** |
|
149 | + * @param mixed $callback - A valid php callback, see php func is_callable() |
|
150 | + * - A PEAR_Exception::OBSERVER_* constant |
|
151 | + * - An array(const PEAR_Exception::OBSERVER_*, |
|
152 | + * mixed $options) |
|
153 | + * @param string $label The name of the observer. Use this if you want |
|
154 | + * to remove it later with removeObserver() |
|
155 | + */ |
|
156 | + public static function addObserver($callback, $label = 'default') |
|
157 | + { |
|
158 | + self::$_observers[$label] = $callback; |
|
159 | + } |
|
160 | 160 | |
161 | - public static function removeObserver($label = 'default') |
|
162 | - { |
|
163 | - unset(self::$_observers[$label]); |
|
164 | - } |
|
161 | + public static function removeObserver($label = 'default') |
|
162 | + { |
|
163 | + unset(self::$_observers[$label]); |
|
164 | + } |
|
165 | 165 | |
166 | - /** |
|
167 | - * @return int unique identifier for an observer |
|
168 | - */ |
|
169 | - public static function getUniqueId() |
|
170 | - { |
|
171 | - return self::$_uniqueid++; |
|
172 | - } |
|
166 | + /** |
|
167 | + * @return int unique identifier for an observer |
|
168 | + */ |
|
169 | + public static function getUniqueId() |
|
170 | + { |
|
171 | + return self::$_uniqueid++; |
|
172 | + } |
|
173 | 173 | |
174 | - private function signal() |
|
175 | - { |
|
176 | - foreach (self::$_observers as $func) { |
|
177 | - if (is_callable($func)) { |
|
178 | - call_user_func($func, $this); |
|
179 | - continue; |
|
180 | - } |
|
181 | - settype($func, 'array'); |
|
182 | - switch ($func[0]) { |
|
183 | - case self::OBSERVER_PRINT : |
|
184 | - $f = (isset($func[1])) ? $func[1] : '%s'; |
|
185 | - printf($f, $this->getMessage()); |
|
186 | - break; |
|
187 | - case self::OBSERVER_TRIGGER : |
|
188 | - $f = (isset($func[1])) ? $func[1] : E_USER_NOTICE; |
|
189 | - trigger_error($this->getMessage(), $f); |
|
190 | - break; |
|
191 | - case self::OBSERVER_DIE : |
|
192 | - $f = (isset($func[1])) ? $func[1] : '%s'; |
|
193 | - die(printf($f, $this->getMessage())); |
|
194 | - break; |
|
195 | - default: |
|
196 | - trigger_error('invalid observer type', E_USER_WARNING); |
|
197 | - } |
|
198 | - } |
|
199 | - } |
|
174 | + private function signal() |
|
175 | + { |
|
176 | + foreach (self::$_observers as $func) { |
|
177 | + if (is_callable($func)) { |
|
178 | + call_user_func($func, $this); |
|
179 | + continue; |
|
180 | + } |
|
181 | + settype($func, 'array'); |
|
182 | + switch ($func[0]) { |
|
183 | + case self::OBSERVER_PRINT : |
|
184 | + $f = (isset($func[1])) ? $func[1] : '%s'; |
|
185 | + printf($f, $this->getMessage()); |
|
186 | + break; |
|
187 | + case self::OBSERVER_TRIGGER : |
|
188 | + $f = (isset($func[1])) ? $func[1] : E_USER_NOTICE; |
|
189 | + trigger_error($this->getMessage(), $f); |
|
190 | + break; |
|
191 | + case self::OBSERVER_DIE : |
|
192 | + $f = (isset($func[1])) ? $func[1] : '%s'; |
|
193 | + die(printf($f, $this->getMessage())); |
|
194 | + break; |
|
195 | + default: |
|
196 | + trigger_error('invalid observer type', E_USER_WARNING); |
|
197 | + } |
|
198 | + } |
|
199 | + } |
|
200 | 200 | |
201 | - /** |
|
202 | - * Return specific error information that can be used for more detailed |
|
203 | - * error messages or translation. |
|
204 | - * |
|
205 | - * This method may be overridden in child exception classes in order |
|
206 | - * to add functionality not present in PEAR_Exception and is a placeholder |
|
207 | - * to define API |
|
208 | - * |
|
209 | - * The returned array must be an associative array of parameter => value like so: |
|
210 | - * <pre> |
|
211 | - * array('name' => $name, 'context' => array(...)) |
|
212 | - * </pre> |
|
213 | - * @return array |
|
214 | - */ |
|
215 | - public function getErrorData() |
|
216 | - { |
|
217 | - return array(); |
|
218 | - } |
|
201 | + /** |
|
202 | + * Return specific error information that can be used for more detailed |
|
203 | + * error messages or translation. |
|
204 | + * |
|
205 | + * This method may be overridden in child exception classes in order |
|
206 | + * to add functionality not present in PEAR_Exception and is a placeholder |
|
207 | + * to define API |
|
208 | + * |
|
209 | + * The returned array must be an associative array of parameter => value like so: |
|
210 | + * <pre> |
|
211 | + * array('name' => $name, 'context' => array(...)) |
|
212 | + * </pre> |
|
213 | + * @return array |
|
214 | + */ |
|
215 | + public function getErrorData() |
|
216 | + { |
|
217 | + return array(); |
|
218 | + } |
|
219 | 219 | |
220 | - /** |
|
221 | - * Returns the exception that caused this exception to be thrown |
|
222 | - * @access public |
|
223 | - * @return Exception|array The context of the exception |
|
224 | - */ |
|
225 | - public function getCause() |
|
226 | - { |
|
227 | - return $this->cause; |
|
228 | - } |
|
220 | + /** |
|
221 | + * Returns the exception that caused this exception to be thrown |
|
222 | + * @access public |
|
223 | + * @return Exception|array The context of the exception |
|
224 | + */ |
|
225 | + public function getCause() |
|
226 | + { |
|
227 | + return $this->cause; |
|
228 | + } |
|
229 | 229 | |
230 | - /** |
|
231 | - * Function must be public to call on caused exceptions |
|
232 | - * @param array |
|
233 | - */ |
|
234 | - public function getCauseMessage(&$causes) |
|
235 | - { |
|
236 | - $trace = $this->getTraceSafe(); |
|
237 | - $cause = array('class' => get_class($this), |
|
238 | - 'message' => $this->message, |
|
239 | - 'file' => 'unknown', |
|
240 | - 'line' => 'unknown'); |
|
241 | - if (isset($trace[0])) { |
|
242 | - if (isset($trace[0]['file'])) { |
|
243 | - $cause['file'] = $trace[0]['file']; |
|
244 | - $cause['line'] = $trace[0]['line']; |
|
245 | - } |
|
246 | - } |
|
247 | - $causes[] = $cause; |
|
248 | - if ($this->cause instanceof PEAR_Exception) { |
|
249 | - $this->cause->getCauseMessage($causes); |
|
250 | - } elseif ($this->cause instanceof Exception) { |
|
251 | - $causes[] = array('class' => get_class($this->cause), |
|
252 | - 'message' => $this->cause->getMessage(), |
|
253 | - 'file' => $this->cause->getFile(), |
|
254 | - 'line' => $this->cause->getLine()); |
|
255 | - } elseif (class_exists('PEAR_Error') && $this->cause instanceof PEAR_Error) { |
|
256 | - $causes[] = array('class' => get_class($this->cause), |
|
257 | - 'message' => $this->cause->getMessage(), |
|
258 | - 'file' => 'unknown', |
|
259 | - 'line' => 'unknown'); |
|
260 | - } elseif (is_array($this->cause)) { |
|
261 | - foreach ($this->cause as $cause) { |
|
262 | - if ($cause instanceof PEAR_Exception) { |
|
263 | - $cause->getCauseMessage($causes); |
|
264 | - } elseif ($cause instanceof Exception) { |
|
265 | - $causes[] = array('class' => get_class($cause), |
|
266 | - 'message' => $cause->getMessage(), |
|
267 | - 'file' => $cause->getFile(), |
|
268 | - 'line' => $cause->getLine()); |
|
269 | - } elseif (class_exists('PEAR_Error') && $cause instanceof PEAR_Error) { |
|
270 | - $causes[] = array('class' => get_class($cause), |
|
271 | - 'message' => $cause->getMessage(), |
|
272 | - 'file' => 'unknown', |
|
273 | - 'line' => 'unknown'); |
|
274 | - } elseif (is_array($cause) && isset($cause['message'])) { |
|
275 | - // PEAR_ErrorStack warning |
|
276 | - $causes[] = array( |
|
277 | - 'class' => $cause['package'], |
|
278 | - 'message' => $cause['message'], |
|
279 | - 'file' => isset($cause['context']['file']) ? |
|
280 | - $cause['context']['file'] : |
|
281 | - 'unknown', |
|
282 | - 'line' => isset($cause['context']['line']) ? |
|
283 | - $cause['context']['line'] : |
|
284 | - 'unknown', |
|
285 | - ); |
|
286 | - } |
|
287 | - } |
|
288 | - } |
|
289 | - } |
|
230 | + /** |
|
231 | + * Function must be public to call on caused exceptions |
|
232 | + * @param array |
|
233 | + */ |
|
234 | + public function getCauseMessage(&$causes) |
|
235 | + { |
|
236 | + $trace = $this->getTraceSafe(); |
|
237 | + $cause = array('class' => get_class($this), |
|
238 | + 'message' => $this->message, |
|
239 | + 'file' => 'unknown', |
|
240 | + 'line' => 'unknown'); |
|
241 | + if (isset($trace[0])) { |
|
242 | + if (isset($trace[0]['file'])) { |
|
243 | + $cause['file'] = $trace[0]['file']; |
|
244 | + $cause['line'] = $trace[0]['line']; |
|
245 | + } |
|
246 | + } |
|
247 | + $causes[] = $cause; |
|
248 | + if ($this->cause instanceof PEAR_Exception) { |
|
249 | + $this->cause->getCauseMessage($causes); |
|
250 | + } elseif ($this->cause instanceof Exception) { |
|
251 | + $causes[] = array('class' => get_class($this->cause), |
|
252 | + 'message' => $this->cause->getMessage(), |
|
253 | + 'file' => $this->cause->getFile(), |
|
254 | + 'line' => $this->cause->getLine()); |
|
255 | + } elseif (class_exists('PEAR_Error') && $this->cause instanceof PEAR_Error) { |
|
256 | + $causes[] = array('class' => get_class($this->cause), |
|
257 | + 'message' => $this->cause->getMessage(), |
|
258 | + 'file' => 'unknown', |
|
259 | + 'line' => 'unknown'); |
|
260 | + } elseif (is_array($this->cause)) { |
|
261 | + foreach ($this->cause as $cause) { |
|
262 | + if ($cause instanceof PEAR_Exception) { |
|
263 | + $cause->getCauseMessage($causes); |
|
264 | + } elseif ($cause instanceof Exception) { |
|
265 | + $causes[] = array('class' => get_class($cause), |
|
266 | + 'message' => $cause->getMessage(), |
|
267 | + 'file' => $cause->getFile(), |
|
268 | + 'line' => $cause->getLine()); |
|
269 | + } elseif (class_exists('PEAR_Error') && $cause instanceof PEAR_Error) { |
|
270 | + $causes[] = array('class' => get_class($cause), |
|
271 | + 'message' => $cause->getMessage(), |
|
272 | + 'file' => 'unknown', |
|
273 | + 'line' => 'unknown'); |
|
274 | + } elseif (is_array($cause) && isset($cause['message'])) { |
|
275 | + // PEAR_ErrorStack warning |
|
276 | + $causes[] = array( |
|
277 | + 'class' => $cause['package'], |
|
278 | + 'message' => $cause['message'], |
|
279 | + 'file' => isset($cause['context']['file']) ? |
|
280 | + $cause['context']['file'] : |
|
281 | + 'unknown', |
|
282 | + 'line' => isset($cause['context']['line']) ? |
|
283 | + $cause['context']['line'] : |
|
284 | + 'unknown', |
|
285 | + ); |
|
286 | + } |
|
287 | + } |
|
288 | + } |
|
289 | + } |
|
290 | 290 | |
291 | - public function getTraceSafe() |
|
292 | - { |
|
293 | - if (!isset($this->_trace)) { |
|
294 | - $this->_trace = $this->getTrace(); |
|
295 | - if (empty($this->_trace)) { |
|
296 | - $backtrace = debug_backtrace(); |
|
297 | - $this->_trace = array($backtrace[count($backtrace)-1]); |
|
298 | - } |
|
299 | - } |
|
300 | - return $this->_trace; |
|
301 | - } |
|
291 | + public function getTraceSafe() |
|
292 | + { |
|
293 | + if (!isset($this->_trace)) { |
|
294 | + $this->_trace = $this->getTrace(); |
|
295 | + if (empty($this->_trace)) { |
|
296 | + $backtrace = debug_backtrace(); |
|
297 | + $this->_trace = array($backtrace[count($backtrace)-1]); |
|
298 | + } |
|
299 | + } |
|
300 | + return $this->_trace; |
|
301 | + } |
|
302 | 302 | |
303 | - public function getErrorClass() |
|
304 | - { |
|
305 | - $trace = $this->getTraceSafe(); |
|
306 | - return $trace[0]['class']; |
|
307 | - } |
|
303 | + public function getErrorClass() |
|
304 | + { |
|
305 | + $trace = $this->getTraceSafe(); |
|
306 | + return $trace[0]['class']; |
|
307 | + } |
|
308 | 308 | |
309 | - public function getErrorMethod() |
|
310 | - { |
|
311 | - $trace = $this->getTraceSafe(); |
|
312 | - return $trace[0]['function']; |
|
313 | - } |
|
309 | + public function getErrorMethod() |
|
310 | + { |
|
311 | + $trace = $this->getTraceSafe(); |
|
312 | + return $trace[0]['function']; |
|
313 | + } |
|
314 | 314 | |
315 | - public function __toString() |
|
316 | - { |
|
317 | - if (isset($_SERVER['REQUEST_URI'])) { |
|
318 | - return $this->toHtml(); |
|
319 | - } |
|
320 | - return $this->toText(); |
|
321 | - } |
|
315 | + public function __toString() |
|
316 | + { |
|
317 | + if (isset($_SERVER['REQUEST_URI'])) { |
|
318 | + return $this->toHtml(); |
|
319 | + } |
|
320 | + return $this->toText(); |
|
321 | + } |
|
322 | 322 | |
323 | - public function toHtml() |
|
324 | - { |
|
325 | - $trace = $this->getTraceSafe(); |
|
326 | - $causes = array(); |
|
327 | - $this->getCauseMessage($causes); |
|
328 | - $html = '<table style="border: 1px" cellspacing="0">' . "\n"; |
|
329 | - foreach ($causes as $i => $cause) { |
|
330 | - $html .= '<tr><td colspan="3" style="background: #ff9999">' |
|
331 | - . str_repeat('-', $i) . ' <b>' . $cause['class'] . '</b>: ' |
|
332 | - . htmlspecialchars($cause['message']) . ' in <b>' . $cause['file'] . '</b> ' |
|
333 | - . 'on line <b>' . $cause['line'] . '</b>' |
|
334 | - . "</td></tr>\n"; |
|
335 | - } |
|
336 | - $html .= '<tr><td colspan="3" style="background-color: #aaaaaa; text-align: center; font-weight: bold;">Exception trace</td></tr>' . "\n" |
|
337 | - . '<tr><td style="text-align: center; background: #cccccc; width:20px; font-weight: bold;">#</td>' |
|
338 | - . '<td style="text-align: center; background: #cccccc; font-weight: bold;">Function</td>' |
|
339 | - . '<td style="text-align: center; background: #cccccc; font-weight: bold;">Location</td></tr>' . "\n"; |
|
323 | + public function toHtml() |
|
324 | + { |
|
325 | + $trace = $this->getTraceSafe(); |
|
326 | + $causes = array(); |
|
327 | + $this->getCauseMessage($causes); |
|
328 | + $html = '<table style="border: 1px" cellspacing="0">' . "\n"; |
|
329 | + foreach ($causes as $i => $cause) { |
|
330 | + $html .= '<tr><td colspan="3" style="background: #ff9999">' |
|
331 | + . str_repeat('-', $i) . ' <b>' . $cause['class'] . '</b>: ' |
|
332 | + . htmlspecialchars($cause['message']) . ' in <b>' . $cause['file'] . '</b> ' |
|
333 | + . 'on line <b>' . $cause['line'] . '</b>' |
|
334 | + . "</td></tr>\n"; |
|
335 | + } |
|
336 | + $html .= '<tr><td colspan="3" style="background-color: #aaaaaa; text-align: center; font-weight: bold;">Exception trace</td></tr>' . "\n" |
|
337 | + . '<tr><td style="text-align: center; background: #cccccc; width:20px; font-weight: bold;">#</td>' |
|
338 | + . '<td style="text-align: center; background: #cccccc; font-weight: bold;">Function</td>' |
|
339 | + . '<td style="text-align: center; background: #cccccc; font-weight: bold;">Location</td></tr>' . "\n"; |
|
340 | 340 | |
341 | - foreach ($trace as $k => $v) { |
|
342 | - $html .= '<tr><td style="text-align: center;">' . $k . '</td>' |
|
343 | - . '<td>'; |
|
344 | - if (!empty($v['class'])) { |
|
345 | - $html .= $v['class'] . $v['type']; |
|
346 | - } |
|
347 | - $html .= $v['function']; |
|
348 | - $args = array(); |
|
349 | - if (!empty($v['args'])) { |
|
350 | - foreach ($v['args'] as $arg) { |
|
351 | - if (is_null($arg)) $args[] = 'null'; |
|
352 | - elseif (is_array($arg)) $args[] = 'Array'; |
|
353 | - elseif (is_object($arg)) $args[] = 'Object('.get_class($arg).')'; |
|
354 | - elseif (is_bool($arg)) $args[] = $arg ? 'true' : 'false'; |
|
355 | - elseif (is_int($arg) || is_double($arg)) $args[] = $arg; |
|
356 | - else { |
|
357 | - $arg = (string)$arg; |
|
358 | - $str = htmlspecialchars(substr($arg, 0, 16)); |
|
359 | - if (strlen($arg) > 16) $str .= '…'; |
|
360 | - $args[] = "'" . $str . "'"; |
|
361 | - } |
|
362 | - } |
|
363 | - } |
|
364 | - $html .= '(' . implode(', ',$args) . ')' |
|
365 | - . '</td>' |
|
366 | - . '<td>' . (isset($v['file']) ? $v['file'] : 'unknown') |
|
367 | - . ':' . (isset($v['line']) ? $v['line'] : 'unknown') |
|
368 | - . '</td></tr>' . "\n"; |
|
369 | - } |
|
370 | - $html .= '<tr><td style="text-align: center;">' . ($k+1) . '</td>' |
|
371 | - . '<td>{main}</td>' |
|
372 | - . '<td> </td></tr>' . "\n" |
|
373 | - . '</table>'; |
|
374 | - return $html; |
|
375 | - } |
|
341 | + foreach ($trace as $k => $v) { |
|
342 | + $html .= '<tr><td style="text-align: center;">' . $k . '</td>' |
|
343 | + . '<td>'; |
|
344 | + if (!empty($v['class'])) { |
|
345 | + $html .= $v['class'] . $v['type']; |
|
346 | + } |
|
347 | + $html .= $v['function']; |
|
348 | + $args = array(); |
|
349 | + if (!empty($v['args'])) { |
|
350 | + foreach ($v['args'] as $arg) { |
|
351 | + if (is_null($arg)) $args[] = 'null'; |
|
352 | + elseif (is_array($arg)) $args[] = 'Array'; |
|
353 | + elseif (is_object($arg)) $args[] = 'Object('.get_class($arg).')'; |
|
354 | + elseif (is_bool($arg)) $args[] = $arg ? 'true' : 'false'; |
|
355 | + elseif (is_int($arg) || is_double($arg)) $args[] = $arg; |
|
356 | + else { |
|
357 | + $arg = (string)$arg; |
|
358 | + $str = htmlspecialchars(substr($arg, 0, 16)); |
|
359 | + if (strlen($arg) > 16) $str .= '…'; |
|
360 | + $args[] = "'" . $str . "'"; |
|
361 | + } |
|
362 | + } |
|
363 | + } |
|
364 | + $html .= '(' . implode(', ',$args) . ')' |
|
365 | + . '</td>' |
|
366 | + . '<td>' . (isset($v['file']) ? $v['file'] : 'unknown') |
|
367 | + . ':' . (isset($v['line']) ? $v['line'] : 'unknown') |
|
368 | + . '</td></tr>' . "\n"; |
|
369 | + } |
|
370 | + $html .= '<tr><td style="text-align: center;">' . ($k+1) . '</td>' |
|
371 | + . '<td>{main}</td>' |
|
372 | + . '<td> </td></tr>' . "\n" |
|
373 | + . '</table>'; |
|
374 | + return $html; |
|
375 | + } |
|
376 | 376 | |
377 | - public function toText() |
|
378 | - { |
|
379 | - $causes = array(); |
|
380 | - $this->getCauseMessage($causes); |
|
381 | - $causeMsg = ''; |
|
382 | - foreach ($causes as $i => $cause) { |
|
383 | - $causeMsg .= str_repeat(' ', $i) . $cause['class'] . ': ' |
|
384 | - . $cause['message'] . ' in ' . $cause['file'] |
|
385 | - . ' on line ' . $cause['line'] . "\n"; |
|
386 | - } |
|
387 | - return $causeMsg . $this->getTraceAsString(); |
|
388 | - } |
|
377 | + public function toText() |
|
378 | + { |
|
379 | + $causes = array(); |
|
380 | + $this->getCauseMessage($causes); |
|
381 | + $causeMsg = ''; |
|
382 | + foreach ($causes as $i => $cause) { |
|
383 | + $causeMsg .= str_repeat(' ', $i) . $cause['class'] . ': ' |
|
384 | + . $cause['message'] . ' in ' . $cause['file'] |
|
385 | + . ' on line ' . $cause['line'] . "\n"; |
|
386 | + } |
|
387 | + return $causeMsg . $this->getTraceAsString(); |
|
388 | + } |
|
389 | 389 | } |
390 | 390 | \ No newline at end of file |
@@ -1,33 +1,33 @@ |
||
1 | 1 | <?php |
2 | 2 | /** |
3 | - * This is only meant for PHP 5 to get rid of certain strict warning |
|
4 | - * that doesn't get hidden since it's in the shutdown function |
|
5 | - */ |
|
3 | + * This is only meant for PHP 5 to get rid of certain strict warning |
|
4 | + * that doesn't get hidden since it's in the shutdown function |
|
5 | + */ |
|
6 | 6 | class PEAR5 |
7 | 7 | { |
8 | - /** |
|
9 | - * If you have a class that's mostly/entirely static, and you need static |
|
10 | - * properties, you can use this method to simulate them. Eg. in your method(s) |
|
11 | - * do this: $myVar = &PEAR5::getStaticProperty('myclass', 'myVar'); |
|
12 | - * You MUST use a reference, or they will not persist! |
|
13 | - * |
|
14 | - * @access public |
|
15 | - * @param string $class The calling classname, to prevent clashes |
|
16 | - * @param string $var The variable to retrieve. |
|
17 | - * @return mixed A reference to the variable. If not set it will be |
|
18 | - * auto initialised to NULL. |
|
19 | - */ |
|
20 | - static function &getStaticProperty($class, $var) |
|
21 | - { |
|
22 | - static $properties; |
|
23 | - if (!isset($properties[$class])) { |
|
24 | - $properties[$class] = array(); |
|
25 | - } |
|
8 | + /** |
|
9 | + * If you have a class that's mostly/entirely static, and you need static |
|
10 | + * properties, you can use this method to simulate them. Eg. in your method(s) |
|
11 | + * do this: $myVar = &PEAR5::getStaticProperty('myclass', 'myVar'); |
|
12 | + * You MUST use a reference, or they will not persist! |
|
13 | + * |
|
14 | + * @access public |
|
15 | + * @param string $class The calling classname, to prevent clashes |
|
16 | + * @param string $var The variable to retrieve. |
|
17 | + * @return mixed A reference to the variable. If not set it will be |
|
18 | + * auto initialised to NULL. |
|
19 | + */ |
|
20 | + static function &getStaticProperty($class, $var) |
|
21 | + { |
|
22 | + static $properties; |
|
23 | + if (!isset($properties[$class])) { |
|
24 | + $properties[$class] = array(); |
|
25 | + } |
|
26 | 26 | |
27 | - if (!array_key_exists($var, $properties[$class])) { |
|
28 | - $properties[$class][$var] = null; |
|
29 | - } |
|
27 | + if (!array_key_exists($var, $properties[$class])) { |
|
28 | + $properties[$class][$var] = null; |
|
29 | + } |
|
30 | 30 | |
31 | - return $properties[$class][$var]; |
|
32 | - } |
|
31 | + return $properties[$class][$var]; |
|
32 | + } |
|
33 | 33 | } |
34 | 34 | \ No newline at end of file |
@@ -18,28 +18,28 @@ |
||
18 | 18 | } |
19 | 19 | |
20 | 20 | public function getResponseCode() { |
21 | - if($this->response) |
|
21 | + if ($this->response) |
|
22 | 22 | { |
23 | 23 | return $this->response->getStatus(); |
24 | 24 | } |
25 | 25 | } |
26 | 26 | |
27 | 27 | public function getResponseHeader() { |
28 | - if($this->response) |
|
28 | + if ($this->response) |
|
29 | 29 | { |
30 | 30 | return $this->response->getHeader(); |
31 | 31 | } |
32 | 32 | } |
33 | 33 | |
34 | 34 | public function getResponseBody() { |
35 | - if($this->response) |
|
35 | + if ($this->response) |
|
36 | 36 | { |
37 | 37 | return $this->response->getBody(); |
38 | 38 | } |
39 | 39 | } |
40 | 40 | |
41 | 41 | public function getResponseCookies() { |
42 | - if($this->response) |
|
42 | + if ($this->response) |
|
43 | 43 | { |
44 | 44 | return $this->response->getCookies(); |
45 | 45 | } |