includes/upload/UploadBase.php

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