@@ -11,61 +11,61 @@ |
||
11 | 11 | * @package Requests |
12 | 12 | */ |
13 | 13 | class Requests_Exception_HTTP extends Requests_Exception { |
14 | - /** |
|
15 | - * HTTP status code |
|
16 | - * |
|
17 | - * @var integer |
|
18 | - */ |
|
19 | - protected $code = 0; |
|
14 | + /** |
|
15 | + * HTTP status code |
|
16 | + * |
|
17 | + * @var integer |
|
18 | + */ |
|
19 | + protected $code = 0; |
|
20 | 20 | |
21 | - /** |
|
22 | - * Reason phrase |
|
23 | - * |
|
24 | - * @var string |
|
25 | - */ |
|
26 | - protected $reason = 'Unknown'; |
|
21 | + /** |
|
22 | + * Reason phrase |
|
23 | + * |
|
24 | + * @var string |
|
25 | + */ |
|
26 | + protected $reason = 'Unknown'; |
|
27 | 27 | |
28 | - /** |
|
29 | - * Create a new exception |
|
30 | - * |
|
31 | - * There is no mechanism to pass in the status code, as this is set by the |
|
32 | - * subclass used. Reason phrases can vary, however. |
|
33 | - * |
|
34 | - * @param string|null $reason Reason phrase |
|
35 | - * @param mixed $data Associated data |
|
36 | - */ |
|
37 | - public function __construct($reason = null, $data = null) { |
|
38 | - if ($reason !== null) { |
|
39 | - $this->reason = $reason; |
|
40 | - } |
|
28 | + /** |
|
29 | + * Create a new exception |
|
30 | + * |
|
31 | + * There is no mechanism to pass in the status code, as this is set by the |
|
32 | + * subclass used. Reason phrases can vary, however. |
|
33 | + * |
|
34 | + * @param string|null $reason Reason phrase |
|
35 | + * @param mixed $data Associated data |
|
36 | + */ |
|
37 | + public function __construct($reason = null, $data = null) { |
|
38 | + if ($reason !== null) { |
|
39 | + $this->reason = $reason; |
|
40 | + } |
|
41 | 41 | |
42 | - $message = sprintf('%d %s', $this->code, $this->reason); |
|
43 | - parent::__construct($message, 'httpresponse', $data, $this->code); |
|
44 | - } |
|
42 | + $message = sprintf('%d %s', $this->code, $this->reason); |
|
43 | + parent::__construct($message, 'httpresponse', $data, $this->code); |
|
44 | + } |
|
45 | 45 | |
46 | - /** |
|
47 | - * Get the status message |
|
48 | - */ |
|
49 | - public function getReason() { |
|
50 | - return $this->reason; |
|
51 | - } |
|
46 | + /** |
|
47 | + * Get the status message |
|
48 | + */ |
|
49 | + public function getReason() { |
|
50 | + return $this->reason; |
|
51 | + } |
|
52 | 52 | |
53 | - /** |
|
54 | - * Get the correct exception class for a given error code |
|
55 | - * |
|
56 | - * @param int|bool $code HTTP status code, or false if unavailable |
|
57 | - * @return string Exception class name to use |
|
58 | - */ |
|
59 | - public static function get_class($code) { |
|
60 | - if (!$code) { |
|
61 | - return 'Requests_Exception_HTTP_Unknown'; |
|
62 | - } |
|
53 | + /** |
|
54 | + * Get the correct exception class for a given error code |
|
55 | + * |
|
56 | + * @param int|bool $code HTTP status code, or false if unavailable |
|
57 | + * @return string Exception class name to use |
|
58 | + */ |
|
59 | + public static function get_class($code) { |
|
60 | + if (!$code) { |
|
61 | + return 'Requests_Exception_HTTP_Unknown'; |
|
62 | + } |
|
63 | 63 | |
64 | - $class = sprintf('Requests_Exception_HTTP_%d', $code); |
|
65 | - if (class_exists($class)) { |
|
66 | - return $class; |
|
67 | - } |
|
64 | + $class = sprintf('Requests_Exception_HTTP_%d', $code); |
|
65 | + if (class_exists($class)) { |
|
66 | + return $class; |
|
67 | + } |
|
68 | 68 | |
69 | - return 'Requests_Exception_HTTP_Unknown'; |
|
70 | - } |
|
69 | + return 'Requests_Exception_HTTP_Unknown'; |
|
70 | + } |
|
71 | 71 | } |
72 | 72 | \ No newline at end of file |
@@ -2,55 +2,55 @@ |
||
2 | 2 | |
3 | 3 | class Requests_Exception_Transport_cURL extends Requests_Exception_Transport { |
4 | 4 | |
5 | - const EASY = 'cURLEasy'; |
|
6 | - const MULTI = 'cURLMulti'; |
|
7 | - const SHARE = 'cURLShare'; |
|
8 | - |
|
9 | - /** |
|
10 | - * cURL error code |
|
11 | - * |
|
12 | - * @var integer |
|
13 | - */ |
|
14 | - protected $code = -1; |
|
15 | - |
|
16 | - /** |
|
17 | - * Which type of cURL error |
|
18 | - * |
|
19 | - * EASY|MULTI|SHARE |
|
20 | - * |
|
21 | - * @var string |
|
22 | - */ |
|
23 | - protected $type = 'Unknown'; |
|
24 | - |
|
25 | - /** |
|
26 | - * Clear text error message |
|
27 | - * |
|
28 | - * @var string |
|
29 | - */ |
|
30 | - protected $reason = 'Unknown'; |
|
31 | - |
|
32 | - public function __construct($message, $type, $data = null, $code = 0) { |
|
33 | - if ($type !== null) { |
|
34 | - $this->type = $type; |
|
35 | - } |
|
36 | - |
|
37 | - if ($code !== null) { |
|
38 | - $this->code = $code; |
|
39 | - } |
|
40 | - |
|
41 | - if ($message !== null) { |
|
42 | - $this->reason = $message; |
|
43 | - } |
|
44 | - |
|
45 | - $message = sprintf('%d %s', $this->code, $this->reason); |
|
46 | - parent::__construct($message, $this->type, $data, $this->code); |
|
47 | - } |
|
48 | - |
|
49 | - /** |
|
50 | - * Get the error message |
|
51 | - */ |
|
52 | - public function getReason() { |
|
53 | - return $this->reason; |
|
54 | - } |
|
5 | + const EASY = 'cURLEasy'; |
|
6 | + const MULTI = 'cURLMulti'; |
|
7 | + const SHARE = 'cURLShare'; |
|
8 | + |
|
9 | + /** |
|
10 | + * cURL error code |
|
11 | + * |
|
12 | + * @var integer |
|
13 | + */ |
|
14 | + protected $code = -1; |
|
15 | + |
|
16 | + /** |
|
17 | + * Which type of cURL error |
|
18 | + * |
|
19 | + * EASY|MULTI|SHARE |
|
20 | + * |
|
21 | + * @var string |
|
22 | + */ |
|
23 | + protected $type = 'Unknown'; |
|
24 | + |
|
25 | + /** |
|
26 | + * Clear text error message |
|
27 | + * |
|
28 | + * @var string |
|
29 | + */ |
|
30 | + protected $reason = 'Unknown'; |
|
31 | + |
|
32 | + public function __construct($message, $type, $data = null, $code = 0) { |
|
33 | + if ($type !== null) { |
|
34 | + $this->type = $type; |
|
35 | + } |
|
36 | + |
|
37 | + if ($code !== null) { |
|
38 | + $this->code = $code; |
|
39 | + } |
|
40 | + |
|
41 | + if ($message !== null) { |
|
42 | + $this->reason = $message; |
|
43 | + } |
|
44 | + |
|
45 | + $message = sprintf('%d %s', $this->code, $this->reason); |
|
46 | + parent::__construct($message, $this->type, $data, $this->code); |
|
47 | + } |
|
48 | + |
|
49 | + /** |
|
50 | + * Get the error message |
|
51 | + */ |
|
52 | + public function getReason() { |
|
53 | + return $this->reason; |
|
54 | + } |
|
55 | 55 | |
56 | 56 | } |
@@ -17,135 +17,135 @@ |
||
17 | 17 | * @since 1.6 |
18 | 18 | */ |
19 | 19 | class Requests_Proxy_HTTP implements Requests_Proxy { |
20 | - /** |
|
21 | - * Proxy host and port |
|
22 | - * |
|
23 | - * Notation: "host:port" (eg 127.0.0.1:8080 or someproxy.com:3128) |
|
24 | - * |
|
25 | - * @var string |
|
26 | - */ |
|
27 | - public $proxy; |
|
20 | + /** |
|
21 | + * Proxy host and port |
|
22 | + * |
|
23 | + * Notation: "host:port" (eg 127.0.0.1:8080 or someproxy.com:3128) |
|
24 | + * |
|
25 | + * @var string |
|
26 | + */ |
|
27 | + public $proxy; |
|
28 | 28 | |
29 | - /** |
|
30 | - * Username |
|
31 | - * |
|
32 | - * @var string |
|
33 | - */ |
|
34 | - public $user; |
|
29 | + /** |
|
30 | + * Username |
|
31 | + * |
|
32 | + * @var string |
|
33 | + */ |
|
34 | + public $user; |
|
35 | 35 | |
36 | - /** |
|
37 | - * Password |
|
38 | - * |
|
39 | - * @var string |
|
40 | - */ |
|
41 | - public $pass; |
|
36 | + /** |
|
37 | + * Password |
|
38 | + * |
|
39 | + * @var string |
|
40 | + */ |
|
41 | + public $pass; |
|
42 | 42 | |
43 | - /** |
|
44 | - * Do we need to authenticate? (ie username & password have been provided) |
|
45 | - * |
|
46 | - * @var boolean |
|
47 | - */ |
|
48 | - public $use_authentication; |
|
43 | + /** |
|
44 | + * Do we need to authenticate? (ie username & password have been provided) |
|
45 | + * |
|
46 | + * @var boolean |
|
47 | + */ |
|
48 | + public $use_authentication; |
|
49 | 49 | |
50 | - /** |
|
51 | - * Constructor |
|
52 | - * |
|
53 | - * @since 1.6 |
|
54 | - * @throws Requests_Exception On incorrect number of arguments (`authbasicbadargs`) |
|
55 | - * @param array|null $args Array of user and password. Must have exactly two elements |
|
56 | - */ |
|
57 | - public function __construct($args = null) { |
|
58 | - if (is_string($args)) { |
|
59 | - $this->proxy = $args; |
|
60 | - } |
|
61 | - elseif (is_array($args)) { |
|
62 | - if (count($args) == 1) { |
|
63 | - list($this->proxy) = $args; |
|
64 | - } |
|
65 | - elseif (count($args) == 3) { |
|
66 | - list($this->proxy, $this->user, $this->pass) = $args; |
|
67 | - $this->use_authentication = true; |
|
68 | - } |
|
69 | - else { |
|
70 | - throw new Requests_Exception('Invalid number of arguments', 'proxyhttpbadargs'); |
|
71 | - } |
|
72 | - } |
|
73 | - } |
|
50 | + /** |
|
51 | + * Constructor |
|
52 | + * |
|
53 | + * @since 1.6 |
|
54 | + * @throws Requests_Exception On incorrect number of arguments (`authbasicbadargs`) |
|
55 | + * @param array|null $args Array of user and password. Must have exactly two elements |
|
56 | + */ |
|
57 | + public function __construct($args = null) { |
|
58 | + if (is_string($args)) { |
|
59 | + $this->proxy = $args; |
|
60 | + } |
|
61 | + elseif (is_array($args)) { |
|
62 | + if (count($args) == 1) { |
|
63 | + list($this->proxy) = $args; |
|
64 | + } |
|
65 | + elseif (count($args) == 3) { |
|
66 | + list($this->proxy, $this->user, $this->pass) = $args; |
|
67 | + $this->use_authentication = true; |
|
68 | + } |
|
69 | + else { |
|
70 | + throw new Requests_Exception('Invalid number of arguments', 'proxyhttpbadargs'); |
|
71 | + } |
|
72 | + } |
|
73 | + } |
|
74 | 74 | |
75 | - /** |
|
76 | - * Register the necessary callbacks |
|
77 | - * |
|
78 | - * @since 1.6 |
|
79 | - * @see curl_before_send |
|
80 | - * @see fsockopen_remote_socket |
|
81 | - * @see fsockopen_remote_host_path |
|
82 | - * @see fsockopen_header |
|
83 | - * @param Requests_Hooks $hooks Hook system |
|
84 | - */ |
|
85 | - public function register(Requests_Hooks &$hooks) { |
|
86 | - $hooks->register('curl.before_send', array(&$this, 'curl_before_send')); |
|
75 | + /** |
|
76 | + * Register the necessary callbacks |
|
77 | + * |
|
78 | + * @since 1.6 |
|
79 | + * @see curl_before_send |
|
80 | + * @see fsockopen_remote_socket |
|
81 | + * @see fsockopen_remote_host_path |
|
82 | + * @see fsockopen_header |
|
83 | + * @param Requests_Hooks $hooks Hook system |
|
84 | + */ |
|
85 | + public function register(Requests_Hooks &$hooks) { |
|
86 | + $hooks->register('curl.before_send', array(&$this, 'curl_before_send')); |
|
87 | 87 | |
88 | - $hooks->register('fsockopen.remote_socket', array(&$this, 'fsockopen_remote_socket')); |
|
89 | - $hooks->register('fsockopen.remote_host_path', array(&$this, 'fsockopen_remote_host_path')); |
|
90 | - if ($this->use_authentication) { |
|
91 | - $hooks->register('fsockopen.after_headers', array(&$this, 'fsockopen_header')); |
|
92 | - } |
|
93 | - } |
|
88 | + $hooks->register('fsockopen.remote_socket', array(&$this, 'fsockopen_remote_socket')); |
|
89 | + $hooks->register('fsockopen.remote_host_path', array(&$this, 'fsockopen_remote_host_path')); |
|
90 | + if ($this->use_authentication) { |
|
91 | + $hooks->register('fsockopen.after_headers', array(&$this, 'fsockopen_header')); |
|
92 | + } |
|
93 | + } |
|
94 | 94 | |
95 | - /** |
|
96 | - * Set cURL parameters before the data is sent |
|
97 | - * |
|
98 | - * @since 1.6 |
|
99 | - * @param resource $handle cURL resource |
|
100 | - */ |
|
101 | - public function curl_before_send(&$handle) { |
|
102 | - curl_setopt($handle, CURLOPT_PROXYTYPE, CURLPROXY_HTTP); |
|
103 | - curl_setopt($handle, CURLOPT_PROXY, $this->proxy); |
|
95 | + /** |
|
96 | + * Set cURL parameters before the data is sent |
|
97 | + * |
|
98 | + * @since 1.6 |
|
99 | + * @param resource $handle cURL resource |
|
100 | + */ |
|
101 | + public function curl_before_send(&$handle) { |
|
102 | + curl_setopt($handle, CURLOPT_PROXYTYPE, CURLPROXY_HTTP); |
|
103 | + curl_setopt($handle, CURLOPT_PROXY, $this->proxy); |
|
104 | 104 | |
105 | - if ($this->use_authentication) { |
|
106 | - curl_setopt($handle, CURLOPT_PROXYAUTH, CURLAUTH_ANY); |
|
107 | - curl_setopt($handle, CURLOPT_PROXYUSERPWD, $this->get_auth_string()); |
|
108 | - } |
|
109 | - } |
|
105 | + if ($this->use_authentication) { |
|
106 | + curl_setopt($handle, CURLOPT_PROXYAUTH, CURLAUTH_ANY); |
|
107 | + curl_setopt($handle, CURLOPT_PROXYUSERPWD, $this->get_auth_string()); |
|
108 | + } |
|
109 | + } |
|
110 | 110 | |
111 | - /** |
|
112 | - * Alter remote socket information before opening socket connection |
|
113 | - * |
|
114 | - * @since 1.6 |
|
115 | - * @param string $remote_socket Socket connection string |
|
116 | - */ |
|
117 | - public function fsockopen_remote_socket(&$remote_socket) { |
|
118 | - $remote_socket = $this->proxy; |
|
119 | - } |
|
111 | + /** |
|
112 | + * Alter remote socket information before opening socket connection |
|
113 | + * |
|
114 | + * @since 1.6 |
|
115 | + * @param string $remote_socket Socket connection string |
|
116 | + */ |
|
117 | + public function fsockopen_remote_socket(&$remote_socket) { |
|
118 | + $remote_socket = $this->proxy; |
|
119 | + } |
|
120 | 120 | |
121 | - /** |
|
122 | - * Alter remote path before getting stream data |
|
123 | - * |
|
124 | - * @since 1.6 |
|
125 | - * @param string $path Path to send in HTTP request string ("GET ...") |
|
126 | - * @param string $url Full URL we're requesting |
|
127 | - */ |
|
128 | - public function fsockopen_remote_host_path(&$path, $url) { |
|
129 | - $path = $url; |
|
130 | - } |
|
121 | + /** |
|
122 | + * Alter remote path before getting stream data |
|
123 | + * |
|
124 | + * @since 1.6 |
|
125 | + * @param string $path Path to send in HTTP request string ("GET ...") |
|
126 | + * @param string $url Full URL we're requesting |
|
127 | + */ |
|
128 | + public function fsockopen_remote_host_path(&$path, $url) { |
|
129 | + $path = $url; |
|
130 | + } |
|
131 | 131 | |
132 | - /** |
|
133 | - * Add extra headers to the request before sending |
|
134 | - * |
|
135 | - * @since 1.6 |
|
136 | - * @param string $out HTTP header string |
|
137 | - */ |
|
138 | - public function fsockopen_header(&$out) { |
|
139 | - $out .= sprintf("Proxy-Authorization: Basic %s\r\n", base64_encode($this->get_auth_string())); |
|
140 | - } |
|
132 | + /** |
|
133 | + * Add extra headers to the request before sending |
|
134 | + * |
|
135 | + * @since 1.6 |
|
136 | + * @param string $out HTTP header string |
|
137 | + */ |
|
138 | + public function fsockopen_header(&$out) { |
|
139 | + $out .= sprintf("Proxy-Authorization: Basic %s\r\n", base64_encode($this->get_auth_string())); |
|
140 | + } |
|
141 | 141 | |
142 | - /** |
|
143 | - * Get the authentication string (user:pass) |
|
144 | - * |
|
145 | - * @since 1.6 |
|
146 | - * @return string |
|
147 | - */ |
|
148 | - public function get_auth_string() { |
|
149 | - return $this->user . ':' . $this->pass; |
|
150 | - } |
|
142 | + /** |
|
143 | + * Get the authentication string (user:pass) |
|
144 | + * |
|
145 | + * @since 1.6 |
|
146 | + * @return string |
|
147 | + */ |
|
148 | + public function get_auth_string() { |
|
149 | + return $this->user . ':' . $this->pass; |
|
150 | + } |
|
151 | 151 | } |
152 | 152 | \ No newline at end of file |
@@ -11,378 +11,378 @@ |
||
11 | 11 | * @see https://tools.ietf.org/html/rfc3492 Punycode/Bootstrap specification |
12 | 12 | */ |
13 | 13 | class Requests_IDNAEncoder { |
14 | - /** |
|
15 | - * ACE prefix used for IDNA |
|
16 | - * |
|
17 | - * @see https://tools.ietf.org/html/rfc3490#section-5 |
|
18 | - * @var string |
|
19 | - */ |
|
20 | - const ACE_PREFIX = 'xn--'; |
|
14 | + /** |
|
15 | + * ACE prefix used for IDNA |
|
16 | + * |
|
17 | + * @see https://tools.ietf.org/html/rfc3490#section-5 |
|
18 | + * @var string |
|
19 | + */ |
|
20 | + const ACE_PREFIX = 'xn--'; |
|
21 | 21 | |
22 | - /**#@+ |
|
22 | + /**#@+ |
|
23 | 23 | * Bootstrap constant for Punycode |
24 | 24 | * |
25 | 25 | * @see https://tools.ietf.org/html/rfc3492#section-5 |
26 | 26 | * @var int |
27 | 27 | */ |
28 | - const BOOTSTRAP_BASE = 36; |
|
29 | - const BOOTSTRAP_TMIN = 1; |
|
30 | - const BOOTSTRAP_TMAX = 26; |
|
31 | - const BOOTSTRAP_SKEW = 38; |
|
32 | - const BOOTSTRAP_DAMP = 700; |
|
33 | - const BOOTSTRAP_INITIAL_BIAS = 72; |
|
34 | - const BOOTSTRAP_INITIAL_N = 128; |
|
35 | - /**#@-*/ |
|
28 | + const BOOTSTRAP_BASE = 36; |
|
29 | + const BOOTSTRAP_TMIN = 1; |
|
30 | + const BOOTSTRAP_TMAX = 26; |
|
31 | + const BOOTSTRAP_SKEW = 38; |
|
32 | + const BOOTSTRAP_DAMP = 700; |
|
33 | + const BOOTSTRAP_INITIAL_BIAS = 72; |
|
34 | + const BOOTSTRAP_INITIAL_N = 128; |
|
35 | + /**#@-*/ |
|
36 | 36 | |
37 | - /** |
|
38 | - * Encode a hostname using Punycode |
|
39 | - * |
|
40 | - * @param string $string Hostname |
|
41 | - * @return string Punycode-encoded hostname |
|
42 | - */ |
|
43 | - public static function encode($string) { |
|
44 | - $parts = explode('.', $string); |
|
45 | - foreach ($parts as &$part) { |
|
46 | - $part = self::to_ascii($part); |
|
47 | - } |
|
48 | - return implode('.', $parts); |
|
49 | - } |
|
37 | + /** |
|
38 | + * Encode a hostname using Punycode |
|
39 | + * |
|
40 | + * @param string $string Hostname |
|
41 | + * @return string Punycode-encoded hostname |
|
42 | + */ |
|
43 | + public static function encode($string) { |
|
44 | + $parts = explode('.', $string); |
|
45 | + foreach ($parts as &$part) { |
|
46 | + $part = self::to_ascii($part); |
|
47 | + } |
|
48 | + return implode('.', $parts); |
|
49 | + } |
|
50 | 50 | |
51 | - /** |
|
52 | - * Convert a UTF-8 string to an ASCII string using Punycode |
|
53 | - * |
|
54 | - * @throws Requests_Exception Provided string longer than 64 ASCII characters (`idna.provided_too_long`) |
|
55 | - * @throws Requests_Exception Prepared string longer than 64 ASCII characters (`idna.prepared_too_long`) |
|
56 | - * @throws Requests_Exception Provided string already begins with xn-- (`idna.provided_is_prefixed`) |
|
57 | - * @throws Requests_Exception Encoded string longer than 64 ASCII characters (`idna.encoded_too_long`) |
|
58 | - * |
|
59 | - * @param string $string ASCII or UTF-8 string (max length 64 characters) |
|
60 | - * @return string ASCII string |
|
61 | - */ |
|
62 | - public static function to_ascii($string) { |
|
63 | - // Step 1: Check if the string is already ASCII |
|
64 | - if (self::is_ascii($string)) { |
|
65 | - // Skip to step 7 |
|
66 | - if (strlen($string) < 64) { |
|
67 | - return $string; |
|
68 | - } |
|
51 | + /** |
|
52 | + * Convert a UTF-8 string to an ASCII string using Punycode |
|
53 | + * |
|
54 | + * @throws Requests_Exception Provided string longer than 64 ASCII characters (`idna.provided_too_long`) |
|
55 | + * @throws Requests_Exception Prepared string longer than 64 ASCII characters (`idna.prepared_too_long`) |
|
56 | + * @throws Requests_Exception Provided string already begins with xn-- (`idna.provided_is_prefixed`) |
|
57 | + * @throws Requests_Exception Encoded string longer than 64 ASCII characters (`idna.encoded_too_long`) |
|
58 | + * |
|
59 | + * @param string $string ASCII or UTF-8 string (max length 64 characters) |
|
60 | + * @return string ASCII string |
|
61 | + */ |
|
62 | + public static function to_ascii($string) { |
|
63 | + // Step 1: Check if the string is already ASCII |
|
64 | + if (self::is_ascii($string)) { |
|
65 | + // Skip to step 7 |
|
66 | + if (strlen($string) < 64) { |
|
67 | + return $string; |
|
68 | + } |
|
69 | 69 | |
70 | - throw new Requests_Exception('Provided string is too long', 'idna.provided_too_long', $string); |
|
71 | - } |
|
70 | + throw new Requests_Exception('Provided string is too long', 'idna.provided_too_long', $string); |
|
71 | + } |
|
72 | 72 | |
73 | - // Step 2: nameprep |
|
74 | - $string = self::nameprep($string); |
|
73 | + // Step 2: nameprep |
|
74 | + $string = self::nameprep($string); |
|
75 | 75 | |
76 | - // Step 3: UseSTD3ASCIIRules is false, continue |
|
77 | - // Step 4: Check if it's ASCII now |
|
78 | - if (self::is_ascii($string)) { |
|
79 | - // Skip to step 7 |
|
80 | - if (strlen($string) < 64) { |
|
81 | - return $string; |
|
82 | - } |
|
76 | + // Step 3: UseSTD3ASCIIRules is false, continue |
|
77 | + // Step 4: Check if it's ASCII now |
|
78 | + if (self::is_ascii($string)) { |
|
79 | + // Skip to step 7 |
|
80 | + if (strlen($string) < 64) { |
|
81 | + return $string; |
|
82 | + } |
|
83 | 83 | |
84 | - throw new Requests_Exception('Prepared string is too long', 'idna.prepared_too_long', $string); |
|
85 | - } |
|
84 | + throw new Requests_Exception('Prepared string is too long', 'idna.prepared_too_long', $string); |
|
85 | + } |
|
86 | 86 | |
87 | - // Step 5: Check ACE prefix |
|
88 | - if (strpos($string, self::ACE_PREFIX) === 0) { |
|
89 | - throw new Requests_Exception('Provided string begins with ACE prefix', 'idna.provided_is_prefixed', $string); |
|
90 | - } |
|
87 | + // Step 5: Check ACE prefix |
|
88 | + if (strpos($string, self::ACE_PREFIX) === 0) { |
|
89 | + throw new Requests_Exception('Provided string begins with ACE prefix', 'idna.provided_is_prefixed', $string); |
|
90 | + } |
|
91 | 91 | |
92 | - // Step 6: Encode with Punycode |
|
93 | - $string = self::punycode_encode($string); |
|
92 | + // Step 6: Encode with Punycode |
|
93 | + $string = self::punycode_encode($string); |
|
94 | 94 | |
95 | - // Step 7: Prepend ACE prefix |
|
96 | - $string = self::ACE_PREFIX . $string; |
|
95 | + // Step 7: Prepend ACE prefix |
|
96 | + $string = self::ACE_PREFIX . $string; |
|
97 | 97 | |
98 | - // Step 8: Check size |
|
99 | - if (strlen($string) < 64) { |
|
100 | - return $string; |
|
101 | - } |
|
98 | + // Step 8: Check size |
|
99 | + if (strlen($string) < 64) { |
|
100 | + return $string; |
|
101 | + } |
|
102 | 102 | |
103 | - throw new Requests_Exception('Encoded string is too long', 'idna.encoded_too_long', $string); |
|
104 | - } |
|
103 | + throw new Requests_Exception('Encoded string is too long', 'idna.encoded_too_long', $string); |
|
104 | + } |
|
105 | 105 | |
106 | - /** |
|
107 | - * Check whether a given string contains only ASCII characters |
|
108 | - * |
|
109 | - * @internal (Testing found regex was the fastest implementation) |
|
110 | - * |
|
111 | - * @param string $string |
|
112 | - * @return bool Is the string ASCII-only? |
|
113 | - */ |
|
114 | - protected static function is_ascii($string) { |
|
115 | - return (preg_match('/(?:[^\x00-\x7F])/', $string) !== 1); |
|
116 | - } |
|
106 | + /** |
|
107 | + * Check whether a given string contains only ASCII characters |
|
108 | + * |
|
109 | + * @internal (Testing found regex was the fastest implementation) |
|
110 | + * |
|
111 | + * @param string $string |
|
112 | + * @return bool Is the string ASCII-only? |
|
113 | + */ |
|
114 | + protected static function is_ascii($string) { |
|
115 | + return (preg_match('/(?:[^\x00-\x7F])/', $string) !== 1); |
|
116 | + } |
|
117 | 117 | |
118 | - /** |
|
119 | - * Prepare a string for use as an IDNA name |
|
120 | - * |
|
121 | - * @todo Implement this based on RFC 3491 and the newer 5891 |
|
122 | - * @param string $string |
|
123 | - * @return string Prepared string |
|
124 | - */ |
|
125 | - protected static function nameprep($string) { |
|
126 | - return $string; |
|
127 | - } |
|
118 | + /** |
|
119 | + * Prepare a string for use as an IDNA name |
|
120 | + * |
|
121 | + * @todo Implement this based on RFC 3491 and the newer 5891 |
|
122 | + * @param string $string |
|
123 | + * @return string Prepared string |
|
124 | + */ |
|
125 | + protected static function nameprep($string) { |
|
126 | + return $string; |
|
127 | + } |
|
128 | 128 | |
129 | - /** |
|
130 | - * Convert a UTF-8 string to a UCS-4 codepoint array |
|
131 | - * |
|
132 | - * Based on Requests_IRI::replace_invalid_with_pct_encoding() |
|
133 | - * |
|
134 | - * @throws Requests_Exception Invalid UTF-8 codepoint (`idna.invalidcodepoint`) |
|
135 | - * @param string $input |
|
136 | - * @return array Unicode code points |
|
137 | - */ |
|
138 | - protected static function utf8_to_codepoints($input) { |
|
139 | - $codepoints = array(); |
|
129 | + /** |
|
130 | + * Convert a UTF-8 string to a UCS-4 codepoint array |
|
131 | + * |
|
132 | + * Based on Requests_IRI::replace_invalid_with_pct_encoding() |
|
133 | + * |
|
134 | + * @throws Requests_Exception Invalid UTF-8 codepoint (`idna.invalidcodepoint`) |
|
135 | + * @param string $input |
|
136 | + * @return array Unicode code points |
|
137 | + */ |
|
138 | + protected static function utf8_to_codepoints($input) { |
|
139 | + $codepoints = array(); |
|
140 | 140 | |
141 | - // Get number of bytes |
|
142 | - $strlen = strlen($input); |
|
141 | + // Get number of bytes |
|
142 | + $strlen = strlen($input); |
|
143 | 143 | |
144 | - for ($position = 0; $position < $strlen; $position++) { |
|
145 | - $value = ord($input[$position]); |
|
144 | + for ($position = 0; $position < $strlen; $position++) { |
|
145 | + $value = ord($input[$position]); |
|
146 | 146 | |
147 | - // One byte sequence: |
|
148 | - if ((~$value & 0x80) === 0x80) { |
|
149 | - $character = $value; |
|
150 | - $length = 1; |
|
151 | - $remaining = 0; |
|
152 | - } |
|
153 | - // Two byte sequence: |
|
154 | - elseif (($value & 0xE0) === 0xC0) { |
|
155 | - $character = ($value & 0x1F) << 6; |
|
156 | - $length = 2; |
|
157 | - $remaining = 1; |
|
158 | - } |
|
159 | - // Three byte sequence: |
|
160 | - elseif (($value & 0xF0) === 0xE0) { |
|
161 | - $character = ($value & 0x0F) << 12; |
|
162 | - $length = 3; |
|
163 | - $remaining = 2; |
|
164 | - } |
|
165 | - // Four byte sequence: |
|
166 | - elseif (($value & 0xF8) === 0xF0) { |
|
167 | - $character = ($value & 0x07) << 18; |
|
168 | - $length = 4; |
|
169 | - $remaining = 3; |
|
170 | - } |
|
171 | - // Invalid byte: |
|
172 | - else { |
|
173 | - throw new Requests_Exception('Invalid Unicode codepoint', 'idna.invalidcodepoint', $value); |
|
174 | - } |
|
147 | + // One byte sequence: |
|
148 | + if ((~$value & 0x80) === 0x80) { |
|
149 | + $character = $value; |
|
150 | + $length = 1; |
|
151 | + $remaining = 0; |
|
152 | + } |
|
153 | + // Two byte sequence: |
|
154 | + elseif (($value & 0xE0) === 0xC0) { |
|
155 | + $character = ($value & 0x1F) << 6; |
|
156 | + $length = 2; |
|
157 | + $remaining = 1; |
|
158 | + } |
|
159 | + // Three byte sequence: |
|
160 | + elseif (($value & 0xF0) === 0xE0) { |
|
161 | + $character = ($value & 0x0F) << 12; |
|
162 | + $length = 3; |
|
163 | + $remaining = 2; |
|
164 | + } |
|
165 | + // Four byte sequence: |
|
166 | + elseif (($value & 0xF8) === 0xF0) { |
|
167 | + $character = ($value & 0x07) << 18; |
|
168 | + $length = 4; |
|
169 | + $remaining = 3; |
|
170 | + } |
|
171 | + // Invalid byte: |
|
172 | + else { |
|
173 | + throw new Requests_Exception('Invalid Unicode codepoint', 'idna.invalidcodepoint', $value); |
|
174 | + } |
|
175 | 175 | |
176 | - if ($remaining > 0) { |
|
177 | - if ($position + $length > $strlen) { |
|
178 | - throw new Requests_Exception('Invalid Unicode codepoint', 'idna.invalidcodepoint', $character); |
|
179 | - } |
|
180 | - for ($position++; $remaining > 0; $position++) { |
|
181 | - $value = ord($input[$position]); |
|
176 | + if ($remaining > 0) { |
|
177 | + if ($position + $length > $strlen) { |
|
178 | + throw new Requests_Exception('Invalid Unicode codepoint', 'idna.invalidcodepoint', $character); |
|
179 | + } |
|
180 | + for ($position++; $remaining > 0; $position++) { |
|
181 | + $value = ord($input[$position]); |
|
182 | 182 | |
183 | - // If it is invalid, count the sequence as invalid and reprocess the current byte: |
|
184 | - if (($value & 0xC0) !== 0x80) { |
|
185 | - throw new Requests_Exception('Invalid Unicode codepoint', 'idna.invalidcodepoint', $character); |
|
186 | - } |
|
183 | + // If it is invalid, count the sequence as invalid and reprocess the current byte: |
|
184 | + if (($value & 0xC0) !== 0x80) { |
|
185 | + throw new Requests_Exception('Invalid Unicode codepoint', 'idna.invalidcodepoint', $character); |
|
186 | + } |
|
187 | 187 | |
188 | - $character |= ($value & 0x3F) << (--$remaining * 6); |
|
189 | - } |
|
190 | - $position--; |
|
191 | - } |
|
188 | + $character |= ($value & 0x3F) << (--$remaining * 6); |
|
189 | + } |
|
190 | + $position--; |
|
191 | + } |
|
192 | 192 | |
193 | - if ( |
|
194 | - // Non-shortest form sequences are invalid |
|
195 | - $length > 1 && $character <= 0x7F |
|
196 | - || $length > 2 && $character <= 0x7FF |
|
197 | - || $length > 3 && $character <= 0xFFFF |
|
198 | - // Outside of range of ucschar codepoints |
|
199 | - // Noncharacters |
|
200 | - || ($character & 0xFFFE) === 0xFFFE |
|
201 | - || $character >= 0xFDD0 && $character <= 0xFDEF |
|
202 | - || ( |
|
203 | - // Everything else not in ucschar |
|
204 | - $character > 0xD7FF && $character < 0xF900 |
|
205 | - || $character < 0x20 |
|
206 | - || $character > 0x7E && $character < 0xA0 |
|
207 | - || $character > 0xEFFFD |
|
208 | - ) |
|
209 | - ) { |
|
210 | - throw new Requests_Exception('Invalid Unicode codepoint', 'idna.invalidcodepoint', $character); |
|
211 | - } |
|
193 | + if ( |
|
194 | + // Non-shortest form sequences are invalid |
|
195 | + $length > 1 && $character <= 0x7F |
|
196 | + || $length > 2 && $character <= 0x7FF |
|
197 | + || $length > 3 && $character <= 0xFFFF |
|
198 | + // Outside of range of ucschar codepoints |
|
199 | + // Noncharacters |
|
200 | + || ($character & 0xFFFE) === 0xFFFE |
|
201 | + || $character >= 0xFDD0 && $character <= 0xFDEF |
|
202 | + || ( |
|
203 | + // Everything else not in ucschar |
|
204 | + $character > 0xD7FF && $character < 0xF900 |
|
205 | + || $character < 0x20 |
|
206 | + || $character > 0x7E && $character < 0xA0 |
|
207 | + || $character > 0xEFFFD |
|
208 | + ) |
|
209 | + ) { |
|
210 | + throw new Requests_Exception('Invalid Unicode codepoint', 'idna.invalidcodepoint', $character); |
|
211 | + } |
|
212 | 212 | |
213 | - $codepoints[] = $character; |
|
214 | - } |
|
213 | + $codepoints[] = $character; |
|
214 | + } |
|
215 | 215 | |
216 | - return $codepoints; |
|
217 | - } |
|
216 | + return $codepoints; |
|
217 | + } |
|
218 | 218 | |
219 | - /** |
|
220 | - * RFC3492-compliant encoder |
|
221 | - * |
|
222 | - * @internal Pseudo-code from Section 6.3 is commented with "#" next to relevant code |
|
223 | - * @throws Requests_Exception On character outside of the domain (never happens with Punycode) (`idna.character_outside_domain`) |
|
224 | - * |
|
225 | - * @param string $input UTF-8 encoded string to encode |
|
226 | - * @return string Punycode-encoded string |
|
227 | - */ |
|
228 | - public static function punycode_encode($input) { |
|
229 | - $output = ''; |
|
219 | + /** |
|
220 | + * RFC3492-compliant encoder |
|
221 | + * |
|
222 | + * @internal Pseudo-code from Section 6.3 is commented with "#" next to relevant code |
|
223 | + * @throws Requests_Exception On character outside of the domain (never happens with Punycode) (`idna.character_outside_domain`) |
|
224 | + * |
|
225 | + * @param string $input UTF-8 encoded string to encode |
|
226 | + * @return string Punycode-encoded string |
|
227 | + */ |
|
228 | + public static function punycode_encode($input) { |
|
229 | + $output = ''; |
|
230 | 230 | # let n = initial_n |
231 | - $n = self::BOOTSTRAP_INITIAL_N; |
|
231 | + $n = self::BOOTSTRAP_INITIAL_N; |
|
232 | 232 | # let delta = 0 |
233 | - $delta = 0; |
|
233 | + $delta = 0; |
|
234 | 234 | # let bias = initial_bias |
235 | - $bias = self::BOOTSTRAP_INITIAL_BIAS; |
|
235 | + $bias = self::BOOTSTRAP_INITIAL_BIAS; |
|
236 | 236 | # let h = b = the number of basic code points in the input |
237 | - $h = $b = 0; // see loop |
|
237 | + $h = $b = 0; // see loop |
|
238 | 238 | # copy them to the output in order |
239 | - $codepoints = self::utf8_to_codepoints($input); |
|
240 | - $extended = array(); |
|
239 | + $codepoints = self::utf8_to_codepoints($input); |
|
240 | + $extended = array(); |
|
241 | 241 | |
242 | - foreach ($codepoints as $char) { |
|
243 | - if ($char < 128) { |
|
244 | - // Character is valid ASCII |
|
245 | - // TODO: this should also check if it's valid for a URL |
|
246 | - $output .= chr($char); |
|
247 | - $h++; |
|
248 | - } |
|
249 | - // Check if the character is non-ASCII, but below initial n |
|
250 | - // This never occurs for Punycode, so ignore in coverage |
|
251 | - // @codeCoverageIgnoreStart |
|
252 | - elseif ($char < $n) { |
|
253 | - throw new Requests_Exception('Invalid character', 'idna.character_outside_domain', $char); |
|
254 | - } |
|
255 | - // @codeCoverageIgnoreEnd |
|
256 | - else { |
|
257 | - $extended[$char] = true; |
|
258 | - } |
|
259 | - } |
|
260 | - $extended = array_keys($extended); |
|
261 | - sort($extended); |
|
262 | - $b = $h; |
|
242 | + foreach ($codepoints as $char) { |
|
243 | + if ($char < 128) { |
|
244 | + // Character is valid ASCII |
|
245 | + // TODO: this should also check if it's valid for a URL |
|
246 | + $output .= chr($char); |
|
247 | + $h++; |
|
248 | + } |
|
249 | + // Check if the character is non-ASCII, but below initial n |
|
250 | + // This never occurs for Punycode, so ignore in coverage |
|
251 | + // @codeCoverageIgnoreStart |
|
252 | + elseif ($char < $n) { |
|
253 | + throw new Requests_Exception('Invalid character', 'idna.character_outside_domain', $char); |
|
254 | + } |
|
255 | + // @codeCoverageIgnoreEnd |
|
256 | + else { |
|
257 | + $extended[$char] = true; |
|
258 | + } |
|
259 | + } |
|
260 | + $extended = array_keys($extended); |
|
261 | + sort($extended); |
|
262 | + $b = $h; |
|
263 | 263 | # [copy them] followed by a delimiter if b > 0 |
264 | - if (strlen($output) > 0) { |
|
265 | - $output .= '-'; |
|
266 | - } |
|
264 | + if (strlen($output) > 0) { |
|
265 | + $output .= '-'; |
|
266 | + } |
|
267 | 267 | # {if the input contains a non-basic code point < n then fail} |
268 | 268 | # while h < length(input) do begin |
269 | - while ($h < count($codepoints)) { |
|
269 | + while ($h < count($codepoints)) { |
|
270 | 270 | # let m = the minimum code point >= n in the input |
271 | - $m = array_shift($extended); |
|
272 | - //printf('next code point to insert is %s' . PHP_EOL, dechex($m)); |
|
271 | + $m = array_shift($extended); |
|
272 | + //printf('next code point to insert is %s' . PHP_EOL, dechex($m)); |
|
273 | 273 | # let delta = delta + (m - n) * (h + 1), fail on overflow |
274 | - $delta += ($m - $n) * ($h + 1); |
|
274 | + $delta += ($m - $n) * ($h + 1); |
|
275 | 275 | # let n = m |
276 | - $n = $m; |
|
276 | + $n = $m; |
|
277 | 277 | # for each code point c in the input (in order) do begin |
278 | - for ($num = 0; $num < count($codepoints); $num++) { |
|
279 | - $c = $codepoints[$num]; |
|
278 | + for ($num = 0; $num < count($codepoints); $num++) { |
|
279 | + $c = $codepoints[$num]; |
|
280 | 280 | # if c < n then increment delta, fail on overflow |
281 | - if ($c < $n) { |
|
282 | - $delta++; |
|
283 | - } |
|
281 | + if ($c < $n) { |
|
282 | + $delta++; |
|
283 | + } |
|
284 | 284 | # if c == n then begin |
285 | - elseif ($c === $n) { |
|
285 | + elseif ($c === $n) { |
|
286 | 286 | # let q = delta |
287 | - $q = $delta; |
|
287 | + $q = $delta; |
|
288 | 288 | # for k = base to infinity in steps of base do begin |
289 | - for ($k = self::BOOTSTRAP_BASE; ; $k += self::BOOTSTRAP_BASE) { |
|
289 | + for ($k = self::BOOTSTRAP_BASE; ; $k += self::BOOTSTRAP_BASE) { |
|
290 | 290 | # let t = tmin if k <= bias {+ tmin}, or |
291 | 291 | # tmax if k >= bias + tmax, or k - bias otherwise |
292 | - if ($k <= ($bias + self::BOOTSTRAP_TMIN)) { |
|
293 | - $t = self::BOOTSTRAP_TMIN; |
|
294 | - } |
|
295 | - elseif ($k >= ($bias + self::BOOTSTRAP_TMAX)) { |
|
296 | - $t = self::BOOTSTRAP_TMAX; |
|
297 | - } |
|
298 | - else { |
|
299 | - $t = $k - $bias; |
|
300 | - } |
|
292 | + if ($k <= ($bias + self::BOOTSTRAP_TMIN)) { |
|
293 | + $t = self::BOOTSTRAP_TMIN; |
|
294 | + } |
|
295 | + elseif ($k >= ($bias + self::BOOTSTRAP_TMAX)) { |
|
296 | + $t = self::BOOTSTRAP_TMAX; |
|
297 | + } |
|
298 | + else { |
|
299 | + $t = $k - $bias; |
|
300 | + } |
|
301 | 301 | # if q < t then break |
302 | - if ($q < $t) { |
|
303 | - break; |
|
304 | - } |
|
302 | + if ($q < $t) { |
|
303 | + break; |
|
304 | + } |
|
305 | 305 | # output the code point for digit t + ((q - t) mod (base - t)) |
306 | - $digit = $t + (($q - $t) % (self::BOOTSTRAP_BASE - $t)); |
|
307 | - $output .= self::digit_to_char($digit); |
|
306 | + $digit = $t + (($q - $t) % (self::BOOTSTRAP_BASE - $t)); |
|
307 | + $output .= self::digit_to_char($digit); |
|
308 | 308 | # let q = (q - t) div (base - t) |
309 | - $q = floor(($q - $t) / (self::BOOTSTRAP_BASE - $t)); |
|
309 | + $q = floor(($q - $t) / (self::BOOTSTRAP_BASE - $t)); |
|
310 | 310 | # end |
311 | - } |
|
311 | + } |
|
312 | 312 | # output the code point for digit q |
313 | - $output .= self::digit_to_char($q); |
|
313 | + $output .= self::digit_to_char($q); |
|
314 | 314 | # let bias = adapt(delta, h + 1, test h equals b?) |
315 | - $bias = self::adapt($delta, $h + 1, $h === $b); |
|
315 | + $bias = self::adapt($delta, $h + 1, $h === $b); |
|
316 | 316 | # let delta = 0 |
317 | - $delta = 0; |
|
317 | + $delta = 0; |
|
318 | 318 | # increment h |
319 | - $h++; |
|
319 | + $h++; |
|
320 | 320 | # end |
321 | - } |
|
321 | + } |
|
322 | 322 | # end |
323 | - } |
|
323 | + } |
|
324 | 324 | # increment delta and n |
325 | - $delta++; |
|
326 | - $n++; |
|
325 | + $delta++; |
|
326 | + $n++; |
|
327 | 327 | # end |
328 | - } |
|
328 | + } |
|
329 | 329 | |
330 | - return $output; |
|
331 | - } |
|
330 | + return $output; |
|
331 | + } |
|
332 | 332 | |
333 | - /** |
|
334 | - * Convert a digit to its respective character |
|
335 | - * |
|
336 | - * @see https://tools.ietf.org/html/rfc3492#section-5 |
|
337 | - * @throws Requests_Exception On invalid digit (`idna.invalid_digit`) |
|
338 | - * |
|
339 | - * @param int $digit Digit in the range 0-35 |
|
340 | - * @return string Single character corresponding to digit |
|
341 | - */ |
|
342 | - protected static function digit_to_char($digit) { |
|
343 | - // @codeCoverageIgnoreStart |
|
344 | - // As far as I know, this never happens, but still good to be sure. |
|
345 | - if ($digit < 0 || $digit > 35) { |
|
346 | - throw new Requests_Exception(sprintf('Invalid digit %d', $digit), 'idna.invalid_digit', $digit); |
|
347 | - } |
|
348 | - // @codeCoverageIgnoreEnd |
|
349 | - $digits = 'abcdefghijklmnopqrstuvwxyz0123456789'; |
|
350 | - return substr($digits, $digit, 1); |
|
351 | - } |
|
333 | + /** |
|
334 | + * Convert a digit to its respective character |
|
335 | + * |
|
336 | + * @see https://tools.ietf.org/html/rfc3492#section-5 |
|
337 | + * @throws Requests_Exception On invalid digit (`idna.invalid_digit`) |
|
338 | + * |
|
339 | + * @param int $digit Digit in the range 0-35 |
|
340 | + * @return string Single character corresponding to digit |
|
341 | + */ |
|
342 | + protected static function digit_to_char($digit) { |
|
343 | + // @codeCoverageIgnoreStart |
|
344 | + // As far as I know, this never happens, but still good to be sure. |
|
345 | + if ($digit < 0 || $digit > 35) { |
|
346 | + throw new Requests_Exception(sprintf('Invalid digit %d', $digit), 'idna.invalid_digit', $digit); |
|
347 | + } |
|
348 | + // @codeCoverageIgnoreEnd |
|
349 | + $digits = 'abcdefghijklmnopqrstuvwxyz0123456789'; |
|
350 | + return substr($digits, $digit, 1); |
|
351 | + } |
|
352 | 352 | |
353 | - /** |
|
354 | - * Adapt the bias |
|
355 | - * |
|
356 | - * @see https://tools.ietf.org/html/rfc3492#section-6.1 |
|
357 | - * @param int $delta |
|
358 | - * @param int $numpoints |
|
359 | - * @param bool $firsttime |
|
360 | - * @return int New bias |
|
361 | - */ |
|
362 | - protected static function adapt($delta, $numpoints, $firsttime) { |
|
353 | + /** |
|
354 | + * Adapt the bias |
|
355 | + * |
|
356 | + * @see https://tools.ietf.org/html/rfc3492#section-6.1 |
|
357 | + * @param int $delta |
|
358 | + * @param int $numpoints |
|
359 | + * @param bool $firsttime |
|
360 | + * @return int New bias |
|
361 | + */ |
|
362 | + protected static function adapt($delta, $numpoints, $firsttime) { |
|
363 | 363 | # function adapt(delta,numpoints,firsttime): |
364 | 364 | # if firsttime then let delta = delta div damp |
365 | - if ($firsttime) { |
|
366 | - $delta = floor($delta / self::BOOTSTRAP_DAMP); |
|
367 | - } |
|
365 | + if ($firsttime) { |
|
366 | + $delta = floor($delta / self::BOOTSTRAP_DAMP); |
|
367 | + } |
|
368 | 368 | # else let delta = delta div 2 |
369 | - else { |
|
370 | - $delta = floor($delta / 2); |
|
371 | - } |
|
369 | + else { |
|
370 | + $delta = floor($delta / 2); |
|
371 | + } |
|
372 | 372 | # let delta = delta + (delta div numpoints) |
373 | - $delta += floor($delta / $numpoints); |
|
373 | + $delta += floor($delta / $numpoints); |
|
374 | 374 | # let k = 0 |
375 | - $k = 0; |
|
375 | + $k = 0; |
|
376 | 376 | # while delta > ((base - tmin) * tmax) div 2 do begin |
377 | - $max = floor(((self::BOOTSTRAP_BASE - self::BOOTSTRAP_TMIN) * self::BOOTSTRAP_TMAX) / 2); |
|
378 | - while ($delta > $max) { |
|
377 | + $max = floor(((self::BOOTSTRAP_BASE - self::BOOTSTRAP_TMIN) * self::BOOTSTRAP_TMAX) / 2); |
|
378 | + while ($delta > $max) { |
|
379 | 379 | # let delta = delta div (base - tmin) |
380 | - $delta = floor($delta / (self::BOOTSTRAP_BASE - self::BOOTSTRAP_TMIN)); |
|
380 | + $delta = floor($delta / (self::BOOTSTRAP_BASE - self::BOOTSTRAP_TMIN)); |
|
381 | 381 | # let k = k + base |
382 | - $k += self::BOOTSTRAP_BASE; |
|
382 | + $k += self::BOOTSTRAP_BASE; |
|
383 | 383 | # end |
384 | - } |
|
384 | + } |
|
385 | 385 | # return k + (((base - tmin + 1) * delta) div (delta + skew)) |
386 | - return $k + floor(((self::BOOTSTRAP_BASE - self::BOOTSTRAP_TMIN + 1) * $delta) / ($delta + self::BOOTSTRAP_SKEW)); |
|
387 | - } |
|
386 | + return $k + floor(((self::BOOTSTRAP_BASE - self::BOOTSTRAP_TMIN + 1) * $delta) / ($delta + self::BOOTSTRAP_SKEW)); |
|
387 | + } |
|
388 | 388 | } |
389 | 389 | \ No newline at end of file |
@@ -19,15 +19,15 @@ |
||
19 | 19 | * @subpackage Authentication |
20 | 20 | */ |
21 | 21 | interface Requests_Auth { |
22 | - /** |
|
23 | - * Register hooks as needed |
|
24 | - * |
|
25 | - * This method is called in {@see Requests::request} when the user has set |
|
26 | - * an instance as the 'auth' option. Use this callback to register all the |
|
27 | - * hooks you'll need. |
|
28 | - * |
|
29 | - * @see Requests_Hooks::register |
|
30 | - * @param Requests_Hooks $hooks Hook system |
|
31 | - */ |
|
32 | - public function register(Requests_Hooks &$hooks); |
|
22 | + /** |
|
23 | + * Register hooks as needed |
|
24 | + * |
|
25 | + * This method is called in {@see Requests::request} when the user has set |
|
26 | + * an instance as the 'auth' option. Use this callback to register all the |
|
27 | + * hooks you'll need. |
|
28 | + * |
|
29 | + * @see Requests_Hooks::register |
|
30 | + * @param Requests_Hooks $hooks Hook system |
|
31 | + */ |
|
32 | + public function register(Requests_Hooks &$hooks); |
|
33 | 33 | } |
34 | 34 | \ No newline at end of file |
@@ -13,109 +13,109 @@ |
||
13 | 13 | * @package Requests |
14 | 14 | */ |
15 | 15 | class Requests_Response { |
16 | - /** |
|
17 | - * Constructor |
|
18 | - */ |
|
19 | - public function __construct() { |
|
20 | - $this->headers = new Requests_Response_Headers(); |
|
21 | - $this->cookies = new Requests_Cookie_Jar(); |
|
22 | - } |
|
16 | + /** |
|
17 | + * Constructor |
|
18 | + */ |
|
19 | + public function __construct() { |
|
20 | + $this->headers = new Requests_Response_Headers(); |
|
21 | + $this->cookies = new Requests_Cookie_Jar(); |
|
22 | + } |
|
23 | 23 | |
24 | - /** |
|
25 | - * Response body |
|
26 | - * |
|
27 | - * @var string |
|
28 | - */ |
|
29 | - public $body = ''; |
|
24 | + /** |
|
25 | + * Response body |
|
26 | + * |
|
27 | + * @var string |
|
28 | + */ |
|
29 | + public $body = ''; |
|
30 | 30 | |
31 | - /** |
|
32 | - * Raw HTTP data from the transport |
|
33 | - * |
|
34 | - * @var string |
|
35 | - */ |
|
36 | - public $raw = ''; |
|
31 | + /** |
|
32 | + * Raw HTTP data from the transport |
|
33 | + * |
|
34 | + * @var string |
|
35 | + */ |
|
36 | + public $raw = ''; |
|
37 | 37 | |
38 | - /** |
|
39 | - * Headers, as an associative array |
|
40 | - * |
|
41 | - * @var Requests_Response_Headers Array-like object representing headers |
|
42 | - */ |
|
43 | - public $headers = array(); |
|
38 | + /** |
|
39 | + * Headers, as an associative array |
|
40 | + * |
|
41 | + * @var Requests_Response_Headers Array-like object representing headers |
|
42 | + */ |
|
43 | + public $headers = array(); |
|
44 | 44 | |
45 | - /** |
|
46 | - * Status code, false if non-blocking |
|
47 | - * |
|
48 | - * @var integer|boolean |
|
49 | - */ |
|
50 | - public $status_code = false; |
|
45 | + /** |
|
46 | + * Status code, false if non-blocking |
|
47 | + * |
|
48 | + * @var integer|boolean |
|
49 | + */ |
|
50 | + public $status_code = false; |
|
51 | 51 | |
52 | - /** |
|
53 | - * Protocol version, false if non-blocking |
|
54 | - * @var float|boolean |
|
55 | - */ |
|
56 | - public $protocol_version = false; |
|
52 | + /** |
|
53 | + * Protocol version, false if non-blocking |
|
54 | + * @var float|boolean |
|
55 | + */ |
|
56 | + public $protocol_version = false; |
|
57 | 57 | |
58 | - /** |
|
59 | - * Whether the request succeeded or not |
|
60 | - * |
|
61 | - * @var boolean |
|
62 | - */ |
|
63 | - public $success = false; |
|
58 | + /** |
|
59 | + * Whether the request succeeded or not |
|
60 | + * |
|
61 | + * @var boolean |
|
62 | + */ |
|
63 | + public $success = false; |
|
64 | 64 | |
65 | - /** |
|
66 | - * Number of redirects the request used |
|
67 | - * |
|
68 | - * @var integer |
|
69 | - */ |
|
70 | - public $redirects = 0; |
|
65 | + /** |
|
66 | + * Number of redirects the request used |
|
67 | + * |
|
68 | + * @var integer |
|
69 | + */ |
|
70 | + public $redirects = 0; |
|
71 | 71 | |
72 | - /** |
|
73 | - * URL requested |
|
74 | - * |
|
75 | - * @var string |
|
76 | - */ |
|
77 | - public $url = ''; |
|
72 | + /** |
|
73 | + * URL requested |
|
74 | + * |
|
75 | + * @var string |
|
76 | + */ |
|
77 | + public $url = ''; |
|
78 | 78 | |
79 | - /** |
|
80 | - * Previous requests (from redirects) |
|
81 | - * |
|
82 | - * @var array Array of Requests_Response objects |
|
83 | - */ |
|
84 | - public $history = array(); |
|
79 | + /** |
|
80 | + * Previous requests (from redirects) |
|
81 | + * |
|
82 | + * @var array Array of Requests_Response objects |
|
83 | + */ |
|
84 | + public $history = array(); |
|
85 | 85 | |
86 | - /** |
|
87 | - * Cookies from the request |
|
88 | - * |
|
89 | - * @var Requests_Cookie_Jar Array-like object representing a cookie jar |
|
90 | - */ |
|
91 | - public $cookies = array(); |
|
86 | + /** |
|
87 | + * Cookies from the request |
|
88 | + * |
|
89 | + * @var Requests_Cookie_Jar Array-like object representing a cookie jar |
|
90 | + */ |
|
91 | + public $cookies = array(); |
|
92 | 92 | |
93 | - /** |
|
94 | - * Is the response a redirect? |
|
95 | - * |
|
96 | - * @return boolean True if redirect (3xx status), false if not. |
|
97 | - */ |
|
98 | - public function is_redirect() { |
|
99 | - $code = $this->status_code; |
|
100 | - return in_array($code, array(300, 301, 302, 303, 307)) || $code > 307 && $code < 400; |
|
101 | - } |
|
93 | + /** |
|
94 | + * Is the response a redirect? |
|
95 | + * |
|
96 | + * @return boolean True if redirect (3xx status), false if not. |
|
97 | + */ |
|
98 | + public function is_redirect() { |
|
99 | + $code = $this->status_code; |
|
100 | + return in_array($code, array(300, 301, 302, 303, 307)) || $code > 307 && $code < 400; |
|
101 | + } |
|
102 | 102 | |
103 | - /** |
|
104 | - * Throws an exception if the request was not successful |
|
105 | - * |
|
106 | - * @throws Requests_Exception If `$allow_redirects` is false, and code is 3xx (`response.no_redirects`) |
|
107 | - * @throws Requests_Exception_HTTP On non-successful status code. Exception class corresponds to code (e.g. {@see Requests_Exception_HTTP_404}) |
|
108 | - * @param boolean $allow_redirects Set to false to throw on a 3xx as well |
|
109 | - */ |
|
110 | - public function throw_for_status($allow_redirects = true) { |
|
111 | - if ($this->is_redirect()) { |
|
112 | - if (!$allow_redirects) { |
|
113 | - throw new Requests_Exception('Redirection not allowed', 'response.no_redirects', $this); |
|
114 | - } |
|
115 | - } |
|
116 | - elseif (!$this->success) { |
|
117 | - $exception = Requests_Exception_HTTP::get_class($this->status_code); |
|
118 | - throw new $exception(null, $this); |
|
119 | - } |
|
120 | - } |
|
103 | + /** |
|
104 | + * Throws an exception if the request was not successful |
|
105 | + * |
|
106 | + * @throws Requests_Exception If `$allow_redirects` is false, and code is 3xx (`response.no_redirects`) |
|
107 | + * @throws Requests_Exception_HTTP On non-successful status code. Exception class corresponds to code (e.g. {@see Requests_Exception_HTTP_404}) |
|
108 | + * @param boolean $allow_redirects Set to false to throw on a 3xx as well |
|
109 | + */ |
|
110 | + public function throw_for_status($allow_redirects = true) { |
|
111 | + if ($this->is_redirect()) { |
|
112 | + if (!$allow_redirects) { |
|
113 | + throw new Requests_Exception('Redirection not allowed', 'response.no_redirects', $this); |
|
114 | + } |
|
115 | + } |
|
116 | + elseif (!$this->success) { |
|
117 | + $exception = Requests_Exception_HTTP::get_class($this->status_code); |
|
118 | + throw new $exception(null, $this); |
|
119 | + } |
|
120 | + } |
|
121 | 121 | } |
@@ -16,73 +16,73 @@ |
||
16 | 16 | * @subpackage Authentication |
17 | 17 | */ |
18 | 18 | class Requests_Auth_Basic implements Requests_Auth { |
19 | - /** |
|
20 | - * Username |
|
21 | - * |
|
22 | - * @var string |
|
23 | - */ |
|
24 | - public $user; |
|
19 | + /** |
|
20 | + * Username |
|
21 | + * |
|
22 | + * @var string |
|
23 | + */ |
|
24 | + public $user; |
|
25 | 25 | |
26 | - /** |
|
27 | - * Password |
|
28 | - * |
|
29 | - * @var string |
|
30 | - */ |
|
31 | - public $pass; |
|
26 | + /** |
|
27 | + * Password |
|
28 | + * |
|
29 | + * @var string |
|
30 | + */ |
|
31 | + public $pass; |
|
32 | 32 | |
33 | - /** |
|
34 | - * Constructor |
|
35 | - * |
|
36 | - * @throws Requests_Exception On incorrect number of arguments (`authbasicbadargs`) |
|
37 | - * @param array|null $args Array of user and password. Must have exactly two elements |
|
38 | - */ |
|
39 | - public function __construct($args = null) { |
|
40 | - if (is_array($args)) { |
|
41 | - if (count($args) !== 2) { |
|
42 | - throw new Requests_Exception('Invalid number of arguments', 'authbasicbadargs'); |
|
43 | - } |
|
33 | + /** |
|
34 | + * Constructor |
|
35 | + * |
|
36 | + * @throws Requests_Exception On incorrect number of arguments (`authbasicbadargs`) |
|
37 | + * @param array|null $args Array of user and password. Must have exactly two elements |
|
38 | + */ |
|
39 | + public function __construct($args = null) { |
|
40 | + if (is_array($args)) { |
|
41 | + if (count($args) !== 2) { |
|
42 | + throw new Requests_Exception('Invalid number of arguments', 'authbasicbadargs'); |
|
43 | + } |
|
44 | 44 | |
45 | - list($this->user, $this->pass) = $args; |
|
46 | - } |
|
47 | - } |
|
45 | + list($this->user, $this->pass) = $args; |
|
46 | + } |
|
47 | + } |
|
48 | 48 | |
49 | - /** |
|
50 | - * Register the necessary callbacks |
|
51 | - * |
|
52 | - * @see curl_before_send |
|
53 | - * @see fsockopen_header |
|
54 | - * @param Requests_Hooks $hooks Hook system |
|
55 | - */ |
|
56 | - public function register(Requests_Hooks &$hooks) { |
|
57 | - $hooks->register('curl.before_send', array(&$this, 'curl_before_send')); |
|
58 | - $hooks->register('fsockopen.after_headers', array(&$this, 'fsockopen_header')); |
|
59 | - } |
|
49 | + /** |
|
50 | + * Register the necessary callbacks |
|
51 | + * |
|
52 | + * @see curl_before_send |
|
53 | + * @see fsockopen_header |
|
54 | + * @param Requests_Hooks $hooks Hook system |
|
55 | + */ |
|
56 | + public function register(Requests_Hooks &$hooks) { |
|
57 | + $hooks->register('curl.before_send', array(&$this, 'curl_before_send')); |
|
58 | + $hooks->register('fsockopen.after_headers', array(&$this, 'fsockopen_header')); |
|
59 | + } |
|
60 | 60 | |
61 | - /** |
|
62 | - * Set cURL parameters before the data is sent |
|
63 | - * |
|
64 | - * @param resource $handle cURL resource |
|
65 | - */ |
|
66 | - public function curl_before_send(&$handle) { |
|
67 | - curl_setopt($handle, CURLOPT_HTTPAUTH, CURLAUTH_BASIC); |
|
68 | - curl_setopt($handle, CURLOPT_USERPWD, $this->getAuthString()); |
|
69 | - } |
|
61 | + /** |
|
62 | + * Set cURL parameters before the data is sent |
|
63 | + * |
|
64 | + * @param resource $handle cURL resource |
|
65 | + */ |
|
66 | + public function curl_before_send(&$handle) { |
|
67 | + curl_setopt($handle, CURLOPT_HTTPAUTH, CURLAUTH_BASIC); |
|
68 | + curl_setopt($handle, CURLOPT_USERPWD, $this->getAuthString()); |
|
69 | + } |
|
70 | 70 | |
71 | - /** |
|
72 | - * Add extra headers to the request before sending |
|
73 | - * |
|
74 | - * @param string $out HTTP header string |
|
75 | - */ |
|
76 | - public function fsockopen_header(&$out) { |
|
77 | - $out .= sprintf("Authorization: Basic %s\r\n", base64_encode($this->getAuthString())); |
|
78 | - } |
|
71 | + /** |
|
72 | + * Add extra headers to the request before sending |
|
73 | + * |
|
74 | + * @param string $out HTTP header string |
|
75 | + */ |
|
76 | + public function fsockopen_header(&$out) { |
|
77 | + $out .= sprintf("Authorization: Basic %s\r\n", base64_encode($this->getAuthString())); |
|
78 | + } |
|
79 | 79 | |
80 | - /** |
|
81 | - * Get the authentication string (user:pass) |
|
82 | - * |
|
83 | - * @return string |
|
84 | - */ |
|
85 | - public function getAuthString() { |
|
86 | - return $this->user . ':' . $this->pass; |
|
87 | - } |
|
80 | + /** |
|
81 | + * Get the authentication string (user:pass) |
|
82 | + * |
|
83 | + * @return string |
|
84 | + */ |
|
85 | + public function getAuthString() { |
|
86 | + return $this->user . ':' . $this->pass; |
|
87 | + } |
|
88 | 88 | } |
89 | 89 | \ No newline at end of file |
@@ -13,163 +13,163 @@ |
||
13 | 13 | * @subpackage Cookies |
14 | 14 | */ |
15 | 15 | class Requests_Cookie_Jar implements ArrayAccess, IteratorAggregate { |
16 | - /** |
|
17 | - * Actual item data |
|
18 | - * |
|
19 | - * @var array |
|
20 | - */ |
|
21 | - protected $cookies = array(); |
|
22 | - |
|
23 | - /** |
|
24 | - * Create a new jar |
|
25 | - * |
|
26 | - * @param array $cookies Existing cookie values |
|
27 | - */ |
|
28 | - public function __construct($cookies = array()) { |
|
29 | - $this->cookies = $cookies; |
|
30 | - } |
|
31 | - |
|
32 | - /** |
|
33 | - * Normalise cookie data into a Requests_Cookie |
|
34 | - * |
|
35 | - * @param string|Requests_Cookie $cookie |
|
36 | - * @return Requests_Cookie |
|
37 | - */ |
|
38 | - public function normalize_cookie($cookie, $key = null) { |
|
39 | - if ($cookie instanceof Requests_Cookie) { |
|
40 | - return $cookie; |
|
41 | - } |
|
42 | - |
|
43 | - return Requests_Cookie::parse($cookie, $key); |
|
44 | - } |
|
45 | - |
|
46 | - /** |
|
47 | - * Normalise cookie data into a Requests_Cookie |
|
48 | - * |
|
49 | - * @codeCoverageIgnore |
|
50 | - * @deprecated Use {@see Requests_Cookie_Jar::normalize_cookie} |
|
51 | - * @return Requests_Cookie |
|
52 | - */ |
|
53 | - public function normalizeCookie($cookie, $key = null) { |
|
54 | - return $this->normalize_cookie($cookie, $key); |
|
55 | - } |
|
56 | - |
|
57 | - /** |
|
58 | - * Check if the given item exists |
|
59 | - * |
|
60 | - * @param string $key Item key |
|
61 | - * @return boolean Does the item exist? |
|
62 | - */ |
|
63 | - public function offsetExists($key) { |
|
64 | - return isset($this->cookies[$key]); |
|
65 | - } |
|
66 | - |
|
67 | - /** |
|
68 | - * Get the value for the item |
|
69 | - * |
|
70 | - * @param string $key Item key |
|
71 | - * @return string Item value |
|
72 | - */ |
|
73 | - public function offsetGet($key) { |
|
74 | - if (!isset($this->cookies[$key])) { |
|
75 | - return null; |
|
76 | - } |
|
77 | - |
|
78 | - return $this->cookies[$key]; |
|
79 | - } |
|
80 | - |
|
81 | - /** |
|
82 | - * Set the given item |
|
83 | - * |
|
84 | - * @throws Requests_Exception On attempting to use dictionary as list (`invalidset`) |
|
85 | - * |
|
86 | - * @param string $key Item name |
|
87 | - * @param string $value Item value |
|
88 | - */ |
|
89 | - public function offsetSet($key, $value) { |
|
90 | - if ($key === null) { |
|
91 | - throw new Requests_Exception('Object is a dictionary, not a list', 'invalidset'); |
|
92 | - } |
|
93 | - |
|
94 | - $this->cookies[$key] = $value; |
|
95 | - } |
|
96 | - |
|
97 | - /** |
|
98 | - * Unset the given header |
|
99 | - * |
|
100 | - * @param string $key |
|
101 | - */ |
|
102 | - public function offsetUnset($key) { |
|
103 | - unset($this->cookies[$key]); |
|
104 | - } |
|
105 | - |
|
106 | - /** |
|
107 | - * Get an iterator for the data |
|
108 | - * |
|
109 | - * @return ArrayIterator |
|
110 | - */ |
|
111 | - public function getIterator() { |
|
112 | - return new ArrayIterator($this->cookies); |
|
113 | - } |
|
114 | - |
|
115 | - /** |
|
116 | - * Register the cookie handler with the request's hooking system |
|
117 | - * |
|
118 | - * @param Requests_Hooker $hooks Hooking system |
|
119 | - */ |
|
120 | - public function register(Requests_Hooker $hooks) { |
|
121 | - $hooks->register('requests.before_request', array($this, 'before_request')); |
|
122 | - $hooks->register('requests.before_redirect_check', array($this, 'before_redirect_check')); |
|
123 | - } |
|
124 | - |
|
125 | - /** |
|
126 | - * Add Cookie header to a request if we have any |
|
127 | - * |
|
128 | - * As per RFC 6265, cookies are separated by '; ' |
|
129 | - * |
|
130 | - * @param string $url |
|
131 | - * @param array $headers |
|
132 | - * @param array $data |
|
133 | - * @param string $type |
|
134 | - * @param array $options |
|
135 | - */ |
|
136 | - public function before_request($url, &$headers, &$data, &$type, &$options) { |
|
137 | - if (!$url instanceof Requests_IRI) { |
|
138 | - $url = new Requests_IRI($url); |
|
139 | - } |
|
140 | - |
|
141 | - if (!empty($this->cookies)) { |
|
142 | - $cookies = array(); |
|
143 | - foreach ($this->cookies as $key => $cookie) { |
|
144 | - $cookie = $this->normalize_cookie($cookie, $key); |
|
145 | - |
|
146 | - // Skip expired cookies |
|
147 | - if ($cookie->is_expired()) { |
|
148 | - continue; |
|
149 | - } |
|
150 | - |
|
151 | - if ($cookie->domain_matches($url->host)) { |
|
152 | - $cookies[] = $cookie->format_for_header(); |
|
153 | - } |
|
154 | - } |
|
155 | - |
|
156 | - $headers['Cookie'] = implode('; ', $cookies); |
|
157 | - } |
|
158 | - } |
|
159 | - |
|
160 | - /** |
|
161 | - * Parse all cookies from a response and attach them to the response |
|
162 | - * |
|
163 | - * @var Requests_Response $response |
|
164 | - */ |
|
165 | - public function before_redirect_check(Requests_Response &$return) { |
|
166 | - $url = $return->url; |
|
167 | - if (!$url instanceof Requests_IRI) { |
|
168 | - $url = new Requests_IRI($url); |
|
169 | - } |
|
170 | - |
|
171 | - $cookies = Requests_Cookie::parse_from_headers($return->headers, $url); |
|
172 | - $this->cookies = array_merge($this->cookies, $cookies); |
|
173 | - $return->cookies = $this; |
|
174 | - } |
|
16 | + /** |
|
17 | + * Actual item data |
|
18 | + * |
|
19 | + * @var array |
|
20 | + */ |
|
21 | + protected $cookies = array(); |
|
22 | + |
|
23 | + /** |
|
24 | + * Create a new jar |
|
25 | + * |
|
26 | + * @param array $cookies Existing cookie values |
|
27 | + */ |
|
28 | + public function __construct($cookies = array()) { |
|
29 | + $this->cookies = $cookies; |
|
30 | + } |
|
31 | + |
|
32 | + /** |
|
33 | + * Normalise cookie data into a Requests_Cookie |
|
34 | + * |
|
35 | + * @param string|Requests_Cookie $cookie |
|
36 | + * @return Requests_Cookie |
|
37 | + */ |
|
38 | + public function normalize_cookie($cookie, $key = null) { |
|
39 | + if ($cookie instanceof Requests_Cookie) { |
|
40 | + return $cookie; |
|
41 | + } |
|
42 | + |
|
43 | + return Requests_Cookie::parse($cookie, $key); |
|
44 | + } |
|
45 | + |
|
46 | + /** |
|
47 | + * Normalise cookie data into a Requests_Cookie |
|
48 | + * |
|
49 | + * @codeCoverageIgnore |
|
50 | + * @deprecated Use {@see Requests_Cookie_Jar::normalize_cookie} |
|
51 | + * @return Requests_Cookie |
|
52 | + */ |
|
53 | + public function normalizeCookie($cookie, $key = null) { |
|
54 | + return $this->normalize_cookie($cookie, $key); |
|
55 | + } |
|
56 | + |
|
57 | + /** |
|
58 | + * Check if the given item exists |
|
59 | + * |
|
60 | + * @param string $key Item key |
|
61 | + * @return boolean Does the item exist? |
|
62 | + */ |
|
63 | + public function offsetExists($key) { |
|
64 | + return isset($this->cookies[$key]); |
|
65 | + } |
|
66 | + |
|
67 | + /** |
|
68 | + * Get the value for the item |
|
69 | + * |
|
70 | + * @param string $key Item key |
|
71 | + * @return string Item value |
|
72 | + */ |
|
73 | + public function offsetGet($key) { |
|
74 | + if (!isset($this->cookies[$key])) { |
|
75 | + return null; |
|
76 | + } |
|
77 | + |
|
78 | + return $this->cookies[$key]; |
|
79 | + } |
|
80 | + |
|
81 | + /** |
|
82 | + * Set the given item |
|
83 | + * |
|
84 | + * @throws Requests_Exception On attempting to use dictionary as list (`invalidset`) |
|
85 | + * |
|
86 | + * @param string $key Item name |
|
87 | + * @param string $value Item value |
|
88 | + */ |
|
89 | + public function offsetSet($key, $value) { |
|
90 | + if ($key === null) { |
|
91 | + throw new Requests_Exception('Object is a dictionary, not a list', 'invalidset'); |
|
92 | + } |
|
93 | + |
|
94 | + $this->cookies[$key] = $value; |
|
95 | + } |
|
96 | + |
|
97 | + /** |
|
98 | + * Unset the given header |
|
99 | + * |
|
100 | + * @param string $key |
|
101 | + */ |
|
102 | + public function offsetUnset($key) { |
|
103 | + unset($this->cookies[$key]); |
|
104 | + } |
|
105 | + |
|
106 | + /** |
|
107 | + * Get an iterator for the data |
|
108 | + * |
|
109 | + * @return ArrayIterator |
|
110 | + */ |
|
111 | + public function getIterator() { |
|
112 | + return new ArrayIterator($this->cookies); |
|
113 | + } |
|
114 | + |
|
115 | + /** |
|
116 | + * Register the cookie handler with the request's hooking system |
|
117 | + * |
|
118 | + * @param Requests_Hooker $hooks Hooking system |
|
119 | + */ |
|
120 | + public function register(Requests_Hooker $hooks) { |
|
121 | + $hooks->register('requests.before_request', array($this, 'before_request')); |
|
122 | + $hooks->register('requests.before_redirect_check', array($this, 'before_redirect_check')); |
|
123 | + } |
|
124 | + |
|
125 | + /** |
|
126 | + * Add Cookie header to a request if we have any |
|
127 | + * |
|
128 | + * As per RFC 6265, cookies are separated by '; ' |
|
129 | + * |
|
130 | + * @param string $url |
|
131 | + * @param array $headers |
|
132 | + * @param array $data |
|
133 | + * @param string $type |
|
134 | + * @param array $options |
|
135 | + */ |
|
136 | + public function before_request($url, &$headers, &$data, &$type, &$options) { |
|
137 | + if (!$url instanceof Requests_IRI) { |
|
138 | + $url = new Requests_IRI($url); |
|
139 | + } |
|
140 | + |
|
141 | + if (!empty($this->cookies)) { |
|
142 | + $cookies = array(); |
|
143 | + foreach ($this->cookies as $key => $cookie) { |
|
144 | + $cookie = $this->normalize_cookie($cookie, $key); |
|
145 | + |
|
146 | + // Skip expired cookies |
|
147 | + if ($cookie->is_expired()) { |
|
148 | + continue; |
|
149 | + } |
|
150 | + |
|
151 | + if ($cookie->domain_matches($url->host)) { |
|
152 | + $cookies[] = $cookie->format_for_header(); |
|
153 | + } |
|
154 | + } |
|
155 | + |
|
156 | + $headers['Cookie'] = implode('; ', $cookies); |
|
157 | + } |
|
158 | + } |
|
159 | + |
|
160 | + /** |
|
161 | + * Parse all cookies from a response and attach them to the response |
|
162 | + * |
|
163 | + * @var Requests_Response $response |
|
164 | + */ |
|
165 | + public function before_redirect_check(Requests_Response &$return) { |
|
166 | + $url = $return->url; |
|
167 | + if (!$url instanceof Requests_IRI) { |
|
168 | + $url = new Requests_IRI($url); |
|
169 | + } |
|
170 | + |
|
171 | + $cookies = Requests_Cookie::parse_from_headers($return->headers, $url); |
|
172 | + $this->cookies = array_merge($this->cookies, $cookies); |
|
173 | + $return->cookies = $this; |
|
174 | + } |
|
175 | 175 | } |
176 | 176 | \ No newline at end of file |
@@ -18,136 +18,136 @@ discard block |
||
18 | 18 | * @subpackage Session Handler |
19 | 19 | */ |
20 | 20 | class Requests_Session { |
21 | - /** |
|
22 | - * Base URL for requests |
|
23 | - * |
|
24 | - * URLs will be made absolute using this as the base |
|
25 | - * @var string|null |
|
26 | - */ |
|
27 | - public $url = null; |
|
21 | + /** |
|
22 | + * Base URL for requests |
|
23 | + * |
|
24 | + * URLs will be made absolute using this as the base |
|
25 | + * @var string|null |
|
26 | + */ |
|
27 | + public $url = null; |
|
28 | 28 | |
29 | - /** |
|
30 | - * Base headers for requests |
|
31 | - * @var array |
|
32 | - */ |
|
33 | - public $headers = array(); |
|
29 | + /** |
|
30 | + * Base headers for requests |
|
31 | + * @var array |
|
32 | + */ |
|
33 | + public $headers = array(); |
|
34 | 34 | |
35 | - /** |
|
36 | - * Base data for requests |
|
37 | - * |
|
38 | - * If both the base data and the per-request data are arrays, the data will |
|
39 | - * be merged before sending the request. |
|
40 | - * |
|
41 | - * @var array |
|
42 | - */ |
|
43 | - public $data = array(); |
|
35 | + /** |
|
36 | + * Base data for requests |
|
37 | + * |
|
38 | + * If both the base data and the per-request data are arrays, the data will |
|
39 | + * be merged before sending the request. |
|
40 | + * |
|
41 | + * @var array |
|
42 | + */ |
|
43 | + public $data = array(); |
|
44 | 44 | |
45 | - /** |
|
46 | - * Base options for requests |
|
47 | - * |
|
48 | - * The base options are merged with the per-request data for each request. |
|
49 | - * The only default option is a shared cookie jar between requests. |
|
50 | - * |
|
51 | - * Values here can also be set directly via properties on the Session |
|
52 | - * object, e.g. `$session->useragent = 'X';` |
|
53 | - * |
|
54 | - * @var array |
|
55 | - */ |
|
56 | - public $options = array(); |
|
45 | + /** |
|
46 | + * Base options for requests |
|
47 | + * |
|
48 | + * The base options are merged with the per-request data for each request. |
|
49 | + * The only default option is a shared cookie jar between requests. |
|
50 | + * |
|
51 | + * Values here can also be set directly via properties on the Session |
|
52 | + * object, e.g. `$session->useragent = 'X';` |
|
53 | + * |
|
54 | + * @var array |
|
55 | + */ |
|
56 | + public $options = array(); |
|
57 | 57 | |
58 | - /** |
|
59 | - * Create a new session |
|
60 | - * |
|
61 | - * @param string|null $url Base URL for requests |
|
62 | - * @param array $headers Default headers for requests |
|
63 | - * @param array $data Default data for requests |
|
64 | - * @param array $options Default options for requests |
|
65 | - */ |
|
66 | - public function __construct($url = null, $headers = array(), $data = array(), $options = array()) { |
|
67 | - $this->url = $url; |
|
68 | - $this->headers = $headers; |
|
69 | - $this->data = $data; |
|
70 | - $this->options = $options; |
|
58 | + /** |
|
59 | + * Create a new session |
|
60 | + * |
|
61 | + * @param string|null $url Base URL for requests |
|
62 | + * @param array $headers Default headers for requests |
|
63 | + * @param array $data Default data for requests |
|
64 | + * @param array $options Default options for requests |
|
65 | + */ |
|
66 | + public function __construct($url = null, $headers = array(), $data = array(), $options = array()) { |
|
67 | + $this->url = $url; |
|
68 | + $this->headers = $headers; |
|
69 | + $this->data = $data; |
|
70 | + $this->options = $options; |
|
71 | 71 | |
72 | - if (empty($this->options['cookies'])) { |
|
73 | - $this->options['cookies'] = new Requests_Cookie_Jar(); |
|
74 | - } |
|
75 | - } |
|
72 | + if (empty($this->options['cookies'])) { |
|
73 | + $this->options['cookies'] = new Requests_Cookie_Jar(); |
|
74 | + } |
|
75 | + } |
|
76 | 76 | |
77 | - /** |
|
78 | - * Get a property's value |
|
79 | - * |
|
80 | - * @param string $key Property key |
|
81 | - * @return mixed|null Property value, null if none found |
|
82 | - */ |
|
83 | - public function __get($key) { |
|
84 | - if (isset($this->options[$key])) { |
|
85 | - return $this->options[$key]; |
|
86 | - } |
|
77 | + /** |
|
78 | + * Get a property's value |
|
79 | + * |
|
80 | + * @param string $key Property key |
|
81 | + * @return mixed|null Property value, null if none found |
|
82 | + */ |
|
83 | + public function __get($key) { |
|
84 | + if (isset($this->options[$key])) { |
|
85 | + return $this->options[$key]; |
|
86 | + } |
|
87 | 87 | |
88 | - return null; |
|
89 | - } |
|
88 | + return null; |
|
89 | + } |
|
90 | 90 | |
91 | - /** |
|
92 | - * Set a property's value |
|
93 | - * |
|
94 | - * @param string $key Property key |
|
95 | - * @param mixed $value Property value |
|
96 | - */ |
|
97 | - public function __set($key, $value) { |
|
98 | - $this->options[$key] = $value; |
|
99 | - } |
|
91 | + /** |
|
92 | + * Set a property's value |
|
93 | + * |
|
94 | + * @param string $key Property key |
|
95 | + * @param mixed $value Property value |
|
96 | + */ |
|
97 | + public function __set($key, $value) { |
|
98 | + $this->options[$key] = $value; |
|
99 | + } |
|
100 | 100 | |
101 | - /** |
|
102 | - * Remove a property's value |
|
103 | - * |
|
104 | - * @param string $key Property key |
|
105 | - */ |
|
106 | - public function __isset($key) { |
|
107 | - return isset($this->options[$key]); |
|
108 | - } |
|
101 | + /** |
|
102 | + * Remove a property's value |
|
103 | + * |
|
104 | + * @param string $key Property key |
|
105 | + */ |
|
106 | + public function __isset($key) { |
|
107 | + return isset($this->options[$key]); |
|
108 | + } |
|
109 | 109 | |
110 | - /** |
|
111 | - * Remove a property's value |
|
112 | - * |
|
113 | - * @param string $key Property key |
|
114 | - */ |
|
115 | - public function __unset($key) { |
|
116 | - if (isset($this->options[$key])) { |
|
117 | - unset($this->options[$key]); |
|
118 | - } |
|
119 | - } |
|
110 | + /** |
|
111 | + * Remove a property's value |
|
112 | + * |
|
113 | + * @param string $key Property key |
|
114 | + */ |
|
115 | + public function __unset($key) { |
|
116 | + if (isset($this->options[$key])) { |
|
117 | + unset($this->options[$key]); |
|
118 | + } |
|
119 | + } |
|
120 | 120 | |
121 | - /**#@+ |
|
121 | + /**#@+ |
|
122 | 122 | * @see request() |
123 | 123 | * @param string $url |
124 | 124 | * @param array $headers |
125 | 125 | * @param array $options |
126 | 126 | * @return Requests_Response |
127 | 127 | */ |
128 | - /** |
|
129 | - * Send a GET request |
|
130 | - */ |
|
131 | - public function get($url, $headers = array(), $options = array()) { |
|
132 | - return $this->request($url, $headers, null, Requests::GET, $options); |
|
133 | - } |
|
128 | + /** |
|
129 | + * Send a GET request |
|
130 | + */ |
|
131 | + public function get($url, $headers = array(), $options = array()) { |
|
132 | + return $this->request($url, $headers, null, Requests::GET, $options); |
|
133 | + } |
|
134 | 134 | |
135 | - /** |
|
136 | - * Send a HEAD request |
|
137 | - */ |
|
138 | - public function head($url, $headers = array(), $options = array()) { |
|
139 | - return $this->request($url, $headers, null, Requests::HEAD, $options); |
|
140 | - } |
|
135 | + /** |
|
136 | + * Send a HEAD request |
|
137 | + */ |
|
138 | + public function head($url, $headers = array(), $options = array()) { |
|
139 | + return $this->request($url, $headers, null, Requests::HEAD, $options); |
|
140 | + } |
|
141 | 141 | |
142 | - /** |
|
143 | - * Send a DELETE request |
|
144 | - */ |
|
145 | - public function delete($url, $headers = array(), $options = array()) { |
|
146 | - return $this->request($url, $headers, null, Requests::DELETE, $options); |
|
147 | - } |
|
148 | - /**#@-*/ |
|
142 | + /** |
|
143 | + * Send a DELETE request |
|
144 | + */ |
|
145 | + public function delete($url, $headers = array(), $options = array()) { |
|
146 | + return $this->request($url, $headers, null, Requests::DELETE, $options); |
|
147 | + } |
|
148 | + /**#@-*/ |
|
149 | 149 | |
150 | - /**#@+ |
|
150 | + /**#@+ |
|
151 | 151 | * @see request() |
152 | 152 | * @param string $url |
153 | 153 | * @param array $headers |
@@ -155,112 +155,112 @@ discard block |
||
155 | 155 | * @param array $options |
156 | 156 | * @return Requests_Response |
157 | 157 | */ |
158 | - /** |
|
159 | - * Send a POST request |
|
160 | - */ |
|
161 | - public function post($url, $headers = array(), $data = array(), $options = array()) { |
|
162 | - return $this->request($url, $headers, $data, Requests::POST, $options); |
|
163 | - } |
|
158 | + /** |
|
159 | + * Send a POST request |
|
160 | + */ |
|
161 | + public function post($url, $headers = array(), $data = array(), $options = array()) { |
|
162 | + return $this->request($url, $headers, $data, Requests::POST, $options); |
|
163 | + } |
|
164 | 164 | |
165 | - /** |
|
166 | - * Send a PUT request |
|
167 | - */ |
|
168 | - public function put($url, $headers = array(), $data = array(), $options = array()) { |
|
169 | - return $this->request($url, $headers, $data, Requests::PUT, $options); |
|
170 | - } |
|
165 | + /** |
|
166 | + * Send a PUT request |
|
167 | + */ |
|
168 | + public function put($url, $headers = array(), $data = array(), $options = array()) { |
|
169 | + return $this->request($url, $headers, $data, Requests::PUT, $options); |
|
170 | + } |
|
171 | 171 | |
172 | - /** |
|
173 | - * Send a PATCH request |
|
174 | - * |
|
175 | - * Note: Unlike {@see post} and {@see put}, `$headers` is required, as the |
|
176 | - * specification recommends that should send an ETag |
|
177 | - * |
|
178 | - * @link https://tools.ietf.org/html/rfc5789 |
|
179 | - */ |
|
180 | - public function patch($url, $headers, $data = array(), $options = array()) { |
|
181 | - return $this->request($url, $headers, $data, Requests::PATCH, $options); |
|
182 | - } |
|
183 | - /**#@-*/ |
|
172 | + /** |
|
173 | + * Send a PATCH request |
|
174 | + * |
|
175 | + * Note: Unlike {@see post} and {@see put}, `$headers` is required, as the |
|
176 | + * specification recommends that should send an ETag |
|
177 | + * |
|
178 | + * @link https://tools.ietf.org/html/rfc5789 |
|
179 | + */ |
|
180 | + public function patch($url, $headers, $data = array(), $options = array()) { |
|
181 | + return $this->request($url, $headers, $data, Requests::PATCH, $options); |
|
182 | + } |
|
183 | + /**#@-*/ |
|
184 | 184 | |
185 | - /** |
|
186 | - * Main interface for HTTP requests |
|
187 | - * |
|
188 | - * This method initiates a request and sends it via a transport before |
|
189 | - * parsing. |
|
190 | - * |
|
191 | - * @see Requests::request() |
|
192 | - * |
|
193 | - * @throws Requests_Exception On invalid URLs (`nonhttp`) |
|
194 | - * |
|
195 | - * @param string $url URL to request |
|
196 | - * @param array $headers Extra headers to send with the request |
|
197 | - * @param array|null $data Data to send either as a query string for GET/HEAD requests, or in the body for POST requests |
|
198 | - * @param string $type HTTP request type (use Requests constants) |
|
199 | - * @param array $options Options for the request (see {@see Requests::request}) |
|
200 | - * @return Requests_Response |
|
201 | - */ |
|
202 | - public function request($url, $headers = array(), $data = array(), $type = Requests::GET, $options = array()) { |
|
203 | - $request = $this->merge_request(compact('url', 'headers', 'data', 'options')); |
|
185 | + /** |
|
186 | + * Main interface for HTTP requests |
|
187 | + * |
|
188 | + * This method initiates a request and sends it via a transport before |
|
189 | + * parsing. |
|
190 | + * |
|
191 | + * @see Requests::request() |
|
192 | + * |
|
193 | + * @throws Requests_Exception On invalid URLs (`nonhttp`) |
|
194 | + * |
|
195 | + * @param string $url URL to request |
|
196 | + * @param array $headers Extra headers to send with the request |
|
197 | + * @param array|null $data Data to send either as a query string for GET/HEAD requests, or in the body for POST requests |
|
198 | + * @param string $type HTTP request type (use Requests constants) |
|
199 | + * @param array $options Options for the request (see {@see Requests::request}) |
|
200 | + * @return Requests_Response |
|
201 | + */ |
|
202 | + public function request($url, $headers = array(), $data = array(), $type = Requests::GET, $options = array()) { |
|
203 | + $request = $this->merge_request(compact('url', 'headers', 'data', 'options')); |
|
204 | 204 | |
205 | - return Requests::request($request['url'], $request['headers'], $request['data'], $type, $request['options']); |
|
206 | - } |
|
205 | + return Requests::request($request['url'], $request['headers'], $request['data'], $type, $request['options']); |
|
206 | + } |
|
207 | 207 | |
208 | - /** |
|
209 | - * Send multiple HTTP requests simultaneously |
|
210 | - * |
|
211 | - * @see Requests::request_multiple() |
|
212 | - * |
|
213 | - * @param array $requests Requests data (see {@see Requests::request_multiple}) |
|
214 | - * @param array $options Global and default options (see {@see Requests::request}) |
|
215 | - * @return array Responses (either Requests_Response or a Requests_Exception object) |
|
216 | - */ |
|
217 | - public function request_multiple($requests, $options = array()) { |
|
218 | - foreach ($requests as $key => $request) { |
|
219 | - $requests[$key] = $this->merge_request($request, false); |
|
220 | - } |
|
208 | + /** |
|
209 | + * Send multiple HTTP requests simultaneously |
|
210 | + * |
|
211 | + * @see Requests::request_multiple() |
|
212 | + * |
|
213 | + * @param array $requests Requests data (see {@see Requests::request_multiple}) |
|
214 | + * @param array $options Global and default options (see {@see Requests::request}) |
|
215 | + * @return array Responses (either Requests_Response or a Requests_Exception object) |
|
216 | + */ |
|
217 | + public function request_multiple($requests, $options = array()) { |
|
218 | + foreach ($requests as $key => $request) { |
|
219 | + $requests[$key] = $this->merge_request($request, false); |
|
220 | + } |
|
221 | 221 | |
222 | - $options = array_merge($this->options, $options); |
|
222 | + $options = array_merge($this->options, $options); |
|
223 | 223 | |
224 | - // Disallow forcing the type, as that's a per request setting |
|
225 | - unset($options['type']); |
|
224 | + // Disallow forcing the type, as that's a per request setting |
|
225 | + unset($options['type']); |
|
226 | 226 | |
227 | - return Requests::request_multiple($requests, $options); |
|
228 | - } |
|
227 | + return Requests::request_multiple($requests, $options); |
|
228 | + } |
|
229 | 229 | |
230 | - /** |
|
231 | - * Merge a request's data with the default data |
|
232 | - * |
|
233 | - * @param array $request Request data (same form as {@see request_multiple}) |
|
234 | - * @param boolean $merge_options Should we merge options as well? |
|
235 | - * @return array Request data |
|
236 | - */ |
|
237 | - protected function merge_request($request, $merge_options = true) { |
|
238 | - if ($this->url !== null) { |
|
239 | - $request['url'] = Requests_IRI::absolutize($this->url, $request['url']); |
|
240 | - $request['url'] = $request['url']->uri; |
|
241 | - } |
|
230 | + /** |
|
231 | + * Merge a request's data with the default data |
|
232 | + * |
|
233 | + * @param array $request Request data (same form as {@see request_multiple}) |
|
234 | + * @param boolean $merge_options Should we merge options as well? |
|
235 | + * @return array Request data |
|
236 | + */ |
|
237 | + protected function merge_request($request, $merge_options = true) { |
|
238 | + if ($this->url !== null) { |
|
239 | + $request['url'] = Requests_IRI::absolutize($this->url, $request['url']); |
|
240 | + $request['url'] = $request['url']->uri; |
|
241 | + } |
|
242 | 242 | |
243 | - if (empty($request['headers'])) { |
|
244 | - $request['headers'] = array(); |
|
245 | - } |
|
246 | - $request['headers'] = array_merge($this->headers, $request['headers']); |
|
243 | + if (empty($request['headers'])) { |
|
244 | + $request['headers'] = array(); |
|
245 | + } |
|
246 | + $request['headers'] = array_merge($this->headers, $request['headers']); |
|
247 | 247 | |
248 | - if (empty($request['data'])) { |
|
249 | - if (is_array($this->data)) { |
|
250 | - $request['data'] = $this->data; |
|
251 | - } |
|
252 | - } |
|
253 | - elseif (is_array($request['data']) && is_array($this->data)) { |
|
254 | - $request['data'] = array_merge($this->data, $request['data']); |
|
255 | - } |
|
248 | + if (empty($request['data'])) { |
|
249 | + if (is_array($this->data)) { |
|
250 | + $request['data'] = $this->data; |
|
251 | + } |
|
252 | + } |
|
253 | + elseif (is_array($request['data']) && is_array($this->data)) { |
|
254 | + $request['data'] = array_merge($this->data, $request['data']); |
|
255 | + } |
|
256 | 256 | |
257 | - if ($merge_options !== false) { |
|
258 | - $request['options'] = array_merge($this->options, $request['options']); |
|
257 | + if ($merge_options !== false) { |
|
258 | + $request['options'] = array_merge($this->options, $request['options']); |
|
259 | 259 | |
260 | - // Disallow forcing the type, as that's a per request setting |
|
261 | - unset($request['options']['type']); |
|
262 | - } |
|
260 | + // Disallow forcing the type, as that's a per request setting |
|
261 | + unset($request['options']['type']); |
|
262 | + } |
|
263 | 263 | |
264 | - return $request; |
|
265 | - } |
|
264 | + return $request; |
|
265 | + } |
|
266 | 266 | } |