-
Notifications
You must be signed in to change notification settings - Fork 238
/
Curl.php
201 lines (181 loc) · 5.55 KB
/
Curl.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
<?php
/**
* Lithium: the most rad php framework
*
* @copyright Copyright 2012, Union of RAD (http://union-of-rad.org)
* @license http://opensource.org/licenses/bsd-license.php The BSD License
*/
namespace lithium\net\socket;
use lithium\net\http\Message;
/**
* A Curl-based socket adapter
*
* This curl adapter provides the required method implementations of the abstract Socket class
* for `open`, `close`, `read`, `write`, `timeout` `eof` and `encoding`.
*
* Your PHP installation must have been compiled with the `--with-curl[=DIR]` directive. If this
* is not the case, you must either recompile PHP with the proper configuration flags to enable
* curl, or you may use the `Stream` adapter that is also included with the Lithium core.
*
* @link http://www.php.net/manual/en/curl.installation.php
* @see lithium\net\socket\Stream
*/
class Curl extends \lithium\net\Socket {
/**
* Contains options that will be passed to `curl_setopt_array` before
* `read` and `write` operations. These options should be set by
* using the `set` method.
*
* @link http://www.php.net/manual/en/function.curl-setopt.php PHP Manual: curl_setopt()
* @see lithium\net\socket\Curl::set()
* @var array
*/
public $options = array();
/**
* Constructor
*
* @param array $config
*/
public function __construct(array $config = array()) {
$defaults = array('ignoreExpect' => true);
parent::__construct($config + $defaults);
}
/**
* Opens a curl connection and initializes the internal resource handle.
*
* @param array $options update the config settings
* @return mixed Returns `false` if the socket configuration does not contain the
* `'scheme'` or `'host'` settings, or if configuration fails, otherwise returns a
* resource stream.
*/
public function open(array $options = array()) {
$this->options = array();
parent::open($options);
$config = $this->_config;
if (empty($config['scheme']) || empty($config['host'])) {
return false;
}
$url = "{$config['scheme']}://{$config['host']}";
$this->_resource = curl_init($url);
$this->set(array(
CURLOPT_PORT => $config['port'],
CURLOPT_HEADER => true,
CURLOPT_RETURNTRANSFER => true
));
if (!is_resource($this->_resource)) {
return false;
}
$this->_isConnected = true;
$this->timeout($config['timeout']);
if (isset($config['encoding'])) {
$this->encoding($config['encoding']);
}
return $this->_resource;
}
/**
* Closes the curl connection.
*
* @return boolean True on closed connection
*/
public function close() {
if (!is_resource($this->_resource)) {
return true;
}
curl_close($this->_resource);
if (is_resource($this->_resource)) {
$this->close();
}
return true;
}
/**
* EOF is unimplemented for this socket adapter.
*
* @return null
*/
public function eof() {
return null;
}
/**
* Reads data from the curl connection.
* The `read` method will utilize the curl options that have been set.
*
* @link http://php.net/manual/en/function.curl-exec.php PHP Manual: curl_exec()
* @return mixed Boolean false if the resource handle is unavailable, and the result
* of `curl_exec` otherwise.
*/
public function read() {
if (!is_resource($this->_resource)) {
return false;
}
return curl_exec($this->_resource);
}
/**
* Writes data to curl options
*
* @param object $data a `lithium\net\Message` object or array
* @return boolean
*/
public function write($data = null) {
if (!is_resource($this->_resource)) {
return false;
}
if (!is_object($data)) {
$data = $this->_instance($this->_classes['request'], (array) $data + $this->_config);
}
$this->set(CURLOPT_URL, $data->to('url'));
if ($data instanceof Message) {
if (!empty($this->_config['ignoreExpect'])) {
$data->headers('Expect', ' ');
}
if (isset($data->headers)) {
$this->set(CURLOPT_HTTPHEADER, $data->headers());
}
if (isset($data->method) && $data->method == 'POST') {
$this->set(array(CURLOPT_POST => true, CURLOPT_POSTFIELDS => $data->body()));
}
}
return (boolean) curl_setopt_array($this->_resource, $this->options);
}
/**
* A convenience method to set the curl `CURLOPT_CONNECTTIMEOUT`
* setting for the current connection. This determines the number
* of seconds to wait while trying to connect.
*
* Note: A value of 0 may be used to specify an indefinite wait time.
*
* @param integer $time The timeout value in seconds
* @return boolean False if the resource handle is unavailable or the
* option could not be set, true otherwise.
*/
public function timeout($time) {
if (!is_resource($this->_resource)) {
return false;
}
return curl_setopt($this->_resource, CURLOPT_CONNECTTIMEOUT, $time);
}
/**
* encoding() is currently unimplemented for this socket adapter
*
* @todo implement Curl::encoding($charset)
* @param string $charset
*/
public function encoding($charset) {}
/**
* Sets the options to be used in subsequent curl requests.
*
* @link http://www.php.net/manual/en/curl.constants.php PHP Manual: cURL Constants
* @param array $flags If $values is an array, $flags will be used as the
* keys to an associative array of curl options. If $values is not set,
* then $flags will be used as the associative array.
* @param array $value If set, this array becomes the values for the
* associative array of curl options.
* @return void
*/
public function set($flags, $value = null) {
if ($value !== null) {
$flags = array($flags => $value);
}
$this->options = $flags + $this->options;
}
}
?>