includes/SpecialUpload.php

   1 <?php
   2 /**
   3  *
   4  * @addtogroup SpecialPage
   5  */
   6
   7
   8 /**
   9  * Entry point
  10  */
  11 function wfSpecialUpload() {
  12         global $wgRequest;
  13         $form = new UploadForm( $wgRequest );
  14         $form->execute();
  15 }
  16
  17 /**
  18  * implements Special:Upload
  19  * @addtogroup SpecialPage
  20  */
  21 class UploadForm {
  22         /**#@+
  23          * @access private
  24          */
  25         var $mComment, $mLicense, $mIgnoreWarning, $mCurlError;
  26         var $mDestName, $mTempPath, $mFileSize, $mFileProps;
  27         var $mCopyrightStatus, $mCopyrightSource, $mReUpload, $mAction, $mUploadClicked;
  28         var $mSrcName, $mSessionKey, $mStashed, $mDesiredDestName, $mRemoveTempFile, $mSourceType;
  29         var $mCurlDestHandle;
  30         var $mLocalFile;
  31
  32         # Placeholders for text injection by hooks (must be HTML)
  33         # extensions should take care to _append_ to the present value
  34         var $uploadFormTextTop;
  35         var $uploadFormTextAfterSummary;
  36
  37         const SESSION_VERSION = 1;
  38         /**#@-*/
  39
  40         /**
  41          * Constructor : initialise object
  42          * Get data POSTed through the form and assign them to the object
  43          * @param $request Data posted.
  44          */
  45         function UploadForm( &$request ) {
  46                 global $wgAllowCopyUploads;
  47                 $this->mDesiredDestName   = $request->getText( 'wpDestFile' );
  48                 $this->mIgnoreWarning     = $request->getCheck( 'wpIgnoreWarning' );
  49
  50                 if( !$request->wasPosted() ) {
  51                         # GET requests just give the main form; no data except wpDestfile.
  52                         return;
  53                 }
  54
  55                 # Placeholders for text injection by hooks (empty per default)
  56                 $this->uploadFormTextTop = "";
  57                 $this->uploadFormTextAfterSummary = "";
  58
  59                 $this->mReUpload          = $request->getCheck( 'wpReUpload' );
  60                 $this->mUploadClicked     = $request->getCheck( 'wpUpload' );
  61
  62                 $this->mComment           = $request->getText( 'wpUploadDescription' );
  63                 $this->mLicense           = $request->getText( 'wpLicense' );
  64                 $this->mCopyrightStatus   = $request->getText( 'wpUploadCopyStatus' );
  65                 $this->mCopyrightSource   = $request->getText( 'wpUploadSource' );
  66                 $this->mWatchthis         = $request->getBool( 'wpWatchthis' );
  67                 $this->mSourceType        = $request->getText( 'wpSourceType' );
  68                 wfDebug( "UploadForm: watchthis is: '$this->mWatchthis'\n" );
  69
  70                 $this->mAction            = $request->getVal( 'action' );
  71
  72                 $this->mSessionKey        = $request->getInt( 'wpSessionKey' );
  73                 if( !empty( $this->mSessionKey ) &&
  74                         isset( $_SESSION['wsUploadData'][$this->mSessionKey]['version'] ) &&
  75                         $_SESSION['wsUploadData'][$this->mSessionKey]['version'] == self::SESSION_VERSION ) {
  76                         /**
  77                          * Confirming a temporarily stashed upload.
  78                          * We don't want path names to be forged, so we keep
  79                          * them in the session on the server and just give
  80                          * an opaque key to the user agent.
  81                          */
  82                         $data = $_SESSION['wsUploadData'][$this->mSessionKey];
  83                         $this->mTempPath         = $data['mTempPath'];
  84                         $this->mFileSize         = $data['mFileSize'];
  85                         $this->mSrcName          = $data['mSrcName'];
  86                         $this->mFileProps        = $data['mFileProps'];
  87                         $this->mCurlError        = 0/*UPLOAD_ERR_OK*/;
  88                         $this->mStashed          = true;
  89                         $this->mRemoveTempFile   = false;
  90                 } else {
  91                         /**
  92                          *Check for a newly uploaded file.
  93                          */
  94                         if( $wgAllowCopyUploads && $this->mSourceType == 'web' ) {
  95                                 $this->initializeFromUrl( $request );
  96                         } else {
  97                                 $this->initializeFromUpload( $request );
  98                         }
  99                 }
 100         }
 101
 102         /**
 103          * Initialize the uploaded file from PHP data
 104          * @access private
 105          */
 106         function initializeFromUpload( $request ) {
 107                 $this->mTempPath       = $request->getFileTempName( 'wpUploadFile' );
 108                 $this->mFileSize       = $request->getFileSize( 'wpUploadFile' );
 109                 $this->mSrcName        = $request->getFileName( 'wpUploadFile' );
 110                 $this->mCurlError      = $request->getUploadError( 'wpUploadFile' );
 111                 $this->mSessionKey     = false;
 112                 $this->mStashed        = false;
 113                 $this->mRemoveTempFile = false; // PHP will handle this
 114         }
 115
 116         /**
 117          * Copy a web file to a temporary file
 118          * @access private
 119          */
 120         function initializeFromUrl( $request ) {
 121                 global $wgTmpDirectory;
 122                 $url = $request->getText( 'wpUploadFileURL' );
 123                 $local_file = tempnam( $wgTmpDirectory, 'WEBUPLOAD' );
 124
 125                 $this->mTempPath       = $local_file;
 126                 $this->mFileSize       = 0; # Will be set by curlCopy
 127                 $this->mCurlError      = $this->curlCopy( $url, $local_file );
 128                 $this->mSrcName        = array_pop( explode( '/', $url ) );
 129                 $this->mSessionKey     = false;
 130                 $this->mStashed        = false;
 131
 132                 // PHP won't auto-cleanup the file
 133                 $this->mRemoveTempFile = file_exists( $local_file );
 134         }
 135
 136         /**
 137          * Safe copy from URL
 138          * Returns true if there was an error, false otherwise
 139          */
 140         private function curlCopy( $url, $dest ) {
 141                 global $wgUser, $wgOut;
 142
 143                 if( !$wgUser->isAllowed( 'upload_by_url' ) ) {
 144                         $wgOut->permissionRequired( 'upload_by_url' );
 145                         return true;
 146                 }
 147
 148                 # Maybe remove some pasting blanks :-)
 149                 $url =  trim( $url );
 150                 if( stripos($url, 'http://') !== 0 && stripos($url, 'ftp://') !== 0 ) {
 151                         # Only HTTP or FTP URLs
 152                         $wgOut->errorPage( 'upload-proto-error', 'upload-proto-error-text' );
 153                         return true;
 154                 }
 155
 156                 # Open temporary file
 157                 $this->mCurlDestHandle = @fopen( $this->mTempPath, "wb" );
 158                 if( $this->mCurlDestHandle === false ) {
 159                         # Could not open temporary file to write in
 160                         $wgOut->errorPage( 'upload-file-error', 'upload-file-error-text');
 161                         return true;
 162                 }
 163
 164                 $ch = curl_init();
 165                 curl_setopt( $ch, CURLOPT_HTTP_VERSION, 1.0); # Probably not needed, but apparently can work around some bug
 166                 curl_setopt( $ch, CURLOPT_TIMEOUT, 10); # 10 seconds timeout
 167                 curl_setopt( $ch, CURLOPT_LOW_SPEED_LIMIT, 512); # 0.5KB per second minimum transfer speed
 168                 curl_setopt( $ch, CURLOPT_URL, $url);
 169                 curl_setopt( $ch, CURLOPT_WRITEFUNCTION, array( $this, 'uploadCurlCallback' ) );
 170                 curl_exec( $ch );
 171                 $error = curl_errno( $ch ) ? true : false;
 172                 $errornum =  curl_errno( $ch );
 173                 // if ( $error ) print curl_error ( $ch ) ; # Debugging output
 174                 curl_close( $ch );
 175
 176                 fclose( $this->mCurlDestHandle );
 177                 unset( $this->mCurlDestHandle );
 178                 if( $error ) {
 179                         unlink( $dest );
 180                         if( wfEmptyMsg( "upload-curl-error$errornum", wfMsg("upload-curl-error$errornum") ) )
 181                                 $wgOut->errorPage( 'upload-misc-error', 'upload-misc-error-text' );
 182                         else
 183                                 $wgOut->errorPage( "upload-curl-error$errornum", "upload-curl-error$errornum-text" );
 184                 }
 185
 186                 return $error;
 187         }
 188
 189         /**
 190          * Callback function for CURL-based web transfer
 191          * Write data to file unless we've passed the length limit;
 192          * if so, abort immediately.
 193          * @access private
 194          */
 195         function uploadCurlCallback( $ch, $data ) {
 196                 global $wgMaxUploadSize;
 197                 $length = strlen( $data );
 198                 $this->mFileSize += $length;
 199                 if( $this->mFileSize > $wgMaxUploadSize ) {
 200                         return 0;
 201                 }
 202                 fwrite( $this->mCurlDestHandle, $data );
 203                 return $length;
 204         }
 205
 206         /**
 207          * Start doing stuff
 208          * @access public
 209          */
 210         function execute() {
 211                 global $wgUser, $wgOut;
 212                 global $wgEnableUploads;
 213
 214                 # Check uploading enabled
 215                 if( !$wgEnableUploads ) {
 216                         $wgOut->showErrorPage( 'uploaddisabled', 'uploaddisabledtext', array( $this->mDesiredDestName ) );
 217                         return;
 218                 }
 219
 220                 # Check permissions
 221                 if( !$wgUser->isAllowed( 'upload' ) ) {
 222                         if( !$wgUser->isLoggedIn() ) {
 223                                 $wgOut->showErrorPage( 'uploadnologin', 'uploadnologintext' );
 224                         } else {
 225                                 $wgOut->permissionRequired( 'upload' );
 226                         }
 227                         return;
 228                 }
 229
 230                 # Check blocks
 231                 if( $wgUser->isBlocked() ) {
 232                         $wgOut->blockedPage();
 233                         return;
 234                 }
 235
 236                 if( wfReadOnly() ) {
 237                         $wgOut->readOnlyPage();
 238                         return;
 239                 }
 240
 241                 if( $this->mReUpload ) {
 242                         if( !$this->unsaveUploadedFile() ) {
 243                                 return;
 244                         }
 245                         $this->mainUploadForm();
 246                 } else if( 'submit' == $this->mAction || $this->mUploadClicked ) {
 247                         $this->processUpload();
 248                 } else {
 249                         $this->mainUploadForm();
 250                 }
 251
 252                 $this->cleanupTempFile();
 253         }
 254
 255         /* -------------------------------------------------------------- */
 256
 257         /**
 258          * Really do the upload
 259          * Checks are made in SpecialUpload::execute()
 260          * @access private
 261          */
 262         function processUpload() {
 263                 global $wgUser, $wgOut;
 264
 265                 if( !wfRunHooks( 'UploadForm:BeforeProcessing', array( &$this ) ) )
 266                 {
 267                         wfDebug( "Hook 'UploadForm:BeforeProcessing' broke processing the file." );
 268                         return false;
 269                 }
 270
 271                 /* Check for PHP error if any, requires php 4.2 or newer */
 272                 if( $this->mCurlError == 1/*UPLOAD_ERR_INI_SIZE*/ ) {
 273                         $this->mainUploadForm( wfMsgHtml( 'largefileserver' ) );
 274                         return;
 275                 }
 276
 277                 /**
 278                  * If there was no filename or a zero size given, give up quick.
 279                  */
 280                 if( trim( $this->mSrcName ) == '' || empty( $this->mFileSize ) ) {
 281                         $this->mainUploadForm( wfMsgHtml( 'emptyfile' ) );
 282                         return;
 283                 }
 284
 285                 # Chop off any directories in the given filename
 286                 if( $this->mDesiredDestName ) {
 287                         $basename = wfBaseName( $this->mDesiredDestName );
 288                 } else {
 289                         $basename = wfBaseName( $this->mSrcName );
 290                 }
 291
 292                 /**
 293                  * We'll want to blacklist against *any* 'extension', and use
 294                  * only the final one for the whitelist.
 295                  */
 296                 list( $partname, $ext ) = $this->splitExtensions( $basename );
 297
 298                 if( count( $ext ) ) {
 299                         $finalExt = $ext[count( $ext ) - 1];
 300                 } else {
 301                         $finalExt = '';
 302                 }
 303
 304                 # If there was more than one "extension", reassemble the base
 305                 # filename to prevent bogus complaints about length
 306                 if( count( $ext ) > 1 ) {
 307                         for( $i = 0; $i < count( $ext ) - 1; $i++ )
 308                                 $partname .= '.' . $ext[$i];
 309                 }
 310
 311                 if( strlen( $partname ) < 1 ) {
 312                         $this->mainUploadForm( wfMsgHtml( 'minlength1' ) );
 313                         return;
 314                 }
 315
 316                 /**
 317                  * Filter out illegal characters, and try to make a legible name
 318                  * out of it. We'll strip some silently that Title would die on.
 319                  */
 320                 $filtered = preg_replace ( "/[^".Title::legalChars()."]|:/", '-', $basename );
 321                 $nt = Title::makeTitleSafe( NS_IMAGE, $filtered );
 322                 if( is_null( $nt ) ) {
 323                         $this->uploadError( wfMsgWikiHtml( 'illegalfilename', htmlspecialchars( $filtered ) ) );
 324                         return;
 325                 }
 326                 $this->mLocalFile = wfLocalFile( $nt );
 327                 $this->mDestName = $this->mLocalFile->getName();
 328
 329                 /**
 330                  * If the image is protected, non-sysop users won't be able
 331                  * to modify it by uploading a new revision.
 332                  */
 333                 if( !$nt->userCan( 'edit' ) ) {
 334                         return $this->uploadError( wfMsgWikiHtml( 'protectedpage' ) );
 335                 }
 336
 337                 /**
 338                  * In some cases we may forbid overwriting of existing files.
 339                  */
 340                 $overwrite = $this->checkOverwrite( $this->mDestName );
 341                 if( WikiError::isError( $overwrite ) ) {
 342                         return $this->uploadError( $overwrite->toString() );
 343                 }
 344
 345                 /* Don't allow users to override the blacklist (check file extension) */
 346                 global $wgStrictFileExtensions;
 347                 global $wgFileExtensions, $wgFileBlacklist;
 348                 if ($finalExt == '') {
 349                         return $this->uploadError( wfMsgExt( 'filetype-missing', array ( 'parseinline' ) ) );
 350                 } elseif ( $this->checkFileExtensionList( $ext, $wgFileBlacklist ) ||
 351                                 ($wgStrictFileExtensions && !$this->checkFileExtension( $finalExt, $wgFileExtensions ) ) ) {
 352                         return $this->uploadError( wfMsgExt( 'filetype-badtype', array ( 'parseinline' ),
 353                                 htmlspecialchars( $finalExt ), implode ( ', ', $wgFileExtensions ) ) );
 354                 }
 355
 356                 /**
 357                  * Look at the contents of the file; if we can recognize the
 358                  * type but it's corrupt or data of the wrong type, we should
 359                  * probably not accept it.
 360                  */
 361                 if( !$this->mStashed ) {
 362                         $this->mFileProps = File::getPropsFromPath( $this->mTempPath, $finalExt );
 363                         $this->checkMacBinary();
 364                         $veri = $this->verify( $this->mTempPath, $finalExt );
 365
 366                         if( $veri !== true ) { //it's a wiki error...
 367                                 return $this->uploadError( $veri->toString() );
 368                         }
 369
 370                         /**
 371                          * Provide an opportunity for extensions to add futher checks
 372                          */
 373                         $error = '';
 374                         if( !wfRunHooks( 'UploadVerification',
 375                                         array( $this->mDestName, $this->mTempPath, &$error ) ) ) {
 376                                 return $this->uploadError( $error );
 377                         }
 378                 }
 379
 380
 381                 /**
 382                  * Check for non-fatal conditions
 383                  */
 384                 if ( ! $this->mIgnoreWarning ) {
 385                         $warning = '';
 386
 387                         global $wgCapitalLinks;
 388                         if( $wgCapitalLinks ) {
 389                                 $filtered = ucfirst( $filtered );
 390                         }
 391                         if( $this->mDestName != $filtered ) {
 392                                 $warning .=  '<li>'.wfMsgHtml( 'badfilename', htmlspecialchars( $this->mDestName ) ).'</li>';
 393                         }
 394
 395                         global $wgCheckFileExtensions;
 396                         if ( $wgCheckFileExtensions ) {
 397                                 if ( ! $this->checkFileExtension( $finalExt, $wgFileExtensions ) ) {
 398                                         $warning .= '<li>'.wfMsgExt( 'filetype-badtype', array ( 'parseinline' ),
 399                                                 htmlspecialchars( $finalExt ), implode ( ', ', $wgFileExtensions ) ).'</li>';
 400                                 }
 401                         }
 402
 403                         global $wgUploadSizeWarning;
 404                         if ( $wgUploadSizeWarning && ( $this->mFileSize > $wgUploadSizeWarning ) ) {
 405                                 $skin = $wgUser->getSkin();
 406                                 $wsize = $skin->formatSize( $wgUploadSizeWarning );
 407                                 $asize = $skin->formatSize( $this->mFileSize );
 408                                 $warning .= '<li>' . wfMsgHtml( 'large-file', $wsize, $asize ) . '</li>';
 409                         }
 410                         if ( $this->mFileSize == 0 ) {
 411                                 $warning .= '<li>'.wfMsgHtml( 'emptyfile' ).'</li>';
 412                         }
 413
 414                         global $wgUser;
 415                         $sk = $wgUser->getSkin();
 416
 417                         // Check for uppercase extension. We allow these filenames but check if an image
 418                         // with lowercase extension exists already
 419                         if ( $finalExt != strtolower( $finalExt ) ) {
 420                                 $nt_lc = Title::newFromText( $partname . '.' . strtolower( $finalExt ) );
 421                                 $image_lc = wfLocalFile( $nt_lc );
 422                         }
 423
 424                         if( $this->mLocalFile->exists() ) {
 425                                 $dlink = $sk->makeKnownLinkObj( $nt );
 426                                 if ( $this->mLocalFile->allowInlineDisplay() ) {
 427                                         $dlink2 = $sk->makeImageLinkObj( $nt, wfMsgExt( 'fileexists-thumb', 'parseinline', $dlink ),
 428                                                 $nt->getText(), 'right', array(), false, true );
 429                                 } elseif ( !$this->mLocalFile->allowInlineDisplay() && $this->mLocalFile->isSafeFile() ) {
 430                                         $icon = $this->mLocalFile->iconThumb();
 431                                         $dlink2 = '<div style="float:right" id="mw-media-icon"><a href="' . $this->mLocalFile->getURL() . '">' .
 432                                                 $icon->toHtml() . '</a><br />' . $dlink . '</div>';
 433                                 } else {
 434                                         $dlink2 = '';
 435                                 }
 436
 437                                 $warning .= '<li>' . wfMsgExt( 'fileexists', 'parseline', $dlink ) . '</li>' . $dlink2;
 438
 439                         } elseif ( isset( $image_lc) && $image_lc->exists() ) {
 440                                 # Check if image with lowercase extension exists.
 441                                 # It's not forbidden but in 99% it makes no sense to upload the same filename with uppercase extension
 442                                 $dlink = $sk->makeKnownLinkObj( $nt_lc );
 443                                 if ( $image_lc->allowInlineDisplay() ) {
 444                                         $dlink2 = $sk->makeImageLinkObj( $nt_lc, wfMsgExt( 'fileexists-thumb', 'parseinline', $dlink ),
 445                                                 $nt_lc->getText(), 'right', array(), false, true );
 446                                 } elseif ( !$image_lc->allowInlineDisplay() && $image_lc->isSafeFile() ) {
 447                                         $icon = $image_lc->iconThumb();
 448                                         $dlink2 = '<div style="float:right" id="mw-media-icon"><a href="' . $image_lc->getURL() . '">' .
 449                                                 $icon->toHtml() . '</a><br />' . $dlink . '</div>';
 450                                 } else {
 451                                         $dlink2 = '';
 452                                 }
 453
 454                                 $warning .= '<li>' . wfMsgExt( 'fileexists-extension', 'parsemag' , $partname . '.'
 455                                         . $finalExt , $dlink ) . '</li>' . $dlink2;
 456
 457                         } elseif ( ( substr( $partname , 3, 3 ) == 'px-' || substr( $partname , 2, 3 ) == 'px-' )
 458                                 && ereg( "[0-9]{2}" , substr( $partname , 0, 2) ) )
 459                         {
 460                                 # Check for filenames like 50px- or 180px-, these are mostly thumbnails
 461                                 $nt_thb = Title::newFromText( substr( $partname , strpos( $partname , '-' ) +1 ) . '.' . $finalExt );
 462                                 $image_thb = wfLocalFile( $nt_thb );
 463                                 if ($image_thb->exists() ) {
 464                                         # Check if an image without leading '180px-' (or similiar) exists
 465                                         $dlink = $sk->makeKnownLinkObj( $nt_thb);
 466                                         if ( $image_thb->allowInlineDisplay() ) {
 467                                                 $dlink2 = $sk->makeImageLinkObj( $nt_thb,
 468                                                         wfMsgExt( 'fileexists-thumb', 'parseinline', $dlink ),
 469                                                         $nt_thb->getText(), 'right', array(), false, true );
 470                                         } elseif ( !$image_thb->allowInlineDisplay() && $image_thb->isSafeFile() ) {
 471                                                 $icon = $image_thb->iconThumb();
 472                                                 $dlink2 = '<div style="float:right" id="mw-media-icon"><a href="' .
 473                                                         $image_thb->getURL() . '">' . $icon->toHtml() . '</a><br />' .
 474                                                         $dlink . '</div>';
 475                                         } else {
 476                                                 $dlink2 = '';
 477                                         }
 478
 479                                         $warning .= '<li>' . wfMsgExt( 'fileexists-thumbnail-yes', 'parsemag', $dlink ) .
 480                                                 '</li>' . $dlink2;
 481                                 } else {
 482                                         # Image w/o '180px-' does not exists, but we do not like these filenames
 483                                         $warning .= '<li>' . wfMsgExt( 'file-thumbnail-no', 'parseinline' ,
 484                                                 substr( $partname , 0, strpos( $partname , '-' ) +1 ) ) . '</li>';
 485                                 }
 486                         }
 487                         if ( $this->mLocalFile->wasDeleted() ) {
 488                                 # If the file existed before and was deleted, warn the user of this
 489                                 # Don't bother doing so if the image exists now, however
 490                                 $ltitle = SpecialPage::getTitleFor( 'Log' );
 491                                 $llink = $sk->makeKnownLinkObj( $ltitle, wfMsgHtml( 'deletionlog' ),
 492                                         'type=delete&page=' . $nt->getPrefixedUrl() );
 493                                 $warning .= wfOpenElement( 'li' ) . wfMsgWikiHtml( 'filewasdeleted', $llink ) .
 494                                         wfCloseElement( 'li' );
 495                         }
 496
 497                         if( $warning != '' ) {
 498                                 /**
 499                                  * Stash the file in a temporary location; the user can choose
 500                                  * to let it through and we'll complete the upload then.
 501                                  */
 502                                 return $this->uploadWarning( $warning );
 503                         }
 504                 }
 505
 506                 /**
 507                  * Try actually saving the thing...
 508                  * It will show an error form on failure.
 509                  */
 510                 $pageText = self::getInitialPageText( $this->mComment, $this->mLicense,
 511                         $this->mCopyrightStatus, $this->mCopyrightSource );
 512
 513                 $error = $this->mLocalFile->upload( $this->mTempPath, $this->mComment, $pageText,
 514                         File::DELETE_SOURCE, $this->mFileProps );
 515                 if ( WikiError::isError( $error ) ) {
 516                         $this->showError( $error );
 517                 } else {
 518                         if ( $this->mWatchthis ) {
 519                                 global $wgUser;
 520                                 $wgUser->addWatch( $this->mLocalFile->getTitle() );
 521                         }
 522                         $this->showSuccess();
 523                         wfRunHooks( 'UploadComplete', array( &$img ) );
 524                 }
 525         }
 526
 527         /**
 528          * Stash a file in a temporary directory for later processing
 529          * after the user has confirmed it.
 530          *
 531          * If the user doesn't explicitly cancel or accept, these files
 532          * can accumulate in the temp directory.
 533          *
 534          * @param string $saveName - the destination filename
 535          * @param string $tempName - the source temporary file to save
 536          * @return string - full path the stashed file, or false on failure
 537          * @access private
 538          */
 539         function saveTempUploadedFile( $saveName, $tempName ) {
 540                 global $wgOut;
 541                 $repo = RepoGroup::singleton()->getLocalRepo();
 542                 $result = $repo->storeTemp( $saveName, $tempName );
 543                 if ( WikiError::isError( $result ) ) {
 544                         $this->showError( $result );
 545                         return false;
 546                 } else {
 547                         return $result;
 548                 }
 549         }
 550
 551         /**
 552          * Stash a file in a temporary directory for later processing,
 553          * and save the necessary descriptive info into the session.
 554          * Returns a key value which will be passed through a form
 555          * to pick up the path info on a later invocation.
 556          *
 557          * @return int
 558          * @access private
 559          */
 560         function stashSession() {
 561                 $stash = $this->saveTempUploadedFile( $this->mDestName, $this->mTempPath );
 562
 563                 if( !$stash ) {
 564                         # Couldn't save the file.
 565                         return false;
 566                 }
 567
 568                 $key = mt_rand( 0, 0x7fffffff );
 569                 $_SESSION['wsUploadData'][$key] = array(
 570                         'mTempPath'       => $stash,
 571                         'mFileSize'       => $this->mFileSize,
 572                         'mSrcName'        => $this->mSrcName,
 573                         'mFileProps'      => $this->mFileProps,
 574                         'version'         => self::SESSION_VERSION,
 575                 );
 576                 return $key;
 577         }
 578
 579         /**
 580          * Remove a temporarily kept file stashed by saveTempUploadedFile().
 581          * @access private
 582          * @return success
 583          */
 584         function unsaveUploadedFile() {
 585                 global $wgOut;
 586                 $repo = RepoGroup::singleton()->getLocalRepo();
 587                 $success = $repo->freeTemp( $this->mTempPath );
 588                 if ( ! $success ) {
 589                         $wgOut->showFileDeleteError( $this->mTempPath );
 590                         return false;
 591                 } else {
 592                         return true;
 593                 }
 594         }
 595
 596         /* -------------------------------------------------------------- */
 597
 598         /**
 599          * Show some text and linkage on successful upload.
 600          * @access private
 601          */
 602         function showSuccess() {
 603                 global $wgUser, $wgOut, $wgContLang;
 604
 605                 $sk = $wgUser->getSkin();
 606                 $ilink = $sk->makeMediaLinkObj( $this->mLocalFile->getTitle() );
 607                 $dname = $wgContLang->getNsText( NS_IMAGE ) . ':'.$this->mDestName;
 608                 $dlink = $sk->makeKnownLink( $dname, $dname );
 609
 610                 $wgOut->addHTML( '<h2>' . wfMsgHtml( 'successfulupload' ) . "</h2>\n" );
 611                 $text = wfMsgWikiHtml( 'fileuploaded', $ilink, $dlink );
 612                 $wgOut->addHTML( $text );
 613                 $wgOut->returnToMain( false );
 614         }
 615
 616         /**
 617          * @param string $error as HTML
 618          * @access private
 619          */
 620         function uploadError( $error ) {
 621                 global $wgOut;
 622                 $wgOut->addHTML( "<h2>" . wfMsgHtml( 'uploadwarning' ) . "</h2>\n" );
 623                 $wgOut->addHTML( "<span class='error'>{$error}</span>\n" );
 624         }
 625
 626         /**
 627          * There's something wrong with this file, not enough to reject it
 628          * totally but we require manual intervention to save it for real.
 629          * Stash it away, then present a form asking to confirm or cancel.
 630          *
 631          * @param string $warning as HTML
 632          * @access private
 633          */
 634         function uploadWarning( $warning ) {
 635                 global $wgOut;
 636                 global $wgUseCopyrightUpload;
 637
 638                 $this->mSessionKey = $this->stashSession();
 639                 if( !$this->mSessionKey ) {
 640                         # Couldn't save file; an error has been displayed so let's go.
 641                         return;
 642                 }
 643
 644                 $wgOut->addHTML( "<h2>" . wfMsgHtml( 'uploadwarning' ) . "</h2>\n" );
 645                 $wgOut->addHTML( "<ul class='warning'>{$warning}</ul><br />\n" );
 646
 647                 $save = wfMsgHtml( 'savefile' );
 648                 $reupload = wfMsgHtml( 'reupload' );
 649                 $iw = wfMsgWikiHtml( 'ignorewarning' );
 650                 $reup = wfMsgWikiHtml( 'reuploaddesc' );
 651                 $titleObj = SpecialPage::getTitleFor( 'Upload' );
 652                 $action = $titleObj->escapeLocalURL( 'action=submit' );
 653
 654                 if ( $wgUseCopyrightUpload )
 655                 {
 656                         $copyright =  "
 657         <input type='hidden' name='wpUploadCopyStatus' value=\"" . htmlspecialchars( $this->mCopyrightStatus ) . "\" />
 658         <input type='hidden' name='wpUploadSource' value=\"" . htmlspecialchars( $this->mCopyrightSource ) . "\" />
 659         ";
 660                 } else {
 661                         $copyright = "";
 662                 }
 663
 664                 $wgOut->addHTML( "
 665         <form id='uploadwarning' method='post' enctype='multipart/form-data' action='$action'>
 666                 <input type='hidden' name='wpIgnoreWarning' value='1' />
 667                 <input type='hidden' name='wpSessionKey' value=\"" . htmlspecialchars( $this->mSessionKey ) . "\" />
 668                 <input type='hidden' name='wpUploadDescription' value=\"" . htmlspecialchars( $this->mComment ) . "\" />
 669                 <input type='hidden' name='wpLicense' value=\"" . htmlspecialchars( $this->mLicense ) . "\" />
 670                 <input type='hidden' name='wpDestFile' value=\"" . htmlspecialchars( $this->mDesiredDestName ) . "\" />
 671                 <input type='hidden' name='wpWatchthis' value=\"" . htmlspecialchars( intval( $this->mWatchthis ) ) . "\" />
 672         {$copyright}
 673         <table border='0'>
 674                 <tr>
 675                         <tr>
 676                                 <td align='right'>
 677                                         <input tabindex='2' type='submit' name='wpUpload' value=\"$save\" />
 678                                 </td>
 679                                 <td align='left'>$iw</td>
 680                         </tr>
 681                         <tr>
 682                                 <td align='right'>
 683                                         <input tabindex='2' type='submit' name='wpReUpload' value=\"{$reupload}\" />
 684                                 </td>
 685                                 <td align='left'>$reup</td>
 686                         </tr>
 687                 </tr>
 688         </table></form>\n" );
 689         }
 690
 691         /**
 692          * Displays the main upload form, optionally with a highlighted
 693          * error message up at the top.
 694          *
 695          * @param string $msg as HTML
 696          * @access private
 697          */
 698         function mainUploadForm( $msg='' ) {
 699                 global $wgOut, $wgUser;
 700                 global $wgUseCopyrightUpload;
 701                 global $wgRequest, $wgAllowCopyUploads;
 702
 703                 if( !wfRunHooks( 'UploadForm:initial', array( &$this ) ) )
 704                 {
 705                         wfDebug( "Hook 'UploadForm:initial' broke output of the upload form" );
 706                         return false;
 707                 }
 708
 709                 $cols = intval($wgUser->getOption( 'cols' ));
 710                 $ew = $wgUser->getOption( 'editwidth' );
 711                 if ( $ew ) $ew = " style=\"width:100%\"";
 712                 else $ew = '';
 713
 714                 if ( '' != $msg ) {
 715                         $sub = wfMsgHtml( 'uploaderror' );
 716                         $wgOut->addHTML( "<h2>{$sub}</h2>\n" .
 717                           "<span class='error'>{$msg}</span>\n" );
 718                 }
 719                 $wgOut->addHTML( '<div id="uploadtext">' );
 720                 $wgOut->addWikiText( wfMsgNoTrans( 'uploadtext', $this->mDesiredDestName ) );
 721                 $wgOut->addHTML( '</div>' );
 722
 723                 $sourcefilename = wfMsgHtml( 'sourcefilename' );
 724                 $destfilename = wfMsgHtml( 'destfilename' );
 725                 $summary = wfMsgWikiHtml( 'fileuploadsummary' );
 726
 727                 $licenses = new Licenses();
 728                 $license = wfMsgExt( 'license', array( 'parseinline' ) );
 729                 $nolicense = wfMsgHtml( 'nolicense' );
 730                 $licenseshtml = $licenses->getHtml();
 731
 732                 $ulb = wfMsgHtml( 'uploadbtn' );
 733
 734
 735                 $titleObj = SpecialPage::getTitleFor( 'Upload' );
 736                 $action = $titleObj->escapeLocalURL();
 737
 738                 $encDestName = htmlspecialchars( $this->mDesiredDestName );
 739
 740                 $watchChecked =
 741                         ( $wgUser->getOption( 'watchdefault' ) ||
 742                                 ( $wgUser->getOption( 'watchcreations' ) && $this->mDesiredDestName == '' ) )
 743                         ? 'checked="checked"'
 744                         : '';
 745                 $warningChecked = $this->mIgnoreWarning ? 'checked' : '';
 746
 747                 // Prepare form for upload or upload/copy
 748                 if( $wgAllowCopyUploads && $wgUser->isAllowed( 'upload_by_url' ) ) {
 749                         $filename_form =
 750                                 "<input type='radio' id='wpSourceTypeFile' name='wpSourceType' value='file' " .
 751                                    "onchange='toggle_element_activation(\"wpUploadFileURL\",\"wpUploadFile\")' checked />" .
 752                                  "<input tabindex='1' type='file' name='wpUploadFile' id='wpUploadFile' " .
 753                                    "onfocus='" .
 754                                      "toggle_element_activation(\"wpUploadFileURL\",\"wpUploadFile\");" .
 755                                      "toggle_element_check(\"wpSourceTypeFile\",\"wpSourceTypeURL\")'" .
 756                                 ($this->mDesiredDestName?"":"onchange='fillDestFilename(\"wpUploadFile\")' ") . "size='40' />" .
 757                                 wfMsgHTML( 'upload_source_file' ) . "<br/>" .
 758                                 "<input type='radio' id='wpSourceTypeURL' name='wpSourceType' value='web' " .
 759                                   "onchange='toggle_element_activation(\"wpUploadFile\",\"wpUploadFileURL\")' />" .
 760                                 "<input tabindex='1' type='text' name='wpUploadFileURL' id='wpUploadFileURL' " .
 761                                   "onfocus='" .
 762                                     "toggle_element_activation(\"wpUploadFile\",\"wpUploadFileURL\");" .
 763                                     "toggle_element_check(\"wpSourceTypeURL\",\"wpSourceTypeFile\")'" .
 764                                 ($this->mDesiredDestName?"":"onchange='fillDestFilename(\"wpUploadFileURL\")' ") . "size='40' DISABLED />" .
 765                                 wfMsgHtml( 'upload_source_url' ) ;
 766                 } else {
 767                         $filename_form =
 768                                 "<input tabindex='1' type='file' name='wpUploadFile' id='wpUploadFile' " .
 769                                 ($this->mDesiredDestName?"":"onchange='fillDestFilename(\"wpUploadFile\")' ") .
 770                                 "size='40' />" .
 771                                 "<input type='hidden' name='wpSourceType' value='file' />" ;
 772                 }
 773                 $encComment = htmlspecialchars( $this->mComment );
 774
 775                 $wgOut->addHTML( <<<EOT
 776         <form id='upload' method='post' enctype='multipart/form-data' action="$action">
 777                 <table border='0'>
 778                 <tr>
 779           {$this->uploadFormTextTop}
 780                         <td align='right' valign='top'><label for='wpUploadFile'>{$sourcefilename}:</label></td>
 781                         <td align='left'>
 782                                 {$filename_form}
 783                         </td>
 784                 </tr>
 785                 <tr>
 786                         <td align='right'><label for='wpDestFile'>{$destfilename}:</label></td>
 787                         <td align='left'>
 788                                 <input tabindex='2' type='text' name='wpDestFile' id='wpDestFile' size='40' value="$encDestName" />
 789                         </td>
 790                 </tr>
 791                 <tr>
 792                         <td align='right'><label for='wpUploadDescription'>{$summary}</label></td>
 793                         <td align='left'>
 794                                 <textarea tabindex='3' name='wpUploadDescription' id='wpUploadDescription' rows='6'
 795                                         cols='{$cols}'{$ew}>$encComment</textarea>
 796            {$this->uploadFormTextAfterSummary}
 797                         </td>
 798                 </tr>
 799                 <tr>
 800 EOT
 801                 );
 802
 803                 if ( $licenseshtml != '' ) {
 804                         global $wgStylePath;
 805                         $wgOut->addHTML( "
 806                         <td align='right'><label for='wpLicense'>$license:</label></td>
 807                         <td align='left'>
 808                                 <script type='text/javascript' src=\"$wgStylePath/common/upload.js\"></script>
 809                                 <select name='wpLicense' id='wpLicense' tabindex='4'
 810                                         onchange='licenseSelectorCheck()'>
 811                                         <option value=''>$nolicense</option>
 812                                         $licenseshtml
 813                                 </select>
 814                         </td>
 815                         </tr>
 816                         <tr>
 817                 ");
 818                 }
 819
 820                 if ( $wgUseCopyrightUpload ) {
 821                         $filestatus = wfMsgHtml ( 'filestatus' );
 822                         $copystatus =  htmlspecialchars( $this->mCopyrightStatus );
 823                         $filesource = wfMsgHtml ( 'filesource' );
 824                         $uploadsource = htmlspecialchars( $this->mCopyrightSource );
 825
 826                         $wgOut->addHTML( "
 827                                 <td align='right' nowrap='nowrap'><label for='wpUploadCopyStatus'>$filestatus:</label></td>
 828                                         <td><input tabindex='5' type='text' name='wpUploadCopyStatus' id='wpUploadCopyStatus'
 829                                           value=\"$copystatus\" size='40' /></td>
 830                         </tr>
 831                         <tr>
 832                                 <td align='right'><label for='wpUploadCopyStatus'>$filesource:</label></td>
 833                                         <td><input tabindex='6' type='text' name='wpUploadSource' id='wpUploadCopyStatus'
 834                                           value=\"$uploadsource\" size='40' /></td>
 835                         </tr>
 836                         <tr>
 837                 ");
 838                 }
 839
 840
 841                 $wgOut->addHtml( "
 842                 <td></td>
 843                 <td>
 844                         <input tabindex='7' type='checkbox' name='wpWatchthis' id='wpWatchthis' $watchChecked value='true' />
 845                         <label for='wpWatchthis'>" . wfMsgHtml( 'watchthisupload' ) . "</label>
 846                         <input tabindex='8' type='checkbox' name='wpIgnoreWarning' id='wpIgnoreWarning' value='true' $warningChecked/>
 847                         <label for='wpIgnoreWarning'>" . wfMsgHtml( 'ignorewarnings' ) . "</label>
 848                 </td>
 849         </tr>
 850         <tr>
 851                 <td></td>
 852                 <td align='left'><input tabindex='9' type='submit' name='wpUpload' value=\"{$ulb}\" /></td>
 853         </tr>
 854
 855         <tr>
 856                 <td></td>
 857                 <td align='left'>
 858                 " );
 859                 $wgOut->addWikiText( wfMsgForContent( 'edittools' ) );
 860                 $wgOut->addHTML( "
 861                 </td>
 862         </tr>
 863
 864         </table>
 865         </form>" );
 866         }
 867
 868         /* -------------------------------------------------------------- */
 869
 870         /**
 871          * Split a file into a base name and all dot-delimited 'extensions'
 872          * on the end. Some web server configurations will fall back to
 873          * earlier pseudo-'extensions' to determine type and execute
 874          * scripts, so the blacklist needs to check them all.
 875          *
 876          * @return array
 877          */
 878         function splitExtensions( $filename ) {
 879                 $bits = explode( '.', $filename );
 880                 $basename = array_shift( $bits );
 881                 return array( $basename, $bits );
 882         }
 883
 884         /**
 885          * Perform case-insensitive match against a list of file extensions.
 886          * Returns true if the extension is in the list.
 887          *
 888          * @param string $ext
 889          * @param array $list
 890          * @return bool
 891          */
 892         function checkFileExtension( $ext, $list ) {
 893                 return in_array( strtolower( $ext ), $list );
 894         }
 895
 896         /**
 897          * Perform case-insensitive match against a list of file extensions.
 898          * Returns true if any of the extensions are in the list.
 899          *
 900          * @param array $ext
 901          * @param array $list
 902          * @return bool
 903          */
 904         function checkFileExtensionList( $ext, $list ) {
 905                 foreach( $ext as $e ) {
 906                         if( in_array( strtolower( $e ), $list ) ) {
 907                                 return true;
 908                         }
 909                 }
 910                 return false;
 911         }
 912
 913         /**
 914          * Verifies that it's ok to include the uploaded file
 915          *
 916          * @param string $tmpfile the full path of the temporary file to verify
 917          * @param string $extension The filename extension that the file is to be served with
 918          * @return mixed true of the file is verified, a WikiError object otherwise.
 919          */
 920         function verify( $tmpfile, $extension ) {
 921                 #magically determine mime type
 922                 $magic=& MimeMagic::singleton();
 923                 $mime= $magic->guessMimeType($tmpfile,false);
 924
 925                 #check mime type, if desired
 926                 global $wgVerifyMimeType;
 927                 if ($wgVerifyMimeType) {
 928
 929                         #check mime type against file extension
 930                         if( !$this->verifyExtension( $mime, $extension ) ) {
 931                                 return new WikiErrorMsg( 'uploadcorrupt' );
 932                         }
 933
 934                         #check mime type blacklist
 935                         global $wgMimeTypeBlacklist;
 936                         if( isset($wgMimeTypeBlacklist) && !is_null($wgMimeTypeBlacklist)
 937                                 && $this->checkFileExtension( $mime, $wgMimeTypeBlacklist ) ) {
 938                                 return new WikiErrorMsg( 'filetype-badmime', htmlspecialchars( $mime ) );
 939                         }
 940                 }
 941
 942                 #check for htmlish code and javascript
 943                 if( $this->detectScript ( $tmpfile, $mime, $extension ) ) {
 944                         return new WikiErrorMsg( 'uploadscripted' );
 945                 }
 946
 947                 /**
 948                 * Scan the uploaded file for viruses
 949                 */
 950                 $virus= $this->detectVirus($tmpfile);
 951                 if ( $virus ) {
 952                         return new WikiErrorMsg( 'uploadvirus', htmlspecialchars($virus) );
 953                 }
 954
 955                 wfDebug( __METHOD__.": all clear; passing.\n" );
 956                 return true;
 957         }
 958
 959         /**
 960          * Checks if the mime type of the uploaded file matches the file extension.
 961          *
 962          * @param string $mime the mime type of the uploaded file
 963          * @param string $extension The filename extension that the file is to be served with
 964          * @return bool
 965          */
 966         function verifyExtension( $mime, $extension ) {
 967                 $magic =& MimeMagic::singleton();
 968
 969                 if ( ! $mime || $mime == 'unknown' || $mime == 'unknown/unknown' )
 970                         if ( ! $magic->isRecognizableExtension( $extension ) ) {
 971                                 wfDebug( __METHOD__.": passing file with unknown detected mime type; " .
 972                                         "unrecognized extension '$extension', can't verify\n" );
 973                                 return true;
 974                         } else {
 975                                 wfDebug( __METHOD__.": rejecting file with unknown detected mime type; ".
 976                                         "recognized extension '$extension', so probably invalid file\n" );
 977                                 return false;
 978                         }
 979
 980                 $match= $magic->isMatchingExtension($extension,$mime);
 981
 982                 if ($match===NULL) {
 983                         wfDebug( __METHOD__.": no file extension known for mime type $mime, passing file\n" );
 984                         return true;
 985                 } elseif ($match===true) {
 986                         wfDebug( __METHOD__.": mime type $mime matches extension $extension, passing file\n" );
 987
 988                         #TODO: if it's a bitmap, make sure PHP or ImageMagic resp. can handle it!
 989                         return true;
 990
 991                 } else {
 992                         wfDebug( __METHOD__.": mime type $mime mismatches file extension $extension, rejecting file\n" );
 993                         return false;
 994                 }
 995         }
 996
 997         /**
 998          * Heuristic for detecting files that *could* contain JavaScript instructions or
 999          * things that may look like HTML to a browser and are thus
1000          * potentially harmful. The present implementation will produce false positives in some situations.
1001          *
1002          * @param string $file Pathname to the temporary upload file
1003          * @param string $mime The mime type of the file
1004          * @param string $extension The extension of the file
1005          * @return bool true if the file contains something looking like embedded scripts
1006          */
1007         function detectScript($file, $mime, $extension) {
1008                 global $wgAllowTitlesInSVG;
1009
1010                 #ugly hack: for text files, always look at the entire file.
1011                 #For binarie field, just check the first K.
1012
1013                 if (strpos($mime,'text/')===0) $chunk = file_get_contents( $file );
1014                 else {
1015                         $fp = fopen( $file, 'rb' );
1016                         $chunk = fread( $fp, 1024 );
1017                         fclose( $fp );
1018                 }
1019
1020                 $chunk= strtolower( $chunk );
1021
1022                 if (!$chunk) return false;
1023
1024                 #decode from UTF-16 if needed (could be used for obfuscation).
1025                 if (substr($chunk,0,2)=="\xfe\xff") $enc= "UTF-16BE";
1026                 elseif (substr($chunk,0,2)=="\xff\xfe") $enc= "UTF-16LE";
1027                 else $enc= NULL;
1028
1029                 if ($enc) $chunk= iconv($enc,"ASCII//IGNORE",$chunk);
1030
1031                 $chunk= trim($chunk);
1032
1033                 #FIXME: convert from UTF-16 if necessarry!
1034
1035                 wfDebug("SpecialUpload::detectScript: checking for embedded scripts and HTML stuff\n");
1036
1037                 #check for HTML doctype
1038                 if (eregi("<!DOCTYPE *X?HTML",$chunk)) return true;
1039
1040                 /**
1041                 * Internet Explorer for Windows performs some really stupid file type
1042                 * autodetection which can cause it to interpret valid image files as HTML
1043                 * and potentially execute JavaScript, creating a cross-site scripting
1044                 * attack vectors.
1045                 *
1046                 * Apple's Safari browser also performs some unsafe file type autodetection
1047                 * which can cause legitimate files to be interpreted as HTML if the
1048                 * web server is not correctly configured to send the right content-type
1049                 * (or if you're really uploading plain text and octet streams!)
1050                 *
1051                 * Returns true if IE is likely to mistake the given file for HTML.
1052                 * Also returns true if Safari would mistake the given file for HTML
1053                 * when served with a generic content-type.
1054                 */
1055
1056                 $tags = array(
1057                         '<body',
1058                         '<head',
1059                         '<html',   #also in safari
1060                         '<img',
1061                         '<pre',
1062                         '<script', #also in safari
1063                         '<table'
1064                         );
1065                 if( ! $wgAllowTitlesInSVG && $extension !== 'svg' && $mime !== 'image/svg' ) {
1066                         $tags[] = '<title';
1067                 }
1068
1069                 foreach( $tags as $tag ) {
1070                         if( false !== strpos( $chunk, $tag ) ) {
1071                                 return true;
1072                         }
1073                 }
1074
1075                 /*
1076                 * look for javascript
1077                 */
1078
1079                 #resolve entity-refs to look at attributes. may be harsh on big files... cache result?
1080                 $chunk = Sanitizer::decodeCharReferences( $chunk );
1081
1082                 #look for script-types
1083                 if (preg_match('!type\s*=\s*[\'"]?\s*(?:\w*/)?(?:ecma|java)!sim',$chunk)) return true;
1084
1085                 #look for html-style script-urls
1086                 if (preg_match('!(?:href|src|data)\s*=\s*[\'"]?\s*(?:ecma|java)script:!sim',$chunk)) return true;
1087
1088                 #look for css-style script-urls
1089                 if (preg_match('!url\s*\(\s*[\'"]?\s*(?:ecma|java)script:!sim',$chunk)) return true;
1090
1091                 wfDebug("SpecialUpload::detectScript: no scripts found\n");
1092                 return false;
1093         }
1094
1095         /**
1096          * Generic wrapper function for a virus scanner program.
1097          * This relies on the $wgAntivirus and $wgAntivirusSetup variables.
1098          * $wgAntivirusRequired may be used to deny upload if the scan fails.
1099          *
1100          * @param string $file Pathname to the temporary upload file
1101          * @return mixed false if not virus is found, NULL if the scan fails or is disabled,
1102          *         or a string containing feedback from the virus scanner if a virus was found.
1103          *         If textual feedback is missing but a virus was found, this function returns true.
1104          */
1105         function detectVirus($file) {
1106                 global $wgAntivirus, $wgAntivirusSetup, $wgAntivirusRequired, $wgOut;
1107
1108                 if ( !$wgAntivirus ) {
1109                         wfDebug( __METHOD__.": virus scanner disabled\n");
1110                         return NULL;
1111                 }
1112
1113                 if ( !$wgAntivirusSetup[$wgAntivirus] ) {
1114                         wfDebug( __METHOD__.": unknown virus scanner: $wgAntivirus\n" );
1115                         # @TODO: localise
1116                         $wgOut->addHTML( "<div class='error'>Bad configuration: unknown virus scanner: <i>$wgAntivirus</i></div>\n" );
1117                         return "unknown antivirus: $wgAntivirus";
1118                 }
1119
1120                 # look up scanner configuration
1121                 $command = $wgAntivirusSetup[$wgAntivirus]["command"];
1122                 $exitCodeMap = $wgAntivirusSetup[$wgAntivirus]["codemap"];
1123                 $msgPattern = isset( $wgAntivirusSetup[$wgAntivirus]["messagepattern"] ) ?
1124                         $wgAntivirusSetup[$wgAntivirus]["messagepattern"] : null;
1125
1126                 if ( strpos( $command,"%f" ) === false ) {
1127                         # simple pattern: append file to scan
1128                         $command .= " " . wfEscapeShellArg( $file );
1129                 } else {
1130                         # complex pattern: replace "%f" with file to scan
1131                         $command = str_replace( "%f", wfEscapeShellArg( $file ), $command );
1132                 }
1133
1134                 wfDebug( __METHOD__.": running virus scan: $command \n" );
1135
1136                 # execute virus scanner
1137                 $exitCode = false;
1138
1139                 #NOTE: there's a 50 line workaround to make stderr redirection work on windows, too.
1140                 #      that does not seem to be worth the pain.
1141                 #      Ask me (Duesentrieb) about it if it's ever needed.
1142                 $output = array();
1143                 if ( wfIsWindows() ) {
1144                         exec( "$command", $output, $exitCode );
1145                 } else {
1146                         exec( "$command 2>&1", $output, $exitCode );
1147                 }
1148
1149                 # map exit code to AV_xxx constants.
1150                 $mappedCode = $exitCode;
1151                 if ( $exitCodeMap ) {
1152                         if ( isset( $exitCodeMap[$exitCode] ) ) {
1153                                 $mappedCode = $exitCodeMap[$exitCode];
1154                         } elseif ( isset( $exitCodeMap["*"] ) ) {
1155                                 $mappedCode = $exitCodeMap["*"];
1156                         }
1157                 }
1158
1159                 if ( $mappedCode === AV_SCAN_FAILED ) {
1160                         # scan failed (code was mapped to false by $exitCodeMap)
1161                         wfDebug( __METHOD__.": failed to scan $file (code $exitCode).\n" );
1162
1163                         if ( $wgAntivirusRequired ) {
1164                                 return "scan failed (code $exitCode)";
1165                         } else {
1166                                 return NULL;
1167                         }
1168                 } else if ( $mappedCode === AV_SCAN_ABORTED ) {
1169                         # scan failed because filetype is unknown (probably imune)
1170                         wfDebug( __METHOD__.": unsupported file type $file (code $exitCode).\n" );
1171                         return NULL;
1172                 } else if ( $mappedCode === AV_NO_VIRUS ) {
1173                         # no virus found
1174                         wfDebug( __METHOD__.": file passed virus scan.\n" );
1175                         return false;
1176                 } else {
1177                         $output = join( "\n", $output );
1178                         $output = trim( $output );
1179
1180                         if ( !$output ) {
1181                                 $output = true; #if there's no output, return true
1182                         } elseif ( $msgPattern ) {
1183                                 $groups = array();
1184                                 if ( preg_match( $msgPattern, $output, $groups ) ) {
1185                                         if ( $groups[1] ) {
1186                                                 $output = $groups[1];
1187                                         }
1188                                 }
1189                         }
1190
1191                         wfDebug( __METHOD__.": FOUND VIRUS! scanner feedback: $output" );
1192                         return $output;
1193                 }
1194         }
1195
1196         /**
1197          * Check if the temporary file is MacBinary-encoded, as some uploads
1198          * from Internet Explorer on Mac OS Classic and Mac OS X will be.
1199          * If so, the data fork will be extracted to a second temporary file,
1200          * which will then be checked for validity and either kept or discarded.
1201          *
1202          * @access private
1203          */
1204         function checkMacBinary() {
1205                 $macbin = new MacBinary( $this->mTempPath );
1206                 if( $macbin->isValid() ) {
1207                         $dataFile = tempnam( wfTempDir(), "WikiMacBinary" );
1208                         $dataHandle = fopen( $dataFile, 'wb' );
1209
1210                         wfDebug( "SpecialUpload::checkMacBinary: Extracting MacBinary data fork to $dataFile\n" );
1211                         $macbin->extractData( $dataHandle );
1212
1213                         $this->mTempPath = $dataFile;
1214                         $this->mFileSize = $macbin->dataForkLength();
1215
1216                         // We'll have to manually remove the new file if it's not kept.
1217                         $this->mRemoveTempFile = true;
1218                 }
1219                 $macbin->close();
1220         }
1221
1222         /**
1223          * If we've modified the upload file we need to manually remove it
1224          * on exit to clean up.
1225          * @access private
1226          */
1227         function cleanupTempFile() {
1228                 if ( $this->mRemoveTempFile && file_exists( $this->mTempPath ) ) {
1229                         wfDebug( "SpecialUpload::cleanupTempFile: Removing temporary file {$this->mTempPath}\n" );
1230                         unlink( $this->mTempPath );
1231                 }
1232         }
1233
1234         /**
1235          * Check if there's an overwrite conflict and, if so, if restrictions
1236          * forbid this user from performing the upload.
1237          *
1238          * @return mixed true on success, WikiError on failure
1239          * @access private
1240          */
1241         function checkOverwrite( $name ) {
1242                 $img = wfFindFile( $name );
1243
1244                 $error = '';
1245                 if( $img ) {
1246                         global $wgUser, $wgOut;
1247                         if( $img->isLocal() ) {
1248                                 if( !self::userCanReUpload( $wgUser, $img->name ) ) {
1249                                         $error = 'fileexists-forbidden';
1250                                 }
1251                         } else {
1252                                 if( !$wgUser->isAllowed( 'reupload' ) ||
1253                                     !$wgUser->isAllowed( 'reupload-shared' ) ) {
1254                                         $error = "fileexists-shared-forbidden";
1255                                 }
1256                         }
1257                 }
1258
1259                 if( $error ) {
1260                         $errorText = wfMsg( $error, wfEscapeWikiText( $img->getName() ) );
1261                         return new WikiError( $wgOut->parse( $errorText ) );
1262                 }
1263
1264                 // Rockin', go ahead and upload
1265                 return true;
1266         }
1267
1268          /**
1269          * Check if a user is the last uploader
1270          *
1271          * @param User $user
1272          * @param string $img, image name
1273          * @return bool
1274          */
1275         public static function userCanReUpload( User $user, $img ) {
1276                 if( $user->isAllowed( 'reupload' ) )
1277                         return true; // non-conditional
1278                 if( !$user->isAllowed( 'reupload-own' ) )
1279                         return false;
1280
1281                 $dbr = wfGetDB( DB_SLAVE );
1282                 $row = $dbr->selectRow('image',
1283                 /* SELECT */ 'img_user',
1284                 /* WHERE */ array( 'img_name' => $img )
1285                 );
1286                 if ( !$row )
1287                         return false;
1288
1289                 return $user->getID() == $row->img_user;
1290         }
1291
1292         /**
1293          * Display an error from a wikitext-formatted WikiError object
1294          */
1295         function showError( WikiError $error ) {
1296                 global $wgOut;
1297                 $wgOut->setPageTitle( wfMsg( "internalerror" ) );
1298                 $wgOut->setRobotpolicy( "noindex,nofollow" );
1299                 $wgOut->setArticleRelated( false );
1300                 $wgOut->enableClientCache( false );
1301                 $wgOut->addWikiText( $error->getMessage() );
1302         }
1303
1304         /**
1305          * Get the initial image page text based on a comment and optional file status information
1306          */
1307         static function getInitialPageText( $comment, $license, $copyStatus, $source ) {
1308                 global $wgUseCopyrightUpload;
1309                 if ( $wgUseCopyrightUpload ) {
1310                         if ( $license != '' ) {
1311                                 $licensetxt = '== ' . wfMsgForContent( 'license' ) . " ==\n" . '{{' . $license . '}}' . "\n";
1312                         }
1313                         $pageText = '== ' . wfMsg ( 'filedesc' ) . " ==\n" . $comment . "\n" .
1314                           '== ' . wfMsgForContent ( 'filestatus' ) . " ==\n" . $copyStatus . "\n" .
1315                           "$licensetxt" .
1316                           '== ' . wfMsgForContent ( 'filesource' ) . " ==\n" . $source ;
1317                 } else {
1318                         if ( $license != '' ) {
1319                                 $filedesc = $comment == '' ? '' : '== ' . wfMsg ( 'filedesc' ) . " ==\n" . $comment . "\n";
1320                                  $pageText = $filedesc .
1321                                          '== ' . wfMsgForContent ( 'license' ) . " ==\n" . '{{' . $license . '}}' . "\n";
1322                         } else {
1323                                 $pageText = $comment;
1324                         }
1325                 }
1326                 return $pageText;
1327         }
1328 }
1329 ?>