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 );
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 $wgSessionsInMemcached, $wgSessionHandler, $wgSessionStarted;
148 wfDebug( __METHOD__
. "\n\n doSessionIdDownload :\n\n" );
149 // set session to the provided key:
150 session_id( $session_id );
151 //fire up mediaWiki session system:
155 if( session_start() === false ){
156 wfDebug( __METHOD__
. ' could not start session' );
158 // get all the vars we need from session_id
159 if( !isset( $_SESSION[ 'wsDownload' ][$upload_session_key] ) ){
160 wfDebug( __METHOD__
. ' Error:could not find upload session');
163 // setup the global user from the session key we just inherited
164 $wgUser = User
::newFromSession();
166 // grab the session data to setup the request:
167 $sd =& $_SESSION['wsDownload'][$upload_session_key];
169 // update the wgServer var ( since cmd line thinks we are localhost when we are really orgServer)
170 if( isset( $sd['orgServer'] ) && $sd['orgServer'] ){
171 $wgServer = $sd['orgServer'];
173 // close down the session so we can other http queries can get session updates: (if not $wgSessionsInMemcached)
174 if( !$wgSessionsInMemcached )
175 session_write_close();
177 $req = new HttpRequest( $sd['url'], array(
178 'target_file_path' => $sd['target_file_path'],
179 'upload_session_key'=> $upload_session_key,
180 'timeout' => $wgAsyncHTTPTimeout,
181 'do_close_session_update' => true
183 // run the actual request .. (this can take some time)
184 wfDebug( __METHOD__
. 'do Session Download :: ' . $sd['url'] . ' tf: ' . $sd['target_file_path'] . "\n\n");
185 $status = $req->doRequest();
186 //wfDebug("done with req status is: ". $status->isOK(). ' '.$status->getWikiText(). "\n");
188 // start up the session again:
189 if( session_start() === false ){
190 wfDebug( __METHOD__
. ' ERROR:: Could not start session');
192 // grab the updated session data pointer
193 $sd =& $_SESSION['wsDownload'][$upload_session_key];
194 // if error update status:
195 if( !$status->isOK() ){
196 $sd['apiUploadResult'] = ApiFormatJson
::getJsonEncode(
197 array( 'error' => $status->getWikiText() )
200 // if status okay process upload using fauxReq to api:
201 if( $status->isOK() ){
202 // setup the FauxRequest
203 $fauxReqData = $sd['mParams'];
205 // Fix boolean parameters
206 foreach( $fauxReqData as $k => $v ) {
208 unset( $fauxReqData[$k] );
211 $fauxReqData['action'] = 'upload';
212 $fauxReqData['format'] = 'json';
213 $fauxReqData['internalhttpsession'] = $upload_session_key;
214 // evil but no other clean way about it:
215 $faxReq = new FauxRequest( $fauxReqData, true );
216 $processor = new ApiMain( $faxReq, $wgEnableWriteAPI );
218 //init the mUpload var for the $processor
219 $processor->execute();
220 $processor->getResult()->cleanUpUTF8();
221 $printer = $processor->createPrinterByName( 'json' );
222 $printer->initPrinter( false );
225 $apiUploadResult = ob_get_clean();
227 //wfDebug( __METHOD__ . "\n\n got api result:: $apiUploadResult \n" );
228 // the status updates runner will grab the result form the session:
229 $sd['apiUploadResult'] = $apiUploadResult;
231 // close the session:
232 session_write_close();
236 * Check if the URL can be served by localhost
237 * @param $url string Full url to check
240 public static function isLocalURL( $url ) {
241 global $wgCommandLineMode, $wgConf;
242 if ( $wgCommandLineMode ) {
248 if ( preg_match( '!^http://([\w.-]+)[/:].*$!', $url, $matches ) ) {
251 $domainParts = explode( '.', $host );
252 // Check if this domain or any superdomain is listed in $wgConf as a local virtual host
253 $domainParts = array_reverse( $domainParts );
254 for ( $i = 0; $i < count( $domainParts ); $i++
) {
255 $domainPart = $domainParts[$i];
257 $domain = $domainPart;
259 $domain = $domainPart . '.' . $domain;
261 if ( $wgConf->isLocalVHost( $domain ) ) {
270 * Return a standard user-agent we can use for external requests.
272 public static function userAgent() {
274 return "MediaWiki/$wgVersion";
279 var $target_file_path;
280 var $upload_session_key;
282 function __construct( $url, $opt ){
283 global $wgSyncHTTPTimeout;
284 // double check that it's a valid url:
287 // set the timeout to default sync timeout (unless the timeout option is provided)
288 $this->timeout
= ( isset( $opt['timeout'] ) ) ?
$opt['timeout'] : $wgSyncHTTPTimeout;
289 $this->method
= ( isset( $opt['method'] ) ) ?
$opt['method'] : 'GET';
290 $this->target_file_path
= ( isset( $opt['target_file_path'] ) ) ?
$opt['target_file_path'] : false;
291 $this->upload_session_key
= ( isset( $opt['upload_session_key'] ) ) ?
$opt['upload_session_key'] : false;
292 $this->headers_only
= ( isset( $opt['headers_only'] ) ) ?
$opt['headers_only'] : false;
293 $this->do_close_session_update
= isset( $opt['do_close_session_update'] );
294 $this->postData
= isset( $opt['postdata'] ) ?
$opt['postdata'] : '';
298 * Get the contents of a file by HTTP
299 * @param $url string Full URL to act on
300 * @param $Opt associative array Optional array of options:
301 * 'method' => 'GET', 'POST' etc.
302 * 'target_file_path' => if curl should output to a target file
303 * 'adapter' => 'curl', 'soket'
305 public function doRequest() {
306 # Make sure we have a valid url
307 if( !UploadFromUrl
::isValidURI( $this->url
) )
308 return Status
::newFatal('bad-url');
310 # Use curl if available
311 if ( function_exists( 'curl_init' ) ) {
312 return $this->doCurlReq();
314 return $this->doPhpReq();
318 private function doCurlReq(){
319 global $wgHTTPProxy, $wgTitle;
321 $status = Status
::newGood();
322 $c = curl_init( $this->url
);
325 if ( Http
::isLocalURL( $this->url
) ) {
326 curl_setopt( $c, CURLOPT_PROXY
, 'localhost:80' );
327 } else if ( $wgHTTPProxy ) {
328 curl_setopt( $c, CURLOPT_PROXY
, $wgHTTPProxy );
331 curl_setopt( $c, CURLOPT_TIMEOUT
, $this->timeout
);
332 curl_setopt( $c, CURLOPT_USERAGENT
, Http
::userAgent() );
334 if ( $this->headers_only
) {
335 curl_setopt( $c, CURLOPT_NOBODY
, true );
336 curl_setopt( $c, CURLOPT_HEADER
, true );
337 } elseif ( $this->method
== 'POST' ) {
338 curl_setopt( $c, CURLOPT_POST
, true );
339 curl_setopt( $c, CURLOPT_POSTFIELDS
, $this->postData
);
340 // Suppress 'Expect: 100-continue' header, as some servers
341 // will reject it with a 417 and Curl won't auto retry
342 // with HTTP 1.0 fallback
343 curl_setopt( $c, CURLOPT_HTTPHEADER
, array( 'Expect:' ) );
345 curl_setopt( $c, CURLOPT_CUSTOMREQUEST
, $this->method
);
348 # Set the referer to $wgTitle, even in command-line mode
349 # This is useful for interwiki transclusion, where the foreign
350 # server wants to know what the referring page is.
351 # $_SERVER['REQUEST_URI'] gives a less reliable indication of the
353 if ( is_object( $wgTitle ) ) {
354 curl_setopt( $c, CURLOPT_REFERER
, $wgTitle->getFullURL() );
357 // set the write back function (if we are writing to a file)
358 if( $this->target_file_path
){
359 $cwrite = new simpleFileWriter( $this->target_file_path
,
360 $this->upload_session_key
,
361 $this->do_close_session_update
363 if( !$cwrite->status
->isOK() ){
364 wfDebug( __METHOD__
. "ERROR in setting up simpleFileWriter\n" );
365 $status = $cwrite->status
;
368 curl_setopt( $c, CURLOPT_WRITEFUNCTION
, array( $cwrite, 'callbackWriteBody' ) );
371 // start output grabber:
372 if( !$this->target_file_path
)
375 //run the actual curl_exec:
377 if ( false === curl_exec( $c ) ) {
378 $error_txt ='Error sending request: #' . curl_errno( $c ) .' '. curl_error( $c );
379 wfDebug( __METHOD__
. $error_txt . "\n" );
380 $status = Status
::newFatal( $error_txt );
382 } catch ( Exception
$e ) {
383 // do something with curl exec error?
385 // if direct request output the results to the stats value:
386 if( !$this->target_file_path
&& $status->isOK() ){
387 $status->value
= ob_get_contents();
390 // if we wrote to a target file close up or return error
391 if( $this->target_file_path
){
393 if( !$cwrite->status
->isOK() ){
394 return $cwrite->status
;
398 if ( $this->headers_only
) {
399 $headers = explode( "\n", $status->value
);
400 $headerArray = array();
401 foreach ( $headers as $header ) {
402 if ( !strlen( trim( $header ) ) )
404 $headerParts = explode( ':', $header, 2 );
405 if ( count( $headerParts ) == 1 ) {
406 $headerArray[] = trim( $header );
408 list( $key, $val ) = $headerParts;
409 $headerArray[trim( $key )] = trim( $val );
412 $status->value
= $headerArray;
414 # Don't return the text of error messages, return false on error
415 $retcode = curl_getinfo( $c, CURLINFO_HTTP_CODE
);
416 if ( $retcode != 200 ) {
417 wfDebug( __METHOD__
. ": HTTP return code $retcode\n" );
418 $status = Status
::newFatal( "HTTP return code $retcode\n" );
420 # Don't return truncated output
421 $errno = curl_errno( $c );
422 if ( $errno != CURLE_OK
) {
423 $errstr = curl_error( $c );
424 wfDebug( __METHOD__
. ": CURL error code $errno: $errstr\n" );
425 $status = Status
::newFatal( " CURL error code $errno: $errstr\n" );
431 // return the result obj
435 public function doPhpReq(){
436 global $wgTitle, $wgHTTPProxy;
437 # Check for php.ini allow_url_fopen
438 if( !ini_get( 'allow_url_fopen' ) ){
439 return Status
::newFatal( 'allow_url_fopen needs to be enabled for http copy to work' );
442 // start with good status:
443 $status = Status
::newGood();
445 if ( $this->headers_only
) {
446 $status->value
= get_headers( $this->url
, 1 );
451 $headers = array( "User-Agent: " . Http
::userAgent() );
452 if ( is_object( $wgTitle ) ) {
453 $headers[] = "Referer: ". $wgTitle->getFullURL();
456 if( strcasecmp( $this->method
, 'post' ) == 0 ) {
457 // Required for HTTP 1.0 POSTs
458 $headers[] = "Content-Length: 0";
460 $fcontext = stream_context_create ( array(
462 'method' => $this->method
,
463 'header' => implode( "\r\n", $headers ),
464 'timeout' => $this->timeout
)
467 $fh = fopen( $this->url
, "r", false, $fcontext);
469 // set the write back function (if we are writing to a file)
470 if( $this->target_file_path
){
471 $cwrite = new simpleFileWriter( $this->target_file_path
, $this->upload_session_key
, $this->do_close_session_update
);
472 if( !$cwrite->status
->isOK() ){
473 wfDebug( __METHOD__
. "ERROR in setting up simpleFileWriter\n" );
474 $status = $cwrite->status
;
478 // read $fh into the simpleFileWriter (grab in 64K chunks since its likely a ~large~ media file)
479 while ( !feof( $fh ) ) {
480 $contents = fread( $fh, 65536 );
481 $cwrite->callbackWriteBody( $fh, $contents );
484 // check for simpleFileWriter error:
485 if( !$cwrite->status
->isOK() ){
486 return $cwrite->status
;
489 // read $fh into status->value
490 $status->value
= @stream_get_contents
( $fh );
492 //close the url file wrapper
496 if( $status->value
=== false ){
497 $status->error( 'file_get_contents-failed' );
505 * a simpleFileWriter with session id updates
507 class simpleFileWriter
{
508 var $target_file_path;
510 var $session_id = null;
511 var $session_update_interval = 0; // how often to update the session while downloading
513 function simpleFileWriter( $target_file_path, $upload_session_key, $do_close_session_update = false ){
514 $this->target_file_path
= $target_file_path;
515 $this->upload_session_key
= $upload_session_key;
516 $this->status
= Status
::newGood();
517 $this->do_close_session_update
= $do_close_session_update;
519 $this->fp
= fopen( $this->target_file_path
, 'w' );
520 if( $this->fp
=== false ){
521 $this->status
= Status
::newFatal( 'HTTP::could-not-open-file-for-writing' );
524 $this->prevTime
= time();
527 public function callbackWriteBody( $ch, $data_packet ){
528 global $wgMaxUploadSize, $wgLang;
530 // write out the content
531 if( fwrite( $this->fp
, $data_packet ) === false ){
532 wfDebug( __METHOD__
." ::could-not-write-to-file\n" );
533 $this->status
= Status
::newFatal( 'HTTP::could-not-write-to-file' );
539 $this->current_fsize
= filesize( $this->target_file_path
);
541 if( $this->current_fsize
> $wgMaxUploadSize ){
542 wfDebug( __METHOD__
. " ::http download too large\n" );
543 $this->status
= Status
::newFatal( 'HTTP::file-has-grown-beyond-upload-limit-killing: downloaded more than ' .
544 $wgLang->formatSize( $wgMaxUploadSize ) . ' ' );
547 // if more than session_update_interval second have passed update_session_progress
548 if( $this->do_close_session_update
&& $this->upload_session_key
&&
549 ( ( time() - $this->prevTime
) > $this->session_update_interval
) ) {
550 $this->prevTime
= time();
551 $session_status = $this->update_session_progress();
552 if( !$session_status->isOK() ){
553 $this->status
= $session_status;
554 wfDebug( __METHOD__
. ' update session failed or was canceled');
558 return strlen( $data_packet );
561 public function update_session_progress(){
562 global $wgSessionsInMemcached;
563 $status = Status
::newGood();
564 // start the session (if necessary)
565 if( !$wgSessionsInMemcached ){
566 if( @session_start
() === false){
567 wfDebug( __METHOD__
. ' could not start session' );
571 $sd =& $_SESSION['wsDownload'][ $this->upload_session_key
];
572 // check if the user canceled the request:
573 if( isset( $sd['user_cancel'] ) && $sd['user_cancel'] == true ){
574 //@@todo kill the download
575 return Status
::newFatal( 'user-canceled-request' );
577 // update the progress bytes download so far:
578 $sd['loaded'] = $this->current_fsize
;
580 // close down the session so we can other http queries can get session updates:
581 if( !$wgSessionsInMemcached )
582 session_write_close();
587 public function close(){
588 // do a final session update:
589 if( $this->do_close_session_update
){
590 $this->update_session_progress();
592 // close up the file handle:
593 if( false === fclose( $this->fp
) ){
594 $this->status
= Status
::newFatal( 'HTTP::could-not-close-file' );