<?php
/**
- * HTTP handling class
* @defgroup HTTP HTTP
- * @file
- * @ingroup HTTP
*/
+/**
+ * Various HTTP related functions
+ * @ingroup HTTP
+ */
class Http {
- const SYNC_DOWNLOAD = 1; // syncronys upload (in a single request)
- const ASYNC_DOWNLOAD = 2; // asynchronous upload we should spawn out another process and monitor progress if possible)
-
- var $body = '';
- public static function request($method, $url, $opts = Array() ){
- $opts['method'] = ( strtoupper( $method ) == 'GET' || strtoupper( $method ) == 'POST' ) ? strtoupper( $method ) : null;
- $req = new HttpRequest( $url, $opts );
- $status = $req->doRequest();
- if( $status->isOK() ){
- return $status->value;
+ static $httpEngine = false;
+
+ /**
+ * Perform an HTTP request
+ * @param $method string HTTP method. Usually GET/POST
+ * @param $url string Full URL to act on
+ * @param $options options to pass to HttpRequest object
+ * @returns mixed (bool)false on failure or a string on success
+ */
+ public static function request( $method, $url, $options = array() ) {
+ wfDebug( "HTTP: $method: $url" );
+ $options['method'] = strtoupper( $method );
+ if ( !isset( $options['timeout'] ) ) {
+ $options['timeout'] = 'default';
+ }
+ $req = HttpRequest::factory( $url, $options );
+ $status = $req->execute();
+ if ( $status->isOK() ) {
+ return $req->getContent();
} else {
- wfDebug( 'http error: ' . $status->getWikiText() );
return false;
}
}
+
/**
* Simple wrapper for Http::request( 'GET' )
+ * @see Http::request()
*/
- public static function get( $url, $timeout = false ) {
- $opts = Array();
- if( $timeout )
- $opts['timeout'] = $timeout;
- return Http::request( 'GET', $url, $opts );
+ public static function get( $url, $timeout = 'default', $options = array() ) {
+ $options['timeout'] = $timeout;
+ return Http::request( 'GET', $url, $options );
}
/**
* Simple wrapper for Http::request( 'POST' )
+ * @see Http::request()
*/
- public static function post( $url, $opts = array() ) {
- return Http::request( 'POST', $url, $opts );
- }
-
- public static function doDownload( $url, $target_file_path , $dl_mode = self::SYNC_DOWNLOAD , $redirectCount = 0 ){
- global $wgPhpCli, $wgMaxUploadSize, $wgMaxRedirects;
- // do a quick check to HEAD to insure the file size is not > $wgMaxUploadSize
- $headRequest = new HttpRequest( $url, array( 'headers_only' => true ) );
- $headResponse = $headRequest->doRequest();
- if( !$headResponse->isOK() ){
- return $headResponse;
- }
- $head = $headResponse->value;
-
- // check for redirects:
- if( isset( $head['Location'] ) && strrpos( $head[0], '302' ) !== false ){
- if( $redirectCount < $wgMaxRedirects ){
- if( UploadFromUrl::isValidURI( $head['Location'] ) ){
- return self::doDownload( $head['Location'], $target_file_path , $dl_mode, $redirectCount++ );
- } else {
- return Status::newFatal( 'upload-proto-error' );
- }
- } else {
- return Status::newFatal( 'upload-too-many-redirects' );
- }
- }
- // we did not get a 200 ok response:
- if( strrpos( $head[0], '200 OK' ) === false ){
- return Status::newFatal( 'upload-http-error', htmlspecialchars( $head[0] ) );
- }
-
- $content_length = ( isset( $head['Content-Length'] ) ) ? $head['Content-Length'] : null;
- if( $content_length ){
- if( $content_length > $wgMaxUploadSize ){
- return Status::newFatal( 'requested file length ' . $content_length . ' is greater than $wgMaxUploadSize: ' . $wgMaxUploadSize );
- }
- }
-
- // check if we can find phpCliPath (for doing a background shell request to php to do the download:
- if( $wgPhpCli && wfShellExecEnabled() && $dl_mode == self::ASYNC_DOWNLOAD ){
- wfDebug( __METHOD__ . "\ASYNC_DOWNLOAD\n" );
- // setup session and shell call:
- return self::initBackgroundDownload( $url, $target_file_path, $content_length );
- } else if( $dl_mode == self::SYNC_DOWNLOAD ){
- wfDebug( __METHOD__ . "\nSYNC_DOWNLOAD\n" );
- // SYNC_DOWNLOAD download as much as we can in the time we have to execute
- $opts['method'] = 'GET';
- $opts['target_file_path'] = $target_file_path;
- $req = new HttpRequest( $url, $opts );
- return $req->doRequest();
- }
- }
-
- /**
- * a non blocking request (generally an exit point in the application)
- * should write to a file location and give updates
- *
- */
- private static function initBackgroundDownload( $url, $target_file_path, $content_length = null ){
- global $wgMaxUploadSize, $IP, $wgPhpCli, $wgServer;
- $status = Status::newGood();
-
- // generate a session id with all the details for the download (pid, target_file_path )
- $upload_session_key = self::getUploadSessionKey();
- $session_id = session_id();
-
- // store the url and target path:
- $_SESSION['wsDownload'][$upload_session_key]['url'] = $url;
- $_SESSION['wsDownload'][$upload_session_key]['target_file_path'] = $target_file_path;
- //since we request from the cmd line we lose the original host name pass in the session:
- $_SESSION['wsDownload'][$upload_session_key]['orgServer'] = $wgServer;
-
- if( $content_length )
- $_SESSION['wsDownload'][$upload_session_key]['content_length'] = $content_length;
-
- // set initial loaded bytes:
- $_SESSION['wsDownload'][$upload_session_key]['loaded'] = 0;
-
- // run the background download request:
- $cmd = $wgPhpCli . ' ' . $IP . "/maintenance/http_session_download.php --sid {$session_id} --usk {$upload_session_key}";
- $pid = wfShellBackgroundExec( $cmd );
- // the pid is not of much use since we won't be visiting this same apache any-time soon.
- if( !$pid )
- return Status::newFatal( 'could not run background shell exec' );
-
- // update the status value with the $upload_session_key (for the user to check on the status of the upload)
- $status->value = $upload_session_key;
-
- // return good status
- return $status;
- }
-
- static function getUploadSessionKey(){
- $key = mt_rand( 0, 0x7fffffff );
- $_SESSION['wsUploadData'][$key] = array();
- return $key;
- }
-
- /**
- * used to run a session based download. Is initiated via the shell.
- *
- * @param $session_id String: the session id to grab download details from
- * @param $upload_session_key String: the key of the given upload session
- * (a given client could have started a few http uploads at once)
- */
- public static function doSessionIdDownload( $session_id, $upload_session_key ){
- global $wgUser, $wgEnableWriteAPI, $wgAsyncHTTPTimeout, $wgServer;
- wfDebug( __METHOD__ . "\n\ndoSessionIdDownload:\n\n" );
- // set session to the provided key:
- session_id( $session_id );
- // start the session
- if( session_start() === false ){
- wfDebug( __METHOD__ . ' could not start session' );
- }
- //get all the vars we need from session_id
- if(!isset($_SESSION[ 'wsDownload' ][$upload_session_key])){
- wfDebug( __METHOD__ .' Error:could not find upload session');
- exit();
- }
- // setup the global user from the session key we just inherited
- $wgUser = User::newFromSession();
-
- // grab the session data to setup the request:
- $sd =& $_SESSION['wsDownload'][$upload_session_key];
-
- //update the wgServer var ( since cmd line thinks we are localhost when we are really orgServer)
- if(isset($sd['orgServer']) && $sd['orgServer']){
- $wgServer = $sd['orgServer'];
- }
- // close down the session so we can other http queries can get session updates:
- session_write_close();
-
- $req = new HttpRequest( $sd['url'], array(
- 'target_file_path' => $sd['target_file_path'],
- 'upload_session_key'=> $upload_session_key,
- 'timeout' => $wgAsyncHTTPTimeout
- ) );
- // run the actual request .. (this can take some time)
- wfDebug( __METHOD__ . "do Request: " . $sd['url'] . ' tf: ' . $sd['target_file_path'] );
- $status = $req->doRequest();
- //wfDebug("done with req status is: ". $status->isOK(). ' '.$status->getWikiText(). "\n");
-
- // start up the session again:
- if( session_start() === false ){
- wfDebug( __METHOD__ . ' ERROR:: Could not start session');
- }
- // grab the updated session data pointer
- $sd =& $_SESSION['wsDownload'][$upload_session_key];
- // if error update status:
- if( !$status->isOK() ){
- $sd['apiUploadResult'] = ApiFormatJson::getJsonEncode(
- array( 'error' => $status->getWikiText() )
- );
- }
- // if status okay process upload using fauxReq to api:
- if( $status->isOK() ){
- // setup the FauxRequest
- $fauxReqData = $sd['mParams'];
- $fauxReqData['action'] = 'upload';
- $fauxReqData['format'] = 'json';
- $fauxReqData['internalhttpsession'] = $upload_session_key;
-
- // evil but no other clean way about it:
- $faxReq = new FauxRequest( $fauxReqData, true );
- $processor = new ApiMain( $faxReq, $wgEnableWriteAPI );
-
- //init the mUpload var for the $processor
- $processor->execute();
- $processor->getResult()->cleanUpUTF8();
- $printer = $processor->createPrinterByName( 'json' );
- $printer->initPrinter( false );
- ob_start();
- $printer->execute();
- $apiUploadResult = ob_get_clean();
-
- wfDebug( __METHOD__ . "\n\n got api result:: $apiUploadResult \n" );
- // the status updates runner will grab the result form the session:
- $sd['apiUploadResult'] = $apiUploadResult;
- }
- // close the session:
- session_write_close();
+ public static function post( $url, $options = array() ) {
+ return Http::request( 'POST', $url, $options );
}
/**
}
/**
- * Return a standard user-agent we can use for external requests.
+ * A standard user-agent we can use for external requests.
+ * @returns string
*/
public static function userAgent() {
global $wgVersion;
return "MediaWiki/$wgVersion";
}
+
+ /**
+ * Checks that the given URI is a valid one
+ * @param $uri Mixed: URI to check for validity
+ * @returns bool
+ */
+ public static function isValidURI( $uri ) {
+ return preg_match(
+ '/(ftp|http|https):\/\/(\w+:{0,1}\w*@)?(\S+)(:[0-9]+)?(\/|\/([\w#!:.?+=&%@!\-\/]))?/',
+ $uri,
+ $matches
+ );
+ }
}
+
+/**
+ * This wrapper class will call out to curl (if available) or fallback
+ * to regular PHP if necessary for handling internal HTTP requests.
+ */
class HttpRequest {
- var $target_file_path;
- var $upload_session_key;
+ protected $content;
+ protected $timeout = 'default';
+ protected $headersOnly = null;
+ protected $postData = null;
+ protected $proxy = null;
+ protected $noProxy = false;
+ protected $sslVerifyHost = true;
+ protected $caInfo = null;
+ protected $method = "GET";
+ protected $reqHeaders = array();
+ protected $url;
+ protected $parsedUrl;
+ protected $callback;
+ public $status;
+
+ /**
+ * @param $url string url to use
+ * @param $options array (optional) extra params to pass
+ * Possible keys for the array:
+ * method
+ * timeout
+ * targetFilePath
+ * requestKey
+ * postData
+ * proxy
+ * noProxy
+ * sslVerifyHost
+ * caInfo
+ */
+ function __construct( $url, $options = array() ) {
+ global $wgHTTPTimeout;
- function __construct( $url, $opt ){
- global $wgSyncHTTPTimeout;
- //double check its a valid url:
$this->url = $url;
+ $this->parsedUrl = parse_url( $url );
+
+ if ( !Http::isValidURI( $this->url ) ) {
+ $this->status = Status::newFromFatal('http-invalid-url');
+ } else {
+ $this->status = Status::newGood( 100 ); // continue
+ }
- // set the timeout to default sync timeout (unless the timeout option is provided)
- $this->timeout = ( isset( $opt['timeout'] ) ) ? $opt['timeout'] : $wgSyncHTTPTimeout;
- $this->method = ( isset( $opt['method'] ) ) ? $opt['method'] : 'GET';
- $this->target_file_path = ( isset( $opt['target_file_path'] ) ) ? $opt['target_file_path'] : false;
- $this->upload_session_key = ( isset( $opt['upload_session_key'] ) ) ? $opt['upload_session_key'] : false;
- $this->headers_only = ( isset( $opt['headers_only'] ) ) ? $opt['headers_only'] : false;
+ if ( isset($options['timeout']) && $options['timeout'] != 'default' ) {
+ $this->timeout = $options['timeout'];
+ } else {
+ $this->timeout = $wgHTTPTimeout;
+ }
+
+ $members = array( "targetFilePath", "requestKey", "postData",
+ "proxy", "noProxy", "sslVerifyHost", "caInfo", "method" );
+ foreach ( $members as $o ) {
+ if ( isset($options[$o]) ) {
+ $this->$o = $options[$o];
+ }
+ }
}
/**
- * Get the contents of a file by HTTP
- * @param $url string Full URL to act on
- * @param $Opt associative array Optional array of options:
- * 'method' => 'GET', 'POST' etc.
- * 'target_file_path' => if curl should output to a target file
- * 'adapter' => 'curl', 'soket'
+ * Generate a new request object
+ * @see HttpRequest::__construct
*/
- public function doRequest() {
-
- #make sure we have a valid url
- if( !UploadFromUrl::isValidURI( $this->url ) )
- return Status::newFatal('bad-url');
-
- # Use curl if available
- if ( function_exists( 'curl_init' ) ) {
- return $this->doCurlReq();
- } else {
- return $this->doPhpReq();
+ public static function factory( $url, $options ) {
+ if ( !Http::$httpEngine ) {
+ Http::$httpEngine = function_exists( 'curl_init' ) ? 'curl' : 'php';
+ } elseif ( Http::$httpEngine == 'curl' && !function_exists( 'curl_init' ) ) {
+ throw new MWException( __METHOD__.': curl (http://php.net/curl) is not installed, but Http::$httpEngine is set to "curl"' );
+ }
+
+ switch( Http::$httpEngine ) {
+ case 'curl':
+ return new CurlHttpRequest( $url, $options );
+ case 'php':
+ if ( !wfIniGetBool( 'allow_url_fopen' ) ) {
+ throw new MWException( __METHOD__.': allow_url_fopen needs to be enabled for pure PHP http requests to work. '.
+ 'If possible, curl should be used instead. See http://php.net/curl.' );
+ }
+ return new PhpHttpRequest( $url, $options );
+ default:
+ throw new MWException( __METHOD__.': The setting of Http::$httpEngine is not valid.' );
}
}
- private function doCurlReq(){
- global $wgHTTPProxy, $wgTitle;
+ /**
+ * Get the body, or content, of the response to the request
+ * @return string
+ */
+ public function getContent() {
+ return $this->content;
+ }
+
+ /**
+ * Take care of setting up the proxy
+ * (override in subclass)
+ * @return string
+ */
+ public function proxySetup() {
+ global $wgHTTPProxy;
- $status = Status::newGood();
- $c = curl_init( $this->url );
- // proxy setup:
+ if ( $this->proxy ) {
+ return;
+ }
if ( Http::isLocalURL( $this->url ) ) {
- curl_setopt( $c, CURLOPT_PROXY, 'localhost:80' );
- } else if ( $wgHTTPProxy ) {
- curl_setopt( $c, CURLOPT_PROXY, $wgHTTPProxy );
+ $this->proxy = 'http://localhost:80/';
+ } elseif ( $wgHTTPProxy ) {
+ $this->proxy = $wgHTTPProxy ;
}
+ }
- curl_setopt( $c, CURLOPT_TIMEOUT, $this->timeout );
- curl_setopt( $c, CURLOPT_USERAGENT, Http::userAgent() );
+ /**
+ * Set the refererer header
+ */
+ public function setReferer( $url ) {
+ $this->setHeader('Referer', $url);
+ }
- if ( $this->headers_only ) {
- curl_setopt( $c, CURLOPT_NOBODY, true );
- curl_setopt( $c, CURLOPT_HEADER, true );
- } elseif ( $this->method == 'POST' ) {
- curl_setopt( $c, CURLOPT_POST, true );
- curl_setopt( $c, CURLOPT_POSTFIELDS, '' );
- } else {
- curl_setopt( $c, CURLOPT_CUSTOMREQUEST, $this->method );
- }
+ /**
+ * Set the user agent
+ */
+ public function setUserAgent( $UA ) {
+ $this->setHeader('User-Agent', $UA);
+ }
- # Set the referer to $wgTitle, even in command-line mode
- # This is useful for interwiki transclusion, where the foreign
- # server wants to know what the referring page is.
- # $_SERVER['REQUEST_URI'] gives a less reliable indication of the
- # referring page.
- if ( is_object( $wgTitle ) ) {
- curl_setopt( $c, CURLOPT_REFERER, $wgTitle->getFullURL() );
- }
+ /**
+ * Set an arbitrary header
+ */
+ public function setHeader($name, $value) {
+ // I feel like I should normalize the case here...
+ $this->reqHeaders[$name] = $value;
+ }
- // set the write back function (if we are writing to a file)
- if( $this->target_file_path ){
- $cwrite = new simpleFileWriter( $this->target_file_path, $this->upload_session_key );
- if( !$cwrite->status->isOK() ){
- wfDebug( __METHOD__ . "ERROR in setting up simpleFileWriter\n" );
- $status = $cwrite->status;
- return $status;
- }
- curl_setopt( $c, CURLOPT_WRITEFUNCTION, array( $cwrite, 'callbackWriteBody' ) );
+ /**
+ * Get an array of the headers
+ */
+ public function getHeaderList() {
+ $list = array();
+
+ foreach($this->reqHeaders as $name => $value) {
+ $list[] = "$name: $value";
}
+ return $list;
+ }
- // start output grabber:
- if( !$this->target_file_path )
- ob_start();
+ /**
+ * Set the callback
+ * @param $callback callback
+ */
+ public function setCallback( $callback ) {
+ $this->callback = $callback;
+ }
- //run the actual curl_exec:
- try {
- if ( false === curl_exec( $c ) ) {
- $error_txt ='Error sending request: #' . curl_errno( $c ) .' '. curl_error( $c );
- wfDebug( __METHOD__ . $error_txt . "\n" );
- $status = Status::newFatal( $error_txt );
- }
- } catch ( Exception $e ) {
- // do something with curl exec error?
+ /**
+ * A generic callback to read in the response from a remote server
+ * @param $fh handle
+ * @param $content string
+ */
+ public function read( $fh, $content ) {
+ $this->content .= $content;
+ return strlen( $content );
+ }
+
+ /**
+ * Take care of whatever is necessary to perform the URI request.
+ * @return Status
+ */
+ public function execute() {
+ global $wgTitle;
+
+ if( strtoupper($this->method) == "HEAD" ) {
+ $this->headersOnly = true;
}
- // if direct request output the results to the stats value:
- if( !$this->target_file_path && $status->isOK() ){
- $status->value = ob_get_contents();
- ob_end_clean();
+
+ if ( is_array( $this->postData ) ) {
+ $this->postData = wfArrayToCGI( $this->postData );
}
- // if we wrote to a target file close up or return error
- if( $this->target_file_path ){
- $cwrite->close();
- if( !$cwrite->status->isOK() ){
- return $cwrite->status;
- }
+
+ if ( is_object( $wgTitle ) && !isset($this->reqHeaders['Referer']) ) {
+ $this->setReferer( $wgTitle->getFullURL() );
}
- if ( $this->headers_only ) {
- $headers = explode( "\n", $status->value );
- $headerArray = array();
- foreach ( $headers as $header ) {
- if ( !strlen( trim( $header ) ) )
- continue;
- $headerParts = explode( ':', $header, 2 );
- if ( count( $headerParts ) == 1 ) {
- $headerArray[] = trim( $header );
- } else {
- list( $key, $val ) = $headerParts;
- $headerArray[trim( $key )] = trim( $val );
- }
- }
- $status->value = $headerArray;
- } else {
- # Don't return the text of error messages, return false on error
- $retcode = curl_getinfo( $c, CURLINFO_HTTP_CODE );
- if ( $retcode != 200 ) {
- wfDebug( __METHOD__ . ": HTTP return code $retcode\n" );
- $status = Status::newFatal( "HTTP return code $retcode\n" );
- }
- # Don't return truncated output
- $errno = curl_errno( $c );
- if ( $errno != CURLE_OK ) {
- $errstr = curl_error( $c );
- wfDebug( __METHOD__ . ": CURL error code $errno: $errstr\n" );
- $status = Status::newFatal( " CURL error code $errno: $errstr\n" );
- }
+ if ( !$this->noProxy ) {
+ $this->proxySetup();
}
- curl_close( $c );
+ if ( !$this->callback ) {
+ $this->setCallback( array( $this, 'read' ) );
+ }
- // return the result obj
- return $status;
+ if ( !isset($this->reqHeaders['User-Agent']) ) {
+ $this->setUserAgent(Http::userAgent());
+ }
}
+}
- public function doPhpReq(){
- global $wgTitle, $wgHTTPProxy;
+/**
+ * HttpRequest implemented using internal curl compiled into PHP
+ */
+class CurlHttpRequest extends HttpRequest {
+ protected $curlOptions = array();
- #check for php.ini allow_url_fopen
- if( !ini_get( 'allow_url_fopen' ) ){
- return Status::newFatal( 'allow_url_fopen needs to be enabled for http copy to work' );
+ public function execute() {
+ parent::execute();
+ if ( !$this->status->isOK() ) {
+ return $this->status;
}
- //start with good status:
- $status = Status::newGood();
+ // A lot of the action up front should probably be in
+ // set* methods, but we'll leave that for another time.
- if ( $this->headers_only ) {
- $status->value = get_headers( $this->url, 1 );
- return $status;
- }
+ $this->curlOptions[CURLOPT_PROXY] = $this->proxy;
+ $this->curlOptions[CURLOPT_TIMEOUT] = $this->timeout;
+ $this->curlOptions[CURLOPT_HTTP_VERSION] = CURL_HTTP_VERSION_1_0;
+ $this->curlOptions[CURLOPT_WRITEFUNCTION] = $this->callback;
- //setup the headers
- $headers = array( "User-Agent: " . Http :: userAgent() );
- if ( is_object( $wgTitle ) ) {
- $headers[] = "Referer: ". $wgTitle->getFullURL();
+ /* not sure these two are actually necessary */
+ if(isset($this->reqHeaders['Referer'])) {
+ $this->curlOptions[CURLOPT_REFERER] = $this->reqHeaders['Referer'];
}
+ $this->curlOptions[CURLOPT_USERAGENT] = $this->reqHeaders['User-Agent'];
- if( strcasecmp( $this->method, 'post' ) == 0 ) {
- // Required for HTTP 1.0 POSTs
- $headers[] = "Content-Length: 0";
+ if ( $this->sslVerifyHost ) {
+ $this->curlOptions[CURLOPT_SSL_VERIFYHOST] = $this->sslVerifyHost;
}
- $fcontext = stream_context_create ( array(
- 'http' => array(
- 'method' => $this->method,
- 'header' => implode( "\r\n", $headers ),
- 'timeout' => $this->timeout )
- )
- );
-
- $fh = fopen( $this->url, "r", false, $fcontext);
- // set the write back function (if we are writing to a file)
- if( $this->target_file_path ){
- $cwrite = new simpleFileWriter( $this->target_file_path, $this->upload_session_key );
- if( !$cwrite->status->isOK() ){
- wfDebug( __METHOD__ . "ERROR in setting up simpleFileWriter\n" );
- $status = $cwrite->status;
- return $status;
- }
- //read $fh into the simpleFileWriter (grab in 64K chunks since its likely a media file)
- while ( !feof( $fh )) {
- $contents = fread($fh, 65536);
- $cwrite->callbackWriteBody($fh, $contents );
- }
+ if ( $this->caInfo ) {
+ $this->curlOptions[CURLOPT_CAINFO] = $this->caInfo;
+ }
- $cwrite->close();
- //check for simpleFileWriter error:
- if( !$cwrite->status->isOK() ){
- return $cwrite->status;
- }
+ if ( $this->headersOnly ) {
+ $this->curlOptions[CURLOPT_NOBODY] = true;
+ $this->curlOptions[CURLOPT_HEADER] = true;
+ } elseif ( $this->method == 'POST' ) {
+ $this->curlOptions[CURLOPT_POST] = true;
+ $this->curlOptions[CURLOPT_POSTFIELDS] = $this->postData;
+ // Suppress 'Expect: 100-continue' header, as some servers
+ // will reject it with a 417 and Curl won't auto retry
+ // with HTTP 1.0 fallback
+ $this->reqHeaders['Expect'] = '';
} else {
- //read $fh into status->value
- $status->value = @stream_get_contents( $fh );
+ $this->curlOptions[CURLOPT_CUSTOMREQUEST] = $this->method;
}
- //close the url file wrapper
- fclose( $fh );
- //check for "false"
- if( $status->value === false ){
- $status->error( 'file_get_contents-failed' );
+ $this->curlOptions[CURLOPT_HTTPHEADER] = $this->getHeaderList();
+
+ $curlHandle = curl_init( $this->url );
+ curl_setopt_array( $curlHandle, $this->curlOptions );
+
+ if ( false === curl_exec( $curlHandle ) ) {
+ // re-using already translated error messages
+ $this->status->fatal( 'upload-curl-error'.curl_errno( $curlHandle ).'-text' );
}
- return $status;
- }
+ curl_close( $curlHandle );
+
+ return $this->status;
+ }
}
-/**
- * a simpleFileWriter with session id updates
- */
-class simpleFileWriter {
- var $target_file_path;
- var $status = null;
- var $session_id = null;
- var $session_update_interval = 0; // how often to update the session while downloading
-
- function simpleFileWriter( $target_file_path, $upload_session_key ){
- $this->target_file_path = $target_file_path;
- $this->upload_session_key = $upload_session_key;
- $this->status = Status::newGood();
- // open the file:
- $this->fp = fopen( $this->target_file_path, 'w' );
- if( $this->fp === false ){
- $this->status = Status::newFatal( 'HTTP::could-not-open-file-for-writing' );
- }
- // true start time
- $this->prevTime = time();
+class PhpHttpRequest extends HttpRequest {
+ private $fh;
+
+ protected function urlToTcp( $url ) {
+ $parsedUrl = parse_url( $url );
+
+ return 'tcp://' . $parsedUrl['host'] . ':' . $parsedUrl['port'];
}
- public function callbackWriteBody($ch, $data_packet){
- global $wgMaxUploadSize;
+ public function execute() {
+ if ( $this->parsedUrl['scheme'] != 'http' ) {
+ $this->status->fatal( 'http-invalid-scheme', $this->parsedURL['scheme'] );
+ }
- // write out the content
- if( fwrite( $this->fp, $data_packet ) === false ){
- wfDebug( __METHOD__ ." ::could-not-write-to-file\n" );
- $this->status = Status::newFatal( 'HTTP::could-not-write-to-file' );
- return 0;
+ parent::execute();
+ if ( !$this->status->isOK() ) {
+ return $this->status;
}
- // check file size:
- clearstatcache();
- $this->current_fsize = filesize( $this->target_file_path );
+ // A lot of the action up front should probably be in
+ // set* methods, but we'll leave that for another time.
- if( $this->current_fsize > $wgMaxUploadSize ){
- wfDebug( __METHOD__ . " ::http download too large\n" );
- $this->status = Status::newFatal( 'HTTP::file-has-grown-beyond-upload-limit-killing: downloaded more than ' .
- Language::formatSize( $wgMaxUploadSize ) . ' ' );
- return 0;
+ $this->reqHeaders['Accept'] = "*/*";
+ if ( $this->method == 'POST' ) {
+ // Required for HTTP 1.0 POSTs
+ $this->reqHeaders['Content-Length'] = strlen( $this->postData );
+ $this->reqHeaders['Content-type'] = "application/x-www-form-urlencoded";
}
- // if more than session_update_interval second have passed update_session_progress
- if( $this->upload_session_key && ( ( time() - $this->prevTime ) > $this->session_update_interval ) ) {
- $this->prevTime = time();
- $session_status = $this->update_session_progress();
- if( !$session_status->isOK() ){
- $this->status = $session_status;
- wfDebug( __METHOD__ . ' update session failed or was canceled');
- return 0;
- }
+ $options = array();
+ if ( $this->proxy && !$this->noProxy ) {
+ $options['proxy'] = $this->urlToTCP( $this->proxy );
+ $options['request_fulluri'] = true;
+ }
+
+ $options['method'] = $this->method;
+ $options['timeout'] = $this->timeout;
+ $options['header'] = implode("\r\n", $this->getHeaderList());
+ // FOR NOW: Force everyone to HTTP 1.0
+ /* if ( version_compare( "5.3.0", phpversion(), ">" ) ) { */
+ $options['protocol_version'] = "1.0";
+ /* } else { */
+ /* $options['protocol_version'] = "1.1"; */
+ /* } */
+
+ if ( $this->postData ) {
+ $options['content'] = $this->postData;
}
- return strlen( $data_packet );
- }
- public function update_session_progress(){
- $status = Status::newGood();
- // start the session
- if( session_start() === false){
- wfDebug( __METHOD__ . ' could not start session' );
- exit( 0 );
+ $context = stream_context_create( array( 'http' => $options ) );
+ try {
+ $this->fh = fopen( $this->url, "r", false, $context );
+ } catch ( Exception $e ) {
+ $this->status->fatal( $e->getMessage() ); /* need some l10n help */
+ return $this->status;
}
- $sd =& $_SESSION['wsDownload'][$this->upload_session_key];
- // check if the user canceled the request:
- if( isset( $sd['user_cancel'] ) && $sd['user_cancel'] == true ){
- // kill the download
- return Status::newFatal( 'user-canceled-request' );
+
+ $result = stream_get_meta_data( $this->fh );
+ if ( $result['timed_out'] ) {
+ $this->status->fatal( 'http-timed-out', $this->url );
+ return $this->status;
}
- // update the progress bytes download so far:
- $sd['loaded'] = $this->current_fsize;
- wfDebug( __METHOD__ . ': set session loaded amount to: ' . $sd['loaded'] . "\n");
- // close down the session so we can other http queries can get session updates:
- session_write_close();
- return $status;
- }
- public function close(){
- // do a final session update:
- $this->update_session_progress();
- // close up the file handle:
- if( false === fclose( $this->fp ) ){
- $this->status = Status::newFatal( 'HTTP::could-not-close-file' );
+ $this->headers = $result['wrapper_data'];
+
+ $end = false;
+ while ( !$end ) {
+ $contents = fread( $this->fh, 8192 );
+ $size = 0;
+ if ( $contents ) {
+ $size = call_user_func_array( $this->callback, array( $this->fh, $contents ) );
+ }
+ $end = ( $size == 0 ) || feof( $this->fh );
}
- }
+ fclose( $this->fh );
+ return $this->status;
+ }
}