);
-//autoloader for javascript files (path is from the mediawiki folder
+// Autoloader for JavaScript files (path is from the MediaWiki folder)
global $wgJSAutoloadLocalClasses;
$wgJSAutoloadLocalClasses = array(
- 'ajax' => 'skins/common/ajax.js',
- 'ajaxwatch' => 'skins/common/ajaxwatch.js',
- 'allmessages' => 'skins/common/allmessages.js',
+ 'ajax' => 'skins/common/ajax.js',
+ 'ajaxwatch' => 'skins/common/ajaxwatch.js',
+ 'allmessages' => 'skins/common/allmessages.js',
'block' => 'skins/common/block.js',
'changepassword' => 'skins/common/changepassword.js',
'diff' => 'skins/common/diff.js',
'preview' => 'skins/common/preview.js',
'protect' => 'skins/common/protect.js',
'rightclickedit' => 'skins/common/rightclickedit.js',
- 'sticky' => 'skins/common/sticky.js',
+ 'sticky' => 'skins/common/sticky.js',
'upload' => 'skins/common/upload.js',
'wikibits' => 'skins/common/wikibits.js',
- //phase 2 javascript:
+ // phase 2 javascript:
'uploadPage' => 'js2/uploadPage.js',
- 'editPage' => 'js2/editPage.js',
+ 'editPage' => 'js2/editPage.js',
);
//Include the js2 autoLoadClasses
<?php
/**
* HTTP handling class
- *
+ * @defgroup HTTP HTTP
+ * @file
+ * @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)
+ 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( $url, $opts = array() ) {
- $req = new HttpRequest( $url, $opts );
- $status = $req->doRequest();
- if( $status->isOK() ){
- return $status->value;
- }else{
- return false;
- }
- }
+ $req = new HttpRequest( $url, $opts );
+ $status = $req->doRequest();
+ if( $status->isOK() ){
+ return $status->value;
+ } else {
+ return false;
+ }
+ }
+
/**
* Simple wrapper for Http::request( 'GET' )
*/
public static function get( $url, $opts = array() ) {
$opt['method'] = 'GET';
- return Http::request($url, $opts);
+ return Http::request( $url, $opts );
}
+
/**
* Simple wrapper for Http::request( 'POST' )
*/
public static function post( $url, $opts = array() ) {
- $opts['method']='POST';
- return Http::request($url, $opts);
+ $opts['method'] = 'POST';
+ return Http::request( $url, $opts );
}
- public static function doDownload( $url, $target_file_path , $dl_mode = self::SYNC_DOWNLOAD , $redirectCount=0){
+ public static function doDownload( $url, $target_file_path , $dl_mode = self::SYNC_DOWNLOAD , $redirectCount = 0 ){
global $wgPhpCliPath, $wgMaxUploadSize, $wgMaxRedirects;
- //do a quick check to HEAD to insure the file size is not > $wgMaxUploadSize
- $head = get_headers($url, 1);
-
- //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');
+ // do a quick check to HEAD to insure the file size is not > $wgMaxUploadSize
+ $head = get_headers( $url, 1 );
+
+ // 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');
+ } 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]) );
+ // 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);
+ $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( $wgPhpCliPath && wfShellExecEnabled() && $dl_mode == self::ASYNC_DOWNLOAD){
- wfDebug("\ASYNC_DOWNLOAD\n");
- //setup session and shell call:
+ // check if we can find phpCliPath (for doing a background shell request to php to do the download:
+ if( $wgPhpCliPath && 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("\nSYNC_DOWNLOAD\n");
- //SYNC_DOWNLOAD download as much as we can in the time we have to execute
- $opts['method']='GET';
+ } 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 );
+ $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
global $wgMaxUploadSize, $IP, $wgPhpCliPath;
$status = Status::newGood();
- //generate a session id with all the details for the download (pid, target_file_path )
+ // 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;
+ // store the url and target path:
+ $_SESSION['wsDownload'][$upload_session_key]['url'] = $url;
+ $_SESSION['wsDownload'][$upload_session_key]['target_file_path'] = $target_file_path;
- if($content_length)
- $_SESSION[ 'wsDownload' ][$upload_session_key]['content_length'] = $content_length;
+ if( $content_length )
+ $_SESSION['wsDownload'][$upload_session_key]['content_length'] = $content_length;
- //set initial loaded bytes:
- $_SESSION[ 'wsDownload' ][$upload_session_key]['loaded'] = 0;
+ // set initial loaded bytes:
+ $_SESSION['wsDownload'][$upload_session_key]['loaded'] = 0;
-
- //run the background download request:
+ // run the background download request:
$cmd = $wgPhpCliPath . ' ' . $IP . "/maintenance/http_session_download.php --sid {$session_id} --usk {$upload_session_key}";
- $pid = wfShellBackgroundExec($cmd , $retval);
- //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');
+ $pid = wfShellBackgroundExec( $cmd, $retval );
+ // 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)
+ // 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 good status
return $status;
}
+
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 string $session_id // the session id to grab download details from
- * @param string $upload_session_key //the key of the given upload session
+ * @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;
- wfDebug("\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');
+ 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
+ // 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];
- //close down the session so we can other http queries can get session updates:
+ // grab the session data to setup the request:
+ $sd =& $_SESSION['wsDownload'][$upload_session_key];
+ // close down the session so we can other http queries can get session updates:
session_write_close();
$req = new HttpRequest( $sd['url'], array(
'upload_session_key'=> $upload_session_key,
'timeout' => $wgAsyncHTTPTimeout
) );
- //run the actual request .. (this can take some time)
- wfDebug("do Request: " . $sd['url'] . ' tf: ' . $sd['target_file_path'] );
+ // 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){
+ // 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:
+ // 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() )
- );
+ $sd['apiUploadResult'] = ApiFormatJson::getJsonEncode(
+ array( 'error' => $status->getWikiText() )
+ );
}
- //if status oky process upload using fauxReq to api:
+ // if status okay process upload using fauxReq to api:
if( $status->isOK() ){
- //setup the faxRequest
+ // 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);
+ // 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);
+ $printer = $processor->createPrinterByName( 'json' );
+ $printer->initPrinter( false );
ob_start();
$printer->execute();
$apiUploadResult = ob_get_clean();
- wfDebug("\n\n got api result:: $apiUploadResult \n" );
- //the status updates runner will grab the result form the session:
+ 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:
+ // close the session:
session_write_close();
}
class HttpRequest{
var $target_file_path;
var $upload_session_key;
- function __construct($url, $opt){
+
+ function __construct( $url, $opt ){
global $wgSyncHTTPTimeout;
$this->url = $url;
- //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;
+ // 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;
}
-/**
+
+ /**
* Get the contents of a file by HTTP
* @param $url string Full URL to act on
* @param $Opt associative array Optional array of options:
* 'target_file_path' => if curl should output to a target file
* 'adapter' => 'curl', 'soket'
*/
- public function doRequest() {
+ public function doRequest() {
# Use curl if available
if ( function_exists( 'curl_init' ) ) {
return $this->doCurlReq();
- }else{
+ } else {
return $this->doPhpReq();
}
- }
- private function doCurlReq(){
+ }
+
+ private function doCurlReq(){
global $wgHTTPProxy, $wgTitle;
$status = Status::newGood();
$c = curl_init( $this->url );
- //proxy setup:
+ // proxy setup:
if ( Http::isLocalURL( $this->url ) ) {
curl_setopt( $c, CURLOPT_PROXY, 'localhost:80' );
- } else if ($wgHTTPProxy) {
- curl_setopt($c, CURLOPT_PROXY, $wgHTTPProxy);
+ } else if ( $wgHTTPProxy ) {
+ curl_setopt( $c, CURLOPT_PROXY, $wgHTTPProxy );
}
curl_setopt( $c, CURLOPT_TIMEOUT, $this->timeout );
-
-
curl_setopt( $c, CURLOPT_USERAGENT, Http::userAgent() );
if ( $this->method == 'POST' ) {
curl_setopt( $c, CURLOPT_POST, true );
curl_setopt( $c, CURLOPT_POSTFIELDS, '' );
- }else{
+ } else {
curl_setopt( $c, CURLOPT_CUSTOMREQUEST, $this->method );
}
curl_setopt( $c, CURLOPT_REFERER, $wgTitle->getFullURL() );
}
- //set the write back function (if we are writing to a file)
+ // 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("ERROR in setting up simpleFileWriter\n");
+ if( !$cwrite->status->isOK() ){
+ wfDebug( __METHOD__ . "ERROR in setting up simpleFileWriter\n" );
$status = $cwrite->status;
}
- curl_setopt( $c, CURLOPT_WRITEFUNCTION, array($cwrite, 'callbackWriteBody') );
+ curl_setopt( $c, CURLOPT_WRITEFUNCTION, array( $cwrite, 'callbackWriteBody' ) );
}
- //start output grabber:
- if(!$this->target_file_path)
+ // start output grabber:
+ if( !$this->target_file_path )
ob_start();
//run the actual curl_exec:
try {
- if (false === curl_exec($c)) {
- $error_txt ='Error sending request: #' . curl_errno($c) .' '. curl_error($c);
- wfDebug($error_txt . "\n");
- $status = Status::newFatal( $error_txt);
- }
- } catch (Exception $e) {
- //do something with curl exec error?
- }
- //if direct request output the results to the stats value:
+ 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?
+ }
+ // if direct request output the results to the stats value:
if( !$this->target_file_path && $status->isOK() ){
- $status->value = ob_get_contents();
+ $status->value = ob_get_contents();
ob_end_clean();
}
- //if we wrote to a target file close up or return error
+ // if we wrote to a target file close up or return error
if( $this->target_file_path ){
$cwrite->close();
- if( ! $cwrite->status->isOK() ){
+ if( !$cwrite->status->isOK() ){
return $cwrite->status;
}
}
}
curl_close( $c );
- //return the result obj
+ // return the result obj
return $status;
}
+
public function doPhpReq(){
#$use file_get_contents...
# This doesn't have local fetch capabilities...
$ctx = stream_context_create( $opts );
$status->value = file_get_contents( $url, false, $ctx );
- if(!$status->value){
- $status->error('file_get_contents-failed');
+ if( !$status->value ){
+ $status->error( 'file_get_contents-failed' );
}
return $status;
}
+
}
+
/**
* a simpleFileWriter with session id updates
- *
*/
-class simpleFileWriter{
+class simpleFileWriter {
var $target_file_path;
var $status = null;
var $session_id = null;
- var $session_update_interval = 0; //how offten to update the session while downloading
+ var $session_update_interval = 0; // how often to update the session while downloading
- function simpleFileWriter($target_file_path, $upload_session_key){
+ 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');
+ // 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');
+ $this->status = Status::newFatal( 'HTTP::could-not-open-file-for-writing' );
}
- //true start time
+ // true start time
$this->prevTime = time();
}
+
public function callbackWriteBody($ch, $data_packet){
global $wgMaxUploadSize;
- //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');
+ // 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;
}
- //check file size:
+ // check file size:
clearstatcache();
- $this->current_fsize = filesize( $this->target_file_path);
+ $this->current_fsize = filesize( $this->target_file_path );
- 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) . ' ');
+ 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;
}
- //if more than session_update_interval second have passed update_session_progress
- if($this->upload_session_key && ( (time() - $this->prevTime) > $this->session_update_interval )) {
+ // 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() ){
}
return strlen( $data_packet );
}
+
public function update_session_progress(){
$status = Status::newGood();
- //start the session
+ // start the session
if( session_start() === false){
- wfDebug( __METHOD__ . ' could not start session');
- exit(0);
+ wfDebug( __METHOD__ . ' could not start session' );
+ exit( 0 );
}
- $sd =& $_SESSION[ 'wsDownload' ][ $this->upload_session_key ];
- //check if the user canceled the request:
+ $sd =& $_SESSION['wsDownload'][$this->upload_session_key];
+ // check if the user canceled the request:
if( $sd['user_cancel'] == true ){
- //kill the download
- return Status::newFatal('user-canceled-request');
+ // kill the download
+ return Status::newFatal( 'user-canceled-request' );
}
- //update the progress bytes download so far:
+ // update the progress bytes download so far:
$sd['loaded'] = $this->current_fsize;
- wfDebug('set session loaded amount to: ' . $sd['loaded'] . "\n");
- //close down the session so we can other http queries can get session updates:
+ 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:
+ // 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');
+ // close up the file handle:
+ if( false === fclose( $this->fp ) ){
+ $this->status = Status::newFatal( 'HTTP::could-not-close-file' );
}
}
+
}
\ No newline at end of file
var $mCategoryLinks = array(), $mLanguageLinks = array();
var $mScriptLoaderClassList = array();
- //the most recent id of any script that is grouped in the script request
+ // the most recent id of any script that is grouped in the script request
var $mLatestScriptRevID = 0;
var $mScripts = '', $mLinkColours, $mPageLinkTitle = '', $mHeadItems = array();
function addKeyword( $text ) {
if( is_array( $text )) {
$this->mKeywords = array_merge( $this->mKeywords, $text );
- }
- else {
+ } else {
array_push( $this->mKeywords, $text );
}
}
if( substr( $file, 0, 1 ) == '/' ) {
$path = $file;
} else {
- $path = "{$wgStylePath}/common/{$file}";
+ $path = "{$wgStylePath}/common/{$file}";
}
+
if( $wgEnableScriptLoader ){
- if( strpos($path, $wgScript) !== false ){
- $reqPath = str_replace($wgScript.'?', '', $path);
- $reqArgs = split('&', $reqPath);
+ if( strpos( $path, $wgScript ) !== false ){
+ $reqPath = str_replace( $wgScript . '?', '', $path );
+ $reqArgs = split( '&', $reqPath );
$reqSet = array();
- foreach($reqArgs as $arg){
- list($key, $var) = split('=', $arg);
- $reqSet[$key]= $var;
+ foreach( $reqArgs as $arg ){
+ list( $key, $var ) = split( '=', $arg );
+ $reqSet[$key] = $var;
}
- if( isset( $reqSet['title'] ) && $reqSet != '' ) {
- //extract any extra param (for now just skin)
- $ext_param = ( isset( $reqSet['useskin'] ) && $reqSet['useskin'] != '') ? '|useskin=' . ucfirst( $reqSet['useskin'] ) : '';
+ if( isset( $reqSet['title'] ) && $reqSet != '' ) {
+ // extract any extra param (for now just skin)
+ $ext_param = ( isset( $reqSet['useskin'] ) && $reqSet['useskin'] != '' ) ? '|useskin=' . ucfirst( $reqSet['useskin'] ) : '';
$this->mScriptLoaderClassList[] = 'WT:' . $reqSet['title'] . $ext_param ;
- //add the title revision to the key
+ // add the title revision to the key
$t = Title::newFromText( $reqSet['title'] );
- //if there is no title (don't worry we just use the $wgStyleVersion var (which should be updated on relevant commits)
+ // if there is no title (don't worry we just use the $wgStyleVersion var (which should be updated on relevant commits)
if( $t->exists() ){
if( $t->getLatestRevID() > $this->mLatestScriptRevID )
$this->mLatestScriptRevID = $t->getLatestRevID();
return true;
}
}
- //check for class from path:
+
+ // check for class from path:
$js_class = $this->getJsClassFromPath( $path );
if( $js_class ){
- //add to the class list:
+ // add to the class list:
$this->mScriptLoaderClassList[] = $js_class;
return true;
}
}
- //die();
- //if the script loader did not find a way to add the script than add using AddScript
+
+ // if the script loader did not find a way to add the script than add using addScript
$this->addScript(
Xml::element( 'script',
array(
)
);
}
- /*
+
+ /**
* This is the core script that is included on every page
* (they are requested separately to improve caching across
* different page load types (edit, upload, view, etc)
*/
function addCoreScripts2Top(){
- global $wgEnableScriptLoader, $wgStyleVersion,$wgJSAutoloadLocalClasses, $wgJsMimeType, $wgScriptPath, $wgEnableJS2system ;
- //@@todo we should depricate wikibits in favor of mv_embed and native jQuery functions
+ global $wgEnableScriptLoader, $wgStyleVersion, $wgJSAutoloadLocalClasses, $wgJsMimeType, $wgScriptPath, $wgEnableJS2system;
+ //@@todo we should deprecate wikibits in favor of mv_embed and native jQuery functions
if( $wgEnableJS2system ){
- $core_classes = array('window.jQuery', 'mv_embed', 'wikibits');
- }else{
- $core_classes = array('wikibits');
+ $core_classes = array( 'window.jQuery', 'mv_embed', 'wikibits' );
+ } else {
+ $core_classes = array( 'wikibits' );
}
+
if( $wgEnableScriptLoader ){
$this->mScripts = $this->getScriptLoaderJs( $core_classes ) . $this->mScripts;
- }else{
+ } else {
$so = '';
- foreach($core_classes as $s){
- if(isset( $wgJSAutoloadLocalClasses[$s] )){
- $so.= Xml::element( 'script', array(
- 'type' => $wgJsMimeType,
- 'src' => "{$wgScriptPath}/{$wgJSAutoloadLocalClasses[$s]}?" . $this->getURIDparam()
- ),
- '', false
- );
+ foreach( $core_classes as $s ){
+ if( isset( $wgJSAutoloadLocalClasses[$s] ) ){
+ $so.= Xml::element( 'script', array(
+ 'type' => $wgJsMimeType,
+ 'src' => "{$wgScriptPath}/{$wgJSAutoloadLocalClasses[$s]}?" . $this->getURIDparam()
+ ),
+ '', false
+ );
}
}
$this->mScripts = $so . $this->mScripts;
}
}
+
+ /**
+ * @param $js_class String: name of JavaScript class
+ * @return Boolean: false if class wasn't found, true on success
+ */
function addScriptClass( $js_class ){
global $wgJSAutoloadClasses, $wgJSAutoloadLocalClasses, $wgJsMimeType,
$wgEnableScriptLoader, $wgStyleVersion, $wgScriptPath;
- if(isset($wgJSAutoloadClasses[ $js_class ] ) || isset( $wgJSAutoloadLocalClasses[$js_class]) ){
- if($wgEnableScriptLoader){
- if( ! in_array( $js_class, $this->mScriptLoaderClassList ) ){
+
+ if( isset( $wgJSAutoloadClasses[$js_class] ) || isset( $wgJSAutoloadLocalClasses[$js_class] ) ){
+ if( $wgEnableScriptLoader ){
+ if( !in_array( $js_class, $this->mScriptLoaderClassList ) ){
$this->mScriptLoaderClassList[] = $js_class;
}
- }else{
- //do a normal load of without the script-loader:
+ } else {
+ // do a normal load of without the script-loader:
$path = $wgScriptPath . '/';
- $path.= isset($wgJSAutoloadClasses[ $js_class ] )?$wgJSAutoloadClasses[ $js_class ]:
+ $path.= isset( $wgJSAutoloadClasses[$js_class] ) ? $wgJSAutoloadClasses[$js_class]:
$wgJSAutoloadLocalClasses[$js_class];
$this->addScript(
Xml::element( 'script',
}
return true;
}
- wfDebug( __METHOD__ . " could not find js_class: " . $js_class );
- return false; //could not find the class
+ wfDebug( __METHOD__ . ' could not find js_class: ' . $js_class );
+ return false; // could not find the class
}
+
/**
* gets the scriptLoader javascript include
- *
+ * @param $forcClassAry Boolean: false by default
*/
- function getScriptLoaderJs( $forceClassAry=false ){
+ function getScriptLoaderJs( $forceClassAry = false ){
global $wgScriptPath, $wgJsMimeType, $wgStyleVersion, $wgRequest, $wgDebugJavaScript;
- if(!$forceClassAry){
- $class_list = implode(',', $this->mScriptLoaderClassList );
- }else{
- $class_list = implode(',', $forceClassAry );
+ if( !$forceClassAry ){
+ $class_list = implode( ',', $this->mScriptLoaderClassList );
+ } else {
+ $class_list = implode( ',', $forceClassAry );
}
$debug_param = ( $wgDebugJavaScript ||
- $wgRequest->getVal('debug')=='true' ||
- $wgRequest->getVal('debug')=='1' )
+ $wgRequest->getVal( 'debug' ) == 'true' ||
+ $wgRequest->getVal( 'debug' ) == '1' )
? '&debug=true' : '';
//@@todo intelligent unique id generation based on svn version of file (rather than just grabbing the $wgStyleVersion var)
'', false
);
}
+
function getURIDparam(){
- global $wgDebugJavaScript,$wgStyleVersion;
+ global $wgDebugJavaScript, $wgStyleVersion;
if( $wgDebugJavaScript ){
- return "urid=". time();
- }else{
+ return 'urid=' . time();
+ } else {
return "urid={$wgStyleVersion}_{$this->mLatestScriptRevID}";
}
}
+
function getJsClassFromPath( $path ){
global $wgJSAutoloadClasses, $wgJSAutoloadLocalClasses, $wgScriptPath;
$scriptLoaderPaths = array_merge( $wgJSAutoloadClasses, $wgJSAutoloadLocalClasses );
foreach( $scriptLoaderPaths as $js_class => $js_path ){
$js_path = "{$wgScriptPath}/{$js_path}";
- if($path == $js_path)
+ if( $path == $js_path )
return $js_class;
}
return false;
}
+
/**
* Add a self-contained script tag with the given contents
* @param string $script JavaScript text, no <script> tags
function getScript() {
global $wgEnableScriptLoader;
if( $wgEnableScriptLoader ){
- //include $this->mScripts (for anything that we could not package into the scriptloader
- return $this->mScripts ."\n". $this->getScriptLoaderJs() . $this->getHeadItems();
- }else{
+ //include $this->mScripts (for anything that we could not package into the scriptloader
+ return $this->mScripts . "\n" . $this->getScriptLoaderJs() . $this->getHeadItems();
+ } else {
return $this->mScripts . $this->getHeadItems();
}
}
$sk = $wgUser->getSkin();
- //add our core scripts to output
+ // add our core scripts to output
$this->addCoreScripts2Top();
if ( $wgUseAjax ) {
$options['dir'] = $dir;
$this->styles[$style] = $options;
}
+
+ /**
+ * Adds inline CSS styles
+ * @param $style_css Mixed: inline CSS
+ */
public function addInlineStyle( $style_css ){
$this->mScripts .= "<style type=\"text/css\">$style_css</style>";
}
+
/**
* Build a set of <link>s for the stylesheets specified in the $this->styles array.
* These will be applied to various media & IE conditionals.
* http://www.gnu.org/copyleft/gpl.html
*/
-if (!defined('MEDIAWIKI')) {
+if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
- require_once ("ApiBase.php");
+ require_once("ApiBase.php");
}
-
/**
* @ingroup API
*/
class ApiUpload extends ApiBase {
var $mUpload = null;
- public function __construct($main, $action) {
- parent :: __construct($main, $action);
+ public function __construct( $main, $action ) {
+ parent::__construct( $main, $action );
}
public function execute() {
global $wgUser;
-
$this->getMain()->isWriteMode();
$this->mParams = $this->extractRequestParams();
$request = $this->getMain()->getRequest();
- //do token checks:
- if(is_null($this->mParams['token']))
- $this->dieUsageMsg(array('missingparam', 'token'));
- if(!$wgUser->matchEditToken($this->mParams['token']))
- $this->dieUsageMsg(array('sessionfailure'));
+ // do token checks:
+ if( is_null( $this->mParams['token'] ) )
+ $this->dieUsageMsg( array( 'missingparam', 'token' ) );
+ if( !$wgUser->matchEditToken( $this->mParams['token'] ) )
+ $this->dieUsageMsg( array( 'sessionfailure' ) );
// Add the uploaded file to the params array
if( !UploadBase::isEnabled() )
$this->dieUsageMsg( array( 'uploaddisabled' ) );
- wfDebug("running require param\n");
+ wfDebug( __METHOD__ . "running require param\n" );
// One and only one of the following parameters is needed
$this->requireOnlyOneParameter( $this->mParams,
'sessionkey', 'file', 'url', 'enablechunks' );
if( $this->mParams['enablechunks'] ){
- //chunks upload enabled
+ // chunks upload enabled
$this->mUpload = new UploadFromChunks();
$this->mUpload->initializeFromParams( $this->mParams, $request );
//if getAPIresult did not exit report the status error:
- if( isset( $this->mUpload->status[ 'error' ] ) )
- $this->dieUsageMsg( $this->mUpload->status[ 'error' ] );
+ if( isset( $this->mUpload->status['error'] ) )
+ $this->dieUsageMsg( $this->mUpload->status['error'] );
- }else if( $this->mParams['internalhttpsession'] ){
- $sd = & $_SESSION['wsDownload'][ $this->mParams['internalhttpsession'] ];
+ } else if( $this->mParams['internalhttpsession'] ){
+ $sd = & $_SESSION['wsDownload'][$this->mParams['internalhttpsession']];
- //get the params from the init session:
+ // get the params from the init session:
$this->mUpload = new UploadFromFile();
$this->mUpload->initialize( $this->mParams['filename'],
if( !isset( $this->mUpload ) )
$this->dieUsage( 'No upload module set', 'nomodule' );
- }else if( $this->mParams['httpstatus'] && $this->mParams['sessionkey']){
- //return the status of the given upload session_key:
- if(!isset($_SESSION['wsDownload'][ $this->mParams['sessionkey'] ])){
+ } else if( $this->mParams['httpstatus'] && $this->mParams['sessionkey'] ){
+ // return the status of the given upload session_key:
+ if( !isset( $_SESSION['wsDownload'][ $this->mParams['sessionkey'] ] ) ){
return $this->getResult()->addValue( null, $this->getModuleName(),
array( 'error' => 'invalid-session-key'
));
}
- $sd = & $_SESSION['wsDownload'][ $this->mParams['sessionkey'] ];
- //keep passing down the upload sessionkey
+ $sd = & $_SESSION['wsDownload'][$this->mParams['sessionkey']];
+ // keep passing down the upload sessionkey
$statusResult = array(
'upload_session_key' => $this->mParams['sessionkey']
);
- //put values into the final apiResult if available
- if( isset($sd['apiUploadResult'])) $statusResult['apiUploadResult'] = $sd['apiUploadResult'];
- if( isset($sd['loaded']) ) $statusResult['loaded'] = $sd['loaded'];
- if( isset($sd['content_length']) ) $statusResult['content_length'] = $sd['content_length'];
+ // put values into the final apiResult if available
+ if( isset( $sd['apiUploadResult'] ) ) $statusResult['apiUploadResult'] = $sd['apiUploadResult'];
+ if( isset( $sd['loaded'] ) ) $statusResult['loaded'] = $sd['loaded'];
+ if( isset( $sd['content_length'] ) ) $statusResult['content_length'] = $sd['content_length'];
return $this->getResult()->addValue( null, $this->getModuleName(),
$statusResult
);
- }else if( $this->mParams['sessionkey'] ) {
+ } else if( $this->mParams['sessionkey'] ) {
// Stashed upload
$this->mUpload = new UploadFromStash();
$this->mUpload->initialize( $this->mParams['filename'], $_SESSION['wsUploadData'][$this->mParams['sessionkey']] );
- }else{
+ } else {
// Upload from url or file
// Parameter filename is required
if( !isset( $this->mParams['filename'] ) )
} elseif( isset( $this->mParams['url'] ) ) {
$this->mUpload = new UploadFromUrl();
- $this->mUpload->initialize( $this->mParams['filename'], $this->mParams['url'], $this->mParams['asyncdownload']);
+ $this->mUpload->initialize( $this->mParams['filename'], $this->mParams['url'], $this->mParams['asyncdownload'] );
$status = $this->mUpload->fetchFile();
if( !$status->isOK() ){
//check if we doing a async request set session info and return the upload_session_key)
if( $this->mUpload->isAsync() ){
$upload_session_key = $status->value;
- //update the session with anything with the params we will need to finish up the upload later on:
- if(!isset($_SESSION['wsDownload'][$upload_session_key]))
+ // update the session with anything with the params we will need to finish up the upload later on:
+ if( !isset( $_SESSION['wsDownload'][$upload_session_key] ) )
$_SESSION['wsDownload'][$upload_session_key] = array();
$sd =& $_SESSION['wsDownload'][$upload_session_key];
- //copy mParams for finishing up after:
+ // copy mParams for finishing up after:
$sd['mParams'] = $this->mParams;
return $this->getResult()->addValue( null, $this->getModuleName(),
//finish up the exec command:
$this->doExecUpload();
}
+
function doExecUpload(){
global $wgUser;
- //Check whether the user has the appropriate permissions to upload anyway
+ // Check whether the user has the appropriate permissions to upload anyway
$permission = $this->mUpload->isAllowed( $wgUser );
-
if( $permission !== true ) {
if( !$wgUser->isLoggedIn() )
$this->dieUsageMsg( array( 'mustbeloggedin', 'upload' ) );
$this->mUpload->cleanupTempFile();
$this->getResult()->addValue( null, $this->getModuleName(), $result );
}
+
private function performUpload() {
global $wgUser;
$result = array();
}
return $result;
}
+
if( !$this->mParams['ignorewarnings'] ) {
$warnings = $this->mUpload->checkWarnings();
if( $warnings ) {
return $result;
}
}
- //do the upload
+
+ // do the upload
$status = $this->mUpload->performUpload( $this->mParams['comment'],
$this->mParams['comment'], $this->mParams['watch'], $wgUser );
$result['result'] = 'Success';
$result['filename'] = $file->getName();
-
// Append imageinfo to the result
- //might be a cleaner way to call this:
+ // might be a cleaner way to call this:
$imParam = ApiQueryImageInfo::getAllowedParams();
- $imProp = $imParam['prop'][ApiBase :: PARAM_TYPE];
+ $imProp = $imParam['prop'][ApiBase::PARAM_TYPE];
$result['imageinfo'] = ApiQueryImageInfo::getInfo( $file,
array_flip( $imProp ),
$this->getResult() );
- wfDebug("\n\n return result: " . print_r($result, true));
+ wfDebug( "\n\n return result: " . print_r( $result, true ) );
return $result;
}
}
public function getAllowedParams() {
- return array (
+ return array(
'filename' => null,
'file' => null,
'chunk' => null,
'url' => null,
- 'token' => null,
+ 'token' => null,
'enablechunks' => null,
'comment' => array(
- ApiBase :: PARAM_DFLT => ''
+ ApiBase::PARAM_DFLT => ''
),
- 'asyncdownload'=>false,
+ 'asyncdownload' => false,
'watch' => false,
'ignorewarnings' => false,
- 'done' => false,
+ 'done' => false,
'sessionkey' => null,
'httpstatus' => null,
- 'chunksessionkey'=> null,
- 'internalhttpsession'=> null,
+ 'chunksessionkey' => null,
+ 'internalhttpsession' => null,
);
}
public function getParamDescription() {
- return array (
+ return array(
'filename' => 'Target filename',
'file' => 'File contents',
'chunk'=> 'Chunk File Contents',
'url' => 'Url to upload from',
'comment' => 'Upload comment or initial page text',
- 'token' => 'Edit token. You can get one of these through prop=info (this helps avoid remote ajax upload requests with your credentials)',
+ 'token' => 'Edit token. You can get one of these through prop=info (this helps avoid remote ajax upload requests with your credentials)',
'enablechunks' => 'Boolean If we are in chunk mode; accepts many small file POSTs',
'asyncdownload' => 'If we should download the url asyncrously usefull for large http downloads (returns a upload session key to get status updates in subquent calls)',
'watch' => 'Watch the page',
public function getDescription() {
return array(
- 'Upload an File'
+ 'Upload a file'
);
}
protected function getExamples() {
- return array (
+ return array(
'api.php?action=upload&filename=Wiki.png&url=http%3A//upload.wikimedia.org/wikipedia/en/b/bc/Wiki.png&ignorewarnings'
);
}
<?php
-/*
- * mvwScriptLoader.php
-* Script Loading Library for MediaWiki
-*
-* @author Michael Dale mdale@wikimedia.org
-* @date feb, 2009
-*
-* This program is free software; you can redistribute it and/or modify
-* it under the terms of the GNU General Public License as published by
-* the Free Software Foundation; either version 2 of the License, or
-* (at your option) any later version.
-*
-* This program is distributed in the hope that it will be useful,
-* but WITHOUT ANY WARRANTY; without even the implied warranty of
-* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-* GNU General Public License for more details.
-*
-* You should have received a copy of the GNU General Public License along
-* with this program; if not, write to the Free Software Foundation, Inc.,
-* 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
-* http://www.gnu.org/copyleft/gpl.html
-*/
-
-/*
- * mvwScriptLoader:
+/**
+ * mvwScriptLoader.php
+ * Script Loading Library for MediaWiki
+ *
+ * @file
+ * @author Michael Dale mdale@wikimedia.org
+ * @date feb, 2009
+ * @link http://www.mediawiki.org/wiki/ScriptLoader Documentation
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
*
- * some documentation about script-loader:
- * http://www.mediawiki.org/wiki/ScriptLoader
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * http://www.gnu.org/copyleft/gpl.html
*/
-//include WebStart.php
+// include WebStart.php
require_once('includes/WebStart.php');
-wfProfileIn('mvwScriptLoader.php');
+wfProfileIn( 'mvwScriptLoader.php' );
if( isset( $_SERVER['SCRIPT_URL'] ) ) {
$url = $_SERVER['SCRIPT_URL'];
$url = $_SERVER['PHP_SELF'];
}
-if( strpos($url, "mwScriptLoader$wgScriptExtension") === false){
+if( strpos( $url, "mwScriptLoader$wgScriptExtension" ) === false ){
wfHttpError( 403, 'Forbidden',
'mvwScriptLoader must be accessed through the primary script entry point.' );
- return ;
+ return;
}
-//Verify the script loader is on:
-if (!$wgEnableScriptLoader) {
+// Verify the script loader is on:
+if ( !$wgEnableScriptLoader ) {
echo '/*ScriptLoader is not enabled for this site. To enable add the following line to your LocalSettings.php';
echo '<pre><b>$wgEnableScriptLoader=true;</b></pre>*/';
echo 'alert(\'Script loader is disabled\');';
- die(1);
+ die( 1 );
}
-//load the mwEmbed language file:
+// load the mwEmbed language file:
$wgExtensionMessagesFiles['mwEmbed'] = "{$IP}/js2/mwEmbed/php/languages/mwEmbed.i18n.php";
-//enable the msgs before we go on:
+// enable the msgs before we go on:
wfLoadExtensionMessages( 'mwEmbed' );
-//run jsScriptLoader action:
+// run jsScriptLoader action:
$myScriptLoader = new jsScriptLoader();
$myScriptLoader->doScriptLoader();
-wfProfileOut();
-?>
\ No newline at end of file
+wfProfileOut( 'mvwScriptLoader.php' );
\ No newline at end of file
dépôts / lhc / web / wiklou.git / commitdiff