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