includes/upload/UploadBase.php

   1 <?php
   2 /**
   3  * @file
   4  * @ingroup upload
   5  *
   6  * UploadBase and subclasses are the backend of MediaWiki's file uploads.
   7  * The frontends are formed by ApiUpload and SpecialUpload.
   8  *
   9  * See also includes/docs/upload.txt
  10  *
  11  * @author Brion Vibber
  12  * @author Bryan Tong Minh
  13  * @author Michael Dale
  14  */
  15
  16 abstract class UploadBase {
  17         protected $mTempPath;
  18         protected $mDesiredDestName, $mDestName, $mRemoveTempFile, $mSourceType;
  19         protected $mTitle = false, $mTitleError = 0;
  20         protected $mFilteredName, $mFinalExtension;
  21         protected $mLocalFile;
  22
  23         const SUCCESS = 0;
  24         const OK = 0;
  25         const EMPTY_FILE = 3;
  26         const MIN_LENGTH_PARTNAME = 4;
  27         const ILLEGAL_FILENAME = 5;
  28         const OVERWRITE_EXISTING_FILE = 7; # Not used anymore; handled by verifyPermissions()
  29         const FILETYPE_MISSING = 8;
  30         const FILETYPE_BADTYPE = 9;
  31         const VERIFICATION_ERROR = 10;
  32
  33         # HOOK_ABORTED is the new name of UPLOAD_VERIFICATION_ERROR
  34         const UPLOAD_VERIFICATION_ERROR = 11;
  35         const HOOK_ABORTED = 11;
  36         const FILE_TOO_LARGE = 12;
  37
  38         const SESSION_VERSION = 2;
  39         const SESSION_KEYNAME = 'wsUploadData';
  40
  41         static public function getSessionKeyname() {
  42                 return self::SESSION_KEYNAME;
  43         }
  44
  45         public function getVerificationErrorCode( $error ) {
  46                 $code_to_status = array(self::EMPTY_FILE => 'empty-file',
  47                                                                 self::FILE_TOO_LARGE => 'file-too-large',
  48                                                                 self::FILETYPE_MISSING => 'filetype-missing',
  49                                                                 self::FILETYPE_BADTYPE => 'filetype-banned',
  50                                                                 self::MIN_LENGTH_PARTNAME => 'filename-tooshort',
  51                                                                 self::ILLEGAL_FILENAME => 'illegal-filename',
  52                                                                 self::OVERWRITE_EXISTING_FILE => 'overwrite',
  53                                                                 self::VERIFICATION_ERROR => 'verification-error',
  54                                                                 self::HOOK_ABORTED =>  'hookaborted',
  55                 );
  56                 if( isset( $code_to_status[$error] ) ) {
  57                         return $code_to_status[$error];
  58                 }
  59
  60                 return 'unknown-error';
  61         }
  62
  63         /**
  64          * Returns true if uploads are enabled.
  65          * Can be override by subclasses.
  66          */
  67         public static function isEnabled() {
  68                 global $wgEnableUploads;
  69                 if ( !$wgEnableUploads ) {
  70                         return false;
  71                 }
  72
  73                 # Check php's file_uploads setting
  74                 if( !wfIniGetBool( 'file_uploads' ) ) {
  75                         return false;
  76                 }
  77                 return true;
  78         }
  79
  80         /**
  81          * Returns true if the user can use this upload module or else a string
  82          * identifying the missing permission.
  83          * Can be overriden by subclasses.
  84          */
  85         public static function isAllowed( $user ) {
  86                 foreach ( array( 'upload', 'edit' ) as $permission ) {
  87                         if ( !$user->isAllowed( $permission ) ) {
  88                                 return $permission;
  89                         }
  90                 }
  91                 return true;
  92         }
  93
  94         // Upload handlers. Should probably just be a global.
  95         static $uploadHandlers = array( 'Stash', 'File', 'Url' );
  96
  97         /**
  98          * Create a form of UploadBase depending on wpSourceType and initializes it
  99          */
 100         public static function createFromRequest( &$request, $type = null ) {
 101                 $type = $type ? $type : $request->getVal( 'wpSourceType', 'File' );
 102
 103                 if( !$type ) {
 104                         return null;
 105                 }
 106
 107                 // Get the upload class
 108                 $type = ucfirst( $type );
 109
 110                 // Give hooks the chance to handle this request
 111                 $className = null;
 112                 wfRunHooks( 'UploadCreateFromRequest', array( $type, &$className ) );
 113                 if ( is_null( $className ) ) {
 114                         $className = 'UploadFrom' . $type;
 115                         wfDebug( __METHOD__ . ": class name: $className\n" );
 116                         if( !in_array( $type, self::$uploadHandlers ) ) {
 117                                 return null;
 118                         }
 119                 }
 120
 121                 // Check whether this upload class is enabled
 122                 if( !call_user_func( array( $className, 'isEnabled' ) ) ) {
 123                         return null;
 124                 }
 125
 126                 // Check whether the request is valid
 127                 if( !call_user_func( array( $className, 'isValidRequest' ), $request ) ) {
 128                         return null;
 129                 }
 130
 131                 $handler = new $className;
 132
 133                 $handler->initializeFromRequest( $request );
 134                 return $handler;
 135         }
 136
 137         /**
 138          * Check whether a request if valid for this handler
 139          */
 140         public static function isValidRequest( $request ) {
 141                 return false;
 142         }
 143
 144         public function __construct() {}
 145
 146         /**
 147          * Returns the upload type. Should be overridden by child classes
 148          *
 149          * @since 1.18
 150          * @return string
 151          */
 152         public function getSourceType() { return null; }
 153
 154         /**
 155          * Initialize the path information
 156          * @param $name string the desired destination name
 157          * @param $tempPath string the temporary path
 158          * @param $fileSize int the file size
 159          * @param $removeTempFile bool (false) remove the temporary file?
 160          * @return null
 161          */
 162         public function initializePathInfo( $name, $tempPath, $fileSize, $removeTempFile = false ) {
 163                 $this->mDesiredDestName = $name;
 164                 $this->mTempPath = $tempPath;
 165                 $this->mFileSize = $fileSize;
 166                 $this->mRemoveTempFile = $removeTempFile;
 167         }
 168
 169         /**
 170          * Initialize from a WebRequest. Override this in a subclass.
 171          */
 172         public abstract function initializeFromRequest( &$request );
 173
 174         /**
 175          * Fetch the file. Usually a no-op
 176          */
 177         public function fetchFile() {
 178                 return Status::newGood();
 179         }
 180
 181         /**
 182          * Return true if the file is empty
 183          * @return bool
 184          */
 185         public function isEmptyFile() {
 186                 return empty( $this->mFileSize );
 187         }
 188
 189         /**
 190          * Return the file size
 191          * @return integer
 192          */
 193         public function getFileSize() {
 194                 return $this->mFileSize;
 195         }
 196
 197         /**
 198          * Append a file to the Repo file
 199          *
 200          * @param $srcPath String: path to source file
 201          * @param $toAppendPath String: path to the Repo file that will be appended to.
 202          * @return Status Status
 203          */
 204         protected function appendToUploadFile( $srcPath, $toAppendPath ) {
 205                 $repo = RepoGroup::singleton()->getLocalRepo();
 206                 $status = $repo->append( $srcPath, $toAppendPath );
 207                 return $status;
 208         }
 209
 210         /**
 211          * @param $srcPath String: the source path
 212          * @return the real path if it was a virtual URL
 213          */
 214         function getRealPath( $srcPath ) {
 215                 $repo = RepoGroup::singleton()->getLocalRepo();
 216                 if ( $repo->isVirtualUrl( $srcPath ) ) {
 217                         return $repo->resolveVirtualUrl( $srcPath );
 218                 }
 219                 return $srcPath;
 220         }
 221
 222         /**
 223          * Verify whether the upload is sane.
 224          * @return mixed self::OK or else an array with error information
 225          */
 226         public function verifyUpload() {
 227                 /**
 228                  * If there was no filename or a zero size given, give up quick.
 229                  */
 230                 if( $this->isEmptyFile() ) {
 231                         return array( 'status' => self::EMPTY_FILE );
 232                 }
 233
 234                 /**
 235                  * Honor $wgMaxUploadSize
 236                  */
 237                 $maxSize = self::getMaxUploadSize( $this->getSourceType() );
 238                 if( $this->mFileSize > $maxSize ) {
 239                         return array(
 240                                 'status' => self::FILE_TOO_LARGE,
 241                                 'max' => $maxSize,
 242                         );
 243                 }
 244
 245                 /**
 246                  * Look at the contents of the file; if we can recognize the
 247                  * type but it's corrupt or data of the wrong type, we should
 248                  * probably not accept it.
 249                  */
 250                 $verification = $this->verifyFile();
 251                 if( $verification !== true ) {
 252                         return array(
 253                                 'status' => self::VERIFICATION_ERROR,
 254                                 'details' => $verification
 255                         );
 256                 }
 257
 258                 /**
 259                  * Make sure this file can be created
 260                  */
 261                 $result = $this->validateName();
 262                 if( $result !== true ) {
 263                         return $result;
 264                 }
 265
 266                 $error = '';
 267                 if( !wfRunHooks( 'UploadVerification',
 268                                 array( $this->mDestName, $this->mTempPath, &$error ) ) ) {
 269                         return array( 'status' => self::HOOK_ABORTED, 'error' => $error );
 270                 }
 271
 272                 return array( 'status' => self::OK );
 273         }
 274
 275         /**
 276          * Verify that the name is valid and, if necessary, that we can overwrite
 277          *
 278          * @return mixed true if valid, otherwise and array with 'status'
 279          * and other keys
 280          **/
 281         protected function validateName() {
 282                 $nt = $this->getTitle();
 283                 if( is_null( $nt ) ) {
 284                         $result = array( 'status' => $this->mTitleError );
 285                         if( $this->mTitleError == self::ILLEGAL_FILENAME ) {
 286                                 $result['filtered'] = $this->mFilteredName;
 287                         }
 288                         if ( $this->mTitleError == self::FILETYPE_BADTYPE ) {
 289                                 $result['finalExt'] = $this->mFinalExtension;
 290                                 if ( count( $this->mBlackListedExtensions ) ) {
 291                                         $result['blacklistedExt'] = $this->mBlackListedExtensions;
 292                                 }
 293                         }
 294                         return $result;
 295                 }
 296                 $this->mDestName = $this->getLocalFile()->getName();
 297
 298                 return true;
 299         }
 300
 301         /**
 302          * Verify the mime type
 303          *
 304          * @param $mime string representing the mime
 305          * @return mixed true if the file is verified, an array otherwise
 306          */
 307         protected function verifyMimeType( $mime ) {
 308                 global $wgVerifyMimeType;
 309                 if ( $wgVerifyMimeType ) {
 310                         wfDebug ( "\n\nmime: <$mime> extension: <{$this->mFinalExtension}>\n\n");
 311                         global $wgMimeTypeBlacklist;
 312                         if ( $this->checkFileExtension( $mime, $wgMimeTypeBlacklist ) ) {
 313                                 return array( 'filetype-badmime', $mime );
 314                         }
 315
 316                         # XXX: Missing extension will be caught by validateName() via getTitle()
 317                         if ( $this->mFinalExtension != '' && !$this->verifyExtension( $mime, $this->mFinalExtension ) ) {
 318                                 return array( 'filetype-mime-mismatch', $this->mFinalExtension, $mime );
 319                         }
 320
 321                         # Check IE type
 322                         $fp = fopen( $this->mTempPath, 'rb' );
 323                         $chunk = fread( $fp, 256 );
 324                         fclose( $fp );
 325
 326                         $magic = MimeMagic::singleton();
 327                         $extMime = $magic->guessTypesForExtension( $this->mFinalExtension );
 328                         $ieTypes = $magic->getIEMimeTypes( $this->mTempPath, $chunk, $extMime );
 329                         foreach ( $ieTypes as $ieType ) {
 330                                 if ( $this->checkFileExtension( $ieType, $wgMimeTypeBlacklist ) ) {
 331                                         return array( 'filetype-bad-ie-mime', $ieType );
 332                                 }
 333                         }
 334                 }
 335
 336                 return true;
 337         }
 338
 339         /**
 340          * Verifies that it's ok to include the uploaded file
 341          *
 342          * @return mixed true of the file is verified, array otherwise.
 343          */
 344         protected function verifyFile() {
 345                 # get the title, even though we are doing nothing with it, because
 346                 # we need to populate mFinalExtension
 347                 $this->getTitle();
 348
 349                 $this->mFileProps = File::getPropsFromPath( $this->mTempPath, $this->mFinalExtension );
 350                 $this->checkMacBinary();
 351
 352                 # check mime type, if desired
 353                 $mime = $this->mFileProps[ 'file-mime' ];
 354                 $status = $this->verifyMimeType( $mime );
 355                 if ( $status !== true ) {
 356                         return $status;
 357                 }
 358
 359                 # check for htmlish code and javascript
 360                 if( self::detectScript( $this->mTempPath, $mime, $this->mFinalExtension ) ) {
 361                         return array( 'uploadscripted' );
 362                 }
 363                 if( $this->mFinalExtension == 'svg' || $mime == 'image/svg+xml' ) {
 364                         if( $this->detectScriptInSvg( $this->mTempPath ) ) {
 365                                 return array( 'uploadscripted' );
 366                         }
 367                 }
 368
 369                 /**
 370                 * Scan the uploaded file for viruses
 371                 */
 372                 $virus = $this->detectVirus( $this->mTempPath );
 373                 if ( $virus ) {
 374                         return array( 'uploadvirus', $virus );
 375                 }
 376
 377                 $handler = MediaHandler::getHandler( $mime );
 378                 if ( $handler ) {
 379                         $handlerStatus = $handler->verifyUpload( $this->mTempPath );
 380                         if ( !$handlerStatus->isOK() ) {
 381                                 $errors = $handlerStatus->getErrorsArray();
 382                                 return reset( $errors );
 383                         }
 384                 }
 385
 386                 wfRunHooks( 'UploadVerifyFile', array( $this, $mime, &$status ) );
 387                 if ( $status !== true ) {
 388                         return $status;
 389                 }
 390
 391                 wfDebug( __METHOD__ . ": all clear; passing.\n" );
 392                 return true;
 393         }
 394
 395         /**
 396          * Check whether the user can edit, upload and create the image. This
 397          * checks only against the current title; if it returns errors, it may
 398          * very well be that another title will not give errors. Therefore
 399          * isAllowed() should be called as well for generic is-user-blocked or
 400          * can-user-upload checking.
 401          *
 402          * @param $user the User object to verify the permissions against
 403          * @return mixed An array as returned by getUserPermissionsErrors or true
 404          *               in case the user has proper permissions.
 405          */
 406         public function verifyPermissions( $user ) {
 407                 /**
 408                  * If the image is protected, non-sysop users won't be able
 409                  * to modify it by uploading a new revision.
 410                  */
 411                 $nt = $this->getTitle();
 412                 if( is_null( $nt ) ) {
 413                         return true;
 414                 }
 415                 $permErrors = $nt->getUserPermissionsErrors( 'edit', $user );
 416                 $permErrorsUpload = $nt->getUserPermissionsErrors( 'upload', $user );
 417                 if ( $nt->exists() ) {
 418                         $permErrorsCreate = $nt->getUserPermissionsErrors( 'createpage', $user );
 419                 } else {
 420                         $permErrorsCreate = array();
 421                 }
 422                 if( $permErrors || $permErrorsUpload || $permErrorsCreate ) {
 423                         $permErrors = array_merge( $permErrors, wfArrayDiff2( $permErrorsUpload, $permErrors ) );
 424                         $permErrors = array_merge( $permErrors, wfArrayDiff2( $permErrorsCreate, $permErrors ) );
 425                         return $permErrors;
 426                 }
 427
 428                 $overwriteError = $this->checkOverwrite( $user );
 429                 if ( $overwriteError !== true ) {
 430                         return array( array( $overwriteError ) );
 431                 }
 432
 433                 return true;
 434         }
 435
 436         /**
 437          * Check for non fatal problems with the file
 438          *
 439          * @return Array of warnings
 440          */
 441         public function checkWarnings() {
 442                 $warnings = array();
 443
 444                 $localFile = $this->getLocalFile();
 445                 $filename = $localFile->getName();
 446
 447                 /**
 448                  * Check whether the resulting filename is different from the desired one,
 449                  * but ignore things like ucfirst() and spaces/underscore things
 450                  */
 451                 $comparableName = str_replace( ' ', '_', $this->mDesiredDestName );
 452                 $comparableName = Title::capitalize( $comparableName, NS_FILE );
 453
 454                 if( $this->mDesiredDestName != $filename && $comparableName != $filename ) {
 455                         $warnings['badfilename'] = $filename;
 456                 }
 457
 458                 // Check whether the file extension is on the unwanted list
 459                 global $wgCheckFileExtensions, $wgFileExtensions;
 460                 if ( $wgCheckFileExtensions ) {
 461                         if ( !$this->checkFileExtension( $this->mFinalExtension, $wgFileExtensions ) ) {
 462                                 $warnings['filetype-unwanted-type'] = $this->mFinalExtension;
 463                         }
 464                 }
 465
 466                 global $wgUploadSizeWarning;
 467                 if ( $wgUploadSizeWarning && ( $this->mFileSize > $wgUploadSizeWarning ) ) {
 468                         $warnings['large-file'] = $wgUploadSizeWarning;
 469                 }
 470
 471                 if ( $this->mFileSize == 0 ) {
 472                         $warnings['emptyfile'] = true;
 473                 }
 474
 475                 $exists = self::getExistsWarning( $localFile );
 476                 if( $exists !== false ) {
 477                         $warnings['exists'] = $exists;
 478                 }
 479
 480                 // Check dupes against existing files
 481                 $hash = File::sha1Base36( $this->mTempPath );
 482                 $dupes = RepoGroup::singleton()->findBySha1( $hash );
 483                 $title = $this->getTitle();
 484                 // Remove all matches against self
 485                 foreach ( $dupes as $key => $dupe ) {
 486                         if( $title->equals( $dupe->getTitle() ) ) {
 487                                 unset( $dupes[$key] );
 488                         }
 489                 }
 490                 if( $dupes ) {
 491                         $warnings['duplicate'] = $dupes;
 492                 }
 493
 494                 // Check dupes against archives
 495                 $archivedImage = new ArchivedFile( null, 0, "{$hash}.{$this->mFinalExtension}" );
 496                 if ( $archivedImage->getID() > 0 ) {
 497                         $warnings['duplicate-archive'] = $archivedImage->getName();
 498                 }
 499
 500                 return $warnings;
 501         }
 502
 503         /**
 504          * Really perform the upload. Stores the file in the local repo, watches
 505          * if necessary and runs the UploadComplete hook.
 506          *
 507          * @return Status indicating the whether the upload succeeded.
 508          */
 509         public function performUpload( $comment, $pageText, $watch, $user ) {
 510                 $status = $this->getLocalFile()->upload(
 511                         $this->mTempPath,
 512                         $comment,
 513                         $pageText,
 514                         File::DELETE_SOURCE,
 515                         $this->mFileProps,
 516                         false,
 517                         $user
 518                 );
 519
 520                 if( $status->isGood() ) {
 521                         if ( $watch ) {
 522                                 $user->addWatch( $this->getLocalFile()->getTitle() );
 523                         }
 524
 525                         wfRunHooks( 'UploadComplete', array( &$this ) );
 526                 }
 527
 528                 return $status;
 529         }
 530
 531         /**
 532          * Returns the title of the file to be uploaded. Sets mTitleError in case
 533          * the name was illegal.
 534          *
 535          * @return Title The title of the file or null in case the name was illegal
 536          */
 537         public function getTitle() {
 538                 if ( $this->mTitle !== false ) {
 539                         return $this->mTitle;
 540                 }
 541
 542                 /**
 543                  * Chop off any directories in the given filename. Then
 544                  * filter out illegal characters, and try to make a legible name
 545                  * out of it. We'll strip some silently that Title would die on.
 546                  */
 547                 $this->mFilteredName = wfStripIllegalFilenameChars( $this->mDesiredDestName );
 548                 /* Normalize to title form before we do any further processing */
 549                 $nt = Title::makeTitleSafe( NS_FILE, $this->mFilteredName );
 550                 if( is_null( $nt ) ) {
 551                         $this->mTitleError = self::ILLEGAL_FILENAME;
 552                         return $this->mTitle = null;
 553                 }
 554                 $this->mFilteredName = $nt->getDBkey();
 555
 556                 /**
 557                  * We'll want to blacklist against *any* 'extension', and use
 558                  * only the final one for the whitelist.
 559                  */
 560                 list( $partname, $ext ) = $this->splitExtensions( $this->mFilteredName );
 561
 562                 if( count( $ext ) ) {
 563                         $this->mFinalExtension = trim( $ext[count( $ext ) - 1] );
 564                 } else {
 565                         $this->mFinalExtension = '';
 566
 567                         # No extension, try guessing one
 568                         $magic = MimeMagic::singleton();
 569                         $mime = $magic->guessMimeType( $this->mTempPath );
 570                         if ( $mime !== 'unknown/unknown' ) {
 571                                 # Get a space separated list of extensions
 572                                 $extList = $magic->getExtensionsForType( $mime );
 573                                 if ( $extList ) {
 574                                         # Set the extension to the canonical extension
 575                                         $this->mFinalExtension = strtok( $extList, ' ' );
 576
 577                                         # Fix up the other variables
 578                                         $this->mFilteredName .= ".{$this->mFinalExtension}";
 579                                         $nt = Title::makeTitleSafe( NS_FILE, $this->mFilteredName );
 580                                         $ext = array( $this->mFinalExtension );
 581                                 }
 582                         }
 583
 584                 }
 585
 586                 /* Don't allow users to override the blacklist (check file extension) */
 587                 global $wgCheckFileExtensions, $wgStrictFileExtensions;
 588                 global $wgFileExtensions, $wgFileBlacklist;
 589
 590                 $blackListedExtensions = $this->checkFileExtensionList( $ext, $wgFileBlacklist );
 591
 592                 if ( $this->mFinalExtension == '' ) {
 593                         $this->mTitleError = self::FILETYPE_MISSING;
 594                         return $this->mTitle = null;
 595                 } elseif ( $blackListedExtensions ||
 596                                 ( $wgCheckFileExtensions && $wgStrictFileExtensions &&
 597                                         !$this->checkFileExtension( $this->mFinalExtension, $wgFileExtensions ) ) ) {
 598                         $this->mBlackListedExtensions = $blackListedExtensions;
 599                         $this->mTitleError = self::FILETYPE_BADTYPE;
 600                         return $this->mTitle = null;
 601                 }
 602
 603                 # If there was more than one "extension", reassemble the base
 604                 # filename to prevent bogus complaints about length
 605                 if( count( $ext ) > 1 ) {
 606                         for( $i = 0; $i < count( $ext ) - 1; $i++ ) {
 607                                 $partname .= '.' . $ext[$i];
 608                         }
 609                 }
 610
 611                 if( strlen( $partname ) < 1 ) {
 612                         $this->mTitleError =  self::MIN_LENGTH_PARTNAME;
 613                         return $this->mTitle = null;
 614                 }
 615
 616                 return $this->mTitle = $nt;
 617         }
 618
 619         /**
 620          * Return the local file and initializes if necessary.
 621          */
 622         public function getLocalFile() {
 623                 if( is_null( $this->mLocalFile ) ) {
 624                         $nt = $this->getTitle();
 625                         $this->mLocalFile = is_null( $nt ) ? null : wfLocalFile( $nt );
 626                 }
 627                 return $this->mLocalFile;
 628         }
 629
 630         /**
 631          * NOTE: Probably should be deprecated in favor of UploadStash, but this is sometimes
 632          * called outside that context.
 633          *
 634          * Stash a file in a temporary directory for later processing
 635          * after the user has confirmed it.
 636          *
 637          * If the user doesn't explicitly cancel or accept, these files
 638          * can accumulate in the temp directory.
 639          *
 640          * @param $saveName String: the destination filename
 641          * @param $tempSrc String: the source temporary file to save
 642          * @return String: full path the stashed file, or false on failure
 643          */
 644         protected function saveTempUploadedFile( $saveName, $tempSrc ) {
 645                 $repo = RepoGroup::singleton()->getLocalRepo();
 646                 $status = $repo->storeTemp( $saveName, $tempSrc );
 647                 return $status;
 648         }
 649
 650         /**
 651          * If the user does not supply all necessary information in the first upload form submission (either by accident or
 652          * by design) then we may want to stash the file temporarily, get more information, and publish the file later.
 653          *
 654          * This method will stash a file in a temporary directory for later processing, and save the necessary descriptive info
 655          * into the user's session.
 656          * This method returns the file object, which also has a 'sessionKey' property which can be passed through a form or
 657          * API request to find this stashed file again.
 658          *
 659          * @param $key String: (optional) the session key used to find the file info again. If not supplied, a key will be autogenerated.
 660          * @return File stashed file
 661          */
 662         public function stashSessionFile( $key = null ) {
 663                 $stash = RepoGroup::singleton()->getLocalRepo()->getUploadStash();
 664                 $data = array(
 665                         'mFileProps' => $this->mFileProps,
 666                         'mSourceType' => $this->getSourceType(),
 667                 );
 668                 $file = $stash->stashFile( $this->mTempPath, $data, $key );
 669                 $this->mLocalFile = $file;
 670                 return $file;
 671         }
 672
 673         /**
 674          * Stash a file in a temporary directory, returning a key which can be used to find the file again. See stashSessionFile().
 675          *
 676          * @param $key String: (optional) the session key used to find the file info again. If not supplied, a key will be autogenerated.
 677          * @return String: session key
 678          */
 679         public function stashSession( $key = null ) {
 680                 return $this->stashSessionFile( $key )->getSessionKey();
 681         }
 682
 683         /**
 684          * If we've modified the upload file we need to manually remove it
 685          * on exit to clean up.
 686          */
 687         public function cleanupTempFile() {
 688                 if ( $this->mRemoveTempFile && $this->mTempPath && file_exists( $this->mTempPath ) ) {
 689                         wfDebug( __METHOD__ . ": Removing temporary file {$this->mTempPath}\n" );
 690                         unlink( $this->mTempPath );
 691                 }
 692         }
 693
 694         public function getTempPath() {
 695                 return $this->mTempPath;
 696         }
 697
 698         /**
 699          * Split a file into a base name and all dot-delimited 'extensions'
 700          * on the end. Some web server configurations will fall back to
 701          * earlier pseudo-'extensions' to determine type and execute
 702          * scripts, so the blacklist needs to check them all.
 703          *
 704          * @return array
 705          */
 706         public static function splitExtensions( $filename ) {
 707                 $bits = explode( '.', $filename );
 708                 $basename = array_shift( $bits );
 709                 return array( $basename, $bits );
 710         }
 711
 712         /**
 713          * Perform case-insensitive match against a list of file extensions.
 714          * Returns true if the extension is in the list.
 715          *
 716          * @param $ext String
 717          * @param $list Array
 718          * @return Boolean
 719          */
 720         public static function checkFileExtension( $ext, $list ) {
 721                 return in_array( strtolower( $ext ), $list );
 722         }
 723
 724         /**
 725          * Perform case-insensitive match against a list of file extensions.
 726          * Returns an array of matching extensions.
 727          *
 728          * @param $ext Array
 729          * @param $list Array
 730          * @return Boolean
 731          */
 732         public static function checkFileExtensionList( $ext, $list ) {
 733                 return array_intersect( array_map( 'strtolower', $ext ), $list );
 734         }
 735
 736         /**
 737          * Checks if the mime type of the uploaded file matches the file extension.
 738          *
 739          * @param $mime String: the mime type of the uploaded file
 740          * @param $extension String: the filename extension that the file is to be served with
 741          * @return Boolean
 742          */
 743         public static function verifyExtension( $mime, $extension ) {
 744                 $magic = MimeMagic::singleton();
 745
 746                 if ( !$mime || $mime == 'unknown' || $mime == 'unknown/unknown' )
 747                         if ( !$magic->isRecognizableExtension( $extension ) ) {
 748                                 wfDebug( __METHOD__ . ": passing file with unknown detected mime type; " .
 749                                         "unrecognized extension '$extension', can't verify\n" );
 750                                 return true;
 751                         } else {
 752                                 wfDebug( __METHOD__ . ": rejecting file with unknown detected mime type; ".
 753                                         "recognized extension '$extension', so probably invalid file\n" );
 754                                 return false;
 755                         }
 756
 757                 $match = $magic->isMatchingExtension( $extension, $mime );
 758
 759                 if ( $match === null ) {
 760                         wfDebug( __METHOD__ . ": no file extension known for mime type $mime, passing file\n" );
 761                         return true;
 762                 } elseif( $match === true ) {
 763                         wfDebug( __METHOD__ . ": mime type $mime matches extension $extension, passing file\n" );
 764
 765                         #TODO: if it's a bitmap, make sure PHP or ImageMagic resp. can handle it!
 766                         return true;
 767
 768                 } else {
 769                         wfDebug( __METHOD__ . ": mime type $mime mismatches file extension $extension, rejecting file\n" );
 770                         return false;
 771                 }
 772         }
 773
 774         /**
 775          * Heuristic for detecting files that *could* contain JavaScript instructions or
 776          * things that may look like HTML to a browser and are thus
 777          * potentially harmful. The present implementation will produce false
 778          * positives in some situations.
 779          *
 780          * @param $file String: pathname to the temporary upload file
 781          * @param $mime String: the mime type of the file
 782          * @param $extension String: the extension of the file
 783          * @return Boolean: true if the file contains something looking like embedded scripts
 784          */
 785         public static function detectScript( $file, $mime, $extension ) {
 786                 global $wgAllowTitlesInSVG;
 787
 788                 # ugly hack: for text files, always look at the entire file.
 789                 # For binary field, just check the first K.
 790
 791                 if( strpos( $mime,'text/' ) === 0 ) {
 792                         $chunk = file_get_contents( $file );
 793                 } else {
 794                         $fp = fopen( $file, 'rb' );
 795                         $chunk = fread( $fp, 1024 );
 796                         fclose( $fp );
 797                 }
 798
 799                 $chunk = strtolower( $chunk );
 800
 801                 if( !$chunk ) {
 802                         return false;
 803                 }
 804
 805                 # decode from UTF-16 if needed (could be used for obfuscation).
 806                 if( substr( $chunk, 0, 2 ) == "\xfe\xff" ) {
 807                         $enc = 'UTF-16BE';
 808                 } elseif( substr( $chunk, 0, 2 ) == "\xff\xfe" ) {
 809                         $enc = 'UTF-16LE';
 810                 } else {
 811                         $enc = null;
 812                 }
 813
 814                 if( $enc ) {
 815                         $chunk = iconv( $enc, "ASCII//IGNORE", $chunk );
 816                 }
 817
 818                 $chunk = trim( $chunk );
 819
 820                 # FIXME: convert from UTF-16 if necessarry!
 821                 wfDebug( __METHOD__ . ": checking for embedded scripts and HTML stuff\n" );
 822
 823                 # check for HTML doctype
 824                 if ( preg_match( "/<!DOCTYPE *X?HTML/i", $chunk ) ) {
 825                         return true;
 826                 }
 827
 828                 /**
 829                  * Internet Explorer for Windows performs some really stupid file type
 830                  * autodetection which can cause it to interpret valid image files as HTML
 831                  * and potentially execute JavaScript, creating a cross-site scripting
 832                  * attack vectors.
 833                  *
 834                  * Apple's Safari browser also performs some unsafe file type autodetection
 835                  * which can cause legitimate files to be interpreted as HTML if the
 836                  * web server is not correctly configured to send the right content-type
 837                  * (or if you're really uploading plain text and octet streams!)
 838                  *
 839                  * Returns true if IE is likely to mistake the given file for HTML.
 840                  * Also returns true if Safari would mistake the given file for HTML
 841                  * when served with a generic content-type.
 842                  */
 843                 $tags = array(
 844                         '<a href',
 845                         '<body',
 846                         '<head',
 847                         '<html',   #also in safari
 848                         '<img',
 849                         '<pre',
 850                         '<script', #also in safari
 851                         '<table'
 852                 );
 853
 854                 if( !$wgAllowTitlesInSVG && $extension !== 'svg' && $mime !== 'image/svg' ) {
 855                         $tags[] = '<title';
 856                 }
 857
 858                 foreach( $tags as $tag ) {
 859                         if( false !== strpos( $chunk, $tag ) ) {
 860                                 return true;
 861                         }
 862                 }
 863
 864                 /*
 865                  * look for JavaScript
 866                  */
 867
 868                 # resolve entity-refs to look at attributes. may be harsh on big files... cache result?
 869                 $chunk = Sanitizer::decodeCharReferences( $chunk );
 870
 871                 # look for script-types
 872                 if( preg_match( '!type\s*=\s*[\'"]?\s*(?:\w*/)?(?:ecma|java)!sim', $chunk ) ) {
 873                         return true;
 874                 }
 875
 876                 # look for html-style script-urls
 877                 if( preg_match( '!(?:href|src|data)\s*=\s*[\'"]?\s*(?:ecma|java)script:!sim', $chunk ) ) {
 878                         return true;
 879                 }
 880
 881                 # look for css-style script-urls
 882                 if( preg_match( '!url\s*\(\s*[\'"]?\s*(?:ecma|java)script:!sim', $chunk ) ) {
 883                         return true;
 884                 }
 885
 886                 wfDebug( __METHOD__ . ": no scripts found\n" );
 887                 return false;
 888         }
 889
 890         protected function detectScriptInSvg( $filename ) {
 891                 $check = new XmlTypeCheck( $filename, array( $this, 'checkSvgScriptCallback' ) );
 892                 return $check->filterMatch;
 893         }
 894
 895         /**
 896          * @todo Replace this with a whitelist filter!
 897          */
 898         public function checkSvgScriptCallback( $element, $attribs ) {
 899                 $stripped = $this->stripXmlNamespace( $element );
 900
 901                 if( $stripped == 'script' ) {
 902                         wfDebug( __METHOD__ . ": Found script element '$element' in uploaded file.\n" );
 903                         return true;
 904                 }
 905
 906                 foreach( $attribs as $attrib => $value ) {
 907                         $stripped = $this->stripXmlNamespace( $attrib );
 908                         if( substr( $stripped, 0, 2 ) == 'on' ) {
 909                                 wfDebug( __METHOD__ . ": Found script attribute '$attrib'='value' in uploaded file.\n" );
 910                                 return true;
 911                         }
 912                         if( $stripped == 'href' && strpos( strtolower( $value ), 'javascript:' ) !== false ) {
 913                                 wfDebug( __METHOD__ . ": Found script href attribute '$attrib'='$value' in uploaded file.\n" );
 914                                 return true;
 915                         }
 916                 }
 917         }
 918
 919         private function stripXmlNamespace( $name ) {
 920                 // 'http://www.w3.org/2000/svg:script' -> 'script'
 921                 $parts = explode( ':', strtolower( $name ) );
 922                 return array_pop( $parts );
 923         }
 924
 925         /**
 926          * Generic wrapper function for a virus scanner program.
 927          * This relies on the $wgAntivirus and $wgAntivirusSetup variables.
 928          * $wgAntivirusRequired may be used to deny upload if the scan fails.
 929          *
 930          * @param $file String: pathname to the temporary upload file
 931          * @return mixed false if not virus is found, NULL if the scan fails or is disabled,
 932          *         or a string containing feedback from the virus scanner if a virus was found.
 933          *         If textual feedback is missing but a virus was found, this function returns true.
 934          */
 935         public static function detectVirus( $file ) {
 936                 global $wgAntivirus, $wgAntivirusSetup, $wgAntivirusRequired, $wgOut;
 937
 938                 if ( !$wgAntivirus ) {
 939                         wfDebug( __METHOD__ . ": virus scanner disabled\n" );
 940                         return null;
 941                 }
 942
 943                 if ( !$wgAntivirusSetup[$wgAntivirus] ) {
 944                         wfDebug( __METHOD__ . ": unknown virus scanner: $wgAntivirus\n" );
 945                         $wgOut->wrapWikiMsg( "<div class=\"error\">\n$1\n</div>",
 946                                 array( 'virus-badscanner', $wgAntivirus ) );
 947                         return wfMsg( 'virus-unknownscanner' ) . " $wgAntivirus";
 948                 }
 949
 950                 # look up scanner configuration
 951                 $command = $wgAntivirusSetup[$wgAntivirus]['command'];
 952                 $exitCodeMap = $wgAntivirusSetup[$wgAntivirus]['codemap'];
 953                 $msgPattern = isset( $wgAntivirusSetup[$wgAntivirus]['messagepattern'] ) ?
 954                         $wgAntivirusSetup[$wgAntivirus]['messagepattern'] : null;
 955
 956                 if ( strpos( $command, "%f" ) === false ) {
 957                         # simple pattern: append file to scan
 958                         $command .= " " . wfEscapeShellArg( $file );
 959                 } else {
 960                         # complex pattern: replace "%f" with file to scan
 961                         $command = str_replace( "%f", wfEscapeShellArg( $file ), $command );
 962                 }
 963
 964                 wfDebug( __METHOD__ . ": running virus scan: $command \n" );
 965
 966                 # execute virus scanner
 967                 $exitCode = false;
 968
 969                 # NOTE: there's a 50 line workaround to make stderr redirection work on windows, too.
 970                 #      that does not seem to be worth the pain.
 971                 #      Ask me (Duesentrieb) about it if it's ever needed.
 972                 $output = wfShellExec( "$command 2>&1", $exitCode );
 973
 974                 # map exit code to AV_xxx constants.
 975                 $mappedCode = $exitCode;
 976                 if ( $exitCodeMap ) {
 977                         if ( isset( $exitCodeMap[$exitCode] ) ) {
 978                                 $mappedCode = $exitCodeMap[$exitCode];
 979                         } elseif ( isset( $exitCodeMap["*"] ) ) {
 980                                 $mappedCode = $exitCodeMap["*"];
 981                         }
 982                 }
 983
 984                 if ( $mappedCode === AV_SCAN_FAILED ) {
 985                         # scan failed (code was mapped to false by $exitCodeMap)
 986                         wfDebug( __METHOD__ . ": failed to scan $file (code $exitCode).\n" );
 987
 988                         if ( $wgAntivirusRequired ) {
 989                                 return wfMsg( 'virus-scanfailed', array( $exitCode ) );
 990                         } else {
 991                                 return null;
 992                         }
 993                 } elseif ( $mappedCode === AV_SCAN_ABORTED ) {
 994                         # scan failed because filetype is unknown (probably imune)
 995                         wfDebug( __METHOD__ . ": unsupported file type $file (code $exitCode).\n" );
 996                         return null;
 997                 } elseif ( $mappedCode === AV_NO_VIRUS ) {
 998                         # no virus found
 999                         wfDebug( __METHOD__ . ": file passed virus scan.\n" );
1000                         return false;
1001                 } else {
1002                         $output = trim( $output );
1003
1004                         if ( !$output ) {
1005                                 $output = true; #if there's no output, return true
1006                         } elseif ( $msgPattern ) {
1007                                 $groups = array();
1008                                 if ( preg_match( $msgPattern, $output, $groups ) ) {
1009                                         if ( $groups[1] ) {
1010                                                 $output = $groups[1];
1011                                         }
1012                                 }
1013                         }
1014
1015                         wfDebug( __METHOD__ . ": FOUND VIRUS! scanner feedback: $output \n" );
1016                         return $output;
1017                 }
1018         }
1019
1020         /**
1021          * Check if the temporary file is MacBinary-encoded, as some uploads
1022          * from Internet Explorer on Mac OS Classic and Mac OS X will be.
1023          * If so, the data fork will be extracted to a second temporary file,
1024          * which will then be checked for validity and either kept or discarded.
1025          */
1026         private function checkMacBinary() {
1027                 $macbin = new MacBinary( $this->mTempPath );
1028                 if( $macbin->isValid() ) {
1029                         $dataFile = tempnam( wfTempDir(), 'WikiMacBinary' );
1030                         $dataHandle = fopen( $dataFile, 'wb' );
1031
1032                         wfDebug( __METHOD__ . ": Extracting MacBinary data fork to $dataFile\n" );
1033                         $macbin->extractData( $dataHandle );
1034
1035                         $this->mTempPath = $dataFile;
1036                         $this->mFileSize = $macbin->dataForkLength();
1037
1038                         // We'll have to manually remove the new file if it's not kept.
1039                         $this->mRemoveTempFile = true;
1040                 }
1041                 $macbin->close();
1042         }
1043
1044         /**
1045          * Check if there's an overwrite conflict and, if so, if restrictions
1046          * forbid this user from performing the upload.
1047          *
1048          * @return mixed true on success, error string on failure
1049          */
1050         private function checkOverwrite( $user ) {
1051                 // First check whether the local file can be overwritten
1052                 $file = $this->getLocalFile();
1053                 if( $file->exists() ) {
1054                         if( !self::userCanReUpload( $user, $file ) ) {
1055                                 return 'fileexists-forbidden';
1056                         } else {
1057                                 return true;
1058                         }
1059                 }
1060
1061                 /* Check shared conflicts: if the local file does not exist, but
1062                  * wfFindFile finds a file, it exists in a shared repository.
1063                  */
1064                 $file = wfFindFile( $this->getTitle() );
1065                 if ( $file && !$user->isAllowed( 'reupload-shared' ) ) {
1066                         return 'fileexists-shared-forbidden';
1067                 }
1068
1069                 return true;
1070         }
1071
1072         /**
1073          * Check if a user is the last uploader
1074          *
1075          * @param $user User object
1076          * @param $img String: image name
1077          * @return Boolean
1078          */
1079         public static function userCanReUpload( User $user, $img ) {
1080                 if( $user->isAllowed( 'reupload' ) ) {
1081                         return true; // non-conditional
1082                 }
1083                 if( !$user->isAllowed( 'reupload-own' ) ) {
1084                         return false;
1085                 }
1086                 if( is_string( $img ) ) {
1087                         $img = wfLocalFile( $img );
1088                 }
1089                 if ( !( $img instanceof LocalFile ) ) {
1090                         return false;
1091                 }
1092
1093                 return $user->getId() == $img->getUser( 'id' );
1094         }
1095
1096         /**
1097          * Helper function that does various existence checks for a file.
1098          * The following checks are performed:
1099          * - The file exists
1100          * - Article with the same name as the file exists
1101          * - File exists with normalized extension
1102          * - The file looks like a thumbnail and the original exists
1103          *
1104          * @param $file File The File object to check
1105          * @return mixed False if the file does not exists, else an array
1106          */
1107         public static function getExistsWarning( $file ) {
1108                 if( $file->exists() ) {
1109                         return array( 'warning' => 'exists', 'file' => $file );
1110                 }
1111
1112                 if( $file->getTitle()->getArticleID() ) {
1113                         return array( 'warning' => 'page-exists', 'file' => $file );
1114                 }
1115
1116                 if ( $file->wasDeleted() && !$file->exists() ) {
1117                         return array( 'warning' => 'was-deleted', 'file' => $file );
1118                 }
1119
1120                 if( strpos( $file->getName(), '.' ) == false ) {
1121                         $partname = $file->getName();
1122                         $extension = '';
1123                 } else {
1124                         $n = strrpos( $file->getName(), '.' );
1125                         $extension = substr( $file->getName(), $n + 1 );
1126                         $partname = substr( $file->getName(), 0, $n );
1127                 }
1128                 $normalizedExtension = File::normalizeExtension( $extension );
1129
1130                 if ( $normalizedExtension != $extension ) {
1131                         // We're not using the normalized form of the extension.
1132                         // Normal form is lowercase, using most common of alternate
1133                         // extensions (eg 'jpg' rather than 'JPEG').
1134                         //
1135                         // Check for another file using the normalized form...
1136                         $nt_lc = Title::makeTitle( NS_FILE, "{$partname}.{$normalizedExtension}" );
1137                         $file_lc = wfLocalFile( $nt_lc );
1138
1139                         if( $file_lc->exists() ) {
1140                                 return array(
1141                                         'warning' => 'exists-normalized',
1142                                         'file' => $file,
1143                                         'normalizedFile' => $file_lc
1144                                 );
1145                         }
1146                 }
1147
1148                 if ( self::isThumbName( $file->getName() ) ) {
1149                         # Check for filenames like 50px- or 180px-, these are mostly thumbnails
1150                         $nt_thb = Title::newFromText( substr( $partname , strpos( $partname , '-' ) +1 ) . '.' . $extension, NS_FILE );
1151                         $file_thb = wfLocalFile( $nt_thb );
1152                         if( $file_thb->exists() ) {
1153                                 return array(
1154                                         'warning' => 'thumb',
1155                                         'file' => $file,
1156                                         'thumbFile' => $file_thb
1157                                 );
1158                         } else {
1159                                 // File does not exist, but we just don't like the name
1160                                 return array(
1161                                         'warning' => 'thumb-name',
1162                                         'file' => $file,
1163                                         'thumbFile' => $file_thb
1164                                 );
1165                         }
1166                 }
1167
1168
1169                 foreach( self::getFilenamePrefixBlacklist() as $prefix ) {
1170                         if ( substr( $partname, 0, strlen( $prefix ) ) == $prefix ) {
1171                                 return array(
1172                                         'warning' => 'bad-prefix',
1173                                         'file' => $file,
1174                                         'prefix' => $prefix
1175                                 );
1176                         }
1177                 }
1178
1179                 return false;
1180         }
1181
1182         /**
1183          * Helper function that checks whether the filename looks like a thumbnail
1184          */
1185         public static function isThumbName( $filename ) {
1186                 $n = strrpos( $filename, '.' );
1187                 $partname = $n ? substr( $filename, 0, $n ) : $filename;
1188                 return (
1189                                         substr( $partname , 3, 3 ) == 'px-' ||
1190                                         substr( $partname , 2, 3 ) == 'px-'
1191                                 ) &&
1192                                 preg_match( "/[0-9]{2}/" , substr( $partname , 0, 2 ) );
1193         }
1194
1195         /**
1196          * Get a list of blacklisted filename prefixes from [[MediaWiki:Filename-prefix-blacklist]]
1197          *
1198          * @return array list of prefixes
1199          */
1200         public static function getFilenamePrefixBlacklist() {
1201                 $blacklist = array();
1202                 $message = wfMessage( 'filename-prefix-blacklist' )->inContentLanguage();
1203                 if( !$message->isDisabled() ) {
1204                         $lines = explode( "\n", $message->plain() );
1205                         foreach( $lines as $line ) {
1206                                 // Remove comment lines
1207                                 $comment = substr( trim( $line ), 0, 1 );
1208                                 if ( $comment == '#' || $comment == '' ) {
1209                                         continue;
1210                                 }
1211                                 // Remove additional comments after a prefix
1212                                 $comment = strpos( $line, '#' );
1213                                 if ( $comment > 0 ) {
1214                                         $line = substr( $line, 0, $comment-1 );
1215                                 }
1216                                 $blacklist[] = trim( $line );
1217                         }
1218                 }
1219                 return $blacklist;
1220         }
1221
1222         /**
1223          * Gets image info about the file just uploaded.
1224          *
1225          * Also has the effect of setting metadata to be an 'indexed tag name' in returned API result if
1226          * 'metadata' was requested. Oddly, we have to pass the "result" object down just so it can do that
1227          * with the appropriate format, presumably.
1228          *
1229          * @param $result ApiResult:
1230          * @return Array: image info
1231          */
1232         public function getImageInfo( $result ) {
1233                 $file = $this->getLocalFile();
1234                 // TODO This cries out for refactoring. We really want to say $file->getAllInfo(); here.
1235                 // Perhaps "info" methods should be moved into files, and the API should just wrap them in queries.
1236                 if ( $file instanceof UploadStashFile ) {
1237                         $imParam = ApiQueryStashImageInfo::getPropertyNames();
1238                         $info = ApiQueryStashImageInfo::getInfo( $file, array_flip( $imParam ), $result );
1239                 } else {
1240                         $imParam = ApiQueryImageInfo::getPropertyNames();
1241                         $info = ApiQueryImageInfo::getInfo( $file, array_flip( $imParam ), $result );
1242                 }
1243                 return $info;
1244         }
1245
1246
1247         public function convertVerifyErrorToStatus( $error ) {
1248                 $code = $error['status'];
1249                 unset( $code['status'] );
1250                 return Status::newFatal( $this->getVerificationErrorCode( $code ), $error );
1251         }
1252
1253         public static function getMaxUploadSize( $forType = null ) {
1254                 global $wgMaxUploadSize;
1255
1256                 if ( is_array( $wgMaxUploadSize ) ) {
1257                         if ( !is_null( $forType) && isset( $wgMaxUploadSize[$forType] ) ) {
1258                                 return $wgMaxUploadSize[$forType];
1259                         } else {
1260                                 return $wgMaxUploadSize['*'];
1261                         }
1262                 } else {
1263                         return intval( $wgMaxUploadSize );
1264                 }
1265
1266         }
1267 }