10 const SYNC_DOWNLOAD
= 1; // syncronys upload (in a single request)
11 const ASYNC_DOWNLOAD
= 2; // asynchronous upload we should spawn out another process and monitor progress if possible)
15 public static function request( $method, $url, $opts = array() ){
16 $opts['method'] = ( strtoupper( $method ) == 'GET' ||
strtoupper( $method ) == 'POST' ) ?
strtoupper( $method ) : null;
17 $req = new HttpRequest( $url, $opts );
18 $status = $req->doRequest();
19 if( $status->isOK() ){
20 return $status->value
;
22 wfDebug( 'http error: ' . $status->getWikiText() );
28 * Simple wrapper for Http::request( 'GET' )
30 public static function get( $url, $timeout = false ) {
33 $opts['timeout'] = $timeout;
34 return Http
::request( 'GET', $url, $opts );
38 * Simple wrapper for Http::request( 'POST' )
40 public static function post( $url, $opts = array() ) {
41 return Http
::request( 'POST', $url, $opts );
44 public static function doDownload( $url, $target_file_path, $dl_mode = self
::SYNC_DOWNLOAD
, $redirectCount = 0 ){
45 global $wgPhpCli, $wgMaxUploadSize, $wgMaxRedirects;
46 // do a quick check to HEAD to insure the file size is not > $wgMaxUploadSize
47 $headRequest = new HttpRequest( $url, array( 'headers_only' => true ) );
48 $headResponse = $headRequest->doRequest();
49 if( !$headResponse->isOK() ){
52 $head = $headResponse->value
;
54 // check for redirects:
55 if( isset( $head['Location'] ) && strrpos( $head[0], '302' ) !== false ){
56 if( $redirectCount < $wgMaxRedirects ){
57 if( UploadFromUrl
::isValidURI( $head['Location'] ) ){
58 return self
::doDownload( $head['Location'], $target_file_path, $dl_mode, $redirectCount++
);
60 return Status
::newFatal( 'upload-proto-error' );
63 return Status
::newFatal( 'upload-too-many-redirects' );
66 // we did not get a 200 ok response:
67 if( strrpos( $head[0], '200 OK' ) === false ){
68 return Status
::newFatal( 'upload-http-error', htmlspecialchars( $head[0] ) );
71 $content_length = ( isset( $head['Content-Length'] ) ) ?
$head['Content-Length'] : null;
72 if( $content_length ){
73 if( $content_length > $wgMaxUploadSize ){
74 return Status
::newFatal( 'requested file length ' . $content_length . ' is greater than $wgMaxUploadSize: ' . $wgMaxUploadSize );
78 // check if we can find phpCliPath (for doing a background shell request to php to do the download:
79 if( $wgPhpCli && wfShellExecEnabled() && $dl_mode == self
::ASYNC_DOWNLOAD
){
80 wfDebug( __METHOD__
. "\ASYNC_DOWNLOAD\n" );
81 // setup session and shell call:
82 return self
::initBackgroundDownload( $url, $target_file_path, $content_length );
83 } else if( $dl_mode == self
::SYNC_DOWNLOAD
){
84 wfDebug( __METHOD__
. "\nSYNC_DOWNLOAD\n" );
85 // SYNC_DOWNLOAD download as much as we can in the time we have to execute
86 $opts['method'] = 'GET';
87 $opts['target_file_path'] = $target_file_path;
88 $req = new HttpRequest( $url, $opts );
89 return $req->doRequest();
94 * a non blocking request (generally an exit point in the application)
95 * should write to a file location and give updates
98 private static function initBackgroundDownload( $url, $target_file_path, $content_length = null ){
99 global $wgMaxUploadSize, $IP, $wgPhpCli, $wgServer;
100 $status = Status
::newGood();
102 // generate a session id with all the details for the download (pid, target_file_path )
103 $upload_session_key = self
::getUploadSessionKey();
104 $session_id = session_id();
106 // store the url and target path:
107 $_SESSION['wsDownload'][$upload_session_key]['url'] = $url;
108 $_SESSION['wsDownload'][$upload_session_key]['target_file_path'] = $target_file_path;
109 // since we request from the cmd line we lose the original host name pass in the session:
110 $_SESSION['wsDownload'][$upload_session_key]['orgServer'] = $wgServer;
112 if( $content_length )
113 $_SESSION['wsDownload'][$upload_session_key]['content_length'] = $content_length;
115 // set initial loaded bytes:
116 $_SESSION['wsDownload'][$upload_session_key]['loaded'] = 0;
118 // run the background download request:
119 $cmd = $wgPhpCli . ' ' . $IP . "/maintenance/http_session_download.php --sid {$session_id} --usk {$upload_session_key}";
120 $pid = wfShellBackgroundExec( $cmd );
121 // the pid is not of much use since we won't be visiting this same apache any-time soon.
123 return Status
::newFatal( 'could not run background shell exec' );
125 // update the status value with the $upload_session_key (for the user to check on the status of the upload)
126 $status->value
= $upload_session_key;
128 // return good status
132 static function getUploadSessionKey(){
133 $key = mt_rand( 0, 0x7fffffff );
134 $_SESSION['wsUploadData'][$key] = array();
139 * used to run a session based download. Is initiated via the shell.
141 * @param $session_id String: the session id to grab download details from
142 * @param $upload_session_key String: the key of the given upload session
143 * (a given client could have started a few http uploads at once)
145 public static function doSessionIdDownload( $session_id, $upload_session_key ){
146 global $wgUser, $wgEnableWriteAPI, $wgAsyncHTTPTimeout, $wgServer;
147 wfDebug( __METHOD__
. "\n\ndoSessionIdDownload:\n\n" );
149 // set session to the provided key:
150 session_id( $session_id );
152 if( session_start() === false ){
153 wfDebug( __METHOD__
. ' could not start session' );
155 // get all the vars we need from session_id
156 if( !isset( $_SESSION[ 'wsDownload' ][$upload_session_key] ) ){
157 wfDebug( __METHOD__
. ' Error:could not find upload session');
160 // setup the global user from the session key we just inherited
161 $wgUser = User
::newFromSession();
163 // grab the session data to setup the request:
164 $sd =& $_SESSION['wsDownload'][$upload_session_key];
166 // update the wgServer var ( since cmd line thinks we are localhost when we are really orgServer)
167 if( isset( $sd['orgServer'] ) && $sd['orgServer'] ){
168 $wgServer = $sd['orgServer'];
170 // close down the session so we can other http queries can get session updates:
171 session_write_close();
173 $req = new HttpRequest( $sd['url'], array(
174 'target_file_path' => $sd['target_file_path'],
175 'upload_session_key'=> $upload_session_key,
176 'timeout' => $wgAsyncHTTPTimeout
178 // run the actual request .. (this can take some time)
179 wfDebug( __METHOD__
. 'do Request: ' . $sd['url'] . ' tf: ' . $sd['target_file_path'] );
180 $status = $req->doRequest();
181 //wfDebug("done with req status is: ". $status->isOK(). ' '.$status->getWikiText(). "\n");
183 // start up the session again:
184 if( session_start() === false ){
185 wfDebug( __METHOD__
. ' ERROR:: Could not start session');
187 // grab the updated session data pointer
188 $sd =& $_SESSION['wsDownload'][$upload_session_key];
189 // if error update status:
190 if( !$status->isOK() ){
191 $sd['apiUploadResult'] = ApiFormatJson
::getJsonEncode(
192 array( 'error' => $status->getWikiText() )
195 // if status okay process upload using fauxReq to api:
196 if( $status->isOK() ){
197 // setup the FauxRequest
198 $fauxReqData = $sd['mParams'];
199 $fauxReqData['action'] = 'upload';
200 $fauxReqData['format'] = 'json';
201 $fauxReqData['internalhttpsession'] = $upload_session_key;
203 // evil but no other clean way about it:
204 $faxReq = new FauxRequest( $fauxReqData, true );
205 $processor = new ApiMain( $faxReq, $wgEnableWriteAPI );
207 //init the mUpload var for the $processor
208 $processor->execute();
209 $processor->getResult()->cleanUpUTF8();
210 $printer = $processor->createPrinterByName( 'json' );
211 $printer->initPrinter( false );
214 $apiUploadResult = ob_get_clean();
216 wfDebug( __METHOD__
. "\n\n got api result:: $apiUploadResult \n" );
217 // the status updates runner will grab the result form the session:
218 $sd['apiUploadResult'] = $apiUploadResult;
220 // close the session:
221 session_write_close();
225 * Check if the URL can be served by localhost
226 * @param $url string Full url to check
229 public static function isLocalURL( $url ) {
230 global $wgCommandLineMode, $wgConf;
231 if ( $wgCommandLineMode ) {
237 if ( preg_match( '!^http://([\w.-]+)[/:].*$!', $url, $matches ) ) {
240 $domainParts = explode( '.', $host );
241 // Check if this domain or any superdomain is listed in $wgConf as a local virtual host
242 $domainParts = array_reverse( $domainParts );
243 for ( $i = 0; $i < count( $domainParts ); $i++
) {
244 $domainPart = $domainParts[$i];
246 $domain = $domainPart;
248 $domain = $domainPart . '.' . $domain;
250 if ( $wgConf->isLocalVHost( $domain ) ) {
259 * Return a standard user-agent we can use for external requests.
261 public static function userAgent() {
263 return "MediaWiki/$wgVersion";
268 var $target_file_path;
269 var $upload_session_key;
271 function __construct( $url, $opt ){
272 global $wgSyncHTTPTimeout;
273 // double check that it's a valid url:
276 // set the timeout to default sync timeout (unless the timeout option is provided)
277 $this->timeout
= ( isset( $opt['timeout'] ) ) ?
$opt['timeout'] : $wgSyncHTTPTimeout;
278 $this->method
= ( isset( $opt['method'] ) ) ?
$opt['method'] : 'GET';
279 $this->target_file_path
= ( isset( $opt['target_file_path'] ) ) ?
$opt['target_file_path'] : false;
280 $this->upload_session_key
= ( isset( $opt['upload_session_key'] ) ) ?
$opt['upload_session_key'] : false;
281 $this->headers_only
= ( isset( $opt['headers_only'] ) ) ?
$opt['headers_only'] : false;
285 * Get the contents of a file by HTTP
286 * @param $url string Full URL to act on
287 * @param $Opt associative array Optional array of options:
288 * 'method' => 'GET', 'POST' etc.
289 * 'target_file_path' => if curl should output to a target file
290 * 'adapter' => 'curl', 'soket'
292 public function doRequest() {
293 # Make sure we have a valid url
294 if( !UploadFromUrl
::isValidURI( $this->url
) )
295 return Status
::newFatal('bad-url');
297 # Use curl if available
298 if ( function_exists( 'curl_init' ) ) {
299 return $this->doCurlReq();
301 return $this->doPhpReq();
305 private function doCurlReq(){
306 global $wgHTTPProxy, $wgTitle;
308 $status = Status
::newGood();
309 $c = curl_init( $this->url
);
312 if ( Http
::isLocalURL( $this->url
) ) {
313 curl_setopt( $c, CURLOPT_PROXY
, 'localhost:80' );
314 } else if ( $wgHTTPProxy ) {
315 curl_setopt( $c, CURLOPT_PROXY
, $wgHTTPProxy );
318 curl_setopt( $c, CURLOPT_TIMEOUT
, $this->timeout
);
319 curl_setopt( $c, CURLOPT_USERAGENT
, Http
::userAgent() );
321 if ( $this->headers_only
) {
322 curl_setopt( $c, CURLOPT_NOBODY
, true );
323 curl_setopt( $c, CURLOPT_HEADER
, true );
324 } elseif ( $this->method
== 'POST' ) {
325 curl_setopt( $c, CURLOPT_POST
, true );
326 curl_setopt( $c, CURLOPT_POSTFIELDS
, '' );
328 curl_setopt( $c, CURLOPT_CUSTOMREQUEST
, $this->method
);
331 # Set the referer to $wgTitle, even in command-line mode
332 # This is useful for interwiki transclusion, where the foreign
333 # server wants to know what the referring page is.
334 # $_SERVER['REQUEST_URI'] gives a less reliable indication of the
336 if ( is_object( $wgTitle ) ) {
337 curl_setopt( $c, CURLOPT_REFERER
, $wgTitle->getFullURL() );
340 // set the write back function (if we are writing to a file)
341 if( $this->target_file_path
){
342 $cwrite = new simpleFileWriter( $this->target_file_path
, $this->upload_session_key
);
343 if( !$cwrite->status
->isOK() ){
344 wfDebug( __METHOD__
. "ERROR in setting up simpleFileWriter\n" );
345 $status = $cwrite->status
;
348 curl_setopt( $c, CURLOPT_WRITEFUNCTION
, array( $cwrite, 'callbackWriteBody' ) );
351 // start output grabber:
352 if( !$this->target_file_path
)
355 //run the actual curl_exec:
357 if ( false === curl_exec( $c ) ) {
358 $error_txt ='Error sending request: #' . curl_errno( $c ) .' '. curl_error( $c );
359 wfDebug( __METHOD__
. $error_txt . "\n" );
360 $status = Status
::newFatal( $error_txt );
362 } catch ( Exception
$e ) {
363 // do something with curl exec error?
365 // if direct request output the results to the stats value:
366 if( !$this->target_file_path
&& $status->isOK() ){
367 $status->value
= ob_get_contents();
370 // if we wrote to a target file close up or return error
371 if( $this->target_file_path
){
373 if( !$cwrite->status
->isOK() ){
374 return $cwrite->status
;
378 if ( $this->headers_only
) {
379 $headers = explode( "\n", $status->value
);
380 $headerArray = array();
381 foreach ( $headers as $header ) {
382 if ( !strlen( trim( $header ) ) )
384 $headerParts = explode( ':', $header, 2 );
385 if ( count( $headerParts ) == 1 ) {
386 $headerArray[] = trim( $header );
388 list( $key, $val ) = $headerParts;
389 $headerArray[trim( $key )] = trim( $val );
392 $status->value
= $headerArray;
394 # Don't return the text of error messages, return false on error
395 $retcode = curl_getinfo( $c, CURLINFO_HTTP_CODE
);
396 if ( $retcode != 200 ) {
397 wfDebug( __METHOD__
. ": HTTP return code $retcode\n" );
398 $status = Status
::newFatal( "HTTP return code $retcode\n" );
400 # Don't return truncated output
401 $errno = curl_errno( $c );
402 if ( $errno != CURLE_OK
) {
403 $errstr = curl_error( $c );
404 wfDebug( __METHOD__
. ": CURL error code $errno: $errstr\n" );
405 $status = Status
::newFatal( " CURL error code $errno: $errstr\n" );
411 // return the result obj
415 public function doPhpReq(){
416 global $wgTitle, $wgHTTPProxy;
418 # Check for php.ini allow_url_fopen
419 if( !ini_get( 'allow_url_fopen' ) ){
420 return Status
::newFatal( 'allow_url_fopen needs to be enabled for http copy to work' );
423 // start with good status:
424 $status = Status
::newGood();
426 if ( $this->headers_only
) {
427 $status->value
= get_headers( $this->url
, 1 );
432 $headers = array( "User-Agent: " . Http
::userAgent() );
433 if ( is_object( $wgTitle ) ) {
434 $headers[] = "Referer: ". $wgTitle->getFullURL();
437 if( strcasecmp( $this->method
, 'post' ) == 0 ) {
438 // Required for HTTP 1.0 POSTs
439 $headers[] = "Content-Length: 0";
441 $fcontext = stream_context_create ( array(
443 'method' => $this->method
,
444 'header' => implode( "\r\n", $headers ),
445 'timeout' => $this->timeout
)
449 $fh = fopen( $this->url
, "r", false, $fcontext);
451 // set the write back function (if we are writing to a file)
452 if( $this->target_file_path
){
453 $cwrite = new simpleFileWriter( $this->target_file_path
, $this->upload_session_key
);
454 if( !$cwrite->status
->isOK() ){
455 wfDebug( __METHOD__
. "ERROR in setting up simpleFileWriter\n" );
456 $status = $cwrite->status
;
460 // read $fh into the simpleFileWriter (grab in 64K chunks since its likely a media file)
461 while ( !feof( $fh ) ) {
462 $contents = fread( $fh, 65536 );
463 $cwrite->callbackWriteBody( $fh, $contents );
467 // check for simpleFileWriter error:
468 if( !$cwrite->status
->isOK() ){
469 return $cwrite->status
;
472 // read $fh into status->value
473 $status->value
= @stream_get_contents
( $fh );
475 //close the url file wrapper
479 if( $status->value
=== false ){
480 $status->error( 'file_get_contents-failed' );
488 * a simpleFileWriter with session id updates
490 class simpleFileWriter
{
491 var $target_file_path;
493 var $session_id = null;
494 var $session_update_interval = 0; // how often to update the session while downloading
496 function simpleFileWriter( $target_file_path, $upload_session_key ){
497 $this->target_file_path
= $target_file_path;
498 $this->upload_session_key
= $upload_session_key;
499 $this->status
= Status
::newGood();
501 $this->fp
= fopen( $this->target_file_path
, 'w' );
502 if( $this->fp
=== false ){
503 $this->status
= Status
::newFatal( 'HTTP::could-not-open-file-for-writing' );
506 $this->prevTime
= time();
509 public function callbackWriteBody( $ch, $data_packet ){
510 global $wgMaxUploadSize;
512 // write out the content
513 if( fwrite( $this->fp
, $data_packet ) === false ){
514 wfDebug( __METHOD__
." ::could-not-write-to-file\n" );
515 $this->status
= Status
::newFatal( 'HTTP::could-not-write-to-file' );
521 $this->current_fsize
= filesize( $this->target_file_path
);
523 if( $this->current_fsize
> $wgMaxUploadSize ){
524 wfDebug( __METHOD__
. " ::http download too large\n" );
525 $this->status
= Status
::newFatal( 'HTTP::file-has-grown-beyond-upload-limit-killing: downloaded more than ' .
526 Language
::formatSize( $wgMaxUploadSize ) . ' ' );
530 // if more than session_update_interval second have passed update_session_progress
531 if( $this->upload_session_key
&& ( ( time() - $this->prevTime
) > $this->session_update_interval
) ) {
532 $this->prevTime
= time();
533 $session_status = $this->update_session_progress();
534 if( !$session_status->isOK() ){
535 $this->status
= $session_status;
536 wfDebug( __METHOD__
. ' update session failed or was canceled');
540 return strlen( $data_packet );
543 public function update_session_progress(){
544 $status = Status
::newGood();
546 if( session_start() === false){
547 wfDebug( __METHOD__
. ' could not start session' );
550 $sd =& $_SESSION['wsDownload'][$this->upload_session_key
];
551 // check if the user canceled the request:
552 if( isset( $sd['user_cancel'] ) && $sd['user_cancel'] == true ){
554 return Status
::newFatal( 'user-canceled-request' );
556 // update the progress bytes download so far:
557 $sd['loaded'] = $this->current_fsize
;
558 wfDebug( __METHOD__
. ': set session loaded amount to: ' . $sd['loaded'] . "\n");
559 // close down the session so we can other http queries can get session updates:
560 session_write_close();
564 public function close(){
565 // do a final session update:
566 $this->update_session_progress();
567 // close up the file handle:
568 if( false === fclose( $this->fp
) ){
569 $this->status
= Status
::newFatal( 'HTTP::could-not-close-file' );