MediaWiki  master
UploadBase.php
Go to the documentation of this file.
1 <?php
24 
39 abstract class UploadBase {
41  protected $mTempPath;
43  protected $tempFileObj;
45  protected $mDesiredDestName;
47  protected $mDestName;
49  protected $mRemoveTempFile;
51  protected $mSourceType;
53  protected $mTitle = false;
55  protected $mTitleError = 0;
57  protected $mFilteredName;
59  protected $mFinalExtension;
61  protected $mLocalFile;
63  protected $mStashFile;
65  protected $mFileSize;
67  protected $mFileProps;
71  protected $mJavaDetected;
73  protected $mSVGNSError;
74 
75  protected static $safeXmlEncodings = [
76  'UTF-8',
77  'ISO-8859-1',
78  'ISO-8859-2',
79  'UTF-16',
80  'UTF-32',
81  'WINDOWS-1250',
82  'WINDOWS-1251',
83  'WINDOWS-1252',
84  'WINDOWS-1253',
85  'WINDOWS-1254',
86  'WINDOWS-1255',
87  'WINDOWS-1256',
88  'WINDOWS-1257',
89  'WINDOWS-1258',
90  ];
91 
92  const SUCCESS = 0;
93  const OK = 0;
94  const EMPTY_FILE = 3;
96  const ILLEGAL_FILENAME = 5;
97  const OVERWRITE_EXISTING_FILE = 7; # Not used anymore; handled by verifyTitlePermissions()
98  const FILETYPE_MISSING = 8;
99  const FILETYPE_BADTYPE = 9;
100  const VERIFICATION_ERROR = 10;
101  const HOOK_ABORTED = 11;
102  const FILE_TOO_LARGE = 12;
104  const FILENAME_TOO_LONG = 14;
105 
111  $code_to_status = [
112  self::EMPTY_FILE => 'empty-file',
113  self::FILE_TOO_LARGE => 'file-too-large',
114  self::FILETYPE_MISSING => 'filetype-missing',
115  self::FILETYPE_BADTYPE => 'filetype-banned',
116  self::MIN_LENGTH_PARTNAME => 'filename-tooshort',
117  self::ILLEGAL_FILENAME => 'illegal-filename',
118  self::OVERWRITE_EXISTING_FILE => 'overwrite',
119  self::VERIFICATION_ERROR => 'verification-error',
120  self::HOOK_ABORTED => 'hookaborted',
121  self::WINDOWS_NONASCII_FILENAME => 'windows-nonascii-filename',
122  self::FILENAME_TOO_LONG => 'filename-toolong',
123  ];
124  return $code_to_status[$error] ?? 'unknown-error';
125  }
126 
132  public static function isEnabled() {
133  global $wgEnableUploads;
134 
135  if ( !$wgEnableUploads ) {
136  return false;
137  }
138 
139  # Check php's file_uploads setting
140  return wfIsHHVM() || wfIniGetBool( 'file_uploads' );
141  }
142 
151  public static function isAllowed( $user ) {
152  foreach ( [ 'upload', 'edit' ] as $permission ) {
153  if ( !$user->isAllowed( $permission ) ) {
154  return $permission;
155  }
156  }
157 
158  return true;
159  }
160 
167  public static function isThrottled( $user ) {
168  return $user->pingLimiter( 'upload' );
169  }
170 
171  // Upload handlers. Should probably just be a global.
172  private static $uploadHandlers = [ 'Stash', 'File', 'Url' ];
173 
181  public static function createFromRequest( &$request, $type = null ) {
182  $type = $type ?: $request->getVal( 'wpSourceType', 'File' );
183 
184  if ( !$type ) {
185  return null;
186  }
187 
188  // Get the upload class
189  $type = ucfirst( $type );
190 
191  // Give hooks the chance to handle this request
192  $className = null;
193  Hooks::run( 'UploadCreateFromRequest', [ $type, &$className ] );
194  if ( is_null( $className ) ) {
195  $className = 'UploadFrom' . $type;
196  wfDebug( __METHOD__ . ": class name: $className\n" );
197  if ( !in_array( $type, self::$uploadHandlers ) ) {
198  return null;
199  }
200  }
201 
202  // Check whether this upload class is enabled
203  if ( !call_user_func( [ $className, 'isEnabled' ] ) ) {
204  return null;
205  }
206 
207  // Check whether the request is valid
208  if ( !call_user_func( [ $className, 'isValidRequest' ], $request ) ) {
209  return null;
210  }
211 
213  $handler = new $className;
214 
215  $handler->initializeFromRequest( $request );
216 
217  return $handler;
218  }
219 
225  public static function isValidRequest( $request ) {
226  return false;
227  }
228 
229  public function __construct() {
230  }
231 
238  public function getSourceType() {
239  return null;
240  }
241 
250  public function initializePathInfo( $name, $tempPath, $fileSize, $removeTempFile = false ) {
251  $this->mDesiredDestName = $name;
252  if ( FileBackend::isStoragePath( $tempPath ) ) {
253  throw new MWException( __METHOD__ . " given storage path `$tempPath`." );
254  }
255 
256  $this->setTempFile( $tempPath, $fileSize );
257  $this->mRemoveTempFile = $removeTempFile;
258  }
259 
265  abstract public function initializeFromRequest( &$request );
266 
271  protected function setTempFile( $tempPath, $fileSize = null ) {
272  $this->mTempPath = $tempPath;
273  $this->mFileSize = $fileSize ?: null;
274  if ( strlen( $this->mTempPath ) && file_exists( $this->mTempPath ) ) {
275  $this->tempFileObj = new TempFSFile( $this->mTempPath );
276  if ( !$fileSize ) {
277  $this->mFileSize = filesize( $this->mTempPath );
278  }
279  } else {
280  $this->tempFileObj = null;
281  }
282  }
283 
288  public function fetchFile() {
289  return Status::newGood();
290  }
291 
296  public function isEmptyFile() {
297  return empty( $this->mFileSize );
298  }
299 
304  public function getFileSize() {
305  return $this->mFileSize;
306  }
307 
312  public function getTempFileSha1Base36() {
313  return FSFile::getSha1Base36FromPath( $this->mTempPath );
314  }
315 
320  public function getRealPath( $srcPath ) {
321  $repo = RepoGroup::singleton()->getLocalRepo();
322  if ( FileRepo::isVirtualUrl( $srcPath ) ) {
326  $tmpFile = $repo->getLocalCopy( $srcPath );
327  if ( $tmpFile ) {
328  $tmpFile->bind( $this ); // keep alive with $this
329  }
330  $path = $tmpFile ? $tmpFile->getPath() : false;
331  } else {
332  $path = $srcPath;
333  }
334 
335  return $path;
336  }
337 
342  public function verifyUpload() {
346  if ( $this->isEmptyFile() ) {
347  return [ 'status' => self::EMPTY_FILE ];
348  }
349 
353  $maxSize = self::getMaxUploadSize( $this->getSourceType() );
354  if ( $this->mFileSize > $maxSize ) {
355  return [
356  'status' => self::FILE_TOO_LARGE,
357  'max' => $maxSize,
358  ];
359  }
360 
366  $verification = $this->verifyFile();
367  if ( $verification !== true ) {
368  return [
369  'status' => self::VERIFICATION_ERROR,
370  'details' => $verification
371  ];
372  }
373 
377  $result = $this->validateName();
378  if ( $result !== true ) {
379  return $result;
380  }
381 
382  return [ 'status' => self::OK ];
383  }
384 
391  public function validateName() {
392  $nt = $this->getTitle();
393  if ( is_null( $nt ) ) {
394  $result = [ 'status' => $this->mTitleError ];
395  if ( $this->mTitleError == self::ILLEGAL_FILENAME ) {
396  $result['filtered'] = $this->mFilteredName;
397  }
398  if ( $this->mTitleError == self::FILETYPE_BADTYPE ) {
399  $result['finalExt'] = $this->mFinalExtension;
400  if ( count( $this->mBlackListedExtensions ) ) {
401  $result['blacklistedExt'] = $this->mBlackListedExtensions;
402  }
403  }
404 
405  return $result;
406  }
407  $this->mDestName = $this->getLocalFile()->getName();
408 
409  return true;
410  }
411 
421  protected function verifyMimeType( $mime ) {
423  if ( $wgVerifyMimeType ) {
424  wfDebug( "mime: <$mime> extension: <{$this->mFinalExtension}>\n" );
425  global $wgMimeTypeBlacklist;
426  if ( $this->checkFileExtension( $mime, $wgMimeTypeBlacklist ) ) {
427  return [ 'filetype-badmime', $mime ];
428  }
429 
430  if ( $wgVerifyMimeTypeIE ) {
431  # Check what Internet Explorer would detect
432  $fp = fopen( $this->mTempPath, 'rb' );
433  $chunk = fread( $fp, 256 );
434  fclose( $fp );
435 
436  $magic = MediaWiki\MediaWikiServices::getInstance()->getMimeAnalyzer();
437  $extMime = $magic->guessTypesForExtension( $this->mFinalExtension );
438  $ieTypes = $magic->getIEMimeTypes( $this->mTempPath, $chunk, $extMime );
439  foreach ( $ieTypes as $ieType ) {
440  if ( $this->checkFileExtension( $ieType, $wgMimeTypeBlacklist ) ) {
441  return [ 'filetype-bad-ie-mime', $ieType ];
442  }
443  }
444  }
445  }
446 
447  return true;
448  }
449 
455  protected function verifyFile() {
457 
458  $status = $this->verifyPartialFile();
459  if ( $status !== true ) {
460  return $status;
461  }
462 
463  $mwProps = new MWFileProps( MediaWiki\MediaWikiServices::getInstance()->getMimeAnalyzer() );
464  $this->mFileProps = $mwProps->getPropsFromPath( $this->mTempPath, $this->mFinalExtension );
465  $mime = $this->mFileProps['mime'];
466 
467  if ( $wgVerifyMimeType ) {
468  # XXX: Missing extension will be caught by validateName() via getTitle()
469  if ( $this->mFinalExtension != '' && !$this->verifyExtension( $mime, $this->mFinalExtension ) ) {
470  return [ 'filetype-mime-mismatch', $this->mFinalExtension, $mime ];
471  }
472  }
473 
474  # check for htmlish code and javascript
475  if ( !$wgDisableUploadScriptChecks ) {
476  if ( $this->mFinalExtension == 'svg' || $mime == 'image/svg+xml' ) {
477  $svgStatus = $this->detectScriptInSvg( $this->mTempPath, false );
478  if ( $svgStatus !== false ) {
479  return $svgStatus;
480  }
481  }
482  }
483 
485  if ( $handler ) {
486  $handlerStatus = $handler->verifyUpload( $this->mTempPath );
487  if ( !$handlerStatus->isOK() ) {
488  $errors = $handlerStatus->getErrorsArray();
489 
490  return reset( $errors );
491  }
492  }
493 
494  $error = true;
495  Hooks::run( 'UploadVerifyFile', [ $this, $mime, &$error ] );
496  if ( $error !== true ) {
497  if ( !is_array( $error ) ) {
498  $error = [ $error ];
499  }
500  return $error;
501  }
502 
503  wfDebug( __METHOD__ . ": all clear; passing.\n" );
504 
505  return true;
506  }
507 
516  protected function verifyPartialFile() {
518 
519  # getTitle() sets some internal parameters like $this->mFinalExtension
520  $this->getTitle();
521 
522  $mwProps = new MWFileProps( MediaWiki\MediaWikiServices::getInstance()->getMimeAnalyzer() );
523  $this->mFileProps = $mwProps->getPropsFromPath( $this->mTempPath, $this->mFinalExtension );
524 
525  # check MIME type, if desired
526  $mime = $this->mFileProps['file-mime'];
527  $status = $this->verifyMimeType( $mime );
528  if ( $status !== true ) {
529  return $status;
530  }
531 
532  # check for htmlish code and javascript
533  if ( !$wgDisableUploadScriptChecks ) {
534  if ( self::detectScript( $this->mTempPath, $mime, $this->mFinalExtension ) ) {
535  return [ 'uploadscripted' ];
536  }
537  if ( $this->mFinalExtension == 'svg' || $mime == 'image/svg+xml' ) {
538  $svgStatus = $this->detectScriptInSvg( $this->mTempPath, true );
539  if ( $svgStatus !== false ) {
540  return $svgStatus;
541  }
542  }
543  }
544 
545  # Check for Java applets, which if uploaded can bypass cross-site
546  # restrictions.
547  if ( !$wgAllowJavaUploads ) {
548  $this->mJavaDetected = false;
549  $zipStatus = ZipDirectoryReader::read( $this->mTempPath,
550  [ $this, 'zipEntryCallback' ] );
551  if ( !$zipStatus->isOK() ) {
552  $errors = $zipStatus->getErrorsArray();
553  $error = reset( $errors );
554  if ( $error[0] !== 'zip-wrong-format' ) {
555  return $error;
556  }
557  }
558  if ( $this->mJavaDetected ) {
559  return [ 'uploadjava' ];
560  }
561  }
562 
563  # Scan the uploaded file for viruses
564  $virus = $this->detectVirus( $this->mTempPath );
565  if ( $virus ) {
566  return [ 'uploadvirus', $virus ];
567  }
568 
569  return true;
570  }
571 
577  public function zipEntryCallback( $entry ) {
578  $names = [ $entry['name'] ];
579 
580  // If there is a null character, cut off the name at it, because JDK's
581  // ZIP_GetEntry() uses strcmp() if the name hashes match. If a file name
582  // were constructed which had ".class\0" followed by a string chosen to
583  // make the hash collide with the truncated name, that file could be
584  // returned in response to a request for the .class file.
585  $nullPos = strpos( $entry['name'], "\000" );
586  if ( $nullPos !== false ) {
587  $names[] = substr( $entry['name'], 0, $nullPos );
588  }
589 
590  // If there is a trailing slash in the file name, we have to strip it,
591  // because that's what ZIP_GetEntry() does.
592  if ( preg_grep( '!\.class/?$!', $names ) ) {
593  $this->mJavaDetected = true;
594  }
595  }
596 
606  public function verifyPermissions( $user ) {
607  return $this->verifyTitlePermissions( $user );
608  }
609 
621  public function verifyTitlePermissions( $user ) {
626  $nt = $this->getTitle();
627  if ( is_null( $nt ) ) {
628  return true;
629  }
630  $permErrors = $nt->getUserPermissionsErrors( 'edit', $user );
631  $permErrorsUpload = $nt->getUserPermissionsErrors( 'upload', $user );
632  if ( !$nt->exists() ) {
633  $permErrorsCreate = $nt->getUserPermissionsErrors( 'create', $user );
634  } else {
635  $permErrorsCreate = [];
636  }
637  if ( $permErrors || $permErrorsUpload || $permErrorsCreate ) {
638  $permErrors = array_merge( $permErrors, wfArrayDiff2( $permErrorsUpload, $permErrors ) );
639  $permErrors = array_merge( $permErrors, wfArrayDiff2( $permErrorsCreate, $permErrors ) );
640 
641  return $permErrors;
642  }
643 
644  $overwriteError = $this->checkOverwrite( $user );
645  if ( $overwriteError !== true ) {
646  return [ $overwriteError ];
647  }
648 
649  return true;
650  }
651 
659  public function checkWarnings() {
660  $warnings = [];
661 
662  $localFile = $this->getLocalFile();
663  $localFile->load( File::READ_LATEST );
664  $filename = $localFile->getName();
665  $hash = $this->getTempFileSha1Base36();
666 
667  $badFileName = $this->checkBadFileName( $filename, $this->mDesiredDestName );
668  if ( $badFileName !== null ) {
669  $warnings['badfilename'] = $badFileName;
670  }
671 
672  $unwantedFileExtensionDetails = $this->checkUnwantedFileExtensions( $this->mFinalExtension );
673  if ( $unwantedFileExtensionDetails !== null ) {
674  $warnings['filetype-unwanted-type'] = $unwantedFileExtensionDetails;
675  }
676 
677  $fileSizeWarnings = $this->checkFileSize( $this->mFileSize );
678  if ( $fileSizeWarnings ) {
679  $warnings = array_merge( $warnings, $fileSizeWarnings );
680  }
681 
682  $localFileExistsWarnings = $this->checkLocalFileExists( $localFile, $hash );
683  if ( $localFileExistsWarnings ) {
684  $warnings = array_merge( $warnings, $localFileExistsWarnings );
685  }
686 
687  if ( $this->checkLocalFileWasDeleted( $localFile ) ) {
688  $warnings['was-deleted'] = $filename;
689  }
690 
691  // If a file with the same name exists locally then the local file has already been tested
692  // for duplication of content
693  $ignoreLocalDupes = isset( $warnings[ 'exists '] );
694  $dupes = $this->checkAgainstExistingDupes( $hash, $ignoreLocalDupes );
695  if ( $dupes ) {
696  $warnings['duplicate'] = $dupes;
697  }
698 
699  $archivedDupes = $this->checkAgainstArchiveDupes( $hash );
700  if ( $archivedDupes !== null ) {
701  $warnings['duplicate-archive'] = $archivedDupes;
702  }
703 
704  return $warnings;
705  }
706 
718  public static function makeWarningsSerializable( $warnings ) {
719  array_walk_recursive( $warnings, function ( &$param, $key ) {
720  if ( $param instanceof File ) {
721  $param = [
722  'fileName' => $param->getName(),
723  'timestamp' => $param->getTimestamp()
724  ];
725  } elseif ( is_object( $param ) ) {
726  throw new InvalidArgumentException(
727  'UploadBase::makeWarningsSerializable: ' .
728  'Unexpected object of class ' . get_class( $param ) );
729  }
730  } );
731  return $warnings;
732  }
733 
743  private function checkBadFileName( $filename, $desiredFileName ) {
744  $comparableName = str_replace( ' ', '_', $desiredFileName );
745  $comparableName = Title::capitalize( $comparableName, NS_FILE );
746 
747  if ( $desiredFileName != $filename && $comparableName != $filename ) {
748  return $filename;
749  }
750 
751  return null;
752  }
753 
762  private function checkUnwantedFileExtensions( $fileExtension ) {
764 
765  if ( $wgCheckFileExtensions ) {
766  $extensions = array_unique( $wgFileExtensions );
767  if ( !$this->checkFileExtension( $fileExtension, $extensions ) ) {
768  return [
769  $fileExtension,
770  $wgLang->commaList( $extensions ),
771  count( $extensions )
772  ];
773  }
774  }
775 
776  return null;
777  }
778 
784  private function checkFileSize( $fileSize ) {
785  global $wgUploadSizeWarning;
786 
787  $warnings = [];
788 
789  if ( $wgUploadSizeWarning && ( $fileSize > $wgUploadSizeWarning ) ) {
790  $warnings['large-file'] = [ $wgUploadSizeWarning, $fileSize ];
791  }
792 
793  if ( $fileSize == 0 ) {
794  $warnings['empty-file'] = true;
795  }
796 
797  return $warnings;
798  }
799 
806  private function checkLocalFileExists( LocalFile $localFile, $hash ) {
807  $warnings = [];
808 
809  $exists = self::getExistsWarning( $localFile );
810  if ( $exists !== false ) {
811  $warnings['exists'] = $exists;
812 
813  // check if file is an exact duplicate of current file version
814  if ( $hash === $localFile->getSha1() ) {
815  $warnings['no-change'] = $localFile;
816  }
817 
818  // check if file is an exact duplicate of older versions of this file
819  $history = $localFile->getHistory();
820  foreach ( $history as $oldFile ) {
821  if ( $hash === $oldFile->getSha1() ) {
822  $warnings['duplicate-version'][] = $oldFile;
823  }
824  }
825  }
826 
827  return $warnings;
828  }
829 
830  private function checkLocalFileWasDeleted( LocalFile $localFile ) {
831  return $localFile->wasDeleted() && !$localFile->exists();
832  }
833 
840  private function checkAgainstExistingDupes( $hash, $ignoreLocalDupes ) {
841  $dupes = RepoGroup::singleton()->findBySha1( $hash );
842  $title = $this->getTitle();
843  foreach ( $dupes as $key => $dupe ) {
844  if (
845  ( $dupe instanceof LocalFile ) &&
846  $ignoreLocalDupes &&
847  $title->equals( $dupe->getTitle() )
848  ) {
849  unset( $dupes[$key] );
850  }
851  }
852 
853  return $dupes;
854  }
855 
862  private function checkAgainstArchiveDupes( $hash ) {
863  $archivedFile = new ArchivedFile( null, 0, '', $hash );
864  if ( $archivedFile->getID() > 0 ) {
865  if ( $archivedFile->userCan( File::DELETED_FILE ) ) {
866  return $archivedFile->getName();
867  } else {
868  return '';
869  }
870  }
871 
872  return null;
873  }
874 
888  public function performUpload( $comment, $pageText, $watch, $user, $tags = [] ) {
889  $this->getLocalFile()->load( File::READ_LATEST );
890  $props = $this->mFileProps;
891 
892  $error = null;
893  Hooks::run( 'UploadVerifyUpload', [ $this, $user, $props, $comment, $pageText, &$error ] );
894  if ( $error ) {
895  if ( !is_array( $error ) ) {
896  $error = [ $error ];
897  }
898  return Status::newFatal( ...$error );
899  }
900 
901  $status = $this->getLocalFile()->upload(
902  $this->mTempPath,
903  $comment,
904  $pageText,
906  $props,
907  false,
908  $user,
909  $tags
910  );
911 
912  if ( $status->isGood() ) {
913  if ( $watch ) {
915  $this->getLocalFile()->getTitle(),
916  $user,
918  );
919  }
920  // Avoid PHP 7.1 warning of passing $this by reference
921  $uploadBase = $this;
922  Hooks::run( 'UploadComplete', [ &$uploadBase ] );
923 
924  $this->postProcessUpload();
925  }
926 
927  return $status;
928  }
929 
935  public function postProcessUpload() {
936  }
937 
944  public function getTitle() {
945  if ( $this->mTitle !== false ) {
946  return $this->mTitle;
947  }
948  if ( !is_string( $this->mDesiredDestName ) ) {
949  $this->mTitleError = self::ILLEGAL_FILENAME;
950  $this->mTitle = null;
951 
952  return $this->mTitle;
953  }
954  /* Assume that if a user specified File:Something.jpg, this is an error
955  * and that the namespace prefix needs to be stripped of.
956  */
957  $title = Title::newFromText( $this->mDesiredDestName );
958  if ( $title && $title->getNamespace() == NS_FILE ) {
959  $this->mFilteredName = $title->getDBkey();
960  } else {
961  $this->mFilteredName = $this->mDesiredDestName;
962  }
963 
964  # oi_archive_name is max 255 bytes, which include a timestamp and an
965  # exclamation mark, so restrict file name to 240 bytes.
966  if ( strlen( $this->mFilteredName ) > 240 ) {
967  $this->mTitleError = self::FILENAME_TOO_LONG;
968  $this->mTitle = null;
969 
970  return $this->mTitle;
971  }
972 
978  $this->mFilteredName = wfStripIllegalFilenameChars( $this->mFilteredName );
979  /* Normalize to title form before we do any further processing */
980  $nt = Title::makeTitleSafe( NS_FILE, $this->mFilteredName );
981  if ( is_null( $nt ) ) {
982  $this->mTitleError = self::ILLEGAL_FILENAME;
983  $this->mTitle = null;
984 
985  return $this->mTitle;
986  }
987  $this->mFilteredName = $nt->getDBkey();
988 
993  list( $partname, $ext ) = $this->splitExtensions( $this->mFilteredName );
994 
995  if ( $ext !== [] ) {
996  $this->mFinalExtension = trim( end( $ext ) );
997  } else {
998  $this->mFinalExtension = '';
999 
1000  # No extension, try guessing one
1001  $magic = MediaWiki\MediaWikiServices::getInstance()->getMimeAnalyzer();
1002  $mime = $magic->guessMimeType( $this->mTempPath );
1003  if ( $mime !== 'unknown/unknown' ) {
1004  # Get a space separated list of extensions
1005  $extList = $magic->getExtensionsForType( $mime );
1006  if ( $extList ) {
1007  # Set the extension to the canonical extension
1008  $this->mFinalExtension = strtok( $extList, ' ' );
1009 
1010  # Fix up the other variables
1011  $this->mFilteredName .= ".{$this->mFinalExtension}";
1012  $nt = Title::makeTitleSafe( NS_FILE, $this->mFilteredName );
1014  }
1015  }
1016  }
1017 
1018  /* Don't allow users to override the blacklist (check file extension) */
1021 
1022  $blackListedExtensions = $this->checkFileExtensionList( $ext, $wgFileBlacklist );
1023 
1024  if ( $this->mFinalExtension == '' ) {
1025  $this->mTitleError = self::FILETYPE_MISSING;
1026  $this->mTitle = null;
1027 
1028  return $this->mTitle;
1029  } elseif ( $blackListedExtensions ||
1030  ( $wgCheckFileExtensions && $wgStrictFileExtensions &&
1031  !$this->checkFileExtension( $this->mFinalExtension, $wgFileExtensions ) )
1032  ) {
1033  $this->mBlackListedExtensions = $blackListedExtensions;
1034  $this->mTitleError = self::FILETYPE_BADTYPE;
1035  $this->mTitle = null;
1036 
1037  return $this->mTitle;
1038  }
1039 
1040  // Windows may be broken with special characters, see T3780
1041  if ( !preg_match( '/^[\x0-\x7f]*$/', $nt->getText() )
1042  && !RepoGroup::singleton()->getLocalRepo()->backendSupportsUnicodePaths()
1043  ) {
1044  $this->mTitleError = self::WINDOWS_NONASCII_FILENAME;
1045  $this->mTitle = null;
1046 
1047  return $this->mTitle;
1048  }
1049 
1050  # If there was more than one "extension", reassemble the base
1051  # filename to prevent bogus complaints about length
1052  if ( count( $ext ) > 1 ) {
1053  $iterations = count( $ext ) - 1;
1054  for ( $i = 0; $i < $iterations; $i++ ) {
1055  $partname .= '.' . $ext[$i];
1056  }
1057  }
1058 
1059  if ( strlen( $partname ) < 1 ) {
1060  $this->mTitleError = self::MIN_LENGTH_PARTNAME;
1061  $this->mTitle = null;
1062 
1063  return $this->mTitle;
1064  }
1065 
1066  $this->mTitle = $nt;
1067 
1068  return $this->mTitle;
1069  }
1070 
1076  public function getLocalFile() {
1077  if ( is_null( $this->mLocalFile ) ) {
1078  $nt = $this->getTitle();
1079  $this->mLocalFile = is_null( $nt ) ? null : wfLocalFile( $nt );
1080  }
1081 
1082  return $this->mLocalFile;
1083  }
1084 
1088  public function getStashFile() {
1089  return $this->mStashFile;
1090  }
1091 
1103  public function tryStashFile( User $user, $isPartial = false ) {
1104  if ( !$isPartial ) {
1105  $error = $this->runUploadStashFileHook( $user );
1106  if ( $error ) {
1107  return Status::newFatal( ...$error );
1108  }
1109  }
1110  try {
1111  $file = $this->doStashFile( $user );
1112  return Status::newGood( $file );
1113  } catch ( UploadStashException $e ) {
1114  return Status::newFatal( 'uploadstash-exception', get_class( $e ), $e->getMessage() );
1115  }
1116  }
1117 
1122  protected function runUploadStashFileHook( User $user ) {
1123  $props = $this->mFileProps;
1124  $error = null;
1125  Hooks::run( 'UploadStashFile', [ $this, $user, $props, &$error ] );
1126  if ( $error && !is_array( $error ) ) {
1127  $error = [ $error ];
1128  }
1129  return $error;
1130  }
1131 
1151  public function stashFile( User $user = null ) {
1152  wfDeprecated( __METHOD__, '1.28' );
1153 
1154  return $this->doStashFile( $user );
1155  }
1156 
1163  protected function doStashFile( User $user = null ) {
1164  $stash = RepoGroup::singleton()->getLocalRepo()->getUploadStash( $user );
1165  $file = $stash->stashFile( $this->mTempPath, $this->getSourceType() );
1166  $this->mStashFile = $file;
1167 
1168  return $file;
1169  }
1170 
1175  public function cleanupTempFile() {
1176  if ( $this->mRemoveTempFile && $this->tempFileObj ) {
1177  // Delete when all relevant TempFSFile handles go out of scope
1178  wfDebug( __METHOD__ . ": Marked temporary file '{$this->mTempPath}' for removal\n" );
1179  $this->tempFileObj->autocollect();
1180  }
1181  }
1182 
1183  public function getTempPath() {
1184  return $this->mTempPath;
1185  }
1186 
1196  public static function splitExtensions( $filename ) {
1197  $bits = explode( '.', $filename );
1198  $basename = array_shift( $bits );
1199 
1200  return [ $basename, $bits ];
1201  }
1202 
1211  public static function checkFileExtension( $ext, $list ) {
1212  return in_array( strtolower( $ext ), $list );
1213  }
1214 
1223  public static function checkFileExtensionList( $ext, $list ) {
1224  return array_intersect( array_map( 'strtolower', $ext ), $list );
1225  }
1226 
1234  public static function verifyExtension( $mime, $extension ) {
1235  $magic = MediaWiki\MediaWikiServices::getInstance()->getMimeAnalyzer();
1236 
1237  if ( !$mime || $mime == 'unknown' || $mime == 'unknown/unknown' ) {
1238  if ( !$magic->isRecognizableExtension( $extension ) ) {
1239  wfDebug( __METHOD__ . ": passing file with unknown detected mime type; " .
1240  "unrecognized extension '$extension', can't verify\n" );
1241 
1242  return true;
1243  } else {
1244  wfDebug( __METHOD__ . ": rejecting file with unknown detected mime type; " .
1245  "recognized extension '$extension', so probably invalid file\n" );
1246 
1247  return false;
1248  }
1249  }
1250 
1251  $match = $magic->isMatchingExtension( $extension, $mime );
1252 
1253  if ( $match === null ) {
1254  if ( $magic->getTypesForExtension( $extension ) !== null ) {
1255  wfDebug( __METHOD__ . ": No extension known for $mime, but we know a mime for $extension\n" );
1256 
1257  return false;
1258  } else {
1259  wfDebug( __METHOD__ . ": no file extension known for mime type $mime, passing file\n" );
1260 
1261  return true;
1262  }
1263  } elseif ( $match === true ) {
1264  wfDebug( __METHOD__ . ": mime type $mime matches extension $extension, passing file\n" );
1265 
1267  return true;
1268  } else {
1269  wfDebug( __METHOD__
1270  . ": mime type $mime mismatches file extension $extension, rejecting file\n" );
1271 
1272  return false;
1273  }
1274  }
1275 
1287  public static function detectScript( $file, $mime, $extension ) {
1288  # ugly hack: for text files, always look at the entire file.
1289  # For binary field, just check the first K.
1290 
1291  $isText = strpos( $mime, 'text/' ) === 0;
1292  if ( $isText ) {
1293  $chunk = file_get_contents( $file );
1294  } else {
1295  $fp = fopen( $file, 'rb' );
1296  $chunk = fread( $fp, 1024 );
1297  fclose( $fp );
1298  }
1299 
1300  $chunk = strtolower( $chunk );
1301 
1302  if ( !$chunk ) {
1303  return false;
1304  }
1305 
1306  # decode from UTF-16 if needed (could be used for obfuscation).
1307  if ( substr( $chunk, 0, 2 ) == "\xfe\xff" ) {
1308  $enc = 'UTF-16BE';
1309  } elseif ( substr( $chunk, 0, 2 ) == "\xff\xfe" ) {
1310  $enc = 'UTF-16LE';
1311  } else {
1312  $enc = null;
1313  }
1314 
1315  if ( $enc ) {
1316  $chunk = iconv( $enc, "ASCII//IGNORE", $chunk );
1317  }
1318 
1319  $chunk = trim( $chunk );
1320 
1322  wfDebug( __METHOD__ . ": checking for embedded scripts and HTML stuff\n" );
1323 
1324  # check for HTML doctype
1325  if ( preg_match( "/<!DOCTYPE *X?HTML/i", $chunk ) ) {
1326  return true;
1327  }
1328 
1329  // Some browsers will interpret obscure xml encodings as UTF-8, while
1330  // PHP/expat will interpret the given encoding in the xml declaration (T49304)
1331  if ( $extension == 'svg' || strpos( $mime, 'image/svg' ) === 0 ) {
1332  if ( self::checkXMLEncodingMissmatch( $file ) ) {
1333  return true;
1334  }
1335  }
1336 
1337  // Quick check for HTML heuristics in old IE and Safari.
1338  //
1339  // The exact heuristics IE uses are checked separately via verifyMimeType(), so we
1340  // don't need them all here as it can cause many false positives.
1341  //
1342  // Check for `<script` and such still to forbid script tags and embedded HTML in SVG:
1343  $tags = [
1344  '<body',
1345  '<head',
1346  '<html', # also in safari
1347  '<script', # also in safari
1348  ];
1349 
1350  foreach ( $tags as $tag ) {
1351  if ( strpos( $chunk, $tag ) !== false ) {
1352  wfDebug( __METHOD__ . ": found something that may make it be mistaken for html: $tag\n" );
1353 
1354  return true;
1355  }
1356  }
1357 
1358  /*
1359  * look for JavaScript
1360  */
1361 
1362  # resolve entity-refs to look at attributes. may be harsh on big files... cache result?
1363  $chunk = Sanitizer::decodeCharReferences( $chunk );
1364 
1365  # look for script-types
1366  if ( preg_match( '!type\s*=\s*[\'"]?\s*(?:\w*/)?(?:ecma|java)!sim', $chunk ) ) {
1367  wfDebug( __METHOD__ . ": found script types\n" );
1368 
1369  return true;
1370  }
1371 
1372  # look for html-style script-urls
1373  if ( preg_match( '!(?:href|src|data)\s*=\s*[\'"]?\s*(?:ecma|java)script:!sim', $chunk ) ) {
1374  wfDebug( __METHOD__ . ": found html-style script urls\n" );
1375 
1376  return true;
1377  }
1378 
1379  # look for css-style script-urls
1380  if ( preg_match( '!url\s*\(\s*[\'"]?\s*(?:ecma|java)script:!sim', $chunk ) ) {
1381  wfDebug( __METHOD__ . ": found css-style script urls\n" );
1382 
1383  return true;
1384  }
1385 
1386  wfDebug( __METHOD__ . ": no scripts found\n" );
1387 
1388  return false;
1389  }
1390 
1398  public static function checkXMLEncodingMissmatch( $file ) {
1399  global $wgSVGMetadataCutoff;
1400  $contents = file_get_contents( $file, false, null, 0, $wgSVGMetadataCutoff );
1401  $encodingRegex = '!encoding[ \t\n\r]*=[ \t\n\r]*[\'"](.*?)[\'"]!si';
1402 
1403  if ( preg_match( "!<\?xml\b(.*?)\?>!si", $contents, $matches ) ) {
1404  if ( preg_match( $encodingRegex, $matches[1], $encMatch )
1405  && !in_array( strtoupper( $encMatch[1] ), self::$safeXmlEncodings )
1406  ) {
1407  wfDebug( __METHOD__ . ": Found unsafe XML encoding '{$encMatch[1]}'\n" );
1408 
1409  return true;
1410  }
1411  } elseif ( preg_match( "!<\?xml\b!si", $contents ) ) {
1412  // Start of XML declaration without an end in the first $wgSVGMetadataCutoff
1413  // bytes. There shouldn't be a legitimate reason for this to happen.
1414  wfDebug( __METHOD__ . ": Unmatched XML declaration start\n" );
1415 
1416  return true;
1417  } elseif ( substr( $contents, 0, 4 ) == "\x4C\x6F\xA7\x94" ) {
1418  // EBCDIC encoded XML
1419  wfDebug( __METHOD__ . ": EBCDIC Encoded XML\n" );
1420 
1421  return true;
1422  }
1423 
1424  // It's possible the file is encoded with multi-byte encoding, so re-encode attempt to
1425  // detect the encoding in case is specifies an encoding not whitelisted in self::$safeXmlEncodings
1426  $attemptEncodings = [ 'UTF-16', 'UTF-16BE', 'UTF-32', 'UTF-32BE' ];
1427  foreach ( $attemptEncodings as $encoding ) {
1428  Wikimedia\suppressWarnings();
1429  $str = iconv( $encoding, 'UTF-8', $contents );
1430  Wikimedia\restoreWarnings();
1431  if ( $str != '' && preg_match( "!<\?xml\b(.*?)\?>!si", $str, $matches ) ) {
1432  if ( preg_match( $encodingRegex, $matches[1], $encMatch )
1433  && !in_array( strtoupper( $encMatch[1] ), self::$safeXmlEncodings )
1434  ) {
1435  wfDebug( __METHOD__ . ": Found unsafe XML encoding '{$encMatch[1]}'\n" );
1436 
1437  return true;
1438  }
1439  } elseif ( $str != '' && preg_match( "!<\?xml\b!si", $str ) ) {
1440  // Start of XML declaration without an end in the first $wgSVGMetadataCutoff
1441  // bytes. There shouldn't be a legitimate reason for this to happen.
1442  wfDebug( __METHOD__ . ": Unmatched XML declaration start\n" );
1443 
1444  return true;
1445  }
1446  }
1447 
1448  return false;
1449  }
1450 
1456  protected function detectScriptInSvg( $filename, $partial ) {
1457  $this->mSVGNSError = false;
1458  $check = new XmlTypeCheck(
1459  $filename,
1460  [ $this, 'checkSvgScriptCallback' ],
1461  true,
1462  [
1463  'processing_instruction_handler' => 'UploadBase::checkSvgPICallback',
1464  'external_dtd_handler' => 'UploadBase::checkSvgExternalDTD',
1465  ]
1466  );
1467  if ( $check->wellFormed !== true ) {
1468  // Invalid xml (T60553)
1469  // But only when non-partial (T67724)
1470  return $partial ? false : [ 'uploadinvalidxml' ];
1471  } elseif ( $check->filterMatch ) {
1472  if ( $this->mSVGNSError ) {
1473  return [ 'uploadscriptednamespace', $this->mSVGNSError ];
1474  }
1475 
1476  return $check->filterMatchType;
1477  }
1478 
1479  return false;
1480  }
1481 
1488  public static function checkSvgPICallback( $target, $data ) {
1489  // Don't allow external stylesheets (T59550)
1490  if ( preg_match( '/xml-stylesheet/i', $target ) ) {
1491  return [ 'upload-scripted-pi-callback' ];
1492  }
1493 
1494  return false;
1495  }
1496 
1508  public static function checkSvgExternalDTD( $type, $publicId, $systemId ) {
1509  // This doesn't include the XHTML+MathML+SVG doctype since we don't
1510  // allow XHTML anyways.
1511  $allowedDTDs = [
1512  'http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd',
1513  'http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd',
1514  'http://www.w3.org/Graphics/SVG/1.1/DTD/svg11-basic.dtd',
1515  'http://www.w3.org/Graphics/SVG/1.1/DTD/svg11-tiny.dtd',
1516  // https://phabricator.wikimedia.org/T168856
1517  'http://www.w3.org/TR/2001/PR-SVG-20010719/DTD/svg10.dtd',
1518  ];
1519  if ( $type !== 'PUBLIC'
1520  || !in_array( $systemId, $allowedDTDs )
1521  || strpos( $publicId, "-//W3C//" ) !== 0
1522  ) {
1523  return [ 'upload-scripted-dtd' ];
1524  }
1525  return false;
1526  }
1527 
1535  public function checkSvgScriptCallback( $element, $attribs, $data = null ) {
1536  list( $namespace, $strippedElement ) = $this->splitXmlNamespace( $element );
1537 
1538  // We specifically don't include:
1539  // http://www.w3.org/1999/xhtml (T62771)
1540  static $validNamespaces = [
1541  '',
1542  'adobe:ns:meta/',
1543  'http://creativecommons.org/ns#',
1544  'http://inkscape.sourceforge.net/dtd/sodipodi-0.dtd',
1545  'http://ns.adobe.com/adobeillustrator/10.0/',
1546  'http://ns.adobe.com/adobesvgviewerextensions/3.0/',
1547  'http://ns.adobe.com/extensibility/1.0/',
1548  'http://ns.adobe.com/flows/1.0/',
1549  'http://ns.adobe.com/illustrator/1.0/',
1550  'http://ns.adobe.com/imagereplacement/1.0/',
1551  'http://ns.adobe.com/pdf/1.3/',
1552  'http://ns.adobe.com/photoshop/1.0/',
1553  'http://ns.adobe.com/saveforweb/1.0/',
1554  'http://ns.adobe.com/variables/1.0/',
1555  'http://ns.adobe.com/xap/1.0/',
1556  'http://ns.adobe.com/xap/1.0/g/',
1557  'http://ns.adobe.com/xap/1.0/g/img/',
1558  'http://ns.adobe.com/xap/1.0/mm/',
1559  'http://ns.adobe.com/xap/1.0/rights/',
1560  'http://ns.adobe.com/xap/1.0/stype/dimensions#',
1561  'http://ns.adobe.com/xap/1.0/stype/font#',
1562  'http://ns.adobe.com/xap/1.0/stype/manifestitem#',
1563  'http://ns.adobe.com/xap/1.0/stype/resourceevent#',
1564  'http://ns.adobe.com/xap/1.0/stype/resourceref#',
1565  'http://ns.adobe.com/xap/1.0/t/pg/',
1566  'http://purl.org/dc/elements/1.1/',
1567  'http://purl.org/dc/elements/1.1',
1568  'http://schemas.microsoft.com/visio/2003/svgextensions/',
1569  'http://sodipodi.sourceforge.net/dtd/sodipodi-0.dtd',
1570  'http://taptrix.com/inkpad/svg_extensions',
1571  'http://web.resource.org/cc/',
1572  'http://www.freesoftware.fsf.org/bkchem/cdml',
1573  'http://www.inkscape.org/namespaces/inkscape',
1574  'http://www.opengis.net/gml',
1575  'http://www.w3.org/1999/02/22-rdf-syntax-ns#',
1576  'http://www.w3.org/2000/svg',
1577  'http://www.w3.org/tr/rec-rdf-syntax/',
1578  'http://www.w3.org/2000/01/rdf-schema#',
1579  ];
1580 
1581  // Inkscape mangles namespace definitions created by Adobe Illustrator.
1582  // This is nasty but harmless. (T144827)
1583  $isBuggyInkscape = preg_match( '/^&(#38;)*ns_[a-z_]+;$/', $namespace );
1584 
1585  if ( !( $isBuggyInkscape || in_array( $namespace, $validNamespaces ) ) ) {
1586  wfDebug( __METHOD__ . ": Non-svg namespace '$namespace' in uploaded file.\n" );
1588  $this->mSVGNSError = $namespace;
1589 
1590  return true;
1591  }
1592 
1593  /*
1594  * check for elements that can contain javascript
1595  */
1596  if ( $strippedElement == 'script' ) {
1597  wfDebug( __METHOD__ . ": Found script element '$element' in uploaded file.\n" );
1598 
1599  return [ 'uploaded-script-svg', $strippedElement ];
1600  }
1601 
1602  # e.g., <svg xmlns="http://www.w3.org/2000/svg">
1603  # <handler xmlns:ev="http://www.w3.org/2001/xml-events" ev:event="load">alert(1)</handler> </svg>
1604  if ( $strippedElement == 'handler' ) {
1605  wfDebug( __METHOD__ . ": Found scriptable element '$element' in uploaded file.\n" );
1606 
1607  return [ 'uploaded-script-svg', $strippedElement ];
1608  }
1609 
1610  # SVG reported in Feb '12 that used xml:stylesheet to generate javascript block
1611  if ( $strippedElement == 'stylesheet' ) {
1612  wfDebug( __METHOD__ . ": Found scriptable element '$element' in uploaded file.\n" );
1613 
1614  return [ 'uploaded-script-svg', $strippedElement ];
1615  }
1616 
1617  # Block iframes, in case they pass the namespace check
1618  if ( $strippedElement == 'iframe' ) {
1619  wfDebug( __METHOD__ . ": iframe in uploaded file.\n" );
1620 
1621  return [ 'uploaded-script-svg', $strippedElement ];
1622  }
1623 
1624  # Check <style> css
1625  if ( $strippedElement == 'style'
1626  && self::checkCssFragment( Sanitizer::normalizeCss( $data ) )
1627  ) {
1628  wfDebug( __METHOD__ . ": hostile css in style element.\n" );
1629  return [ 'uploaded-hostile-svg' ];
1630  }
1631 
1632  foreach ( $attribs as $attrib => $value ) {
1633  $stripped = $this->stripXmlNamespace( $attrib );
1634  $value = strtolower( $value );
1635 
1636  if ( substr( $stripped, 0, 2 ) == 'on' ) {
1637  wfDebug( __METHOD__
1638  . ": Found event-handler attribute '$attrib'='$value' in uploaded file.\n" );
1639 
1640  return [ 'uploaded-event-handler-on-svg', $attrib, $value ];
1641  }
1642 
1643  # Do not allow relative links, or unsafe url schemas.
1644  # For <a> tags, only data:, http: and https: and same-document
1645  # fragment links are allowed. For all other tags, only data:
1646  # and fragment are allowed.
1647  if ( $stripped == 'href'
1648  && $value !== ''
1649  && strpos( $value, 'data:' ) !== 0
1650  && strpos( $value, '#' ) !== 0
1651  ) {
1652  if ( !( $strippedElement === 'a'
1653  && preg_match( '!^https?://!i', $value ) )
1654  ) {
1655  wfDebug( __METHOD__ . ": Found href attribute <$strippedElement "
1656  . "'$attrib'='$value' in uploaded file.\n" );
1657 
1658  return [ 'uploaded-href-attribute-svg', $strippedElement, $attrib, $value ];
1659  }
1660  }
1661 
1662  # only allow data: targets that should be safe. This prevents vectors like,
1663  # image/svg, text/xml, application/xml, and text/html, which can contain scripts
1664  if ( $stripped == 'href' && strncasecmp( 'data:', $value, 5 ) === 0 ) {
1665  // rfc2397 parameters. This is only slightly slower than (;[\w;]+)*.
1666  // phpcs:ignore Generic.Files.LineLength
1667  $parameters = '(?>;[a-zA-Z0-9\!#$&\'*+.^_`{|}~-]+=(?>[a-zA-Z0-9\!#$&\'*+.^_`{|}~-]+|"(?>[\0-\x0c\x0e-\x21\x23-\x5b\x5d-\x7f]+|\\\\[\0-\x7f])*"))*(?:;base64)?';
1668 
1669  if ( !preg_match( "!^data:\s*image/(gif|jpeg|jpg|png)$parameters,!i", $value ) ) {
1670  wfDebug( __METHOD__ . ": Found href to unwhitelisted data: uri "
1671  . "\"<$strippedElement '$attrib'='$value'...\" in uploaded file.\n" );
1672  return [ 'uploaded-href-unsafe-target-svg', $strippedElement, $attrib, $value ];
1673  }
1674  }
1675 
1676  # Change href with animate from (http://html5sec.org/#137).
1677  if ( $stripped === 'attributename'
1678  && $strippedElement === 'animate'
1679  && $this->stripXmlNamespace( $value ) == 'href'
1680  ) {
1681  wfDebug( __METHOD__ . ": Found animate that might be changing href using from "
1682  . "\"<$strippedElement '$attrib'='$value'...\" in uploaded file.\n" );
1683 
1684  return [ 'uploaded-animate-svg', $strippedElement, $attrib, $value ];
1685  }
1686 
1687  # use set/animate to add event-handler attribute to parent
1688  if ( ( $strippedElement == 'set' || $strippedElement == 'animate' )
1689  && $stripped == 'attributename'
1690  && substr( $value, 0, 2 ) == 'on'
1691  ) {
1692  wfDebug( __METHOD__ . ": Found svg setting event-handler attribute with "
1693  . "\"<$strippedElement $stripped='$value'...\" in uploaded file.\n" );
1694 
1695  return [ 'uploaded-setting-event-handler-svg', $strippedElement, $stripped, $value ];
1696  }
1697 
1698  # use set to add href attribute to parent element
1699  if ( $strippedElement == 'set'
1700  && $stripped == 'attributename'
1701  && strpos( $value, 'href' ) !== false
1702  ) {
1703  wfDebug( __METHOD__ . ": Found svg setting href attribute '$value' in uploaded file.\n" );
1704 
1705  return [ 'uploaded-setting-href-svg' ];
1706  }
1707 
1708  # use set to add a remote / data / script target to an element
1709  if ( $strippedElement == 'set'
1710  && $stripped == 'to'
1711  && preg_match( '!(http|https|data|script):!sim', $value )
1712  ) {
1713  wfDebug( __METHOD__ . ": Found svg setting attribute to '$value' in uploaded file.\n" );
1714 
1715  return [ 'uploaded-wrong-setting-svg', $value ];
1716  }
1717 
1718  # use handler attribute with remote / data / script
1719  if ( $stripped == 'handler' && preg_match( '!(http|https|data|script):!sim', $value ) ) {
1720  wfDebug( __METHOD__ . ": Found svg setting handler with remote/data/script "
1721  . "'$attrib'='$value' in uploaded file.\n" );
1722 
1723  return [ 'uploaded-setting-handler-svg', $attrib, $value ];
1724  }
1725 
1726  # use CSS styles to bring in remote code
1727  if ( $stripped == 'style'
1728  && self::checkCssFragment( Sanitizer::normalizeCss( $value ) )
1729  ) {
1730  wfDebug( __METHOD__ . ": Found svg setting a style with "
1731  . "remote url '$attrib'='$value' in uploaded file.\n" );
1732  return [ 'uploaded-remote-url-svg', $attrib, $value ];
1733  }
1734 
1735  # Several attributes can include css, css character escaping isn't allowed
1736  $cssAttrs = [ 'font', 'clip-path', 'fill', 'filter', 'marker',
1737  'marker-end', 'marker-mid', 'marker-start', 'mask', 'stroke' ];
1738  if ( in_array( $stripped, $cssAttrs )
1739  && self::checkCssFragment( $value )
1740  ) {
1741  wfDebug( __METHOD__ . ": Found svg setting a style with "
1742  . "remote url '$attrib'='$value' in uploaded file.\n" );
1743  return [ 'uploaded-remote-url-svg', $attrib, $value ];
1744  }
1745 
1746  # image filters can pull in url, which could be svg that executes scripts
1747  # Only allow url( "#foo" ). Do not allow url( http://example.com )
1748  if ( $strippedElement == 'image'
1749  && $stripped == 'filter'
1750  && preg_match( '!url\s*\(\s*["\']?[^#]!sim', $value )
1751  ) {
1752  wfDebug( __METHOD__ . ": Found image filter with url: "
1753  . "\"<$strippedElement $stripped='$value'...\" in uploaded file.\n" );
1754 
1755  return [ 'uploaded-image-filter-svg', $strippedElement, $stripped, $value ];
1756  }
1757  }
1758 
1759  return false; // No scripts detected
1760  }
1761 
1769  private static function checkCssFragment( $value ) {
1770  # Forbid external stylesheets, for both reliability and to protect viewer's privacy
1771  if ( stripos( $value, '@import' ) !== false ) {
1772  return true;
1773  }
1774 
1775  # We allow @font-face to embed fonts with data: urls, so we snip the string
1776  # 'url' out so this case won't match when we check for urls below
1777  $pattern = '!(@font-face\s*{[^}]*src:)url(\("data:;base64,)!im';
1778  $value = preg_replace( $pattern, '$1$2', $value );
1779 
1780  # Check for remote and executable CSS. Unlike in Sanitizer::checkCss, the CSS
1781  # properties filter and accelerator don't seem to be useful for xss in SVG files.
1782  # Expression and -o-link don't seem to work either, but filtering them here in case.
1783  # Additionally, we catch remote urls like url("http:..., url('http:..., url(http:...,
1784  # but not local ones such as url("#..., url('#..., url(#....
1785  if ( preg_match( '!expression
1786  | -o-link\s*:
1787  | -o-link-source\s*:
1788  | -o-replace\s*:!imx', $value ) ) {
1789  return true;
1790  }
1791 
1792  if ( preg_match_all(
1793  "!(\s*(url|image|image-set)\s*\(\s*[\"']?\s*[^#]+.*?\))!sim",
1794  $value,
1795  $matches
1796  ) !== 0
1797  ) {
1798  # TODO: redo this in one regex. Until then, url("#whatever") matches the first
1799  foreach ( $matches[1] as $match ) {
1800  if ( !preg_match( "!\s*(url|image|image-set)\s*\(\s*(#|'#|\"#)!im", $match ) ) {
1801  return true;
1802  }
1803  }
1804  }
1805 
1806  if ( preg_match( '/[\000-\010\013\016-\037\177]/', $value ) ) {
1807  return true;
1808  }
1809 
1810  return false;
1811  }
1812 
1818  private static function splitXmlNamespace( $element ) {
1819  // 'http://www.w3.org/2000/svg:script' -> [ 'http://www.w3.org/2000/svg', 'script' ]
1820  $parts = explode( ':', strtolower( $element ) );
1821  $name = array_pop( $parts );
1822  $ns = implode( ':', $parts );
1823 
1824  return [ $ns, $name ];
1825  }
1826 
1831  private function stripXmlNamespace( $name ) {
1832  // 'http://www.w3.org/2000/svg:script' -> 'script'
1833  $parts = explode( ':', strtolower( $name ) );
1834 
1835  return array_pop( $parts );
1836  }
1837 
1848  public static function detectVirus( $file ) {
1850 
1851  if ( !$wgAntivirus ) {
1852  wfDebug( __METHOD__ . ": virus scanner disabled\n" );
1853 
1854  return null;
1855  }
1856 
1857  if ( !$wgAntivirusSetup[$wgAntivirus] ) {
1858  wfDebug( __METHOD__ . ": unknown virus scanner: $wgAntivirus\n" );
1859  $wgOut->wrapWikiMsg( "<div class=\"error\">\n$1\n</div>",
1860  [ 'virus-badscanner', $wgAntivirus ] );
1861 
1862  return wfMessage( 'virus-unknownscanner' )->text() . " $wgAntivirus";
1863  }
1864 
1865  # look up scanner configuration
1866  $command = $wgAntivirusSetup[$wgAntivirus]['command'];
1867  $exitCodeMap = $wgAntivirusSetup[$wgAntivirus]['codemap'];
1868  $msgPattern = $wgAntivirusSetup[$wgAntivirus]['messagepattern'] ?? null;
1869 
1870  if ( strpos( $command, "%f" ) === false ) {
1871  # simple pattern: append file to scan
1872  $command .= " " . Shell::escape( $file );
1873  } else {
1874  # complex pattern: replace "%f" with file to scan
1875  $command = str_replace( "%f", Shell::escape( $file ), $command );
1876  }
1877 
1878  wfDebug( __METHOD__ . ": running virus scan: $command \n" );
1879 
1880  # execute virus scanner
1881  $exitCode = false;
1882 
1883  # NOTE: there's a 50 line workaround to make stderr redirection work on windows, too.
1884  # that does not seem to be worth the pain.
1885  # Ask me (Duesentrieb) about it if it's ever needed.
1886  $output = wfShellExecWithStderr( $command, $exitCode );
1887 
1888  # map exit code to AV_xxx constants.
1889  $mappedCode = $exitCode;
1890  if ( $exitCodeMap ) {
1891  if ( isset( $exitCodeMap[$exitCode] ) ) {
1892  $mappedCode = $exitCodeMap[$exitCode];
1893  } elseif ( isset( $exitCodeMap["*"] ) ) {
1894  $mappedCode = $exitCodeMap["*"];
1895  }
1896  }
1897 
1898  /* NB: AV_NO_VIRUS is 0 but AV_SCAN_FAILED is false,
1899  * so we need the strict equalities === and thus can't use a switch here
1900  */
1901  if ( $mappedCode === AV_SCAN_FAILED ) {
1902  # scan failed (code was mapped to false by $exitCodeMap)
1903  wfDebug( __METHOD__ . ": failed to scan $file (code $exitCode).\n" );
1904 
1905  $output = $wgAntivirusRequired
1906  ? wfMessage( 'virus-scanfailed', [ $exitCode ] )->text()
1907  : null;
1908  } elseif ( $mappedCode === AV_SCAN_ABORTED ) {
1909  # scan failed because filetype is unknown (probably imune)
1910  wfDebug( __METHOD__ . ": unsupported file type $file (code $exitCode).\n" );
1911  $output = null;
1912  } elseif ( $mappedCode === AV_NO_VIRUS ) {
1913  # no virus found
1914  wfDebug( __METHOD__ . ": file passed virus scan.\n" );
1915  $output = false;
1916  } else {
1917  $output = trim( $output );
1918 
1919  if ( !$output ) {
1920  $output = true; # if there's no output, return true
1921  } elseif ( $msgPattern ) {
1922  $groups = [];
1923  if ( preg_match( $msgPattern, $output, $groups ) && $groups[1] ) {
1924  $output = $groups[1];
1925  }
1926  }
1927 
1928  wfDebug( __METHOD__ . ": FOUND VIRUS! scanner feedback: $output \n" );
1929  }
1930 
1931  return $output;
1932  }
1933 
1942  private function checkOverwrite( $user ) {
1943  // First check whether the local file can be overwritten
1944  $file = $this->getLocalFile();
1945  $file->load( File::READ_LATEST );
1946  if ( $file->exists() ) {
1947  if ( !self::userCanReUpload( $user, $file ) ) {
1948  return [ 'fileexists-forbidden', $file->getName() ];
1949  } else {
1950  return true;
1951  }
1952  }
1953 
1954  /* Check shared conflicts: if the local file does not exist, but
1955  * wfFindFile finds a file, it exists in a shared repository.
1956  */
1957  $file = wfFindFile( $this->getTitle(), [ 'latest' => true ] );
1958  if ( $file && !$user->isAllowed( 'reupload-shared' ) ) {
1959  return [ 'fileexists-shared-forbidden', $file->getName() ];
1960  }
1961 
1962  return true;
1963  }
1964 
1972  public static function userCanReUpload( User $user, File $img ) {
1973  if ( $user->isAllowed( 'reupload' ) ) {
1974  return true; // non-conditional
1975  } elseif ( !$user->isAllowed( 'reupload-own' ) ) {
1976  return false;
1977  }
1978 
1979  if ( !( $img instanceof LocalFile ) ) {
1980  return false;
1981  }
1982 
1983  $img->load();
1984 
1985  return $user->getId() == $img->getUser( 'id' );
1986  }
1987 
1999  public static function getExistsWarning( $file ) {
2000  if ( $file->exists() ) {
2001  return [ 'warning' => 'exists', 'file' => $file ];
2002  }
2003 
2004  if ( $file->getTitle()->getArticleID() ) {
2005  return [ 'warning' => 'page-exists', 'file' => $file ];
2006  }
2007 
2008  if ( strpos( $file->getName(), '.' ) == false ) {
2009  $partname = $file->getName();
2010  $extension = '';
2011  } else {
2012  $n = strrpos( $file->getName(), '.' );
2013  $extension = substr( $file->getName(), $n + 1 );
2014  $partname = substr( $file->getName(), 0, $n );
2015  }
2016  $normalizedExtension = File::normalizeExtension( $extension );
2017 
2018  if ( $normalizedExtension != $extension ) {
2019  // We're not using the normalized form of the extension.
2020  // Normal form is lowercase, using most common of alternate
2021  // extensions (eg 'jpg' rather than 'JPEG').
2022 
2023  // Check for another file using the normalized form...
2024  $nt_lc = Title::makeTitle( NS_FILE, "{$partname}.{$normalizedExtension}" );
2025  $file_lc = wfLocalFile( $nt_lc );
2026 
2027  if ( $file_lc->exists() ) {
2028  return [
2029  'warning' => 'exists-normalized',
2030  'file' => $file,
2031  'normalizedFile' => $file_lc
2032  ];
2033  }
2034  }
2035 
2036  // Check for files with the same name but a different extension
2037  $similarFiles = RepoGroup::singleton()->getLocalRepo()->findFilesByPrefix(
2038  "{$partname}.", 1 );
2039  if ( count( $similarFiles ) ) {
2040  return [
2041  'warning' => 'exists-normalized',
2042  'file' => $file,
2043  'normalizedFile' => $similarFiles[0],
2044  ];
2045  }
2046 
2047  if ( self::isThumbName( $file->getName() ) ) {
2048  # Check for filenames like 50px- or 180px-, these are mostly thumbnails
2049  $nt_thb = Title::newFromText(
2050  substr( $partname, strpos( $partname, '-' ) + 1 ) . '.' . $extension,
2051  NS_FILE
2052  );
2053  $file_thb = wfLocalFile( $nt_thb );
2054  if ( $file_thb->exists() ) {
2055  return [
2056  'warning' => 'thumb',
2057  'file' => $file,
2058  'thumbFile' => $file_thb
2059  ];
2060  } else {
2061  // File does not exist, but we just don't like the name
2062  return [
2063  'warning' => 'thumb-name',
2064  'file' => $file,
2065  'thumbFile' => $file_thb
2066  ];
2067  }
2068  }
2069 
2070  foreach ( self::getFilenamePrefixBlacklist() as $prefix ) {
2071  if ( substr( $partname, 0, strlen( $prefix ) ) == $prefix ) {
2072  return [
2073  'warning' => 'bad-prefix',
2074  'file' => $file,
2075  'prefix' => $prefix
2076  ];
2077  }
2078  }
2079 
2080  return false;
2081  }
2082 
2088  public static function isThumbName( $filename ) {
2089  $n = strrpos( $filename, '.' );
2090  $partname = $n ? substr( $filename, 0, $n ) : $filename;
2091 
2092  return (
2093  substr( $partname, 3, 3 ) == 'px-' ||
2094  substr( $partname, 2, 3 ) == 'px-'
2095  ) &&
2096  preg_match( "/[0-9]{2}/", substr( $partname, 0, 2 ) );
2097  }
2098 
2104  public static function getFilenamePrefixBlacklist() {
2105  $blacklist = [];
2106  $message = wfMessage( 'filename-prefix-blacklist' )->inContentLanguage();
2107  if ( !$message->isDisabled() ) {
2108  $lines = explode( "\n", $message->plain() );
2109  foreach ( $lines as $line ) {
2110  // Remove comment lines
2111  $comment = substr( trim( $line ), 0, 1 );
2112  if ( $comment == '#' || $comment == '' ) {
2113  continue;
2114  }
2115  // Remove additional comments after a prefix
2116  $comment = strpos( $line, '#' );
2117  if ( $comment > 0 ) {
2118  $line = substr( $line, 0, $comment - 1 );
2119  }
2120  $blacklist[] = trim( $line );
2121  }
2122  }
2123 
2124  return $blacklist;
2125  }
2126 
2138  public function getImageInfo( $result ) {
2139  $localFile = $this->getLocalFile();
2140  $stashFile = $this->getStashFile();
2141  // Calling a different API module depending on whether the file was stashed is less than optimal.
2142  // In fact, calling API modules here at all is less than optimal. Maybe it should be refactored.
2143  if ( $stashFile ) {
2145  $info = ApiQueryStashImageInfo::getInfo( $stashFile, array_flip( $imParam ), $result );
2146  } else {
2148  $info = ApiQueryImageInfo::getInfo( $localFile, array_flip( $imParam ), $result );
2149  }
2150 
2151  return $info;
2152  }
2153 
2158  public function convertVerifyErrorToStatus( $error ) {
2159  $code = $error['status'];
2160  unset( $code['status'] );
2161 
2162  return Status::newFatal( $this->getVerificationErrorCode( $code ), $error );
2163  }
2164 
2172  public static function getMaxUploadSize( $forType = null ) {
2173  global $wgMaxUploadSize;
2174 
2175  if ( is_array( $wgMaxUploadSize ) ) {
2176  if ( !is_null( $forType ) && isset( $wgMaxUploadSize[$forType] ) ) {
2177  return $wgMaxUploadSize[$forType];
2178  } else {
2179  return $wgMaxUploadSize['*'];
2180  }
2181  } else {
2182  return intval( $wgMaxUploadSize );
2183  }
2184  }
2185 
2193  public static function getMaxPhpUploadSize() {
2194  $phpMaxFileSize = wfShorthandToInteger(
2195  ini_get( 'upload_max_filesize' ) ?: ini_get( 'hhvm.server.upload.upload_max_file_size' ),
2196  PHP_INT_MAX
2197  );
2198  $phpMaxPostSize = wfShorthandToInteger(
2199  ini_get( 'post_max_size' ) ?: ini_get( 'hhvm.server.max_post_size' ),
2200  PHP_INT_MAX
2201  ) ?: PHP_INT_MAX;
2202  return min( $phpMaxFileSize, $phpMaxPostSize );
2203  }
2204 
2214  public static function getSessionStatus( User $user, $statusKey ) {
2215  $store = self::getUploadSessionStore();
2216  $key = self::getUploadSessionKey( $store, $user, $statusKey );
2217 
2218  return $store->get( $key );
2219  }
2220 
2233  public static function setSessionStatus( User $user, $statusKey, $value ) {
2234  $store = self::getUploadSessionStore();
2235  $key = self::getUploadSessionKey( $store, $user, $statusKey );
2236 
2237  if ( $value === false ) {
2238  $store->delete( $key );
2239  } else {
2240  $store->set( $key, $value, $store::TTL_DAY );
2241  }
2242  }
2243 
2250  private static function getUploadSessionKey( BagOStuff $store, User $user, $statusKey ) {
2251  return $store->makeKey(
2252  'uploadstatus',
2253  $user->getId() ?: md5( $user->getName() ),
2254  $statusKey
2255  );
2256  }
2257 
2261  private static function getUploadSessionStore() {
2262  return ObjectCache::getInstance( 'db-replicated' );
2263  }
2264 }
$wgStrictFileExtensions
If this is turned off, users may override the warning for files not covered by $wgFileExtensions.
checkOverwrite( $user)
Check if there&#39;s an overwrite conflict and, if so, if restrictions forbid this user from performing t...
detectScriptInSvg( $filename, $partial)
return true to allow those checks to and false if checking is done remove or add to the links of a group of changes in EnhancedChangesList Hook subscribers can return false to omit this line from recentchanges use this to change the tables headers change it to an object instance and return false override the list derivative used $groups Array of ChangesListFilterGroup objects(added in 1.34) 'FileDeleteComplete' null for the local wiki Added in
Definition: hooks.txt:1529
null means default in associative array form
Definition: hooks.txt:1972
exists()
canRender inherited
Definition: LocalFile.php:986
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition: deferred.txt:11
const FILENAME_TOO_LONG
Definition: UploadBase.php:104
static getUploadSessionKey(BagOStuff $store, User $user, $statusKey)
$wgSVGMetadataCutoff
Don&#39;t read SVG metadata beyond this point.
$wgDisableUploadScriptChecks
Setting this to true will disable the upload system&#39;s checks for HTML/JavaScript. ...
static splitXmlNamespace( $element)
Divide the element name passed by the xml parser to the callback into URI and prifix.
static getPropertyNames( $filter=[])
Returns all possible parameters to iiprop.
tryStashFile(User $user, $isPartial=false)
Like stashFile(), but respects extensions&#39; wishes to prevent the stashing.
wfIsHHVM()
Check if we are running under HHVM.
int $mTitleError
Definition: UploadBase.php:55
const SUCCESS
Definition: UploadBase.php:92
static createFromRequest(&$request, $type=null)
Create a form of UploadBase depending on wpSourceType and initializes it.
Definition: UploadBase.php:181
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:187
convertVerifyErrorToStatus( $error)
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
if(PHP_SAPI !='cli-server') if(!isset( $_SERVER['SCRIPT_FILENAME'])) $file
Definition: router.php:42
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2147
$command
Definition: cdb.php:65
globals txt Globals are evil The original MediaWiki code relied on globals for processing context far too often MediaWiki development since then has been a story of slowly moving context out of global variables and into objects Storing processing context in object member variables allows those objects to be reused in a much more flexible way Consider the elegance of
database rows
Definition: globals.txt:10
const DELETE_SOURCE
Definition: File.php:76
string null $mSVGNSError
Definition: UploadBase.php:73
static getSessionStatus(User $user, $statusKey)
Get the current status of a chunked upload (used for polling)
const OVERWRITE_EXISTING_FILE
Definition: UploadBase.php:97
static $safeXmlEncodings
Definition: UploadBase.php:75
This class is used to hold the location and do limited manipulation of files stored temporarily (this...
Definition: TempFSFile.php:30
you don t have to do a grep find to see where the $wgReverseTitle variable is used
Definition: hooks.txt:115
has been added to your &Future changes to this page and its associated Talk page will be listed there
$value
initializePathInfo( $name, $tempPath, $fileSize, $removeTempFile=false)
Initialize the path information.
Definition: UploadBase.php:250
static getUploadSessionStore()
makeKey( $class,... $components)
Make a cache key, scoped to this instance&#39;s keyspace.
static normalizeCss( $value)
Normalize CSS into a format we can easily search for hostile input.
Definition: Sanitizer.php:958
wfStripIllegalFilenameChars( $name)
Replace all invalid characters with &#39;-&#39;.
const AV_NO_VIRUS
Definition: Defines.php:91
static getInstance( $id)
Get a cached instance of the specified type of cache object.
Definition: ObjectCache.php:92
checkLocalFileExists(LocalFile $localFile, $hash)
Definition: UploadBase.php:806
string null $mSourceType
Definition: UploadBase.php:51
static splitExtensions( $filename)
Split a file into a base name and all dot-delimited &#39;extensions&#39; on the end.
static detectScript( $file, $mime, $extension)
Heuristic for detecting files that could contain JavaScript instructions or things that may look like...
string null $mDestName
Definition: UploadBase.php:47
checkUnwantedFileExtensions( $fileExtension)
Definition: UploadBase.php:762
A helper class for throttling authentication attempts.
const ILLEGAL_FILENAME
Definition: UploadBase.php:96
isEmptyFile()
Return true if the file is empty.
Definition: UploadBase.php:296
const AV_SCAN_FAILED
Definition: Defines.php:94
string $mTempPath
Local file system path to the file to upload (or a local copy)
Definition: UploadBase.php:41
target page
static getMaxUploadSize( $forType=null)
Get the MediaWiki maximum uploaded file size for given type of upload, based on $wgMaxUploadSize.
static isStoragePath( $path)
Check if a given path is a "mwstore://" path.
static getInstance()
Returns the global default instance of the top level service locator.
wfLocalFile( $title)
Get an object referring to a locally registered file.
$wgAllowJavaUploads
Allow Java archive uploads.
getName()
Get the user name, or the IP of an anonymous user.
Definition: User.php:2251
const AV_SCAN_ABORTED
Definition: Defines.php:93
const DELETED_FILE
Definition: File.php:63
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title e g db for database replication lag or jobqueue for job queue size converted to pseudo seconds It is possible to add more fields and they will be returned to the user in the API response after the basic globals have been set but before ordinary actions take place $output
Definition: hooks.txt:2205
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\*-\*)") will be honored when streaming the file. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED since 1.28! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1970
checkAgainstArchiveDupes( $hash)
Definition: UploadBase.php:862
verifyPartialFile()
A verification routine suitable for partial files.
Definition: UploadBase.php:516
$wgCheckFileExtensions
This is a flag to determine whether or not to check file extensions on upload.
The User object encapsulates all of the user-specific settings (user_id, name, rights, email address, options, last login time).
Definition: User.php:51
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable modifiable after all normalizations have been except for the $wgMaxImageArea check set to true or false to override the $wgMaxImageArea check result gives extension the possibility to transform it themselves $handler
Definition: hooks.txt:767
$wgEnableUploads
Allow users to upload files.
static checkCssFragment( $value)
Check a block of CSS or CSS fragment for anything that looks like it is bringing in remote code...
static newFatal( $message)
Factory function for fatal errors.
Definition: StatusValue.php:68
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action, or null $user:User who performed the tagging when the tagging is subsequent to the action, or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, whether it is OK to use $contentModel on $title. Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy:boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'ContentSecurityPolicyDefaultSource':Modify the allowed CSP load sources. This affects all directives except for the script directive. If you want to add a script source, see ContentSecurityPolicyScriptSource hook. & $defaultSrc:Array of Content-Security-Policy allowed sources $policyConfig:Current configuration for the Content-Security-Policy header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyDirectives':Modify the content security policy directives. Use this only if ContentSecurityPolicyDefaultSource and ContentSecurityPolicyScriptSource do not meet your needs. & $directives:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyScriptSource':Modify the allowed CSP script sources. Note that you also have to use ContentSecurityPolicyDefaultSource if you want non-script sources to be loaded from whatever you add. & $scriptSrc:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DeleteUnknownPreferences':Called by the cleanupPreferences.php maintenance script to build a WHERE clause with which to delete preferences that are not known about. This hook is used by extensions that have dynamically-named preferences that should not be deleted in the usual cleanup process. For example, the Gadgets extension creates preferences prefixed with 'gadget-', and so anything with that prefix is excluded from the deletion. &where:An array that will be passed as the $cond parameter to IDatabase::select() to determine what will be deleted from the user_properties table. $db:The IDatabase object, useful for accessing $db->buildLike() etc. 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function. $differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable 's value is null. This hook can be used to inject content into said class member variable. $differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the "mark as patrolled" link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink". $differenceEngine:DifferenceEngine object & $markAsPatrolledLink:The "mark as patrolled" link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter. For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions. & $rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision 's author, whether the revision was marked as a minor edit or not, etc. $differenceEngine:DifferenceEngine object & $newHeader:The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
Definition: hooks.txt:1244
Class representing a row of the &#39;filearchive&#39; table.
getHistory( $limit=null, $start=null, $end=null, $inc=true)
purgeDescription inherited
Definition: LocalFile.php:1183
wasDeleted()
Was this file ever deleted from the wiki?
Definition: File.php:1914
$wgLang
Definition: Setup.php:922
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation use $formDescriptor instead default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "&lt
$wgAntivirusRequired
Determines if a failed virus scan (AV_SCAN_FAILED) will cause the file to be rejected.
Using a hook running we can avoid having all this option specific stuff in our mainline code Using the function We ve cleaned up the code here by removing clumps of infrequently used code and moving them off somewhere else It s much easier for someone working with this code to see what s _really_ going and make changes or fix bugs In we can take all the code that deals with the little used title reversing we can concentrate it all in an extension file
Definition: hooks.txt:91
getTempFileSha1Base36()
Get the base 36 SHA1 of the file.
Definition: UploadBase.php:312
UploadBase and subclasses are the backend of MediaWiki&#39;s file uploads.
Definition: UploadBase.php:39
static getInfo( $file, $prop, $result, $thumbParams=null, $opts=false)
Get result information for an image revision.
getDBkey()
Get the main part with underscores.
Definition: Title.php:1021
static checkSvgPICallback( $target, $data)
Callback to filter SVG Processing Instructions.
static singleton()
Definition: RepoGroup.php:60
fetchFile()
Fetch the file.
Definition: UploadBase.php:288
static newGood( $value=null)
Factory function for good results.
Definition: StatusValue.php:81
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
int null $mFileSize
Definition: UploadBase.php:65
string null $mRemoveTempFile
Definition: UploadBase.php:49
postProcessUpload()
Perform extra steps after a successful upload.
Definition: UploadBase.php:935
static isVirtualUrl( $url)
Determine if a string is an mwrepo:// URL.
Definition: FileRepo.php:257
const IGNORE_USER_RIGHTS
Definition: User.php:83
static doWatch(Title $title, User $user, $checkRights=User::CHECK_USER_RIGHTS)
Watch a page.
getTitle()
Returns the title of the file to be uploaded.
Definition: UploadBase.php:944
static makeWarningsSerializable( $warnings)
Convert the warnings array returned by checkWarnings() to something that can be serialized.
Definition: UploadBase.php:718
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing & $attribs
Definition: hooks.txt:1972
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback function
Definition: injection.txt:30
cleanupTempFile()
If we&#39;ve modified the upload file we need to manually remove it on exit to clean up.
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:767
getSourceType()
Returns the upload type.
Definition: UploadBase.php:238
LocalFile $mLocalFile
Definition: UploadBase.php:61
static checkSvgExternalDTD( $type, $publicId, $systemId)
Verify that DTD urls referenced are only the standard dtds.
const FILE_TOO_LARGE
Definition: UploadBase.php:102
checkBadFileName( $filename, $desiredFileName)
Check whether the resulting filename is different from the desired one, but ignore things like ucfirs...
Definition: UploadBase.php:743
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:912
string null $mFinalExtension
Definition: UploadBase.php:59
checkWarnings()
Check for non fatal problems with the file.
Definition: UploadBase.php:659
initializeFromRequest(&$request)
Initialize from a WebRequest.
verifyUpload()
Verify whether the upload is sane.
Definition: UploadBase.php:342
const MIN_LENGTH_PARTNAME
Definition: UploadBase.php:95
getFileSize()
Return the file size.
Definition: UploadBase.php:304
$wgVerifyMimeTypeIE
Determines whether extra checks for IE type detection should be applied.
const NS_FILE
Definition: Defines.php:66
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for and distribution as defined by Sections through of this document Licensor shall mean the copyright owner or entity authorized by the copyright owner that is granting the License Legal Entity shall mean the union of the acting entity and all other entities that control are controlled by or are under common control with that entity For the purposes of this definition control direct or to cause the direction or management of such whether by contract or including but not limited to software source documentation and configuration files Object form shall mean any form resulting from mechanical transformation or translation of a Source including but not limited to compiled object generated and conversions to other media types Work shall mean the work of whether in Source or Object made available under the as indicated by a copyright notice that is included in or attached to the whether in Source or Object that is based or other modifications as a an original work of authorship For the purposes of this Derivative Works shall not include works that remain separable or merely the Work and Derivative Works thereof Contribution shall mean any work of including the original version of the Work and any modifications or additions to that Work or Derivative Works that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner For the purposes of this submitted means any form of or written communication sent to the Licensor or its including but not limited to communication on electronic mailing source code control and issue tracking systems that are managed by
const VERIFICATION_ERROR
Definition: UploadBase.php:100
static getSha1Base36FromPath( $path)
Get a SHA-1 hash of a file in the local filesystem, in base-36 lower case encoding, zero padded to 31 digits.
Definition: FSFile.php:218
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable & $code
Definition: hooks.txt:767
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
string null $mDesiredDestName
Definition: UploadBase.php:45
array null $mFileProps
Definition: UploadBase.php:67
static isEnabled()
Returns true if uploads are enabled.
Definition: UploadBase.php:132
doStashFile(User $user=null)
Implementation for stashFile() and tryStashFile().
validateName()
Verify that the name is valid and, if necessary, that we can overwrite.
Definition: UploadBase.php:391
static isThrottled( $user)
Returns true if the user has surpassed the upload rate limit, false otherwise.
Definition: UploadBase.php:167
static checkXMLEncodingMissmatch( $file)
Check a whitelist of xml encodings that are known not to be interpreted differently by the server&#39;s x...
const FILETYPE_BADTYPE
Definition: UploadBase.php:99
$wgMaxUploadSize
Max size for uploads, in bytes.
getLocalFile()
Return the local file and initializes if necessary.
$wgAntivirusSetup
Configuration for different virus scanners.
const FILETYPE_MISSING
Definition: UploadBase.php:98
Title bool $mTitle
Definition: UploadBase.php:53
getRealPath( $srcPath)
Definition: UploadBase.php:320
static makeTitleSafe( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:620
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:592
verifyPermissions( $user)
Alias for verifyTitlePermissions.
Definition: UploadBase.php:606
$wgFileExtensions
This is the list of preferred extensions for uploading files.
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
verifyTitlePermissions( $user)
Check whether the user can edit, upload and create the image.
Definition: UploadBase.php:621
static getFilenamePrefixBlacklist()
Get a list of blacklisted filename prefixes from [[MediaWiki:Filename-prefix-blacklist]].
$wgUploadSizeWarning
Warn if uploaded files are larger than this (in bytes), or false to disable.
this hook is for auditing only RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your own(ChangesListBooleanFilterGroup or ChangesListStringOptionsFilterGroup). If you create new groups
$lines
Definition: router.php:61
const HOOK_ABORTED
Definition: UploadBase.php:101
string [] $mBlackListedExtensions
Definition: UploadBase.php:69
stashFile(User $user=null)
If the user does not supply all necessary information in the first upload form submission (either by ...
bool null $mJavaDetected
Definition: UploadBase.php:71
getId()
Get the user&#39;s ID.
Definition: User.php:2224
static isThumbName( $filename)
Helper function that checks whether the filename looks like a thumbnail.
static capitalize( $text, $ns=NS_MAIN)
Capitalize a text string for a title if it belongs to a namespace that capitalizes.
Definition: Title.php:3183
performUpload( $comment, $pageText, $watch, $user, $tags=[])
Really perform the upload.
Definition: UploadBase.php:888
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
$line
Definition: cdb.php:59
static $uploadHandlers
Definition: UploadBase.php:172
static decodeCharReferences( $text)
Decode any character references, numeric or named entities, in the text and return a UTF-8 string...
Definition: Sanitizer.php:1669
wfShellExecWithStderr( $cmd, &$retval=null, $environ=[], $limits=[])
Execute a shell command, returning both stdout and stderr.
checkFileSize( $fileSize)
Definition: UploadBase.php:784
const WINDOWS_NONASCII_FILENAME
Definition: UploadBase.php:103
if(!is_readable( $file)) $ext
Definition: router.php:48
checkAgainstExistingDupes( $hash, $ignoreLocalDupes)
Definition: UploadBase.php:840
Class to represent a local file in the wiki&#39;s own database.
Definition: LocalFile.php:56
MimeMagic helper wrapper.
Definition: MWFileProps.php:28
string null $mFilteredName
Definition: UploadBase.php:57
stripXmlNamespace( $name)
static checkFileExtensionList( $ext, $list)
Perform case-insensitive match against a list of file extensions.
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
static getMaxPhpUploadSize()
Get the PHP maximum uploaded file size, based on ini settings.
$wgOut
Definition: Setup.php:927
static detectVirus( $file)
Generic wrapper function for a virus scanner program.
static verifyExtension( $mime, $extension)
Checks if the MIME type of the uploaded file matches the file extension.
static setSessionStatus(User $user, $statusKey, $value)
Set the current status of a chunked upload (used for polling)
wfArrayDiff2( $a, $b)
Like array_diff( $a, $b ) except that it works with two-dimensional arrays.
setTempFile( $tempPath, $fileSize=null)
Definition: UploadBase.php:271
verifyMimeType( $mime)
Verify the MIME type.
Definition: UploadBase.php:421
TempFSFile null $tempFileObj
Wrapper to handle deleting the temp file.
Definition: UploadBase.php:43
$wgMimeTypeBlacklist
Files with these MIME types will never be allowed as uploads if $wgVerifyMimeType is enabled...
wfIniGetBool( $setting)
Safety wrapper around ini_get() for boolean settings.
getVerificationErrorCode( $error)
Definition: UploadBase.php:110
getImageInfo( $result)
Gets image info about the file just uploaded.
verifyFile()
Verifies that it&#39;s ok to include the uploaded file.
Definition: UploadBase.php:455
Implements some public methods and some protected utility functions which are required by multiple ch...
Definition: File.php:61
const OK
Definition: UploadBase.php:93
$wgVerifyMimeType
Determines if the MIME type of uploaded files should be checked.
static getHandler( $type)
Get a MediaHandler for a given MIME type from the instance cache.
static checkFileExtension( $ext, $list)
Perform case-insensitive match against a list of file extensions.
$wgFileBlacklist
Files with these extensions will never be allowed as uploads.
static read( $fileName, $callback, $options=[])
Read a ZIP file and call a function for each file discovered in it.
static isValidRequest( $request)
Check whether a request if valid for this handler.
Definition: UploadBase.php:225
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on $request
Definition: hooks.txt:2621
const EMPTY_FILE
Definition: UploadBase.php:94
zipEntryCallback( $entry)
Callback for ZipDirectoryReader to detect Java class files.
Definition: UploadBase.php:577
wfShorthandToInteger( $string='', $default=-1)
Converts shorthand byte notation to integer form.
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1454
UploadStashFile $mStashFile
Definition: UploadBase.php:63
checkLocalFileWasDeleted(LocalFile $localFile)
Definition: UploadBase.php:830
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:200
static isAllowed( $user)
Returns true if the user can use this upload module or else a string identifying the missing permissi...
Definition: UploadBase.php:151
$wgAntivirus
Internal name of virus scanner.
$matches
runUploadStashFileHook(User $user)
checkSvgScriptCallback( $element, $attribs, $data=null)
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:322