includes/upload/UploadBase.php

   1 <?php
   2 /**
   3  * Base class for the backend of file upload.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @ingroup Upload
  22  */
  23
  24 /**
  25  * @defgroup Upload Upload related
  26  */
  27
  28 /**
  29  * @ingroup Upload
  30  *
  31  * UploadBase and subclasses are the backend of MediaWiki's file uploads.
  32  * The frontends are formed by ApiUpload and SpecialUpload.
  33  *
  34  * @author Brion Vibber
  35  * @author Bryan Tong Minh
  36  * @author Michael Dale
  37  */
  38 abstract class UploadBase {
  39         protected $mTempPath;
  40         protected $mDesiredDestName, $mDestName, $mRemoveTempFile, $mSourceType;
  41         protected $mTitle = false, $mTitleError = 0;
  42         protected $mFilteredName, $mFinalExtension;
  43         protected $mLocalFile, $mFileSize, $mFileProps;
  44         protected $mBlackListedExtensions;
  45         protected $mJavaDetected, $mSVGNSError;
  46
  47         protected static $safeXmlEncodings = array(
  48                 'UTF-8',
  49                 'ISO-8859-1',
  50                 'ISO-8859-2',
  51                 'UTF-16',
  52                 'UTF-32'
  53         );
  54
  55         const SUCCESS = 0;
  56         const OK = 0;
  57         const EMPTY_FILE = 3;
  58         const MIN_LENGTH_PARTNAME = 4;
  59         const ILLEGAL_FILENAME = 5;
  60         const OVERWRITE_EXISTING_FILE = 7; # Not used anymore; handled by verifyTitlePermissions()
  61         const FILETYPE_MISSING = 8;
  62         const FILETYPE_BADTYPE = 9;
  63         const VERIFICATION_ERROR = 10;
  64         const HOOK_ABORTED = 11;
  65         const FILE_TOO_LARGE = 12;
  66         const WINDOWS_NONASCII_FILENAME = 13;
  67         const FILENAME_TOO_LONG = 14;
  68
  69         /**
  70          * @param int $error
  71          * @return string
  72          */
  73         public function getVerificationErrorCode( $error ) {
  74                 $code_to_status = array(
  75                         self::EMPTY_FILE => 'empty-file',
  76                         self::FILE_TOO_LARGE => 'file-too-large',
  77                         self::FILETYPE_MISSING => 'filetype-missing',
  78                         self::FILETYPE_BADTYPE => 'filetype-banned',
  79                         self::MIN_LENGTH_PARTNAME => 'filename-tooshort',
  80                         self::ILLEGAL_FILENAME => 'illegal-filename',
  81                         self::OVERWRITE_EXISTING_FILE => 'overwrite',
  82                         self::VERIFICATION_ERROR => 'verification-error',
  83                         self::HOOK_ABORTED => 'hookaborted',
  84                         self::WINDOWS_NONASCII_FILENAME => 'windows-nonascii-filename',
  85                         self::FILENAME_TOO_LONG => 'filename-toolong',
  86                 );
  87                 if ( isset( $code_to_status[$error] ) ) {
  88                         return $code_to_status[$error];
  89                 }
  90
  91                 return 'unknown-error';
  92         }
  93
  94         /**
  95          * Returns true if uploads are enabled.
  96          * Can be override by subclasses.
  97          * @return bool
  98          */
  99         public static function isEnabled() {
 100                 global $wgEnableUploads;
 101
 102                 if ( !$wgEnableUploads ) {
 103                         return false;
 104                 }
 105
 106                 # Check php's file_uploads setting
 107                 return wfIsHHVM() || wfIniGetBool( 'file_uploads' );
 108         }
 109
 110         /**
 111          * Returns true if the user can use this upload module or else a string
 112          * identifying the missing permission.
 113          * Can be overridden by subclasses.
 114          *
 115          * @param User $user
 116          * @return bool|string
 117          */
 118         public static function isAllowed( $user ) {
 119                 foreach ( array( 'upload', 'edit' ) as $permission ) {
 120                         if ( !$user->isAllowed( $permission ) ) {
 121                                 return $permission;
 122                         }
 123                 }
 124
 125                 return true;
 126         }
 127
 128         /**
 129          * Returns true if the user has surpassed the upload rate limit, false otherwise.
 130          *
 131          * @param User $user
 132          * @return bool
 133          */
 134         public static function isThrottled( $user ) {
 135                 return $user->pingLimiter( 'upload' );
 136         }
 137
 138         // Upload handlers. Should probably just be a global.
 139         private static $uploadHandlers = array( 'Stash', 'File', 'Url' );
 140
 141         /**
 142          * Create a form of UploadBase depending on wpSourceType and initializes it
 143          *
 144          * @param WebRequest $request
 145          * @param string|null $type
 146          * @return null|UploadBase
 147          */
 148         public static function createFromRequest( &$request, $type = null ) {
 149                 $type = $type ? $type : $request->getVal( 'wpSourceType', 'File' );
 150
 151                 if ( !$type ) {
 152                         return null;
 153                 }
 154
 155                 // Get the upload class
 156                 $type = ucfirst( $type );
 157
 158                 // Give hooks the chance to handle this request
 159                 $className = null;
 160                 Hooks::run( 'UploadCreateFromRequest', array( $type, &$className ) );
 161                 if ( is_null( $className ) ) {
 162                         $className = 'UploadFrom' . $type;
 163                         wfDebug( __METHOD__ . ": class name: $className\n" );
 164                         if ( !in_array( $type, self::$uploadHandlers ) ) {
 165                                 return null;
 166                         }
 167                 }
 168
 169                 // Check whether this upload class is enabled
 170                 if ( !call_user_func( array( $className, 'isEnabled' ) ) ) {
 171                         return null;
 172                 }
 173
 174                 // Check whether the request is valid
 175                 if ( !call_user_func( array( $className, 'isValidRequest' ), $request ) ) {
 176                         return null;
 177                 }
 178
 179                 /** @var UploadBase $handler */
 180                 $handler = new $className;
 181
 182                 $handler->initializeFromRequest( $request );
 183
 184                 return $handler;
 185         }
 186
 187         /**
 188          * Check whether a request if valid for this handler
 189          * @param WebRequest $request
 190          * @return bool
 191          */
 192         public static function isValidRequest( $request ) {
 193                 return false;
 194         }
 195
 196         public function __construct() {
 197         }
 198
 199         /**
 200          * Returns the upload type. Should be overridden by child classes
 201          *
 202          * @since 1.18
 203          * @return string
 204          */
 205         public function getSourceType() {
 206                 return null;
 207         }
 208
 209         /**
 210          * Initialize the path information
 211          * @param string $name The desired destination name
 212          * @param string $tempPath The temporary path
 213          * @param int $fileSize The file size
 214          * @param bool $removeTempFile (false) remove the temporary file?
 215          * @throws MWException
 216          */
 217         public function initializePathInfo( $name, $tempPath, $fileSize, $removeTempFile = false ) {
 218                 $this->mDesiredDestName = $name;
 219                 if ( FileBackend::isStoragePath( $tempPath ) ) {
 220                         throw new MWException( __METHOD__ . " given storage path `$tempPath`." );
 221                 }
 222                 $this->mTempPath = $tempPath;
 223                 $this->mFileSize = $fileSize;
 224                 $this->mRemoveTempFile = $removeTempFile;
 225         }
 226
 227         /**
 228          * Initialize from a WebRequest. Override this in a subclass.
 229          *
 230          * @param WebRequest $request
 231          */
 232         abstract public function initializeFromRequest( &$request );
 233
 234         /**
 235          * Fetch the file. Usually a no-op
 236          * @return Status
 237          */
 238         public function fetchFile() {
 239                 return Status::newGood();
 240         }
 241
 242         /**
 243          * Return true if the file is empty
 244          * @return bool
 245          */
 246         public function isEmptyFile() {
 247                 return empty( $this->mFileSize );
 248         }
 249
 250         /**
 251          * Return the file size
 252          * @return int
 253          */
 254         public function getFileSize() {
 255                 return $this->mFileSize;
 256         }
 257
 258         /**
 259          * Get the base 36 SHA1 of the file
 260          * @return string
 261          */
 262         public function getTempFileSha1Base36() {
 263                 return FSFile::getSha1Base36FromPath( $this->mTempPath );
 264         }
 265
 266         /**
 267          * @param string $srcPath The source path
 268          * @return string|bool The real path if it was a virtual URL Returns false on failure
 269          */
 270         function getRealPath( $srcPath ) {
 271                 $repo = RepoGroup::singleton()->getLocalRepo();
 272                 if ( $repo->isVirtualUrl( $srcPath ) ) {
 273                         /** @todo Just make uploads work with storage paths UploadFromStash
 274                          *  loads files via virtual URLs.
 275                          */
 276                         $tmpFile = $repo->getLocalCopy( $srcPath );
 277                         if ( $tmpFile ) {
 278                                 $tmpFile->bind( $this ); // keep alive with $this
 279                         }
 280                         $path = $tmpFile ? $tmpFile->getPath() : false;
 281                 } else {
 282                         $path = $srcPath;
 283                 }
 284
 285                 return $path;
 286         }
 287
 288         /**
 289          * Verify whether the upload is sane.
 290          * @return mixed Const self::OK or else an array with error information
 291          */
 292         public function verifyUpload() {
 293
 294                 /**
 295                  * If there was no filename or a zero size given, give up quick.
 296                  */
 297                 if ( $this->isEmptyFile() ) {
 298                         return array( 'status' => self::EMPTY_FILE );
 299                 }
 300
 301                 /**
 302                  * Honor $wgMaxUploadSize
 303                  */
 304                 $maxSize = self::getMaxUploadSize( $this->getSourceType() );
 305                 if ( $this->mFileSize > $maxSize ) {
 306                         return array(
 307                                 'status' => self::FILE_TOO_LARGE,
 308                                 'max' => $maxSize,
 309                         );
 310                 }
 311
 312                 /**
 313                  * Look at the contents of the file; if we can recognize the
 314                  * type but it's corrupt or data of the wrong type, we should
 315                  * probably not accept it.
 316                  */
 317                 $verification = $this->verifyFile();
 318                 if ( $verification !== true ) {
 319                         return array(
 320                                 'status' => self::VERIFICATION_ERROR,
 321                                 'details' => $verification
 322                         );
 323                 }
 324
 325                 /**
 326                  * Make sure this file can be created
 327                  */
 328                 $result = $this->validateName();
 329                 if ( $result !== true ) {
 330                         return $result;
 331                 }
 332
 333                 $error = '';
 334                 if ( !Hooks::run( 'UploadVerification',
 335                         array( $this->mDestName, $this->mTempPath, &$error ) )
 336                 ) {
 337                         return array( 'status' => self::HOOK_ABORTED, 'error' => $error );
 338                 }
 339
 340                 return array( 'status' => self::OK );
 341         }
 342
 343         /**
 344          * Verify that the name is valid and, if necessary, that we can overwrite
 345          *
 346          * @return mixed True if valid, otherwise and array with 'status'
 347          * and other keys
 348          */
 349         public function validateName() {
 350                 $nt = $this->getTitle();
 351                 if ( is_null( $nt ) ) {
 352                         $result = array( 'status' => $this->mTitleError );
 353                         if ( $this->mTitleError == self::ILLEGAL_FILENAME ) {
 354                                 $result['filtered'] = $this->mFilteredName;
 355                         }
 356                         if ( $this->mTitleError == self::FILETYPE_BADTYPE ) {
 357                                 $result['finalExt'] = $this->mFinalExtension;
 358                                 if ( count( $this->mBlackListedExtensions ) ) {
 359                                         $result['blacklistedExt'] = $this->mBlackListedExtensions;
 360                                 }
 361                         }
 362
 363                         return $result;
 364                 }
 365                 $this->mDestName = $this->getLocalFile()->getName();
 366
 367                 return true;
 368         }
 369
 370         /**
 371          * Verify the MIME type.
 372          *
 373          * @note Only checks that it is not an evil MIME. The "does it have
 374          *  correct extension given its MIME type?" check is in verifyFile.
 375          *  in `verifyFile()` that MIME type and file extension correlate.
 376          * @param string $mime Representing the MIME
 377          * @return mixed True if the file is verified, an array otherwise
 378          */
 379         protected function verifyMimeType( $mime ) {
 380                 global $wgVerifyMimeType;
 381                 if ( $wgVerifyMimeType ) {
 382                         wfDebug( "mime: <$mime> extension: <{$this->mFinalExtension}>\n" );
 383                         global $wgMimeTypeBlacklist;
 384                         if ( $this->checkFileExtension( $mime, $wgMimeTypeBlacklist ) ) {
 385                                 return array( 'filetype-badmime', $mime );
 386                         }
 387
 388                         # Check what Internet Explorer would detect
 389                         $fp = fopen( $this->mTempPath, 'rb' );
 390                         $chunk = fread( $fp, 256 );
 391                         fclose( $fp );
 392
 393                         $magic = MimeMagic::singleton();
 394                         $extMime = $magic->guessTypesForExtension( $this->mFinalExtension );
 395                         $ieTypes = $magic->getIEMimeTypes( $this->mTempPath, $chunk, $extMime );
 396                         foreach ( $ieTypes as $ieType ) {
 397                                 if ( $this->checkFileExtension( $ieType, $wgMimeTypeBlacklist ) ) {
 398                                         return array( 'filetype-bad-ie-mime', $ieType );
 399                                 }
 400                         }
 401                 }
 402
 403                 return true;
 404         }
 405
 406         /**
 407          * Verifies that it's ok to include the uploaded file
 408          *
 409          * @return mixed True of the file is verified, array otherwise.
 410          */
 411         protected function verifyFile() {
 412                 global $wgVerifyMimeType, $wgDisableUploadScriptChecks;
 413
 414                 $status = $this->verifyPartialFile();
 415                 if ( $status !== true ) {
 416                         return $status;
 417                 }
 418
 419                 $this->mFileProps = FSFile::getPropsFromPath( $this->mTempPath, $this->mFinalExtension );
 420                 $mime = $this->mFileProps['mime'];
 421
 422                 if ( $wgVerifyMimeType ) {
 423                         # XXX: Missing extension will be caught by validateName() via getTitle()
 424                         if ( $this->mFinalExtension != '' && !$this->verifyExtension( $mime, $this->mFinalExtension ) ) {
 425                                 return array( 'filetype-mime-mismatch', $this->mFinalExtension, $mime );
 426                         }
 427                 }
 428
 429                 # check for htmlish code and javascript
 430                 if ( !$wgDisableUploadScriptChecks ) {
 431                         if ( $this->mFinalExtension == 'svg' || $mime == 'image/svg+xml' ) {
 432                                 $svgStatus = $this->detectScriptInSvg( $this->mTempPath, false );
 433                                 if ( $svgStatus !== false ) {
 434                                         return $svgStatus;
 435                                 }
 436                         }
 437                 }
 438
 439                 $handler = MediaHandler::getHandler( $mime );
 440                 if ( $handler ) {
 441                         $handlerStatus = $handler->verifyUpload( $this->mTempPath );
 442                         if ( !$handlerStatus->isOK() ) {
 443                                 $errors = $handlerStatus->getErrorsArray();
 444
 445                                 return reset( $errors );
 446                         }
 447                 }
 448
 449                 Hooks::run( 'UploadVerifyFile', array( $this, $mime, &$status ) );
 450                 if ( $status !== true ) {
 451                         return $status;
 452                 }
 453
 454                 wfDebug( __METHOD__ . ": all clear; passing.\n" );
 455
 456                 return true;
 457         }
 458
 459         /**
 460          * A verification routine suitable for partial files
 461          *
 462          * Runs the blacklist checks, but not any checks that may
 463          * assume the entire file is present.
 464          *
 465          * @return mixed True for valid or array with error message key.
 466          */
 467         protected function verifyPartialFile() {
 468                 global $wgAllowJavaUploads, $wgDisableUploadScriptChecks;
 469
 470                 # getTitle() sets some internal parameters like $this->mFinalExtension
 471                 $this->getTitle();
 472
 473                 $this->mFileProps = FSFile::getPropsFromPath( $this->mTempPath, $this->mFinalExtension );
 474
 475                 # check MIME type, if desired
 476                 $mime = $this->mFileProps['file-mime'];
 477                 $status = $this->verifyMimeType( $mime );
 478                 if ( $status !== true ) {
 479                         return $status;
 480                 }
 481
 482                 # check for htmlish code and javascript
 483                 if ( !$wgDisableUploadScriptChecks ) {
 484                         if ( self::detectScript( $this->mTempPath, $mime, $this->mFinalExtension ) ) {
 485                                 return array( 'uploadscripted' );
 486                         }
 487                         if ( $this->mFinalExtension == 'svg' || $mime == 'image/svg+xml' ) {
 488                                 $svgStatus = $this->detectScriptInSvg( $this->mTempPath, true );
 489                                 if ( $svgStatus !== false ) {
 490                                         return $svgStatus;
 491                                 }
 492                         }
 493                 }
 494
 495                 # Check for Java applets, which if uploaded can bypass cross-site
 496                 # restrictions.
 497                 if ( !$wgAllowJavaUploads ) {
 498                         $this->mJavaDetected = false;
 499                         $zipStatus = ZipDirectoryReader::read( $this->mTempPath,
 500                                 array( $this, 'zipEntryCallback' ) );
 501                         if ( !$zipStatus->isOK() ) {
 502                                 $errors = $zipStatus->getErrorsArray();
 503                                 $error = reset( $errors );
 504                                 if ( $error[0] !== 'zip-wrong-format' ) {
 505                                         return $error;
 506                                 }
 507                         }
 508                         if ( $this->mJavaDetected ) {
 509                                 return array( 'uploadjava' );
 510                         }
 511                 }
 512
 513                 # Scan the uploaded file for viruses
 514                 $virus = $this->detectVirus( $this->mTempPath );
 515                 if ( $virus ) {
 516                         return array( 'uploadvirus', $virus );
 517                 }
 518
 519                 return true;
 520         }
 521
 522         /**
 523          * Callback for ZipDirectoryReader to detect Java class files.
 524          *
 525          * @param array $entry
 526          */
 527         function zipEntryCallback( $entry ) {
 528                 $names = array( $entry['name'] );
 529
 530                 // If there is a null character, cut off the name at it, because JDK's
 531                 // ZIP_GetEntry() uses strcmp() if the name hashes match. If a file name
 532                 // were constructed which had ".class\0" followed by a string chosen to
 533                 // make the hash collide with the truncated name, that file could be
 534                 // returned in response to a request for the .class file.
 535                 $nullPos = strpos( $entry['name'], "\000" );
 536                 if ( $nullPos !== false ) {
 537                         $names[] = substr( $entry['name'], 0, $nullPos );
 538                 }
 539
 540                 // If there is a trailing slash in the file name, we have to strip it,
 541                 // because that's what ZIP_GetEntry() does.
 542                 if ( preg_grep( '!\.class/?$!', $names ) ) {
 543                         $this->mJavaDetected = true;
 544                 }
 545         }
 546
 547         /**
 548          * Alias for verifyTitlePermissions. The function was originally
 549          * 'verifyPermissions', but that suggests it's checking the user, when it's
 550          * really checking the title + user combination.
 551          *
 552          * @param User $user User object to verify the permissions against
 553          * @return mixed An array as returned by getUserPermissionsErrors or true
 554          *   in case the user has proper permissions.
 555          */
 556         public function verifyPermissions( $user ) {
 557                 return $this->verifyTitlePermissions( $user );
 558         }
 559
 560         /**
 561          * Check whether the user can edit, upload and create the image. This
 562          * checks only against the current title; if it returns errors, it may
 563          * very well be that another title will not give errors. Therefore
 564          * isAllowed() should be called as well for generic is-user-blocked or
 565          * can-user-upload checking.
 566          *
 567          * @param User $user User object to verify the permissions against
 568          * @return mixed An array as returned by getUserPermissionsErrors or true
 569          *   in case the user has proper permissions.
 570          */
 571         public function verifyTitlePermissions( $user ) {
 572                 /**
 573                  * If the image is protected, non-sysop users won't be able
 574                  * to modify it by uploading a new revision.
 575                  */
 576                 $nt = $this->getTitle();
 577                 if ( is_null( $nt ) ) {
 578                         return true;
 579                 }
 580                 $permErrors = $nt->getUserPermissionsErrors( 'edit', $user );
 581                 $permErrorsUpload = $nt->getUserPermissionsErrors( 'upload', $user );
 582                 if ( !$nt->exists() ) {
 583                         $permErrorsCreate = $nt->getUserPermissionsErrors( 'create', $user );
 584                 } else {
 585                         $permErrorsCreate = array();
 586                 }
 587                 if ( $permErrors || $permErrorsUpload || $permErrorsCreate ) {
 588                         $permErrors = array_merge( $permErrors, wfArrayDiff2( $permErrorsUpload, $permErrors ) );
 589                         $permErrors = array_merge( $permErrors, wfArrayDiff2( $permErrorsCreate, $permErrors ) );
 590
 591                         return $permErrors;
 592                 }
 593
 594                 $overwriteError = $this->checkOverwrite( $user );
 595                 if ( $overwriteError !== true ) {
 596                         return array( $overwriteError );
 597                 }
 598
 599                 return true;
 600         }
 601
 602         /**
 603          * Check for non fatal problems with the file.
 604          *
 605          * This should not assume that mTempPath is set.
 606          *
 607          * @return array Array of warnings
 608          */
 609         public function checkWarnings() {
 610                 global $wgLang;
 611
 612                 $warnings = array();
 613
 614                 $localFile = $this->getLocalFile();
 615                 $localFile->load( File::READ_LATEST );
 616                 $filename = $localFile->getName();
 617
 618                 /**
 619                  * Check whether the resulting filename is different from the desired one,
 620                  * but ignore things like ucfirst() and spaces/underscore things
 621                  */
 622                 $comparableName = str_replace( ' ', '_', $this->mDesiredDestName );
 623                 $comparableName = Title::capitalize( $comparableName, NS_FILE );
 624
 625                 if ( $this->mDesiredDestName != $filename && $comparableName != $filename ) {
 626                         $warnings['badfilename'] = $filename;
 627                         // Debugging for bug 62241
 628                         wfDebugLog( 'upload', "Filename: '$filename', mDesiredDestName: "
 629                                 . "'$this->mDesiredDestName', comparableName: '$comparableName'" );
 630                 }
 631
 632                 // Check whether the file extension is on the unwanted list
 633                 global $wgCheckFileExtensions, $wgFileExtensions;
 634                 if ( $wgCheckFileExtensions ) {
 635                         $extensions = array_unique( $wgFileExtensions );
 636                         if ( !$this->checkFileExtension( $this->mFinalExtension, $extensions ) ) {
 637                                 $warnings['filetype-unwanted-type'] = array( $this->mFinalExtension,
 638                                         $wgLang->commaList( $extensions ), count( $extensions ) );
 639                         }
 640                 }
 641
 642                 global $wgUploadSizeWarning;
 643                 if ( $wgUploadSizeWarning && ( $this->mFileSize > $wgUploadSizeWarning ) ) {
 644                         $warnings['large-file'] = array( $wgUploadSizeWarning, $this->mFileSize );
 645                 }
 646
 647                 if ( $this->mFileSize == 0 ) {
 648                         $warnings['emptyfile'] = true;
 649                 }
 650
 651                 $exists = self::getExistsWarning( $localFile );
 652                 if ( $exists !== false ) {
 653                         $warnings['exists'] = $exists;
 654                 }
 655
 656                 if ( $localFile->wasDeleted() && !$localFile->exists() ) {
 657                         $warnings['was-deleted'] = $filename;
 658                 }
 659
 660                 // Check dupes against existing files
 661                 $hash = $this->getTempFileSha1Base36();
 662                 $dupes = RepoGroup::singleton()->findBySha1( $hash );
 663                 $title = $this->getTitle();
 664                 // Remove all matches against self
 665                 foreach ( $dupes as $key => $dupe ) {
 666                         if ( $title->equals( $dupe->getTitle() ) ) {
 667                                 unset( $dupes[$key] );
 668                         }
 669                 }
 670                 if ( $dupes ) {
 671                         $warnings['duplicate'] = $dupes;
 672                 }
 673
 674                 // Check dupes against archives
 675                 $archivedFile = new ArchivedFile( null, 0, '', $hash );
 676                 if ( $archivedFile->getID() > 0 ) {
 677                         if ( $archivedFile->userCan( File::DELETED_FILE ) ) {
 678                                 $warnings['duplicate-archive'] = $archivedFile->getName();
 679                         } else {
 680                                 $warnings['duplicate-archive'] = '';
 681                         }
 682                 }
 683
 684                 return $warnings;
 685         }
 686
 687         /**
 688          * Really perform the upload. Stores the file in the local repo, watches
 689          * if necessary and runs the UploadComplete hook.
 690          *
 691          * @param string $comment
 692          * @param string $pageText
 693          * @param bool $watch
 694          * @param User $user
 695          *
 696          * @return Status Indicating the whether the upload succeeded.
 697          */
 698         public function performUpload( $comment, $pageText, $watch, $user ) {
 699                 $this->getLocalFile()->load( File::READ_LATEST );
 700
 701                 $status = $this->getLocalFile()->upload(
 702                         $this->mTempPath,
 703                         $comment,
 704                         $pageText,
 705                         File::DELETE_SOURCE,
 706                         $this->mFileProps,
 707                         false,
 708                         $user
 709                 );
 710
 711                 if ( $status->isGood() ) {
 712                         if ( $watch ) {
 713                                 WatchAction::doWatch(
 714                                         $this->getLocalFile()->getTitle(),
 715                                         $user,
 716                                         WatchedItem::IGNORE_USER_RIGHTS
 717                                 );
 718                         }
 719                         Hooks::run( 'UploadComplete', array( &$this ) );
 720
 721                         $this->postProcessUpload();
 722                 }
 723
 724                 return $status;
 725         }
 726
 727         /**
 728          * Perform extra steps after a successful upload.
 729          *
 730          * @since  1.25
 731          */
 732         public function postProcessUpload() {
 733                 global $wgUploadThumbnailRenderMap;
 734
 735                 $jobs = array();
 736
 737                 $sizes = $wgUploadThumbnailRenderMap;
 738                 rsort( $sizes );
 739
 740                 $file = $this->getLocalFile();
 741
 742                 foreach ( $sizes as $size ) {
 743                         if ( $file->isVectorized() || $file->getWidth() > $size ) {
 744                                 $jobs[] = new ThumbnailRenderJob(
 745                                         $file->getTitle(),
 746                                         array( 'transformParams' => array( 'width' => $size ) )
 747                                 );
 748                         }
 749                 }
 750
 751                 if ( $jobs ) {
 752                         JobQueueGroup::singleton()->push( $jobs );
 753                 }
 754         }
 755
 756         /**
 757          * Returns the title of the file to be uploaded. Sets mTitleError in case
 758          * the name was illegal.
 759          *
 760          * @return Title The title of the file or null in case the name was illegal
 761          */
 762         public function getTitle() {
 763                 if ( $this->mTitle !== false ) {
 764                         return $this->mTitle;
 765                 }
 766                 if ( !is_string( $this->mDesiredDestName ) ) {
 767                         $this->mTitleError = self::ILLEGAL_FILENAME;
 768                         $this->mTitle = null;
 769
 770                         return $this->mTitle;
 771                 }
 772                 /* Assume that if a user specified File:Something.jpg, this is an error
 773                  * and that the namespace prefix needs to be stripped of.
 774                  */
 775                 $title = Title::newFromText( $this->mDesiredDestName );
 776                 if ( $title && $title->getNamespace() == NS_FILE ) {
 777                         $this->mFilteredName = $title->getDBkey();
 778                 } else {
 779                         $this->mFilteredName = $this->mDesiredDestName;
 780                 }
 781
 782                 # oi_archive_name is max 255 bytes, which include a timestamp and an
 783                 # exclamation mark, so restrict file name to 240 bytes.
 784                 if ( strlen( $this->mFilteredName ) > 240 ) {
 785                         $this->mTitleError = self::FILENAME_TOO_LONG;
 786                         $this->mTitle = null;
 787
 788                         return $this->mTitle;
 789                 }
 790
 791                 /**
 792                  * Chop off any directories in the given filename. Then
 793                  * filter out illegal characters, and try to make a legible name
 794                  * out of it. We'll strip some silently that Title would die on.
 795                  */
 796                 $this->mFilteredName = wfStripIllegalFilenameChars( $this->mFilteredName );
 797                 /* Normalize to title form before we do any further processing */
 798                 $nt = Title::makeTitleSafe( NS_FILE, $this->mFilteredName );
 799                 if ( is_null( $nt ) ) {
 800                         $this->mTitleError = self::ILLEGAL_FILENAME;
 801                         $this->mTitle = null;
 802
 803                         return $this->mTitle;
 804                 }
 805                 $this->mFilteredName = $nt->getDBkey();
 806
 807                 /**
 808                  * We'll want to blacklist against *any* 'extension', and use
 809                  * only the final one for the whitelist.
 810                  */
 811                 list( $partname, $ext ) = $this->splitExtensions( $this->mFilteredName );
 812
 813                 if ( count( $ext ) ) {
 814                         $this->mFinalExtension = trim( $ext[count( $ext ) - 1] );
 815                 } else {
 816                         $this->mFinalExtension = '';
 817
 818                         # No extension, try guessing one
 819                         $magic = MimeMagic::singleton();
 820                         $mime = $magic->guessMimeType( $this->mTempPath );
 821                         if ( $mime !== 'unknown/unknown' ) {
 822                                 # Get a space separated list of extensions
 823                                 $extList = $magic->getExtensionsForType( $mime );
 824                                 if ( $extList ) {
 825                                         # Set the extension to the canonical extension
 826                                         $this->mFinalExtension = strtok( $extList, ' ' );
 827
 828                                         # Fix up the other variables
 829                                         $this->mFilteredName .= ".{$this->mFinalExtension}";
 830                                         $nt = Title::makeTitleSafe( NS_FILE, $this->mFilteredName );
 831                                         $ext = array( $this->mFinalExtension );
 832                                 }
 833                         }
 834                 }
 835
 836                 /* Don't allow users to override the blacklist (check file extension) */
 837                 global $wgCheckFileExtensions, $wgStrictFileExtensions;
 838                 global $wgFileExtensions, $wgFileBlacklist;
 839
 840                 $blackListedExtensions = $this->checkFileExtensionList( $ext, $wgFileBlacklist );
 841
 842                 if ( $this->mFinalExtension == '' ) {
 843                         $this->mTitleError = self::FILETYPE_MISSING;
 844                         $this->mTitle = null;
 845
 846                         return $this->mTitle;
 847                 } elseif ( $blackListedExtensions ||
 848                         ( $wgCheckFileExtensions && $wgStrictFileExtensions &&
 849                                 !$this->checkFileExtension( $this->mFinalExtension, $wgFileExtensions ) )
 850                 ) {
 851                         $this->mBlackListedExtensions = $blackListedExtensions;
 852                         $this->mTitleError = self::FILETYPE_BADTYPE;
 853                         $this->mTitle = null;
 854
 855                         return $this->mTitle;
 856                 }
 857
 858                 // Windows may be broken with special characters, see bug 1780
 859                 if ( !preg_match( '/^[\x0-\x7f]*$/', $nt->getText() )
 860                         && !RepoGroup::singleton()->getLocalRepo()->backendSupportsUnicodePaths()
 861                 ) {
 862                         $this->mTitleError = self::WINDOWS_NONASCII_FILENAME;
 863                         $this->mTitle = null;
 864
 865                         return $this->mTitle;
 866                 }
 867
 868                 # If there was more than one "extension", reassemble the base
 869                 # filename to prevent bogus complaints about length
 870                 if ( count( $ext ) > 1 ) {
 871                         $iterations = count( $ext ) - 1;
 872                         for ( $i = 0; $i < $iterations; $i++ ) {
 873                                 $partname .= '.' . $ext[$i];
 874                         }
 875                 }
 876
 877                 if ( strlen( $partname ) < 1 ) {
 878                         $this->mTitleError = self::MIN_LENGTH_PARTNAME;
 879                         $this->mTitle = null;
 880
 881                         return $this->mTitle;
 882                 }
 883
 884                 $this->mTitle = $nt;
 885
 886                 return $this->mTitle;
 887         }
 888
 889         /**
 890          * Return the local file and initializes if necessary.
 891          *
 892          * @return LocalFile|UploadStashFile|null
 893          */
 894         public function getLocalFile() {
 895                 if ( is_null( $this->mLocalFile ) ) {
 896                         $nt = $this->getTitle();
 897                         $this->mLocalFile = is_null( $nt ) ? null : wfLocalFile( $nt );
 898                 }
 899
 900                 return $this->mLocalFile;
 901         }
 902
 903         /**
 904          * If the user does not supply all necessary information in the first upload
 905          * form submission (either by accident or by design) then we may want to
 906          * stash the file temporarily, get more information, and publish the file
 907          * later.
 908          *
 909          * This method will stash a file in a temporary directory for later
 910          * processing, and save the necessary descriptive info into the database.
 911          * This method returns the file object, which also has a 'fileKey' property
 912          * which can be passed through a form or API request to find this stashed
 913          * file again.
 914          *
 915          * @param User $user
 916          * @return UploadStashFile Stashed file
 917          */
 918         public function stashFile( User $user = null ) {
 919                 // was stashSessionFile
 920
 921                 $stash = RepoGroup::singleton()->getLocalRepo()->getUploadStash( $user );
 922                 $file = $stash->stashFile( $this->mTempPath, $this->getSourceType() );
 923                 $this->mLocalFile = $file;
 924
 925                 return $file;
 926         }
 927
 928         /**
 929          * Stash a file in a temporary directory, returning a key which can be used
 930          * to find the file again. See stashFile().
 931          *
 932          * @return string File key
 933          */
 934         public function stashFileGetKey() {
 935                 return $this->stashFile()->getFileKey();
 936         }
 937
 938         /**
 939          * alias for stashFileGetKey, for backwards compatibility
 940          *
 941          * @return string File key
 942          */
 943         public function stashSession() {
 944                 return $this->stashFileGetKey();
 945         }
 946
 947         /**
 948          * If we've modified the upload file we need to manually remove it
 949          * on exit to clean up.
 950          */
 951         public function cleanupTempFile() {
 952                 if ( $this->mRemoveTempFile && $this->mTempPath && file_exists( $this->mTempPath ) ) {
 953                         wfDebug( __METHOD__ . ": Removing temporary file {$this->mTempPath}\n" );
 954                         unlink( $this->mTempPath );
 955                 }
 956         }
 957
 958         public function getTempPath() {
 959                 return $this->mTempPath;
 960         }
 961
 962         /**
 963          * Split a file into a base name and all dot-delimited 'extensions'
 964          * on the end. Some web server configurations will fall back to
 965          * earlier pseudo-'extensions' to determine type and execute
 966          * scripts, so the blacklist needs to check them all.
 967          *
 968          * @param string $filename
 969          * @return array
 970          */
 971         public static function splitExtensions( $filename ) {
 972                 $bits = explode( '.', $filename );
 973                 $basename = array_shift( $bits );
 974
 975                 return array( $basename, $bits );
 976         }
 977
 978         /**
 979          * Perform case-insensitive match against a list of file extensions.
 980          * Returns true if the extension is in the list.
 981          *
 982          * @param string $ext
 983          * @param array $list
 984          * @return bool
 985          */
 986         public static function checkFileExtension( $ext, $list ) {
 987                 return in_array( strtolower( $ext ), $list );
 988         }
 989
 990         /**
 991          * Perform case-insensitive match against a list of file extensions.
 992          * Returns an array of matching extensions.
 993          *
 994          * @param array $ext
 995          * @param array $list
 996          * @return bool
 997          */
 998         public static function checkFileExtensionList( $ext, $list ) {
 999                 return array_intersect( array_map( 'strtolower', $ext ), $list );
1000         }
1001
1002         /**
1003          * Checks if the MIME type of the uploaded file matches the file extension.
1004          *
1005          * @param string $mime The MIME type of the uploaded file
1006          * @param string $extension The filename extension that the file is to be served with
1007          * @return bool
1008          */
1009         public static function verifyExtension( $mime, $extension ) {
1010                 $magic = MimeMagic::singleton();
1011
1012                 if ( !$mime || $mime == 'unknown' || $mime == 'unknown/unknown' ) {
1013                         if ( !$magic->isRecognizableExtension( $extension ) ) {
1014                                 wfDebug( __METHOD__ . ": passing file with unknown detected mime type; " .
1015                                         "unrecognized extension '$extension', can't verify\n" );
1016
1017                                 return true;
1018                         } else {
1019                                 wfDebug( __METHOD__ . ": rejecting file with unknown detected mime type; " .
1020                                         "recognized extension '$extension', so probably invalid file\n" );
1021
1022                                 return false;
1023                         }
1024                 }
1025
1026                 $match = $magic->isMatchingExtension( $extension, $mime );
1027
1028                 if ( $match === null ) {
1029                         if ( $magic->getTypesForExtension( $extension ) !== null ) {
1030                                 wfDebug( __METHOD__ . ": No extension known for $mime, but we know a mime for $extension\n" );
1031
1032                                 return false;
1033                         } else {
1034                                 wfDebug( __METHOD__ . ": no file extension known for mime type $mime, passing file\n" );
1035
1036                                 return true;
1037                         }
1038                 } elseif ( $match === true ) {
1039                         wfDebug( __METHOD__ . ": mime type $mime matches extension $extension, passing file\n" );
1040
1041                         /** @todo If it's a bitmap, make sure PHP or ImageMagick resp. can handle it! */
1042                         return true;
1043                 } else {
1044                         wfDebug( __METHOD__
1045                                 . ": mime type $mime mismatches file extension $extension, rejecting file\n" );
1046
1047                         return false;
1048                 }
1049         }
1050
1051         /**
1052          * Heuristic for detecting files that *could* contain JavaScript instructions or
1053          * things that may look like HTML to a browser and are thus
1054          * potentially harmful. The present implementation will produce false
1055          * positives in some situations.
1056          *
1057          * @param string $file Pathname to the temporary upload file
1058          * @param string $mime The MIME type of the file
1059          * @param string $extension The extension of the file
1060          * @return bool True if the file contains something looking like embedded scripts
1061          */
1062         public static function detectScript( $file, $mime, $extension ) {
1063                 global $wgAllowTitlesInSVG;
1064
1065                 # ugly hack: for text files, always look at the entire file.
1066                 # For binary field, just check the first K.
1067
1068                 if ( strpos( $mime, 'text/' ) === 0 ) {
1069                         $chunk = file_get_contents( $file );
1070                 } else {
1071                         $fp = fopen( $file, 'rb' );
1072                         $chunk = fread( $fp, 1024 );
1073                         fclose( $fp );
1074                 }
1075
1076                 $chunk = strtolower( $chunk );
1077
1078                 if ( !$chunk ) {
1079                         return false;
1080                 }
1081
1082                 # decode from UTF-16 if needed (could be used for obfuscation).
1083                 if ( substr( $chunk, 0, 2 ) == "\xfe\xff" ) {
1084                         $enc = 'UTF-16BE';
1085                 } elseif ( substr( $chunk, 0, 2 ) == "\xff\xfe" ) {
1086                         $enc = 'UTF-16LE';
1087                 } else {
1088                         $enc = null;
1089                 }
1090
1091                 if ( $enc ) {
1092                         $chunk = iconv( $enc, "ASCII//IGNORE", $chunk );
1093                 }
1094
1095                 $chunk = trim( $chunk );
1096
1097                 /** @todo FIXME: Convert from UTF-16 if necessary! */
1098                 wfDebug( __METHOD__ . ": checking for embedded scripts and HTML stuff\n" );
1099
1100                 # check for HTML doctype
1101                 if ( preg_match( "/<!DOCTYPE *X?HTML/i", $chunk ) ) {
1102                         return true;
1103                 }
1104
1105                 // Some browsers will interpret obscure xml encodings as UTF-8, while
1106                 // PHP/expat will interpret the given encoding in the xml declaration (bug 47304)
1107                 if ( $extension == 'svg' || strpos( $mime, 'image/svg' ) === 0 ) {
1108                         if ( self::checkXMLEncodingMissmatch( $file ) ) {
1109                                 return true;
1110                         }
1111                 }
1112
1113                 /**
1114                  * Internet Explorer for Windows performs some really stupid file type
1115                  * autodetection which can cause it to interpret valid image files as HTML
1116                  * and potentially execute JavaScript, creating a cross-site scripting
1117                  * attack vectors.
1118                  *
1119                  * Apple's Safari browser also performs some unsafe file type autodetection
1120                  * which can cause legitimate files to be interpreted as HTML if the
1121                  * web server is not correctly configured to send the right content-type
1122                  * (or if you're really uploading plain text and octet streams!)
1123                  *
1124                  * Returns true if IE is likely to mistake the given file for HTML.
1125                  * Also returns true if Safari would mistake the given file for HTML
1126                  * when served with a generic content-type.
1127                  */
1128                 $tags = array(
1129                         '<a href',
1130                         '<body',
1131                         '<head',
1132                         '<html', # also in safari
1133                         '<img',
1134                         '<pre',
1135                         '<script', # also in safari
1136                         '<table'
1137                 );
1138
1139                 if ( !$wgAllowTitlesInSVG && $extension !== 'svg' && $mime !== 'image/svg' ) {
1140                         $tags[] = '<title';
1141                 }
1142
1143                 foreach ( $tags as $tag ) {
1144                         if ( false !== strpos( $chunk, $tag ) ) {
1145                                 wfDebug( __METHOD__ . ": found something that may make it be mistaken for html: $tag\n" );
1146
1147                                 return true;
1148                         }
1149                 }
1150
1151                 /*
1152                  * look for JavaScript
1153                  */
1154
1155                 # resolve entity-refs to look at attributes. may be harsh on big files... cache result?
1156                 $chunk = Sanitizer::decodeCharReferences( $chunk );
1157
1158                 # look for script-types
1159                 if ( preg_match( '!type\s*=\s*[\'"]?\s*(?:\w*/)?(?:ecma|java)!sim', $chunk ) ) {
1160                         wfDebug( __METHOD__ . ": found script types\n" );
1161
1162                         return true;
1163                 }
1164
1165                 # look for html-style script-urls
1166                 if ( preg_match( '!(?:href|src|data)\s*=\s*[\'"]?\s*(?:ecma|java)script:!sim', $chunk ) ) {
1167                         wfDebug( __METHOD__ . ": found html-style script urls\n" );
1168
1169                         return true;
1170                 }
1171
1172                 # look for css-style script-urls
1173                 if ( preg_match( '!url\s*\(\s*[\'"]?\s*(?:ecma|java)script:!sim', $chunk ) ) {
1174                         wfDebug( __METHOD__ . ": found css-style script urls\n" );
1175
1176                         return true;
1177                 }
1178
1179                 wfDebug( __METHOD__ . ": no scripts found\n" );
1180
1181                 return false;
1182         }
1183
1184         /**
1185          * Check a whitelist of xml encodings that are known not to be interpreted differently
1186          * by the server's xml parser (expat) and some common browsers.
1187          *
1188          * @param string $file Pathname to the temporary upload file
1189          * @return bool True if the file contains an encoding that could be misinterpreted
1190          */
1191         public static function checkXMLEncodingMissmatch( $file ) {
1192                 global $wgSVGMetadataCutoff;
1193                 $contents = file_get_contents( $file, false, null, -1, $wgSVGMetadataCutoff );
1194                 $encodingRegex = '!encoding[ \t\n\r]*=[ \t\n\r]*[\'"](.*?)[\'"]!si';
1195
1196                 if ( preg_match( "!<\?xml\b(.*?)\?>!si", $contents, $matches ) ) {
1197                         if ( preg_match( $encodingRegex, $matches[1], $encMatch )
1198                                 && !in_array( strtoupper( $encMatch[1] ), self::$safeXmlEncodings )
1199                         ) {
1200                                 wfDebug( __METHOD__ . ": Found unsafe XML encoding '{$encMatch[1]}'\n" );
1201
1202                                 return true;
1203                         }
1204                 } elseif ( preg_match( "!<\?xml\b!si", $contents ) ) {
1205                         // Start of XML declaration without an end in the first $wgSVGMetadataCutoff
1206                         // bytes. There shouldn't be a legitimate reason for this to happen.
1207                         wfDebug( __METHOD__ . ": Unmatched XML declaration start\n" );
1208
1209                         return true;
1210                 } elseif ( substr( $contents, 0, 4 ) == "\x4C\x6F\xA7\x94" ) {
1211                         // EBCDIC encoded XML
1212                         wfDebug( __METHOD__ . ": EBCDIC Encoded XML\n" );
1213
1214                         return true;
1215                 }
1216
1217                 // It's possible the file is encoded with multi-byte encoding, so re-encode attempt to
1218                 // detect the encoding in case is specifies an encoding not whitelisted in self::$safeXmlEncodings
1219                 $attemptEncodings = array( 'UTF-16', 'UTF-16BE', 'UTF-32', 'UTF-32BE' );
1220                 foreach ( $attemptEncodings as $encoding ) {
1221                         MediaWiki\suppressWarnings();
1222                         $str = iconv( $encoding, 'UTF-8', $contents );
1223                         MediaWiki\restoreWarnings();
1224                         if ( $str != '' && preg_match( "!<\?xml\b(.*?)\?>!si", $str, $matches ) ) {
1225                                 if ( preg_match( $encodingRegex, $matches[1], $encMatch )
1226                                         && !in_array( strtoupper( $encMatch[1] ), self::$safeXmlEncodings )
1227                                 ) {
1228                                         wfDebug( __METHOD__ . ": Found unsafe XML encoding '{$encMatch[1]}'\n" );
1229
1230                                         return true;
1231                                 }
1232                         } elseif ( $str != '' && preg_match( "!<\?xml\b!si", $str ) ) {
1233                                 // Start of XML declaration without an end in the first $wgSVGMetadataCutoff
1234                                 // bytes. There shouldn't be a legitimate reason for this to happen.
1235                                 wfDebug( __METHOD__ . ": Unmatched XML declaration start\n" );
1236
1237                                 return true;
1238                         }
1239                 }
1240
1241                 return false;
1242         }
1243
1244         /**
1245          * @param string $filename
1246          * @param bool $partial
1247          * @return mixed False of the file is verified (does not contain scripts), array otherwise.
1248          */
1249         protected function detectScriptInSvg( $filename, $partial ) {
1250                 $this->mSVGNSError = false;
1251                 $check = new XmlTypeCheck(
1252                         $filename,
1253                         array( $this, 'checkSvgScriptCallback' ),
1254                         true,
1255                         array( 'processing_instruction_handler' => 'UploadBase::checkSvgPICallback' )
1256                 );
1257                 if ( $check->wellFormed !== true ) {
1258                         // Invalid xml (bug 58553)
1259                         // But only when non-partial (bug 65724)
1260                         return $partial ? false : array( 'uploadinvalidxml' );
1261                 } elseif ( $check->filterMatch ) {
1262                         if ( $this->mSVGNSError ) {
1263                                 return array( 'uploadscriptednamespace', $this->mSVGNSError );
1264                         }
1265
1266                         return $check->filterMatchType;
1267                 }
1268
1269                 return false;
1270         }
1271
1272         /**
1273          * Callback to filter SVG Processing Instructions.
1274          * @param string $target Processing instruction name
1275          * @param string $data Processing instruction attribute and value
1276          * @return bool (true if the filter identified something bad)
1277          */
1278         public static function checkSvgPICallback( $target, $data ) {
1279                 // Don't allow external stylesheets (bug 57550)
1280                 if ( preg_match( '/xml-stylesheet/i', $target ) ) {
1281                         return array( 'upload-scripted-pi-callback' );
1282                 }
1283
1284                 return false;
1285         }
1286
1287         /**
1288          * @todo Replace this with a whitelist filter!
1289          * @param string $element
1290          * @param array $attribs
1291          * @return bool
1292          */
1293         public function checkSvgScriptCallback( $element, $attribs, $data = null ) {
1294
1295                 list( $namespace, $strippedElement ) = $this->splitXmlNamespace( $element );
1296
1297                 // We specifically don't include:
1298                 // http://www.w3.org/1999/xhtml (bug 60771)
1299                 static $validNamespaces = array(
1300                         '',
1301                         'adobe:ns:meta/',
1302                         'http://creativecommons.org/ns#',
1303                         'http://inkscape.sourceforge.net/dtd/sodipodi-0.dtd',
1304                         'http://ns.adobe.com/adobeillustrator/10.0/',
1305                         'http://ns.adobe.com/adobesvgviewerextensions/3.0/',
1306                         'http://ns.adobe.com/extensibility/1.0/',
1307                         'http://ns.adobe.com/flows/1.0/',
1308                         'http://ns.adobe.com/illustrator/1.0/',
1309                         'http://ns.adobe.com/imagereplacement/1.0/',
1310                         'http://ns.adobe.com/pdf/1.3/',
1311                         'http://ns.adobe.com/photoshop/1.0/',
1312                         'http://ns.adobe.com/saveforweb/1.0/',
1313                         'http://ns.adobe.com/variables/1.0/',
1314                         'http://ns.adobe.com/xap/1.0/',
1315                         'http://ns.adobe.com/xap/1.0/g/',
1316                         'http://ns.adobe.com/xap/1.0/g/img/',
1317                         'http://ns.adobe.com/xap/1.0/mm/',
1318                         'http://ns.adobe.com/xap/1.0/rights/',
1319                         'http://ns.adobe.com/xap/1.0/stype/dimensions#',
1320                         'http://ns.adobe.com/xap/1.0/stype/font#',
1321                         'http://ns.adobe.com/xap/1.0/stype/manifestitem#',
1322                         'http://ns.adobe.com/xap/1.0/stype/resourceevent#',
1323                         'http://ns.adobe.com/xap/1.0/stype/resourceref#',
1324                         'http://ns.adobe.com/xap/1.0/t/pg/',
1325                         'http://purl.org/dc/elements/1.1/',
1326                         'http://purl.org/dc/elements/1.1',
1327                         'http://schemas.microsoft.com/visio/2003/svgextensions/',
1328                         'http://sodipodi.sourceforge.net/dtd/sodipodi-0.dtd',
1329                         'http://taptrix.com/inkpad/svg_extensions',
1330                         'http://web.resource.org/cc/',
1331                         'http://www.freesoftware.fsf.org/bkchem/cdml',
1332                         'http://www.inkscape.org/namespaces/inkscape',
1333                         'http://www.opengis.net/gml',
1334                         'http://www.w3.org/1999/02/22-rdf-syntax-ns#',
1335                         'http://www.w3.org/2000/svg',
1336                         'http://www.w3.org/tr/rec-rdf-syntax/',
1337                 );
1338
1339                 if ( !in_array( $namespace, $validNamespaces ) ) {
1340                         wfDebug( __METHOD__ . ": Non-svg namespace '$namespace' in uploaded file.\n" );
1341                         /** @todo Return a status object to a closure in XmlTypeCheck, for MW1.21+ */
1342                         $this->mSVGNSError = $namespace;
1343
1344                         return true;
1345                 }
1346
1347                 /*
1348                  * check for elements that can contain javascript
1349                  */
1350                 if ( $strippedElement == 'script' ) {
1351                         wfDebug( __METHOD__ . ": Found script element '$element' in uploaded file.\n" );
1352
1353                         return array( 'uploaded-script-svg', $strippedElement );
1354                 }
1355
1356                 # e.g., <svg xmlns="http://www.w3.org/2000/svg">
1357                 #  <handler xmlns:ev="http://www.w3.org/2001/xml-events" ev:event="load">alert(1)</handler> </svg>
1358                 if ( $strippedElement == 'handler' ) {
1359                         wfDebug( __METHOD__ . ": Found scriptable element '$element' in uploaded file.\n" );
1360
1361                         return array( 'uploaded-script-svg', $strippedElement );
1362                 }
1363
1364                 # SVG reported in Feb '12 that used xml:stylesheet to generate javascript block
1365                 if ( $strippedElement == 'stylesheet' ) {
1366                         wfDebug( __METHOD__ . ": Found scriptable element '$element' in uploaded file.\n" );
1367
1368                         return array( 'uploaded-script-svg', $strippedElement );
1369                 }
1370
1371                 # Block iframes, in case they pass the namespace check
1372                 if ( $strippedElement == 'iframe' ) {
1373                         wfDebug( __METHOD__ . ": iframe in uploaded file.\n" );
1374
1375                         return array( 'uploaded-script-svg', $strippedElement );
1376                 }
1377
1378                 # Check <style> css
1379                 if ( $strippedElement == 'style'
1380                         && self::checkCssFragment( Sanitizer::normalizeCss( $data ) )
1381                 ) {
1382                         wfDebug( __METHOD__ . ": hostile css in style element.\n" );
1383                         return array( 'uploaded-hostile-svg' );
1384                 }
1385
1386                 foreach ( $attribs as $attrib => $value ) {
1387                         $stripped = $this->stripXmlNamespace( $attrib );
1388                         $value = strtolower( $value );
1389
1390                         if ( substr( $stripped, 0, 2 ) == 'on' ) {
1391                                 wfDebug( __METHOD__
1392                                         . ": Found event-handler attribute '$attrib'='$value' in uploaded file.\n" );
1393
1394                                 return array( 'uploaded-event-handler-on-svg', $attrib, $value );
1395                         }
1396
1397                         # href with non-local target (don't allow http://, javascript:, etc)
1398                         if ( $stripped == 'href'
1399                                 && strpos( $value, 'data:' ) !== 0
1400                                 && strpos( $value, '#' ) !== 0
1401                         ) {
1402                                 if ( !( $strippedElement === 'a'
1403                                         && preg_match( '!^https?://!im', $value ) )
1404                                 ) {
1405                                         wfDebug( __METHOD__ . ": Found href attribute <$strippedElement "
1406                                                 . "'$attrib'='$value' in uploaded file.\n" );
1407
1408                                         return array( 'uploaded-href-attribute-svg', $strippedElement, $attrib, $value );
1409                                 }
1410                         }
1411
1412                         # only allow data: targets that should be safe. This prevents vectors like,
1413                         # image/svg, text/xml, application/xml, and text/html, which can contain scripts
1414                         if ( $stripped == 'href' && strncasecmp( 'data:', $value, 5 ) === 0 ) {
1415                                 // rfc2397 parameters. This is only slightly slower than (;[\w;]+)*.
1416                                 // @codingStandardsIgnoreStart Generic.Files.LineLength
1417                                 $parameters = '(?>;[a-zA-Z0-9\!#$&\'*+.^_`{|}~-]+=(?>[a-zA-Z0-9\!#$&\'*+.^_`{|}~-]+|"(?>[\0-\x0c\x0e-\x21\x23-\x5b\x5d-\x7f]+|\\\\[\0-\x7f])*"))*(?:;base64)?';
1418                                 // @codingStandardsIgnoreEnd
1419
1420                                 if ( !preg_match( "!^data:\s*image/(gif|jpeg|jpg|png)$parameters,!i", $value ) ) {
1421                                         wfDebug( __METHOD__ . ": Found href to unwhitelisted data: uri "
1422                                                 . "\"<$strippedElement '$attrib'='$value'...\" in uploaded file.\n" );
1423                                         return array( 'uploaded-href-unsafe-target-svg', $strippedElement, $attrib, $value );
1424                                 }
1425                         }
1426
1427                         # Change href with animate from (http://html5sec.org/#137).
1428                         if ( $stripped === 'attributename'
1429                                 && $strippedElement === 'animate'
1430                                 && $this->stripXmlNamespace( $value ) == 'href'
1431                         ) {
1432                                 wfDebug( __METHOD__ . ": Found animate that might be changing href using from "
1433                                         . "\"<$strippedElement '$attrib'='$value'...\" in uploaded file.\n" );
1434
1435                                 return array( 'uploaded-animate-svg', $strippedElement, $attrib, $value );
1436                         }
1437
1438                         # use set/animate to add event-handler attribute to parent
1439                         if ( ( $strippedElement == 'set' || $strippedElement == 'animate' )
1440                                 && $stripped == 'attributename'
1441                                 && substr( $value, 0, 2 ) == 'on'
1442                         ) {
1443                                 wfDebug( __METHOD__ . ": Found svg setting event-handler attribute with "
1444                                         . "\"<$strippedElement $stripped='$value'...\" in uploaded file.\n" );
1445
1446                                 return array( 'uploaded-setting-event-handler-svg', $strippedElement, $stripped, $value );
1447                         }
1448
1449                         # use set to add href attribute to parent element
1450                         if ( $strippedElement == 'set'
1451                                 && $stripped == 'attributename'
1452                                 && strpos( $value, 'href' ) !== false
1453                         ) {
1454                                 wfDebug( __METHOD__ . ": Found svg setting href attribute '$value' in uploaded file.\n" );
1455
1456                                 return array( 'uploaded-setting-href-svg' );
1457                         }
1458
1459                         # use set to add a remote / data / script target to an element
1460                         if ( $strippedElement == 'set'
1461                                 && $stripped == 'to'
1462                                 && preg_match( '!(http|https|data|script):!sim', $value )
1463                         ) {
1464                                 wfDebug( __METHOD__ . ": Found svg setting attribute to '$value' in uploaded file.\n" );
1465
1466                                 return array( 'uploaded-wrong-setting-svg', $value );
1467                         }
1468
1469                         # use handler attribute with remote / data / script
1470                         if ( $stripped == 'handler' && preg_match( '!(http|https|data|script):!sim', $value ) ) {
1471                                 wfDebug( __METHOD__ . ": Found svg setting handler with remote/data/script "
1472                                         . "'$attrib'='$value' in uploaded file.\n" );
1473
1474                                 return array( 'uploaded-setting-handler-svg', $attrib, $value );
1475                         }
1476
1477                         # use CSS styles to bring in remote code
1478                         if ( $stripped == 'style'
1479                                 && self::checkCssFragment( Sanitizer::normalizeCss( $value ) )
1480                         ) {
1481                                 wfDebug( __METHOD__ . ": Found svg setting a style with "
1482                                         . "remote url '$attrib'='$value' in uploaded file.\n" );
1483                                 return array( 'uploaded-remote-url-svg', $attrib, $value );
1484                         }
1485
1486                         # Several attributes can include css, css character escaping isn't allowed
1487                         $cssAttrs = array( 'font', 'clip-path', 'fill', 'filter', 'marker',
1488                                 'marker-end', 'marker-mid', 'marker-start', 'mask', 'stroke' );
1489                         if ( in_array( $stripped, $cssAttrs )
1490                                 && self::checkCssFragment( $value )
1491                         ) {
1492                                 wfDebug( __METHOD__ . ": Found svg setting a style with "
1493                                         . "remote url '$attrib'='$value' in uploaded file.\n" );
1494                                 return array( 'uploaded-remote-url-svg', $attrib, $value );
1495                         }
1496
1497                         # image filters can pull in url, which could be svg that executes scripts
1498                         if ( $strippedElement == 'image'
1499                                 && $stripped == 'filter'
1500                                 && preg_match( '!url\s*\(!sim', $value )
1501                         ) {
1502                                 wfDebug( __METHOD__ . ": Found image filter with url: "
1503                                         . "\"<$strippedElement $stripped='$value'...\" in uploaded file.\n" );
1504
1505                                 return array( 'uploaded-image-filter-svg', $strippedElement, $stripped, $value );
1506                         }
1507                 }
1508
1509                 return false; // No scripts detected
1510         }
1511
1512         /**
1513          * Check a block of CSS or CSS fragment for anything that looks like
1514          * it is bringing in remote code.
1515          * @param string $value a string of CSS
1516          * @param bool $propOnly only check css properties (start regex with :)
1517          * @return bool true if the CSS contains an illegal string, false if otherwise
1518          */
1519         private static function checkCssFragment( $value ) {
1520
1521                 # Forbid external stylesheets, for both reliability and to protect viewer's privacy
1522                 if ( stripos( $value, '@import' ) !== false ) {
1523                         return true;
1524                 }
1525
1526                 # We allow @font-face to embed fonts with data: urls, so we snip the string
1527                 # 'url' out so this case won't match when we check for urls below
1528                 $pattern = '!(@font-face\s*{[^}]*src:)url(\("data:;base64,)!im';
1529                 $value = preg_replace( $pattern, '$1$2', $value );
1530
1531                 # Check for remote and executable CSS. Unlike in Sanitizer::checkCss, the CSS
1532                 # properties filter and accelerator don't seem to be useful for xss in SVG files.
1533                 # Expression and -o-link don't seem to work either, but filtering them here in case.
1534                 # Additionally, we catch remote urls like url("http:..., url('http:..., url(http:...,
1535                 # but not local ones such as url("#..., url('#..., url(#....
1536                 if ( preg_match( '!expression
1537                                 | -o-link\s*:
1538                                 | -o-link-source\s*:
1539                                 | -o-replace\s*:!imx', $value ) ) {
1540                         return true;
1541                 }
1542
1543                 if ( preg_match_all(
1544                                 "!(\s*(url|image|image-set)\s*\(\s*[\"']?\s*[^#]+.*?\))!sim",
1545                                 $value,
1546                                 $matches
1547                         ) !== 0
1548                 ) {
1549                         # TODO: redo this in one regex. Until then, url("#whatever") matches the first
1550                         foreach ( $matches[1] as $match ) {
1551                                 if ( !preg_match( "!\s*(url|image|image-set)\s*\(\s*(#|'#|\"#)!im", $match ) ) {
1552                                         return true;
1553                                 }
1554                         }
1555                 }
1556
1557                 if ( preg_match( '/[\000-\010\013\016-\037\177]/', $value ) ) {
1558                         return true;
1559                 }
1560
1561                 return false;
1562         }
1563
1564         /**
1565          * Divide the element name passed by the xml parser to the callback into URI and prifix.
1566          * @param string $element
1567          * @return array Containing the namespace URI and prefix
1568          */
1569         private static function splitXmlNamespace( $element ) {
1570                 // 'http://www.w3.org/2000/svg:script' -> array( 'http://www.w3.org/2000/svg', 'script' )
1571                 $parts = explode( ':', strtolower( $element ) );
1572                 $name = array_pop( $parts );
1573                 $ns = implode( ':', $parts );
1574
1575                 return array( $ns, $name );
1576         }
1577
1578         /**
1579          * @param string $name
1580          * @return string
1581          */
1582         private function stripXmlNamespace( $name ) {
1583                 // 'http://www.w3.org/2000/svg:script' -> 'script'
1584                 $parts = explode( ':', strtolower( $name ) );
1585
1586                 return array_pop( $parts );
1587         }
1588
1589         /**
1590          * Generic wrapper function for a virus scanner program.
1591          * This relies on the $wgAntivirus and $wgAntivirusSetup variables.
1592          * $wgAntivirusRequired may be used to deny upload if the scan fails.
1593          *
1594          * @param string $file Pathname to the temporary upload file
1595          * @return mixed False if not virus is found, null if the scan fails or is disabled,
1596          *   or a string containing feedback from the virus scanner if a virus was found.
1597          *   If textual feedback is missing but a virus was found, this function returns true.
1598          */
1599         public static function detectVirus( $file ) {
1600                 global $wgAntivirus, $wgAntivirusSetup, $wgAntivirusRequired, $wgOut;
1601
1602                 if ( !$wgAntivirus ) {
1603                         wfDebug( __METHOD__ . ": virus scanner disabled\n" );
1604
1605                         return null;
1606                 }
1607
1608                 if ( !$wgAntivirusSetup[$wgAntivirus] ) {
1609                         wfDebug( __METHOD__ . ": unknown virus scanner: $wgAntivirus\n" );
1610                         $wgOut->wrapWikiMsg( "<div class=\"error\">\n$1\n</div>",
1611                                 array( 'virus-badscanner', $wgAntivirus ) );
1612
1613                         return wfMessage( 'virus-unknownscanner' )->text() . " $wgAntivirus";
1614                 }
1615
1616                 # look up scanner configuration
1617                 $command = $wgAntivirusSetup[$wgAntivirus]['command'];
1618                 $exitCodeMap = $wgAntivirusSetup[$wgAntivirus]['codemap'];
1619                 $msgPattern = isset( $wgAntivirusSetup[$wgAntivirus]['messagepattern'] ) ?
1620                         $wgAntivirusSetup[$wgAntivirus]['messagepattern'] : null;
1621
1622                 if ( strpos( $command, "%f" ) === false ) {
1623                         # simple pattern: append file to scan
1624                         $command .= " " . wfEscapeShellArg( $file );
1625                 } else {
1626                         # complex pattern: replace "%f" with file to scan
1627                         $command = str_replace( "%f", wfEscapeShellArg( $file ), $command );
1628                 }
1629
1630                 wfDebug( __METHOD__ . ": running virus scan: $command \n" );
1631
1632                 # execute virus scanner
1633                 $exitCode = false;
1634
1635                 # NOTE: there's a 50 line workaround to make stderr redirection work on windows, too.
1636                 #      that does not seem to be worth the pain.
1637                 #      Ask me (Duesentrieb) about it if it's ever needed.
1638                 $output = wfShellExecWithStderr( $command, $exitCode );
1639
1640                 # map exit code to AV_xxx constants.
1641                 $mappedCode = $exitCode;
1642                 if ( $exitCodeMap ) {
1643                         if ( isset( $exitCodeMap[$exitCode] ) ) {
1644                                 $mappedCode = $exitCodeMap[$exitCode];
1645                         } elseif ( isset( $exitCodeMap["*"] ) ) {
1646                                 $mappedCode = $exitCodeMap["*"];
1647                         }
1648                 }
1649
1650                 /* NB: AV_NO_VIRUS is 0 but AV_SCAN_FAILED is false,
1651                  * so we need the strict equalities === and thus can't use a switch here
1652                  */
1653                 if ( $mappedCode === AV_SCAN_FAILED ) {
1654                         # scan failed (code was mapped to false by $exitCodeMap)
1655                         wfDebug( __METHOD__ . ": failed to scan $file (code $exitCode).\n" );
1656
1657                         $output = $wgAntivirusRequired
1658                                 ? wfMessage( 'virus-scanfailed', array( $exitCode ) )->text()
1659                                 : null;
1660                 } elseif ( $mappedCode === AV_SCAN_ABORTED ) {
1661                         # scan failed because filetype is unknown (probably imune)
1662                         wfDebug( __METHOD__ . ": unsupported file type $file (code $exitCode).\n" );
1663                         $output = null;
1664                 } elseif ( $mappedCode === AV_NO_VIRUS ) {
1665                         # no virus found
1666                         wfDebug( __METHOD__ . ": file passed virus scan.\n" );
1667                         $output = false;
1668                 } else {
1669                         $output = trim( $output );
1670
1671                         if ( !$output ) {
1672                                 $output = true; # if there's no output, return true
1673                         } elseif ( $msgPattern ) {
1674                                 $groups = array();
1675                                 if ( preg_match( $msgPattern, $output, $groups ) ) {
1676                                         if ( $groups[1] ) {
1677                                                 $output = $groups[1];
1678                                         }
1679                                 }
1680                         }
1681
1682                         wfDebug( __METHOD__ . ": FOUND VIRUS! scanner feedback: $output \n" );
1683                 }
1684
1685                 return $output;
1686         }
1687
1688         /**
1689          * Check if there's an overwrite conflict and, if so, if restrictions
1690          * forbid this user from performing the upload.
1691          *
1692          * @param User $user
1693          *
1694          * @return mixed True on success, array on failure
1695          */
1696         private function checkOverwrite( $user ) {
1697                 // First check whether the local file can be overwritten
1698                 $file = $this->getLocalFile();
1699                 $file->load( File::READ_LATEST );
1700                 if ( $file->exists() ) {
1701                         if ( !self::userCanReUpload( $user, $file ) ) {
1702                                 return array( 'fileexists-forbidden', $file->getName() );
1703                         } else {
1704                                 return true;
1705                         }
1706                 }
1707
1708                 /* Check shared conflicts: if the local file does not exist, but
1709                  * wfFindFile finds a file, it exists in a shared repository.
1710                  */
1711                 $file = wfFindFile( $this->getTitle(), array( 'latest' => true ) );
1712                 if ( $file && !$user->isAllowed( 'reupload-shared' ) ) {
1713                         return array( 'fileexists-shared-forbidden', $file->getName() );
1714                 }
1715
1716                 return true;
1717         }
1718
1719         /**
1720          * Check if a user is the last uploader
1721          *
1722          * @param User $user
1723          * @param File $img
1724          * @return bool
1725          */
1726         public static function userCanReUpload( User $user, File $img ) {
1727                 if ( $user->isAllowed( 'reupload' ) ) {
1728                         return true; // non-conditional
1729                 } elseif ( !$user->isAllowed( 'reupload-own' ) ) {
1730                         return false;
1731                 }
1732
1733                 if ( !( $img instanceof LocalFile ) ) {
1734                         return false;
1735                 }
1736
1737                 $img->load();
1738
1739                 return $user->getId() == $img->getUser( 'id' );
1740         }
1741
1742         /**
1743          * Helper function that does various existence checks for a file.
1744          * The following checks are performed:
1745          * - The file exists
1746          * - Article with the same name as the file exists
1747          * - File exists with normalized extension
1748          * - The file looks like a thumbnail and the original exists
1749          *
1750          * @param File $file The File object to check
1751          * @return mixed False if the file does not exists, else an array
1752          */
1753         public static function getExistsWarning( $file ) {
1754                 if ( $file->exists() ) {
1755                         return array( 'warning' => 'exists', 'file' => $file );
1756                 }
1757
1758                 if ( $file->getTitle()->getArticleID() ) {
1759                         return array( 'warning' => 'page-exists', 'file' => $file );
1760                 }
1761
1762                 if ( strpos( $file->getName(), '.' ) == false ) {
1763                         $partname = $file->getName();
1764                         $extension = '';
1765                 } else {
1766                         $n = strrpos( $file->getName(), '.' );
1767                         $extension = substr( $file->getName(), $n + 1 );
1768                         $partname = substr( $file->getName(), 0, $n );
1769                 }
1770                 $normalizedExtension = File::normalizeExtension( $extension );
1771
1772                 if ( $normalizedExtension != $extension ) {
1773                         // We're not using the normalized form of the extension.
1774                         // Normal form is lowercase, using most common of alternate
1775                         // extensions (eg 'jpg' rather than 'JPEG').
1776
1777                         // Check for another file using the normalized form...
1778                         $nt_lc = Title::makeTitle( NS_FILE, "{$partname}.{$normalizedExtension}" );
1779                         $file_lc = wfLocalFile( $nt_lc );
1780
1781                         if ( $file_lc->exists() ) {
1782                                 return array(
1783                                         'warning' => 'exists-normalized',
1784                                         'file' => $file,
1785                                         'normalizedFile' => $file_lc
1786                                 );
1787                         }
1788                 }
1789
1790                 // Check for files with the same name but a different extension
1791                 $similarFiles = RepoGroup::singleton()->getLocalRepo()->findFilesByPrefix(
1792                         "{$partname}.", 1 );
1793                 if ( count( $similarFiles ) ) {
1794                         return array(
1795                                 'warning' => 'exists-normalized',
1796                                 'file' => $file,
1797                                 'normalizedFile' => $similarFiles[0],
1798                         );
1799                 }
1800
1801                 if ( self::isThumbName( $file->getName() ) ) {
1802                         # Check for filenames like 50px- or 180px-, these are mostly thumbnails
1803                         $nt_thb = Title::newFromText(
1804                                 substr( $partname, strpos( $partname, '-' ) + 1 ) . '.' . $extension,
1805                                 NS_FILE
1806                         );
1807                         $file_thb = wfLocalFile( $nt_thb );
1808                         if ( $file_thb->exists() ) {
1809                                 return array(
1810                                         'warning' => 'thumb',
1811                                         'file' => $file,
1812                                         'thumbFile' => $file_thb
1813                                 );
1814                         } else {
1815                                 // File does not exist, but we just don't like the name
1816                                 return array(
1817                                         'warning' => 'thumb-name',
1818                                         'file' => $file,
1819                                         'thumbFile' => $file_thb
1820                                 );
1821                         }
1822                 }
1823
1824                 foreach ( self::getFilenamePrefixBlacklist() as $prefix ) {
1825                         if ( substr( $partname, 0, strlen( $prefix ) ) == $prefix ) {
1826                                 return array(
1827                                         'warning' => 'bad-prefix',
1828                                         'file' => $file,
1829                                         'prefix' => $prefix
1830                                 );
1831                         }
1832                 }
1833
1834                 return false;
1835         }
1836
1837         /**
1838          * Helper function that checks whether the filename looks like a thumbnail
1839          * @param string $filename
1840          * @return bool
1841          */
1842         public static function isThumbName( $filename ) {
1843                 $n = strrpos( $filename, '.' );
1844                 $partname = $n ? substr( $filename, 0, $n ) : $filename;
1845
1846                 return (
1847                         substr( $partname, 3, 3 ) == 'px-' ||
1848                         substr( $partname, 2, 3 ) == 'px-'
1849                 ) &&
1850                 preg_match( "/[0-9]{2}/", substr( $partname, 0, 2 ) );
1851         }
1852
1853         /**
1854          * Get a list of blacklisted filename prefixes from [[MediaWiki:Filename-prefix-blacklist]]
1855          *
1856          * @return array List of prefixes
1857          */
1858         public static function getFilenamePrefixBlacklist() {
1859                 $blacklist = array();
1860                 $message = wfMessage( 'filename-prefix-blacklist' )->inContentLanguage();
1861                 if ( !$message->isDisabled() ) {
1862                         $lines = explode( "\n", $message->plain() );
1863                         foreach ( $lines as $line ) {
1864                                 // Remove comment lines
1865                                 $comment = substr( trim( $line ), 0, 1 );
1866                                 if ( $comment == '#' || $comment == '' ) {
1867                                         continue;
1868                                 }
1869                                 // Remove additional comments after a prefix
1870                                 $comment = strpos( $line, '#' );
1871                                 if ( $comment > 0 ) {
1872                                         $line = substr( $line, 0, $comment - 1 );
1873                                 }
1874                                 $blacklist[] = trim( $line );
1875                         }
1876                 }
1877
1878                 return $blacklist;
1879         }
1880
1881         /**
1882          * Gets image info about the file just uploaded.
1883          *
1884          * Also has the effect of setting metadata to be an 'indexed tag name' in
1885          * returned API result if 'metadata' was requested. Oddly, we have to pass
1886          * the "result" object down just so it can do that with the appropriate
1887          * format, presumably.
1888          *
1889          * @param ApiResult $result
1890          * @return array Image info
1891          */
1892         public function getImageInfo( $result ) {
1893                 $file = $this->getLocalFile();
1894                 /** @todo This cries out for refactoring.
1895                  *  We really want to say $file->getAllInfo(); here.
1896                  * Perhaps "info" methods should be moved into files, and the API should
1897                  * just wrap them in queries.
1898                  */
1899                 if ( $file instanceof UploadStashFile ) {
1900                         $imParam = ApiQueryStashImageInfo::getPropertyNames();
1901                         $info = ApiQueryStashImageInfo::getInfo( $file, array_flip( $imParam ), $result );
1902                 } else {
1903                         $imParam = ApiQueryImageInfo::getPropertyNames();
1904                         $info = ApiQueryImageInfo::getInfo( $file, array_flip( $imParam ), $result );
1905                 }
1906
1907                 return $info;
1908         }
1909
1910         /**
1911          * @param array $error
1912          * @return Status
1913          */
1914         public function convertVerifyErrorToStatus( $error ) {
1915                 $code = $error['status'];
1916                 unset( $code['status'] );
1917
1918                 return Status::newFatal( $this->getVerificationErrorCode( $code ), $error );
1919         }
1920
1921         /**
1922          * @param null|string $forType
1923          * @return int
1924          */
1925         public static function getMaxUploadSize( $forType = null ) {
1926                 global $wgMaxUploadSize;
1927
1928                 if ( is_array( $wgMaxUploadSize ) ) {
1929                         if ( !is_null( $forType ) && isset( $wgMaxUploadSize[$forType] ) ) {
1930                                 return $wgMaxUploadSize[$forType];
1931                         } else {
1932                                 return $wgMaxUploadSize['*'];
1933                         }
1934                 } else {
1935                         return intval( $wgMaxUploadSize );
1936                 }
1937         }
1938
1939         /**
1940          * Get the current status of a chunked upload (used for polling)
1941          *
1942          * The value will be read from cache.
1943          *
1944          * @param User $user
1945          * @param string $statusKey
1946          * @return Status[]|bool
1947          */
1948         public static function getSessionStatus( User $user, $statusKey ) {
1949                 $key = wfMemcKey( 'uploadstatus', $user->getId() ?: md5( $user->getName() ), $statusKey );
1950
1951                 return ObjectCache::getMainStashInstance()->get( $key );
1952         }
1953
1954         /**
1955          * Set the current status of a chunked upload (used for polling)
1956          *
1957          * The value will be set in cache for 1 day
1958          *
1959          * @param User $user
1960          * @param string $statusKey
1961          * @param array|bool $value
1962          * @return void
1963          */
1964         public static function setSessionStatus( User $user, $statusKey, $value ) {
1965                 $key = wfMemcKey( 'uploadstatus', $user->getId() ?: md5( $user->getName() ), $statusKey );
1966
1967                 $cache = ObjectCache::getMainStashInstance();
1968                 if ( $value === false ) {
1969                         $cache->delete( $key );
1970                 } else {
1971                         $cache->set( $key, $value, 86400 );
1972                 }
1973         }
1974 }