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                                 $dlink2 = $sk->makeImageLinkObj( $nt, wfMsgExt( 'fileexists-thumb', 'parseinline', $dlink ), $nt->getText(), 'right', false, false, false, true );
 419
 420                                 # when $dlink2 begins with a normal href it is not a thumbnail -> do not show the link twice
 421                                 if ( substr( $dlink2, 0, 7) == '<a href' ) $dlink2 = '';
 422
 423                                 $warning .= '<li>' . wfMsgHtml( 'fileexists', $dlink ) . '</li>' . $dlink2;
 424                         } else {
 425                                 # If the file existed before and was deleted, warn the user of this
 426                                 # Don't bother doing so if the image exists now, however
 427                                 if( $image->wasDeleted() ) {
 428                                         $skin = $wgUser->getSkin();
 429                                         $ltitle = SpecialPage::getTitleFor( 'Log' );
 430                                         $llink = $skin->makeKnownLinkObj( $ltitle, wfMsgHtml( 'deletionlog' ), 'type=delete&page=' . $nt->getPrefixedUrl() );
 431                                         $warning .= wfOpenElement( 'li' ) . wfMsgWikiHtml( 'filewasdeleted', $llink ) . wfCloseElement( 'li' );
 432                                 }
 433                         }
 434
 435                         if( $warning != '' ) {
 436                                 /**
 437                                  * Stash the file in a temporary location; the user can choose
 438                                  * to let it through and we'll complete the upload then.
 439                                  */
 440                                 return $this->uploadWarning( $warning );
 441                         }
 442                 }
 443
 444                 /**
 445                  * Try actually saving the thing...
 446                  * It will show an error form on failure.
 447                  */
 448                 $hasBeenMunged = !empty( $this->mSessionKey ) || $this->mRemoveTempFile;
 449                 if( $this->saveUploadedFile( $this->mUploadSaveName,
 450                                              $this->mUploadTempName,
 451                                              $hasBeenMunged ) ) {
 452                         /**
 453                          * Update the upload log and create the description page
 454                          * if it's a new file.
 455                          */
 456                         $img = Image::newFromName( $this->mUploadSaveName );
 457                         $success = $img->recordUpload( $this->mUploadOldVersion,
 458                                                         $this->mUploadDescription,
 459                                                         $this->mLicense,
 460                                                         $this->mUploadCopyStatus,
 461                                                         $this->mUploadSource,
 462                                                         $this->mWatchthis );
 463
 464                         if ( $success ) {
 465                                 $this->showSuccess();
 466                                 wfRunHooks( 'UploadComplete', array( &$img ) );
 467                         } else {
 468                                 // Image::recordUpload() fails if the image went missing, which is
 469                                 // unlikely, hence the lack of a specialised message
 470                                 $wgOut->showFileNotFoundError( $this->mUploadSaveName );
 471                         }
 472                 }
 473         }
 474
 475         /**
 476          * Move the uploaded file from its temporary location to the final
 477          * destination. If a previous version of the file exists, move
 478          * it into the archive subdirectory.
 479          *
 480          * @todo If the later save fails, we may have disappeared the original file.
 481          *
 482          * @param string $saveName
 483          * @param string $tempName full path to the temporary file
 484          * @param bool $useRename if true, doesn't check that the source file
 485          *                        is a PHP-managed upload temporary
 486          */
 487         function saveUploadedFile( $saveName, $tempName, $useRename = false ) {
 488                 global $wgOut, $wgAllowCopyUploads;
 489
 490                 if ( !$useRename AND $wgAllowCopyUploads AND $this->mSourceType == 'web' ) $useRename = true;
 491
 492                 $fname= "SpecialUpload::saveUploadedFile";
 493
 494                 $dest = wfImageDir( $saveName );
 495                 $archive = wfImageArchiveDir( $saveName );
 496                 if ( !is_dir( $dest ) ) wfMkdirParents( $dest );
 497                 if ( !is_dir( $archive ) ) wfMkdirParents( $archive );
 498
 499                 $this->mSavedFile = "{$dest}/{$saveName}";
 500
 501                 if( is_file( $this->mSavedFile ) ) {
 502                         $this->mUploadOldVersion = gmdate( 'YmdHis' ) . "!{$saveName}";
 503                         wfSuppressWarnings();
 504                         $success = rename( $this->mSavedFile, "${archive}/{$this->mUploadOldVersion}" );
 505                         wfRestoreWarnings();
 506
 507                         if( ! $success ) {
 508                                 $wgOut->showFileRenameError( $this->mSavedFile,
 509                                   "${archive}/{$this->mUploadOldVersion}" );
 510                                 return false;
 511                         }
 512                         else wfDebug("$fname: moved file ".$this->mSavedFile." to ${archive}/{$this->mUploadOldVersion}\n");
 513                 }
 514                 else {
 515                         $this->mUploadOldVersion = '';
 516                 }
 517
 518                 wfSuppressWarnings();
 519                 $success = $useRename
 520                         ? rename( $tempName, $this->mSavedFile )
 521                         : move_uploaded_file( $tempName, $this->mSavedFile );
 522                 wfRestoreWarnings();
 523
 524                 if( ! $success ) {
 525                         $wgOut->showFileCopyError( $tempName, $this->mSavedFile );
 526                         return false;
 527                 } else {
 528                         wfDebug("$fname: wrote tempfile $tempName to ".$this->mSavedFile."\n");
 529                 }
 530
 531                 chmod( $this->mSavedFile, 0644 );
 532                 return true;
 533         }
 534
 535         /**
 536          * Stash a file in a temporary directory for later processing
 537          * after the user has confirmed it.
 538          *
 539          * If the user doesn't explicitly cancel or accept, these files
 540          * can accumulate in the temp directory.
 541          *
 542          * @param string $saveName - the destination filename
 543          * @param string $tempName - the source temporary file to save
 544          * @return string - full path the stashed file, or false on failure
 545          * @access private
 546          */
 547         function saveTempUploadedFile( $saveName, $tempName ) {
 548                 global $wgOut;
 549                 $archive = wfImageArchiveDir( $saveName, 'temp' );
 550                 if ( !is_dir ( $archive ) ) wfMkdirParents( $archive );
 551                 $stash = $archive . '/' . gmdate( "YmdHis" ) . '!' . $saveName;
 552
 553                 $success = $this->mRemoveTempFile
 554                         ? rename( $tempName, $stash )
 555                         : move_uploaded_file( $tempName, $stash );
 556                 if ( !$success ) {
 557                         $wgOut->showFileCopyError( $tempName, $stash );
 558                         return false;
 559                 }
 560
 561                 return $stash;
 562         }
 563
 564         /**
 565          * Stash a file in a temporary directory for later processing,
 566          * and save the necessary descriptive info into the session.
 567          * Returns a key value which will be passed through a form
 568          * to pick up the path info on a later invocation.
 569          *
 570          * @return int
 571          * @access private
 572          */
 573         function stashSession() {
 574                 $stash = $this->saveTempUploadedFile(
 575                         $this->mUploadSaveName, $this->mUploadTempName );
 576
 577                 if( !$stash ) {
 578                         # Couldn't save the file.
 579                         return false;
 580                 }
 581
 582                 $key = mt_rand( 0, 0x7fffffff );
 583                 $_SESSION['wsUploadData'][$key] = array(
 584                         'mUploadTempName' => $stash,
 585                         'mUploadSize'     => $this->mUploadSize,
 586                         'mOname'          => $this->mOname );
 587                 return $key;
 588         }
 589
 590         /**
 591          * Remove a temporarily kept file stashed by saveTempUploadedFile().
 592          * @access private
 593          * @return success
 594          */
 595         function unsaveUploadedFile() {
 596                 global $wgOut;
 597                 wfSuppressWarnings();
 598                 $success = unlink( $this->mUploadTempName );
 599                 wfRestoreWarnings();
 600                 if ( ! $success ) {
 601                         $wgOut->showFileDeleteError( $this->mUploadTempName );
 602                         return false;
 603                 } else {
 604                         return true;
 605                 }
 606         }
 607
 608         /* -------------------------------------------------------------- */
 609
 610         /**
 611          * Show some text and linkage on successful upload.
 612          * @access private
 613          */
 614         function showSuccess() {
 615                 global $wgUser, $wgOut, $wgContLang;
 616
 617                 $sk = $wgUser->getSkin();
 618                 $ilink = $sk->makeMediaLink( $this->mUploadSaveName, Image::imageUrl( $this->mUploadSaveName ) );
 619                 $dname = $wgContLang->getNsText( NS_IMAGE ) . ':'.$this->mUploadSaveName;
 620                 $dlink = $sk->makeKnownLink( $dname, $dname );
 621
 622                 $wgOut->addHTML( '<h2>' . wfMsgHtml( 'successfulupload' ) . "</h2>\n" );
 623                 $text = wfMsgWikiHtml( 'fileuploaded', $ilink, $dlink );
 624                 $wgOut->addHTML( $text );
 625                 $wgOut->returnToMain( false );
 626         }
 627
 628         /**
 629          * @param string $error as HTML
 630          * @access private
 631          */
 632         function uploadError( $error ) {
 633                 global $wgOut;
 634                 $wgOut->addHTML( "<h2>" . wfMsgHtml( 'uploadwarning' ) . "</h2>\n" );
 635                 $wgOut->addHTML( "<span class='error'>{$error}</span>\n" );
 636         }
 637
 638         /**
 639          * There's something wrong with this file, not enough to reject it
 640          * totally but we require manual intervention to save it for real.
 641          * Stash it away, then present a form asking to confirm or cancel.
 642          *
 643          * @param string $warning as HTML
 644          * @access private
 645          */
 646         function uploadWarning( $warning ) {
 647                 global $wgOut;
 648                 global $wgUseCopyrightUpload;
 649
 650                 $this->mSessionKey = $this->stashSession();
 651                 if( !$this->mSessionKey ) {
 652                         # Couldn't save file; an error has been displayed so let's go.
 653                         return;
 654                 }
 655
 656                 $wgOut->addHTML( "<h2>" . wfMsgHtml( 'uploadwarning' ) . "</h2>\n" );
 657                 $wgOut->addHTML( "<ul class='warning'>{$warning}</ul><br />\n" );
 658
 659                 $save = wfMsgHtml( 'savefile' );
 660                 $reupload = wfMsgHtml( 'reupload' );
 661                 $iw = wfMsgWikiHtml( 'ignorewarning' );
 662                 $reup = wfMsgWikiHtml( 'reuploaddesc' );
 663                 $titleObj = SpecialPage::getTitleFor( 'Upload' );
 664                 $action = $titleObj->escapeLocalURL( 'action=submit' );
 665
 666                 if ( $wgUseCopyrightUpload )
 667                 {
 668                         $copyright =  "
 669         <input type='hidden' name='wpUploadCopyStatus' value=\"" . htmlspecialchars( $this->mUploadCopyStatus ) . "\" />
 670         <input type='hidden' name='wpUploadSource' value=\"" . htmlspecialchars( $this->mUploadSource ) . "\" />
 671         ";
 672                 } else {
 673                         $copyright = "";
 674                 }
 675
 676                 $wgOut->addHTML( "
 677         <form id='uploadwarning' method='post' enctype='multipart/form-data' action='$action'>
 678                 <input type='hidden' name='wpIgnoreWarning' value='1' />
 679                 <input type='hidden' name='wpSessionKey' value=\"" . htmlspecialchars( $this->mSessionKey ) . "\" />
 680                 <input type='hidden' name='wpUploadDescription' value=\"" . htmlspecialchars( $this->mUploadDescription ) . "\" />
 681                 <input type='hidden' name='wpLicense' value=\"" . htmlspecialchars( $this->mLicense ) . "\" />
 682                 <input type='hidden' name='wpDestFile' value=\"" . htmlspecialchars( $this->mDestFile ) . "\" />
 683                 <input type='hidden' name='wpWatchthis' value=\"" . htmlspecialchars( intval( $this->mWatchthis ) ) . "\" />
 684         {$copyright}
 685         <table border='0'>
 686                 <tr>
 687                         <tr>
 688                                 <td align='right'>
 689                                         <input tabindex='2' type='submit' name='wpUpload' value=\"$save\" />
 690                                 </td>
 691                                 <td align='left'>$iw</td>
 692                         </tr>
 693                         <tr>
 694                                 <td align='right'>
 695                                         <input tabindex='2' type='submit' name='wpReUpload' value=\"{$reupload}\" />
 696                                 </td>
 697                                 <td align='left'>$reup</td>
 698                         </tr>
 699                 </tr>
 700         </table></form>\n" );
 701         }
 702
 703         /**
 704          * Displays the main upload form, optionally with a highlighted
 705          * error message up at the top.
 706          *
 707          * @param string $msg as HTML
 708          * @access private
 709          */
 710         function mainUploadForm( $msg='' ) {
 711                 global $wgOut, $wgUser;
 712                 global $wgUseCopyrightUpload;
 713                 global $wgRequest, $wgAllowCopyUploads;
 714
 715                 if( !wfRunHooks( 'UploadForm:initial', array( &$this ) ) )
 716                 {
 717                         wfDebug( "Hook 'UploadForm:initial' broke output of the upload form" );
 718                         return false;
 719                 }
 720
 721                 $cols = intval($wgUser->getOption( 'cols' ));
 722                 $ew = $wgUser->getOption( 'editwidth' );
 723                 if ( $ew ) $ew = " style=\"width:100%\"";
 724                 else $ew = '';
 725
 726                 if ( '' != $msg ) {
 727                         $sub = wfMsgHtml( 'uploaderror' );
 728                         $wgOut->addHTML( "<h2>{$sub}</h2>\n" .
 729                           "<span class='error'>{$msg}</span>\n" );
 730                 }
 731                 $wgOut->addHTML( '<div id="uploadtext">' );
 732                 $wgOut->addWikiText( wfMsgNoTrans( 'uploadtext', $this->mDestFile ) );
 733                 $wgOut->addHTML( '</div>' );
 734
 735                 $sourcefilename = wfMsgHtml( 'sourcefilename' );
 736                 $destfilename = wfMsgHtml( 'destfilename' );
 737                 $summary = wfMsgWikiHtml( 'fileuploadsummary' );
 738
 739                 $licenses = new Licenses();
 740                 $license = wfMsgHtml( 'license' );
 741                 $nolicense = wfMsgHtml( 'nolicense' );
 742                 $licenseshtml = $licenses->getHtml();
 743
 744                 $ulb = wfMsgHtml( 'uploadbtn' );
 745
 746
 747                 $titleObj = SpecialPage::getTitleFor( 'Upload' );
 748                 $action = $titleObj->escapeLocalURL();
 749
 750                 $encDestFile = htmlspecialchars( $this->mDestFile );
 751
 752                 $watchChecked =
 753                         ( $wgUser->getOption( 'watchdefault' ) ||
 754                                 ( $wgUser->getOption( 'watchcreations' ) && $this->mDestFile == '' ) )
 755                         ? 'checked="checked"'
 756                         : '';
 757
 758                 // Prepare form for upload or upload/copy
 759                 if( $wgAllowCopyUploads && $wgUser->isAllowed( 'upload_by_url' ) ) {
 760                         $filename_form =
 761                                 "<input type='radio' id='wpSourceTypeFile' name='wpSourceType' value='file' onchange='toggle_element_activation(\"wpUploadFileURL\",\"wpUploadFile\")' checked />" .
 762                                 "<input tabindex='1' type='file' name='wpUploadFile' id='wpUploadFile' onfocus='toggle_element_activation(\"wpUploadFileURL\",\"wpUploadFile\");toggle_element_check(\"wpSourceTypeFile\",\"wpSourceTypeURL\")'" .
 763                                 ($this->mDestFile?"":"onchange='fillDestFilename(\"wpUploadFile\")' ") . "size='40' />" .
 764                                 wfMsgHTML( 'upload_source_file' ) . "<br/>" .
 765                                 "<input type='radio' id='wpSourceTypeURL' name='wpSourceType' value='web' onchange='toggle_element_activation(\"wpUploadFile\",\"wpUploadFileURL\")' />" .
 766                                 "<input tabindex='1' type='text' name='wpUploadFileURL' id='wpUploadFileURL' onfocus='toggle_element_activation(\"wpUploadFile\",\"wpUploadFileURL\");toggle_element_check(\"wpSourceTypeURL\",\"wpSourceTypeFile\")'" .
 767                                 ($this->mDestFile?"":"onchange='fillDestFilename(\"wpUploadFileURL\")' ") . "size='40' DISABLED />" .
 768                                 wfMsgHtml( 'upload_source_url' ) ;
 769                 } else {
 770                         $filename_form =
 771                                 "<input tabindex='1' type='file' name='wpUploadFile' id='wpUploadFile' " .
 772                                 ($this->mDestFile?"":"onchange='fillDestFilename(\"wpUploadFile\")' ") .
 773                                 "size='40' />" .
 774                                 "<input type='hidden' name='wpSourceType' value='file' />" ;
 775                 }
 776
 777                 $wgOut->addHTML( "
 778         <form id='upload' method='post' enctype='multipart/form-data' action=\"$action\">
 779                 <table border='0'>
 780                 <tr>
 781           {$this->uploadFormTextTop}
 782                         <td align='right' valign='top'><label for='wpUploadFile'>{$sourcefilename}:</label></td>
 783                         <td align='left'>
 784                                 {$filename_form}
 785                         </td>
 786                 </tr>
 787                 <tr>
 788                         <td align='right'><label for='wpDestFile'>{$destfilename}:</label></td>
 789                         <td align='left'>
 790                                 <input tabindex='2' type='text' name='wpDestFile' id='wpDestFile' size='40' value=\"$encDestFile\" />
 791                         </td>
 792                 </tr>
 793                 <tr>
 794                         <td align='right'><label for='wpUploadDescription'>{$summary}</label></td>
 795                         <td align='left'>
 796                                 <textarea tabindex='3' name='wpUploadDescription' id='wpUploadDescription' rows='6' cols='{$cols}'{$ew}>" . htmlspecialchars( $this->mUploadDescription ) . "</textarea>
 797            {$this->uploadFormTextAfterSummary}
 798                         </td>
 799                 </tr>
 800                 <tr>" );
 801
 802                 if ( $licenseshtml != '' ) {
 803                         global $wgStylePath;
 804                         $wgOut->addHTML( "
 805                         <td align='right'><label for='wpLicense'>$license:</label></td>
 806                         <td align='left'>
 807                                 <script type='text/javascript' src=\"$wgStylePath/common/upload.js\"></script>
 808                                 <select name='wpLicense' id='wpLicense' tabindex='4'
 809                                         onchange='licenseSelectorCheck()'>
 810                                         <option value=''>$nolicense</option>
 811                                         $licenseshtml
 812                                 </select>
 813                         </td>
 814                         </tr>
 815                         <tr>
 816                 ");
 817                 }
 818
 819                 if ( $wgUseCopyrightUpload ) {
 820                         $filestatus = wfMsgHtml ( 'filestatus' );
 821                         $copystatus =  htmlspecialchars( $this->mUploadCopyStatus );
 822                         $filesource = wfMsgHtml ( 'filesource' );
 823                         $uploadsource = htmlspecialchars( $this->mUploadSource );
 824
 825                         $wgOut->addHTML( "
 826                                 <td align='right' nowrap='nowrap'><label for='wpUploadCopyStatus'>$filestatus:</label></td>
 827                                 <td><input tabindex='5' type='text' name='wpUploadCopyStatus' id='wpUploadCopyStatus' value=\"$copystatus\" size='40' /></td>
 828                         </tr>
 829                         <tr>
 830                                 <td align='right'><label for='wpUploadCopyStatus'>$filesource:</label></td>
 831                                 <td><input tabindex='6' type='text' name='wpUploadSource' id='wpUploadCopyStatus' value=\"$uploadsource\" size='40' /></td>
 832                         </tr>
 833                         <tr>
 834                 ");
 835                 }
 836
 837
 838                 $wgOut->addHtml( "
 839                 <td></td>
 840                 <td>
 841                         <input tabindex='7' type='checkbox' name='wpWatchthis' id='wpWatchthis' $watchChecked value='true' />
 842                         <label for='wpWatchthis'>" . wfMsgHtml( 'watchthisupload' ) . "</label>
 843                         <input tabindex='8' type='checkbox' name='wpIgnoreWarning' id='wpIgnoreWarning' value='true' />
 844                         <label for='wpIgnoreWarning'>" . wfMsgHtml( 'ignorewarnings' ) . "</label>
 845                 </td>
 846         </tr>
 847         <tr>
 848                 <td></td>
 849                 <td align='left'><input tabindex='9' type='submit' name='wpUpload' value=\"{$ulb}\" /></td>
 850         </tr>
 851
 852         <tr>
 853                 <td></td>
 854                 <td align='left'>
 855                 " );
 856                 $wgOut->addWikiText( wfMsgForContent( 'edittools' ) );
 857                 $wgOut->addHTML( "
 858                 </td>
 859         </tr>
 860
 861         </table>
 862         </form>" );
 863         }
 864
 865         /* -------------------------------------------------------------- */
 866
 867         /**
 868          * Split a file into a base name and all dot-delimited 'extensions'
 869          * on the end. Some web server configurations will fall back to
 870          * earlier pseudo-'extensions' to determine type and execute
 871          * scripts, so the blacklist needs to check them all.
 872          *
 873          * @return array
 874          */
 875         function splitExtensions( $filename ) {
 876                 $bits = explode( '.', $filename );
 877                 $basename = array_shift( $bits );
 878                 return array( $basename, $bits );
 879         }
 880
 881         /**
 882          * Perform case-insensitive match against a list of file extensions.
 883          * Returns true if the extension is in the list.
 884          *
 885          * @param string $ext
 886          * @param array $list
 887          * @return bool
 888          */
 889         function checkFileExtension( $ext, $list ) {
 890                 return in_array( strtolower( $ext ), $list );
 891         }
 892
 893         /**
 894          * Perform case-insensitive match against a list of file extensions.
 895          * Returns true if any of the extensions are in the list.
 896          *
 897          * @param array $ext
 898          * @param array $list
 899          * @return bool
 900          */
 901         function checkFileExtensionList( $ext, $list ) {
 902                 foreach( $ext as $e ) {
 903                         if( in_array( strtolower( $e ), $list ) ) {
 904                                 return true;
 905                         }
 906                 }
 907                 return false;
 908         }
 909
 910         /**
 911          * Verifies that it's ok to include the uploaded file
 912          *
 913          * @param string $tmpfile the full path of the temporary file to verify
 914          * @param string $extension The filename extension that the file is to be served with
 915          * @return mixed true of the file is verified, a WikiError object otherwise.
 916          */
 917         function verify( $tmpfile, $extension ) {
 918                 #magically determine mime type
 919                 $magic=& MimeMagic::singleton();
 920                 $mime= $magic->guessMimeType($tmpfile,false);
 921
 922                 $fname= "SpecialUpload::verify";
 923
 924                 #check mime type, if desired
 925                 global $wgVerifyMimeType;
 926                 if ($wgVerifyMimeType) {
 927
 928                         #check mime type against file extension
 929                         if( !$this->verifyExtension( $mime, $extension ) ) {
 930                                 return new WikiErrorMsg( 'uploadcorrupt' );
 931                         }
 932
 933                         #check mime type blacklist
 934                         global $wgMimeTypeBlacklist;
 935                         if( isset($wgMimeTypeBlacklist) && !is_null($wgMimeTypeBlacklist)
 936                                 && $this->checkFileExtension( $mime, $wgMimeTypeBlacklist ) ) {
 937                                 return new WikiErrorMsg( 'filetype-badmime', htmlspecialchars( $mime ) );
 938                         }
 939                 }
 940
 941                 #check for htmlish code and javascript
 942                 if( $this->detectScript ( $tmpfile, $mime, $extension ) ) {
 943                         return new WikiErrorMsg( 'uploadscripted' );
 944                 }
 945
 946                 /**
 947                 * Scan the uploaded file for viruses
 948                 */
 949                 $virus= $this->detectVirus($tmpfile);
 950                 if ( $virus ) {
 951                         return new WikiErrorMsg( 'uploadvirus', htmlspecialchars($virus) );
 952                 }
 953
 954                 wfDebug( "$fname: all clear; passing.\n" );
 955                 return true;
 956         }
 957
 958         /**
 959          * Checks if the mime type of the uploaded file matches the file extension.
 960          *
 961          * @param string $mime the mime type of the uploaded file
 962          * @param string $extension The filename extension that the file is to be served with
 963          * @return bool
 964          */
 965         function verifyExtension( $mime, $extension ) {
 966                 $fname = 'SpecialUpload::verifyExtension';
 967
 968                 $magic =& MimeMagic::singleton();
 969
 970                 if ( ! $mime || $mime == 'unknown' || $mime == 'unknown/unknown' )
 971                         if ( ! $magic->isRecognizableExtension( $extension ) ) {
 972                                 wfDebug( "$fname: passing file with unknown detected mime type; unrecognized extension '$extension', can't verify\n" );
 973                                 return true;
 974                         } else {
 975                                 wfDebug( "$fname: rejecting file with unknown detected mime type; recognized extension '$extension', so probably invalid file\n" );
 976                                 return false;
 977                         }
 978
 979                 $match= $magic->isMatchingExtension($extension,$mime);
 980
 981                 if ($match===NULL) {
 982                         wfDebug( "$fname: no file extension known for mime type $mime, passing file\n" );
 983                         return true;
 984                 } elseif ($match===true) {
 985                         wfDebug( "$fname: mime type $mime matches extension $extension, passing file\n" );
 986
 987                         #TODO: if it's a bitmap, make sure PHP or ImageMagic resp. can handle it!
 988                         return true;
 989
 990                 } else {
 991                         wfDebug( "$fname: mime type $mime mismatches file extension $extension, rejecting file\n" );
 992                         return false;
 993                 }
 994         }
 995
 996         /** Heuristig for detecting files that *could* contain JavaScript instructions or
 997         * things that may look like HTML to a browser and are thus
 998         * potentially harmful. The present implementation will produce false positives in some situations.
 999         *
1000         * @param string $file Pathname to the temporary upload file
1001         * @param string $mime The mime type of the file
1002         * @param string $extension The extension of the file
1003         * @return bool true if the file contains something looking like embedded scripts
1004         */
1005         function detectScript($file, $mime, $extension) {
1006                 global $wgAllowTitlesInSVG;
1007
1008                 #ugly hack: for text files, always look at the entire file.
1009                 #For binarie field, just check the first K.
1010
1011                 if (strpos($mime,'text/')===0) $chunk = file_get_contents( $file );
1012                 else {
1013                         $fp = fopen( $file, 'rb' );
1014                         $chunk = fread( $fp, 1024 );
1015                         fclose( $fp );
1016                 }
1017
1018                 $chunk= strtolower( $chunk );
1019
1020                 if (!$chunk) return false;
1021
1022                 #decode from UTF-16 if needed (could be used for obfuscation).
1023                 if (substr($chunk,0,2)=="\xfe\xff") $enc= "UTF-16BE";
1024                 elseif (substr($chunk,0,2)=="\xff\xfe") $enc= "UTF-16LE";
1025                 else $enc= NULL;
1026
1027                 if ($enc) $chunk= iconv($enc,"ASCII//IGNORE",$chunk);
1028
1029                 $chunk= trim($chunk);
1030
1031                 #FIXME: convert from UTF-16 if necessarry!
1032
1033                 wfDebug("SpecialUpload::detectScript: checking for embedded scripts and HTML stuff\n");
1034
1035                 #check for HTML doctype
1036                 if (eregi("<!DOCTYPE *X?HTML",$chunk)) return true;
1037
1038                 /**
1039                 * Internet Explorer for Windows performs some really stupid file type
1040                 * autodetection which can cause it to interpret valid image files as HTML
1041                 * and potentially execute JavaScript, creating a cross-site scripting
1042                 * attack vectors.
1043                 *
1044                 * Apple's Safari browser also performs some unsafe file type autodetection
1045                 * which can cause legitimate files to be interpreted as HTML if the
1046                 * web server is not correctly configured to send the right content-type
1047                 * (or if you're really uploading plain text and octet streams!)
1048                 *
1049                 * Returns true if IE is likely to mistake the given file for HTML.
1050                 * Also returns true if Safari would mistake the given file for HTML
1051                 * when served with a generic content-type.
1052                 */
1053
1054                 $tags = array(
1055                         '<body',
1056                         '<head',
1057                         '<html',   #also in safari
1058                         '<img',
1059                         '<pre',
1060                         '<script', #also in safari
1061                         '<table'
1062                         );
1063                 if( ! $wgAllowTitlesInSVG && $extension !== 'svg' && $mime !== 'image/svg' ) {
1064                         $tags[] = '<title';
1065                 }
1066
1067                 foreach( $tags as $tag ) {
1068                         if( false !== strpos( $chunk, $tag ) ) {
1069                                 return true;
1070                         }
1071                 }
1072
1073                 /*
1074                 * look for javascript
1075                 */
1076
1077                 #resolve entity-refs to look at attributes. may be harsh on big files... cache result?
1078                 $chunk = Sanitizer::decodeCharReferences( $chunk );
1079
1080                 #look for script-types
1081                 if (preg_match('!type\s*=\s*[\'"]?\s*(\w*/)?(ecma|java)!sim',$chunk)) return true;
1082
1083                 #look for html-style script-urls
1084                 if (preg_match('!(href|src|data)\s*=\s*[\'"]?\s*(ecma|java)script:!sim',$chunk)) return true;
1085
1086                 #look for css-style script-urls
1087                 if (preg_match('!url\s*\(\s*[\'"]?\s*(ecma|java)script:!sim',$chunk)) return true;
1088
1089                 wfDebug("SpecialUpload::detectScript: no scripts found\n");
1090                 return false;
1091         }
1092
1093         /** Generic wrapper function for a virus scanner program.
1094         * This relies on the $wgAntivirus and $wgAntivirusSetup variables.
1095         * $wgAntivirusRequired may be used to deny upload if the scan fails.
1096         *
1097         * @param string $file Pathname to the temporary upload file
1098         * @return mixed false if not virus is found, NULL if the scan fails or is disabled,
1099         *         or a string containing feedback from the virus scanner if a virus was found.
1100         *         If textual feedback is missing but a virus was found, this function returns true.
1101         */
1102         function detectVirus($file) {
1103                 global $wgAntivirus, $wgAntivirusSetup, $wgAntivirusRequired, $wgOut;
1104
1105                 $fname= "SpecialUpload::detectVirus";
1106
1107                 if (!$wgAntivirus) { #disabled?
1108                         wfDebug("$fname: virus scanner disabled\n");
1109
1110                         return NULL;
1111                 }
1112
1113                 if (!$wgAntivirusSetup[$wgAntivirus]) {
1114                         wfDebug("$fname: unknown virus scanner: $wgAntivirus\n");
1115
1116                         $wgOut->addHTML( "<div class='error'>Bad configuration: unknown virus scanner: <i>$wgAntivirus</i></div>\n" ); #LOCALIZE
1117
1118                         return "unknown antivirus: $wgAntivirus";
1119                 }
1120
1121                 #look up scanner configuration
1122                 $virus_scanner= $wgAntivirusSetup[$wgAntivirus]["command"]; #command pattern
1123                 $virus_scanner_codes= $wgAntivirusSetup[$wgAntivirus]["codemap"]; #exit-code map
1124                 $msg_pattern= $wgAntivirusSetup[$wgAntivirus]["messagepattern"]; #message pattern
1125
1126                 $scanner= $virus_scanner; #copy, so we can resolve the pattern
1127
1128                 if (strpos($scanner,"%f")===false) $scanner.= " ".wfEscapeShellArg($file); #simple pattern: append file to scan
1129                 else $scanner= str_replace("%f",wfEscapeShellArg($file),$scanner); #complex pattern: replace "%f" with file to scan
1130
1131                 wfDebug("$fname: running virus scan: $scanner \n");
1132
1133                 #execute virus scanner
1134                 $code= false;
1135
1136                 #NOTE: there's a 50 line workaround to make stderr redirection work on windows, too.
1137                 #      that does not seem to be worth the pain.
1138                 #      Ask me (Duesentrieb) about it if it's ever needed.
1139                 $output = array();
1140                 if (wfIsWindows()) exec("$scanner",$output,$code);
1141                 else exec("$scanner 2>&1",$output,$code);
1142
1143                 $exit_code= $code; #remember for user feedback
1144
1145                 if ($virus_scanner_codes) { #map exit code to AV_xxx constants.
1146                         if (isset($virus_scanner_codes[$code])) {
1147                                 $code= $virus_scanner_codes[$code]; # explicit mapping
1148                         } else if (isset($virus_scanner_codes["*"])) {
1149                                 $code= $virus_scanner_codes["*"];   # fallback mapping
1150                         }
1151                 }
1152
1153                 if ($code===AV_SCAN_FAILED) { #scan failed (code was mapped to false by $virus_scanner_codes)
1154                         wfDebug("$fname: failed to scan $file (code $exit_code).\n");
1155
1156                         if ($wgAntivirusRequired) { return "scan failed (code $exit_code)"; }
1157                         else { return NULL; }
1158                 }
1159                 else if ($code===AV_SCAN_ABORTED) { #scan failed because filetype is unknown (probably imune)
1160                         wfDebug("$fname: unsupported file type $file (code $exit_code).\n");
1161                         return NULL;
1162                 }
1163                 else if ($code===AV_NO_VIRUS) {
1164                         wfDebug("$fname: file passed virus scan.\n");
1165                         return false; #no virus found
1166                 }
1167                 else {
1168                         $output= join("\n",$output);
1169                         $output= trim($output);
1170
1171                         if (!$output) $output= true; #if there's no output, return true
1172                         else if ($msg_pattern) {
1173                                 $groups= array();
1174                                 if (preg_match($msg_pattern,$output,$groups)) {
1175                                         if ($groups[1]) $output= $groups[1];
1176                                 }
1177                         }
1178
1179                         wfDebug("$fname: FOUND VIRUS! scanner feedback: $output");
1180                         return $output;
1181                 }
1182         }
1183
1184         /**
1185          * Check if the temporary file is MacBinary-encoded, as some uploads
1186          * from Internet Explorer on Mac OS Classic and Mac OS X will be.
1187          * If so, the data fork will be extracted to a second temporary file,
1188          * which will then be checked for validity and either kept or discarded.
1189          *
1190          * @access private
1191          */
1192         function checkMacBinary() {
1193                 $macbin = new MacBinary( $this->mUploadTempName );
1194                 if( $macbin->isValid() ) {
1195                         $dataFile = tempnam( wfTempDir(), "WikiMacBinary" );
1196                         $dataHandle = fopen( $dataFile, 'wb' );
1197
1198                         wfDebug( "SpecialUpload::checkMacBinary: Extracting MacBinary data fork to $dataFile\n" );
1199                         $macbin->extractData( $dataHandle );
1200
1201                         $this->mUploadTempName = $dataFile;
1202                         $this->mUploadSize = $macbin->dataForkLength();
1203
1204                         // We'll have to manually remove the new file if it's not kept.
1205                         $this->mRemoveTempFile = true;
1206                 }
1207                 $macbin->close();
1208         }
1209
1210         /**
1211          * If we've modified the upload file we need to manually remove it
1212          * on exit to clean up.
1213          * @access private
1214          */
1215         function cleanupTempFile() {
1216                 if( $this->mRemoveTempFile && file_exists( $this->mUploadTempName ) ) {
1217                         wfDebug( "SpecialUpload::cleanupTempFile: Removing temporary file $this->mUploadTempName\n" );
1218                         unlink( $this->mUploadTempName );
1219                 }
1220         }
1221
1222         /**
1223          * Check if there's an overwrite conflict and, if so, if restrictions
1224          * forbid this user from performing the upload.
1225          *
1226          * @return mixed true on success, WikiError on failure
1227          * @access private
1228          */
1229         function checkOverwrite( $name ) {
1230                 $img = Image::newFromName( $name );
1231                 if( is_null( $img ) ) {
1232                         // Uh... this shouldn't happen ;)
1233                         // But if it does, fall through to previous behavior
1234                         return false;
1235                 }
1236
1237                 $error = '';
1238                 if( $img->exists() ) {
1239                         global $wgUser, $wgOut;
1240                         if( $img->isLocal() ) {
1241                                 if( !$wgUser->isAllowed( 'reupload' ) ) {
1242                                         $error = 'fileexists-forbidden';
1243                                 }
1244                         } else {
1245                                 if( !$wgUser->isAllowed( 'reupload' ) ||
1246                                     !$wgUser->isAllowed( 'reupload-shared' ) ) {
1247                                         $error = "fileexists-shared-forbidden";
1248                                 }
1249                         }
1250                 }
1251
1252                 if( $error ) {
1253                         $errorText = wfMsg( $error, wfEscapeWikiText( $img->getName() ) );
1254                         return new WikiError( $wgOut->parse( $errorText ) );
1255                 }
1256
1257                 // Rockin', go ahead and upload
1258                 return true;
1259         }
1260
1261 }
1262 ?>