includes/HttpFunctions.php

   1 <?php
   2 /**
   3  * HTTP handling class
   4  * @defgroup HTTP HTTP
   5  * @file
   6  * @ingroup HTTP
   7  */
   8
   9 class Http {
  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)
  12
  13         var $body = '';
  14
  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;
  21                 } else {
  22                         wfDebug( 'http error: ' . $status->getWikiText() );
  23                         return false;
  24                 }
  25         }
  26
  27         /**
  28          * Simple wrapper for Http::request( 'GET' )
  29          */
  30         public static function get( $url, $timeout = false, $opts = array() ) {
  31                 global $wgSyncHTTPTimeout;
  32                 if( $timeout )
  33                         $opts['timeout'] = $timeout;
  34                 return Http::request( 'GET', $url, $opts );
  35         }
  36
  37         /**
  38          * Simple wrapper for Http::request( 'POST' )
  39          */
  40         public static function post( $url, $opts = array() ) {
  41                 return Http::request( 'POST', $url, $opts );
  42         }
  43
  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() ){
  50                         return $headResponse;
  51                 }
  52                 $head = $headResponse->value;
  53
  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++ );
  59                                 } else {
  60                                         return Status::newFatal( 'upload-proto-error' );
  61                                 }
  62                         } else {
  63                                 return Status::newFatal( 'upload-too-many-redirects' );
  64                         }
  65                 }
  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] ) );
  69                 }
  70
  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 );
  75                         }
  76                 }
  77
  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 {
  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();
  90                 }
  91         }
  92
  93         /**
  94          * a non blocking request (generally an exit point in the application)
  95          * should write to a file location and give updates
  96          *
  97          */
  98         private static function initBackgroundDownload( $url, $target_file_path, $content_length = null ){
  99                 global $wgMaxUploadSize, $IP, $wgPhpCli, $wgServer;
 100                 $status = Status::newGood();
 101
 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();
 105
 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;
 111
 112                 if( $content_length )
 113                         $_SESSION['wsDownload'][$upload_session_key]['content_length'] = $content_length;
 114
 115                 // set initial loaded bytes:
 116                 $_SESSION['wsDownload'][$upload_session_key]['loaded'] = 0;
 117
 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.
 122                 if( !$pid )
 123                         return Status::newFatal( 'could not run background shell exec' );
 124
 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;
 127
 128                 // return good status
 129                 return $status;
 130         }
 131
 132         static function getUploadSessionKey(){
 133                 $key = mt_rand( 0, 0x7fffffff );
 134                 $_SESSION['wsUploadData'][$key] = array();
 135                 return $key;
 136         }
 137
 138         /**
 139          * used to run a session based download. Is initiated via the shell.
 140          *
 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)
 144          */
 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:
 152                 wfSetupSession();
 153
 154                 // start the session
 155                 if( session_start() === false ){
 156                         wfDebug( __METHOD__ . ' could not start session' );
 157                 }
 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');
 161                         exit();
 162                 }
 163                 // setup the global user from the session key we just inherited
 164                 $wgUser = User::newFromSession();
 165
 166                 // grab the session data to setup the request:
 167                 $sd =& $_SESSION['wsDownload'][$upload_session_key];
 168
 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'];
 172                 }
 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();
 176
 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
 182                 ) );
 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");
 187
 188                 // start up the session again:
 189                 if( session_start() === false ){
 190                         wfDebug( __METHOD__ . ' ERROR:: Could not start session');
 191                 }
 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() )
 198                         );
 199                 }
 200                 // if status okay process upload using fauxReq to api:
 201                 if( $status->isOK() ){
 202                         // setup the FauxRequest
 203                         $fauxReqData = $sd['mParams'];
 204
 205                         // Fix boolean parameters
 206                         foreach( $fauxReqData as $k => $v ) {
 207                                 if( $v === false )
 208                                         unset( $fauxReqData[$k] );
 209                         }
 210
 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 );
 217
 218                         //init the mUpload var for the $processor
 219                         $processor->execute();
 220                         $processor->getResult()->cleanUpUTF8();
 221                         $printer = $processor->createPrinterByName( 'json' );
 222                         $printer->initPrinter( false );
 223                         ob_start();
 224                         $printer->execute();
 225                         $apiUploadResult = ob_get_clean();
 226
 227                         // the status updates runner will grab the result form the session:
 228                         $sd['apiUploadResult'] = $apiUploadResult;
 229                 }
 230                 // close the session:
 231                 session_write_close();
 232         }
 233
 234         /**
 235          * Check if the URL can be served by localhost
 236          * @param $url string Full url to check
 237          * @return bool
 238          */
 239         public static function isLocalURL( $url ) {
 240                 global $wgCommandLineMode, $wgConf;
 241                 if ( $wgCommandLineMode ) {
 242                         return false;
 243                 }
 244
 245                 // Extract host part
 246                 $matches = array();
 247                 if ( preg_match( '!^http://([\w.-]+)[/:].*$!', $url, $matches ) ) {
 248                         $host = $matches[1];
 249                         // Split up dotwise
 250                         $domainParts = explode( '.', $host );
 251                         // Check if this domain or any superdomain is listed in $wgConf as a local virtual host
 252                         $domainParts = array_reverse( $domainParts );
 253                         for ( $i = 0; $i < count( $domainParts ); $i++ ) {
 254                                 $domainPart = $domainParts[$i];
 255                                 if ( $i == 0 ) {
 256                                         $domain = $domainPart;
 257                                 } else {
 258                                         $domain = $domainPart . '.' . $domain;
 259                                 }
 260                                 if ( $wgConf->isLocalVHost( $domain ) ) {
 261                                         return true;
 262                                 }
 263                         }
 264                 }
 265                 return false;
 266         }
 267
 268         /**
 269          * Return a standard user-agent we can use for external requests.
 270          */
 271         public static function userAgent() {
 272                 global $wgVersion;
 273                 return "MediaWiki/$wgVersion";
 274         }
 275 }
 276
 277 class HttpRequest {
 278         var $target_file_path;
 279         var $upload_session_key;
 280         var $supportedCurlOpts = array(
 281                 'CURLOPT_SSL_VERIFYHOST',
 282                 'CURLOPT_CAINFO',
 283                 'CURLOPT_COOKIE',
 284                 'CURLOPT_FOLLOWLOCATION',
 285                 'CURLOPT_FAILONERROR'
 286         );
 287         function __construct( $url, $opt ){
 288                 global $wgSyncHTTPTimeout;
 289                 // double check that it's a valid url:
 290                 $this->url = $url;
 291
 292                 // set the timeout to default sync timeout (unless the timeout option is provided)
 293                 $this->timeout = ( isset( $opt['timeout'] ) ) ? $opt['timeout'] : $wgSyncHTTPTimeout;
 294                 //check special key default
 295                 if($timeout == 'default'){
 296                         $opts['timeout'] = $wgSyncHTTPTimeout;
 297                 }
 298
 299                 $this->method = ( isset( $opt['method'] ) ) ? $opt['method'] : 'GET';
 300                 $this->target_file_path = ( isset( $opt['target_file_path'] ) ) ? $opt['target_file_path'] : false;
 301                 $this->upload_session_key = ( isset( $opt['upload_session_key'] ) ) ? $opt['upload_session_key'] : false;
 302                 $this->headers_only = ( isset( $opt['headers_only'] ) ) ? $opt['headers_only'] : false;
 303                 $this->do_close_session_update = isset( $opt['do_close_session_update'] );
 304                 $this->postData = isset( $opt['postdata'] ) ? $opt['postdata'] : '';
 305
 306                 $this->curlOpt = array();
 307                 //check for some curl options:
 308                 foreach($this->supportedCurlOpts as $curlOpt){
 309                         if(isset($opt[ $curlOpt ])){
 310                                 $this->curlOpt[$curlOpt] = $opt[ $curlOpt ];
 311                         }
 312                 }
 313         }
 314
 315         /**
 316          * Get the contents of a file by HTTP
 317          * @param $url string Full URL to act on
 318          * @param $Opt associative array Optional array of options:
 319          *     'method'           => 'GET', 'POST' etc.
 320          *     'target_file_path' => if curl should output to a target file
 321          *     'adapter'          => 'curl', 'soket'
 322          */
 323         public function doRequest() {
 324                 # Make sure we have a valid url
 325                 if( !UploadFromUrl::isValidURI( $this->url ) )
 326                         return Status::newFatal('bad-url');
 327
 328                 # Use curl if available
 329                 if ( function_exists( 'curl_init' ) ) {
 330                         return $this->doCurlReq();
 331                 } else {
 332                         return $this->doPhpReq();
 333                 }
 334         }
 335
 336         private function doCurlReq(){
 337                 global $wgHTTPProxy, $wgTitle;
 338
 339                 $status = Status::newGood();
 340                 $c = curl_init( $this->url );
 341
 342                 // proxy setup:
 343                 if ( Http::isLocalURL( $this->url ) ) {
 344                         curl_setopt( $c, CURLOPT_PROXY, 'localhost:80' );
 345                 } else if ( $wgHTTPProxy ) {
 346                         curl_setopt( $c, CURLOPT_PROXY, $wgHTTPProxy );
 347                 }
 348
 349                 curl_setopt( $c, CURLOPT_TIMEOUT, $this->timeout );
 350                 curl_setopt( $c, CURLOPT_USERAGENT, Http::userAgent() );
 351
 352                 //set any curl specific opts:
 353                 foreach($this->curlOpt as $optKey => $optVal){
 354                         curl_setopt($c, constant( $optKey ),  $optVal);
 355                 }
 356
 357                 if ( $this->headers_only ) {
 358                         curl_setopt( $c, CURLOPT_NOBODY, true );
 359                         curl_setopt( $c, CURLOPT_HEADER, true );
 360                 } elseif ( $this->method == 'POST' ) {
 361                         curl_setopt( $c, CURLOPT_POST, true );
 362                         curl_setopt( $c, CURLOPT_POSTFIELDS, $this->postData );
 363                         // Suppress 'Expect: 100-continue' header, as some servers
 364                         // will reject it with a 417 and Curl won't auto retry
 365                         // with HTTP 1.0 fallback
 366                         curl_setopt( $c, CURLOPT_HTTPHEADER, array( 'Expect:' ) );
 367                 } else {
 368                         curl_setopt( $c, CURLOPT_CUSTOMREQUEST, $this->method );
 369                 }
 370
 371                 # Set the referer to $wgTitle, even in command-line mode
 372                 # This is useful for interwiki transclusion, where the foreign
 373                 # server wants to know what the referring page is.
 374                 # $_SERVER['REQUEST_URI'] gives a less reliable indication of the
 375                 # referring page.
 376                 if ( is_object( $wgTitle ) ) {
 377                         curl_setopt( $c, CURLOPT_REFERER, $wgTitle->getFullURL() );
 378                 }
 379
 380                 // set the write back function (if we are writing to a file)
 381                 if( $this->target_file_path ){
 382                         $cwrite = new simpleFileWriter( $this->target_file_path,
 383                                 $this->upload_session_key,
 384                                 $this->do_close_session_update
 385                         );
 386                         if( !$cwrite->status->isOK() ){
 387                                 wfDebug( __METHOD__ . "ERROR in setting up simpleFileWriter\n" );
 388                                 $status = $cwrite->status;
 389                                 return $status;
 390                         }
 391                         curl_setopt( $c, CURLOPT_WRITEFUNCTION, array( $cwrite, 'callbackWriteBody' ) );
 392                 }
 393
 394                 // start output grabber:
 395                 if( !$this->target_file_path )
 396                         ob_start();
 397
 398                 //run the actual curl_exec:
 399                 try {
 400                         if ( false === curl_exec( $c ) ) {
 401                                 $error_txt ='Error sending request: #' . curl_errno( $c ) .' '. curl_error( $c );
 402                                 wfDebug( __METHOD__ . $error_txt . "\n" );
 403                                 $status = Status::newFatal( $error_txt );
 404                         }
 405                 } catch ( Exception $e ) {
 406                         // do something with curl exec error?
 407                 }
 408                 // if direct request output the results to the stats value:
 409                 if( !$this->target_file_path && $status->isOK() ){
 410                         $status->value = ob_get_contents();
 411                         ob_end_clean();
 412                 }
 413                 // if we wrote to a target file close up or return error
 414                 if( $this->target_file_path ){
 415                         $cwrite->close();
 416                         if( !$cwrite->status->isOK() ){
 417                                 return $cwrite->status;
 418                         }
 419                 }
 420
 421                 if ( $this->headers_only ) {
 422                         $headers = explode( "\n", $status->value );
 423                         $headerArray = array();
 424                         foreach ( $headers as $header ) {
 425                                 if ( !strlen( trim( $header ) ) )
 426                                         continue;
 427                                 $headerParts = explode( ':', $header, 2 );
 428                                 if ( count( $headerParts ) == 1 ) {
 429                                         $headerArray[] = trim( $header );
 430                                 } else {
 431                                         list( $key, $val ) = $headerParts;
 432                                         $headerArray[trim( $key )] = trim( $val );
 433                                 }
 434                         }
 435                         $status->value = $headerArray;
 436                 } else {
 437                         # Don't return the text of error messages, return false on error
 438                         $retcode = curl_getinfo( $c, CURLINFO_HTTP_CODE );
 439                         if ( $retcode != 200 ) {
 440                                 wfDebug( __METHOD__ . ": HTTP return code $retcode\n" );
 441                                 $status = Status::newFatal( "HTTP return code $retcode\n" );
 442                         }
 443                         # Don't return truncated output
 444                         $errno = curl_errno( $c );
 445                         if ( $errno != CURLE_OK ) {
 446                                 $errstr = curl_error( $c );
 447                                 wfDebug( __METHOD__ . ": CURL error code $errno: $errstr\n" );
 448                                 $status = Status::newFatal( " CURL error code $errno: $errstr\n" );
 449                         }
 450                 }
 451
 452                 curl_close( $c );
 453
 454                 // return the result obj
 455                 return $status;
 456         }
 457
 458         public function doPhpReq(){
 459                 global $wgTitle, $wgHTTPProxy;
 460                 # Check for php.ini allow_url_fopen
 461                 if( !ini_get( 'allow_url_fopen' ) ){
 462                         return Status::newFatal( 'allow_url_fopen needs to be enabled for http copy to work' );
 463                 }
 464
 465                 // start with good status:
 466                 $status = Status::newGood();
 467
 468                 if ( $this->headers_only ) {
 469                         $status->value = get_headers( $this->url, 1 );
 470                         return $status;
 471                 }
 472
 473                 // setup the headers
 474                 $headers = array( "User-Agent: " . Http::userAgent() );
 475                 if ( is_object( $wgTitle ) ) {
 476                         $headers[] = "Referer: ". $wgTitle->getFullURL();
 477                 }
 478
 479                 if( strcasecmp( $this->method, 'post' ) == 0 ) {
 480                         // Required for HTTP 1.0 POSTs
 481                         $headers[] = "Content-Length: 0";
 482                 }
 483                 $fcontext = stream_context_create ( array(
 484                         'http' => array(
 485                                 'method' => $this->method,
 486                                 'header' => implode( "\r\n", $headers ),
 487                                 'timeout' => $this->timeout )
 488                         )
 489                 );
 490                 $fh = fopen( $this->url, "r", false, $fcontext);
 491
 492                 // set the write back function (if we are writing to a file)
 493                 if( $this->target_file_path ){
 494                         $cwrite = new simpleFileWriter( $this->target_file_path, $this->upload_session_key, $this->do_close_session_update );
 495                         if( !$cwrite->status->isOK() ){
 496                                 wfDebug( __METHOD__ . "ERROR in setting up simpleFileWriter\n" );
 497                                 $status = $cwrite->status;
 498                                 return $status;
 499                         }
 500
 501                         // read $fh into the simpleFileWriter (grab in 64K chunks since its likely a ~large~ media file)
 502                         while ( !feof( $fh ) ) {
 503                                 $contents = fread( $fh, 65536 );
 504                                 $cwrite->callbackWriteBody( $fh, $contents );
 505                         }
 506                         $cwrite->close();
 507                         // check for simpleFileWriter error:
 508                         if( !$cwrite->status->isOK() ){
 509                                 return $cwrite->status;
 510                         }
 511                 } else {
 512                         // read $fh into status->value
 513                         $status->value = @stream_get_contents( $fh );
 514                 }
 515                 //close the url file wrapper
 516                 fclose( $fh );
 517
 518                 // check for "false"
 519                 if( $status->value === false ){
 520                         $status->error( 'file_get_contents-failed' );
 521                 }
 522                 return $status;
 523         }
 524
 525 }
 526
 527 /**
 528  * a simpleFileWriter with session id updates
 529  */
 530 class simpleFileWriter {
 531         var $target_file_path;
 532         var $status = null;
 533         var $session_id = null;
 534         var $session_update_interval = 0; // how often to update the session while downloading
 535
 536         function simpleFileWriter( $target_file_path, $upload_session_key, $do_close_session_update = false ){
 537                 $this->target_file_path = $target_file_path;
 538                 $this->upload_session_key = $upload_session_key;
 539                 $this->status = Status::newGood();
 540                 $this->do_close_session_update = $do_close_session_update;
 541                 // open the file:
 542                 $this->fp = fopen( $this->target_file_path, 'w' );
 543                 if( $this->fp === false ){
 544                         $this->status = Status::newFatal( 'HTTP::could-not-open-file-for-writing' );
 545                 }
 546                 // true start time
 547                 $this->prevTime = time();
 548         }
 549
 550         public function callbackWriteBody( $ch, $data_packet ){
 551                 global $wgMaxUploadSize, $wgLang;
 552
 553                 // write out the content
 554                 if( fwrite( $this->fp, $data_packet ) === false ){
 555                         wfDebug( __METHOD__ ." ::could-not-write-to-file\n" );
 556                         $this->status = Status::newFatal( 'HTTP::could-not-write-to-file' );
 557                         return 0;
 558                 }
 559
 560                 // check file size:
 561                 clearstatcache();
 562                 $this->current_fsize = filesize( $this->target_file_path );
 563
 564                 if( $this->current_fsize > $wgMaxUploadSize ){
 565                         wfDebug( __METHOD__ . " ::http download too large\n" );
 566                         $this->status = Status::newFatal( 'HTTP::file-has-grown-beyond-upload-limit-killing: downloaded more than ' .
 567                                 $wgLang->formatSize( $wgMaxUploadSize ) . ' ' );
 568                         return 0;
 569                 }
 570                 // if more than session_update_interval second have passed update_session_progress
 571                 if( $this->do_close_session_update && $this->upload_session_key &&
 572                         ( ( time() - $this->prevTime ) > $this->session_update_interval ) ) {
 573                                 $this->prevTime = time();
 574                                 $session_status = $this->update_session_progress();
 575                                 if( !$session_status->isOK() ){
 576                                         $this->status = $session_status;
 577                                         wfDebug( __METHOD__ . ' update session failed or was canceled');
 578                                         return 0;
 579                                 }
 580                 }
 581                 return strlen( $data_packet );
 582         }
 583
 584         public function update_session_progress(){
 585                 global $wgSessionsInMemcached;
 586                 $status = Status::newGood();
 587                 // start the session (if necessary)
 588                 if( !$wgSessionsInMemcached ){
 589                         if(  @session_start() === false){
 590                                 wfDebug( __METHOD__ . ' could not start session' );
 591                                 exit( 0 );
 592                         }
 593                 }
 594                 $sd =& $_SESSION['wsDownload'][ $this->upload_session_key ];
 595                 // check if the user canceled the request:
 596                 if( isset( $sd['user_cancel'] ) && $sd['user_cancel'] == true ){
 597                         //@@todo kill the download
 598                         return Status::newFatal( 'user-canceled-request' );
 599                 }
 600                 // update the progress bytes download so far:
 601                 $sd['loaded'] = $this->current_fsize;
 602
 603                 // close down the session so we can other http queries can get session updates:
 604                 if( !$wgSessionsInMemcached )
 605                         session_write_close();
 606
 607                 return $status;
 608         }
 609
 610         public function close(){
 611                 // do a final session update:
 612                 if( $this->do_close_session_update ){
 613                         $this->update_session_progress();
 614                 }
 615                 // close up the file handle:
 616                 if( false === fclose( $this->fp ) ){
 617                         $this->status = Status::newFatal( 'HTTP::could-not-close-file' );
 618                 }
 619         }
 620
 621 }