MDL-56001 lib: Upgrade simplepie to 1.4.2
[moodle.git] / lib / simplepie / library / SimplePie / File.php
1 <?php
2 /**
3  * SimplePie
4  *
5  * A PHP-Based RSS and Atom Feed Framework.
6  * Takes the hard work out of managing a complete RSS/Atom solution.
7  *
8  * Copyright (c) 2004-2016, Ryan Parman, Geoffrey Sneddon, Ryan McCue, and contributors
9  * All rights reserved.
10  *
11  * Redistribution and use in source and binary forms, with or without modification, are
12  * permitted provided that the following conditions are met:
13  *
14  *      * Redistributions of source code must retain the above copyright notice, this list of
15  *        conditions and the following disclaimer.
16  *
17  *      * Redistributions in binary form must reproduce the above copyright notice, this list
18  *        of conditions and the following disclaimer in the documentation and/or other materials
19  *        provided with the distribution.
20  *
21  *      * Neither the name of the SimplePie Team nor the names of its contributors may be used
22  *        to endorse or promote products derived from this software without specific prior
23  *        written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS
26  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
27  * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS
28  * AND CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
29  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
30  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
31  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
32  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
33  * POSSIBILITY OF SUCH DAMAGE.
34  *
35  * @package SimplePie
36  * @copyright 2004-2016 Ryan Parman, Geoffrey Sneddon, Ryan McCue
37  * @author Ryan Parman
38  * @author Geoffrey Sneddon
39  * @author Ryan McCue
40  * @link http://simplepie.org/ SimplePie
41  * @license http://www.opensource.org/licenses/bsd-license.php BSD License
42  */
44 /**
45  * Used for fetching remote files and reading local files
46  *
47  * Supports HTTP 1.0 via cURL or fsockopen, with spotty HTTP 1.1 support
48  *
49  * This class can be overloaded with {@see SimplePie::set_file_class()}
50  *
51  * @package SimplePie
52  * @subpackage HTTP
53  * @todo Move to properly supporting RFC2616 (HTTP/1.1)
54  */
55 class SimplePie_File
56 {
57         var $url;
58         var $useragent;
59         var $success = true;
60         var $headers = array();
61         var $body;
62         var $status_code;
63         var $redirects = 0;
64         var $error;
65         var $method = SIMPLEPIE_FILE_SOURCE_NONE;
66         var $permanent_url;
68         public function __construct($url, $timeout = 10, $redirects = 5, $headers = null, $useragent = null, $force_fsockopen = false, $curl_options = array())
69         {
70                 if (class_exists('idna_convert'))
71                 {
72                         $idn = new idna_convert();
73                         $parsed = SimplePie_Misc::parse_url($url);
74                         $url = SimplePie_Misc::compress_parse_url($parsed['scheme'], $idn->encode($parsed['authority']), $parsed['path'], $parsed['query'], $parsed['fragment']);
75                 }
76                 $this->url = $url;
77                 $this->permanent_url = $url;
78                 $this->useragent = $useragent;
79                 if (preg_match('/^http(s)?:\/\//i', $url))
80                 {
81                         if ($useragent === null)
82                         {
83                                 $useragent = ini_get('user_agent');
84                                 $this->useragent = $useragent;
85                         }
86                         if (!is_array($headers))
87                         {
88                                 $headers = array();
89                         }
90                         if (!$force_fsockopen && function_exists('curl_exec'))
91                         {
92                                 $this->method = SIMPLEPIE_FILE_SOURCE_REMOTE | SIMPLEPIE_FILE_SOURCE_CURL;
93                                 $fp = curl_init();
94                                 $headers2 = array();
95                                 foreach ($headers as $key => $value)
96                                 {
97                                         $headers2[] = "$key: $value";
98                                 }
99                                 if (version_compare(SimplePie_Misc::get_curl_version(), '7.10.5', '>='))
100                                 {
101                                         curl_setopt($fp, CURLOPT_ENCODING, '');
102                                 }
103                                 curl_setopt($fp, CURLOPT_URL, $url);
104                                 curl_setopt($fp, CURLOPT_HEADER, 1);
105                                 curl_setopt($fp, CURLOPT_RETURNTRANSFER, 1);
106                                 curl_setopt($fp, CURLOPT_FAILONERROR, 1);
107                                 curl_setopt($fp, CURLOPT_TIMEOUT, $timeout);
108                                 curl_setopt($fp, CURLOPT_CONNECTTIMEOUT, $timeout);
109                                 curl_setopt($fp, CURLOPT_REFERER, $url);
110                                 curl_setopt($fp, CURLOPT_USERAGENT, $useragent);
111                                 curl_setopt($fp, CURLOPT_HTTPHEADER, $headers2);
112                                 if (!ini_get('open_basedir') && !ini_get('safe_mode') && version_compare(SimplePie_Misc::get_curl_version(), '7.15.2', '>='))
113                                 {
114                                         curl_setopt($fp, CURLOPT_FOLLOWLOCATION, 1);
115                                         curl_setopt($fp, CURLOPT_MAXREDIRS, $redirects);
116                                 }
117                                 foreach ($curl_options as $curl_param => $curl_value) {
118                                         curl_setopt($fp, $curl_param, $curl_value);
119                                 }
121                                 $this->headers = curl_exec($fp);
122                                 if (curl_errno($fp) === 23 || curl_errno($fp) === 61)
123                                 {
124                                         curl_setopt($fp, CURLOPT_ENCODING, 'none');
125                                         $this->headers = curl_exec($fp);
126                                 }
127                                 if (curl_errno($fp))
128                                 {
129                                         $this->error = 'cURL error ' . curl_errno($fp) . ': ' . curl_error($fp);
130                                         $this->success = false;
131                                 }
132                                 else
133                                 {
134                                         // Use the updated url provided by curl_getinfo after any redirects.
135                                         if ($info = curl_getinfo($fp)) {
136                                                 $this->url = $info['url'];
137                                         }
138                                         curl_close($fp);
139                                         $this->headers = explode("\r\n\r\n", $this->headers, $info['redirect_count'] + 1);
140                                         $this->headers = array_pop($this->headers);
141                                         $parser = new SimplePie_HTTP_Parser($this->headers);
142                                         if ($parser->parse())
143                                         {
144                                                 $this->headers = $parser->headers;
145                                                 $this->body = trim($parser->body);
146                                                 $this->status_code = $parser->status_code;
147                                                 if ((in_array($this->status_code, array(300, 301, 302, 303, 307)) || $this->status_code > 307 && $this->status_code < 400) && isset($this->headers['location']) && $this->redirects < $redirects)
148                                                 {
149                                                         $this->redirects++;
150                                                         $location = SimplePie_Misc::absolutize_url($this->headers['location'], $url);
151                                                         $previousStatusCode = $this->status_code;
152                                                         $this->__construct($location, $timeout, $redirects, $headers, $useragent, $force_fsockopen);
153                                                         $this->permanent_url = ($previousStatusCode == 301) ? $location : $url;
154                                                         return;
155                                                 }
156                                         }
157                                 }
158                         }
159                         else
160                         {
161                                 $this->method = SIMPLEPIE_FILE_SOURCE_REMOTE | SIMPLEPIE_FILE_SOURCE_FSOCKOPEN;
162                                 $url_parts = parse_url($url);
163                                 $socket_host = $url_parts['host'];
164                                 if (isset($url_parts['scheme']) && strtolower($url_parts['scheme']) === 'https')
165                                 {
166                                         $socket_host = "ssl://$url_parts[host]";
167                                         $url_parts['port'] = 443;
168                                 }
169                                 if (!isset($url_parts['port']))
170                                 {
171                                         $url_parts['port'] = 80;
172                                 }
173                                 $fp = @fsockopen($socket_host, $url_parts['port'], $errno, $errstr, $timeout);
174                                 if (!$fp)
175                                 {
176                                         $this->error = 'fsockopen error: ' . $errstr;
177                                         $this->success = false;
178                                 }
179                                 else
180                                 {
181                                         stream_set_timeout($fp, $timeout);
182                                         if (isset($url_parts['path']))
183                                         {
184                                                 if (isset($url_parts['query']))
185                                                 {
186                                                         $get = "$url_parts[path]?$url_parts[query]";
187                                                 }
188                                                 else
189                                                 {
190                                                         $get = $url_parts['path'];
191                                                 }
192                                         }
193                                         else
194                                         {
195                                                 $get = '/';
196                                         }
197                                         $out = "GET $get HTTP/1.1\r\n";
198                                         $out .= "Host: $url_parts[host]\r\n";
199                                         $out .= "User-Agent: $useragent\r\n";
200                                         if (extension_loaded('zlib'))
201                                         {
202                                                 $out .= "Accept-Encoding: x-gzip,gzip,deflate\r\n";
203                                         }
205                                         if (isset($url_parts['user']) && isset($url_parts['pass']))
206                                         {
207                                                 $out .= "Authorization: Basic " . base64_encode("$url_parts[user]:$url_parts[pass]") . "\r\n";
208                                         }
209                                         foreach ($headers as $key => $value)
210                                         {
211                                                 $out .= "$key: $value\r\n";
212                                         }
213                                         $out .= "Connection: Close\r\n\r\n";
214                                         fwrite($fp, $out);
216                                         $info = stream_get_meta_data($fp);
218                                         $this->headers = '';
219                                         while (!$info['eof'] && !$info['timed_out'])
220                                         {
221                                                 $this->headers .= fread($fp, 1160);
222                                                 $info = stream_get_meta_data($fp);
223                                         }
224                                         if (!$info['timed_out'])
225                                         {
226                                                 $parser = new SimplePie_HTTP_Parser($this->headers);
227                                                 if ($parser->parse())
228                                                 {
229                                                         $this->headers = $parser->headers;
230                                                         $this->body = trim($parser->body);
231                                                         $this->status_code = $parser->status_code;
232                                                         if ((in_array($this->status_code, array(300, 301, 302, 303, 307)) || $this->status_code > 307 && $this->status_code < 400) && isset($this->headers['location']) && $this->redirects < $redirects)
233                                                         {
234                                                                 $this->redirects++;
235                                                                 $location = SimplePie_Misc::absolutize_url($this->headers['location'], $url);
236                                                                 $previousStatusCode = $this->status_code;
237                                                                 $this->__construct($location, $timeout, $redirects, $headers, $useragent, $force_fsockopen);
238                                                                 $this->permanent_url = ($previousStatusCode == 301) ? $location : $url;
239                                                                 return;
240                                                         }
241                                                         if (isset($this->headers['content-encoding']))
242                                                         {
243                                                                 // Hey, we act dumb elsewhere, so let's do that here too
244                                                                 switch (strtolower(trim($this->headers['content-encoding'], "\x09\x0A\x0D\x20")))
245                                                                 {
246                                                                         case 'gzip':
247                                                                         case 'x-gzip':
248                                                                                 $decoder = new SimplePie_gzdecode($this->body);
249                                                                                 if (!$decoder->parse())
250                                                                                 {
251                                                                                         $this->error = 'Unable to decode HTTP "gzip" stream';
252                                                                                         $this->success = false;
253                                                                                 }
254                                                                                 else
255                                                                                 {
256                                                                                         $this->body = trim($decoder->data);
257                                                                                 }
258                                                                                 break;
260                                                                         case 'deflate':
261                                                                                 if (($decompressed = gzinflate($this->body)) !== false)
262                                                                                 {
263                                                                                         $this->body = $decompressed;
264                                                                                 }
265                                                                                 else if (($decompressed = gzuncompress($this->body)) !== false)
266                                                                                 {
267                                                                                         $this->body = $decompressed;
268                                                                                 }
269                                                                                 else if (function_exists('gzdecode') && ($decompressed = gzdecode($this->body)) !== false)
270                                                                                 {
271                                                                                         $this->body = $decompressed;
272                                                                                 }
273                                                                                 else
274                                                                                 {
275                                                                                         $this->error = 'Unable to decode HTTP "deflate" stream';
276                                                                                         $this->success = false;
277                                                                                 }
278                                                                                 break;
280                                                                         default:
281                                                                                 $this->error = 'Unknown content coding';
282                                                                                 $this->success = false;
283                                                                 }
284                                                         }
285                                                 }
286                                         }
287                                         else
288                                         {
289                                                 $this->error = 'fsocket timed out';
290                                                 $this->success = false;
291                                         }
292                                         fclose($fp);
293                                 }
294                         }
295                 }
296                 else
297                 {
298                         $this->method = SIMPLEPIE_FILE_SOURCE_LOCAL | SIMPLEPIE_FILE_SOURCE_FILE_GET_CONTENTS;
299                         if (empty($url) || !($this->body = trim(file_get_contents($url))))
300                         {
301                                 $this->error = 'file_get_contents could not read the file';
302                                 $this->success = false;
303                         }
304                 }
305         }