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