MediaWiki  master
UploadBase.php
Go to the documentation of this file.
1 <?php
38 abstract class UploadBase {
40  protected $mTempPath;
42  protected $tempFileObj;
43 
45  protected $mTitle = false, $mTitleError = 0;
50 
51  protected static $safeXmlEncodings = [
52  'UTF-8',
53  'ISO-8859-1',
54  'ISO-8859-2',
55  'UTF-16',
56  'UTF-32',
57  'WINDOWS-1250',
58  'WINDOWS-1251',
59  'WINDOWS-1252',
60  'WINDOWS-1253',
61  'WINDOWS-1254',
62  'WINDOWS-1255',
63  'WINDOWS-1256',
64  'WINDOWS-1257',
65  'WINDOWS-1258',
66  ];
67 
68  const SUCCESS = 0;
69  const OK = 0;
70  const EMPTY_FILE = 3;
72  const ILLEGAL_FILENAME = 5;
73  const OVERWRITE_EXISTING_FILE = 7; # Not used anymore; handled by verifyTitlePermissions()
74  const FILETYPE_MISSING = 8;
75  const FILETYPE_BADTYPE = 9;
76  const VERIFICATION_ERROR = 10;
77  const HOOK_ABORTED = 11;
78  const FILE_TOO_LARGE = 12;
80  const FILENAME_TOO_LONG = 14;
81 
87  $code_to_status = [
88  self::EMPTY_FILE => 'empty-file',
89  self::FILE_TOO_LARGE => 'file-too-large',
90  self::FILETYPE_MISSING => 'filetype-missing',
91  self::FILETYPE_BADTYPE => 'filetype-banned',
92  self::MIN_LENGTH_PARTNAME => 'filename-tooshort',
93  self::ILLEGAL_FILENAME => 'illegal-filename',
94  self::OVERWRITE_EXISTING_FILE => 'overwrite',
95  self::VERIFICATION_ERROR => 'verification-error',
96  self::HOOK_ABORTED => 'hookaborted',
97  self::WINDOWS_NONASCII_FILENAME => 'windows-nonascii-filename',
98  self::FILENAME_TOO_LONG => 'filename-toolong',
99  ];
100  if ( isset( $code_to_status[$error] ) ) {
101  return $code_to_status[$error];
102  }
103 
104  return 'unknown-error';
105  }
106 
112  public static function isEnabled() {
114 
115  if ( !$wgEnableUploads ) {
116  return false;
117  }
118 
119  # Check php's file_uploads setting
120  return wfIsHHVM() || wfIniGetBool( 'file_uploads' );
121  }
122 
131  public static function isAllowed( $user ) {
132  foreach ( [ 'upload', 'edit' ] as $permission ) {
133  if ( !$user->isAllowed( $permission ) ) {
134  return $permission;
135  }
136  }
137 
138  return true;
139  }
140 
147  public static function isThrottled( $user ) {
148  return $user->pingLimiter( 'upload' );
149  }
150 
151  // Upload handlers. Should probably just be a global.
152  private static $uploadHandlers = [ 'Stash', 'File', 'Url' ];
153 
161  public static function createFromRequest( &$request, $type = null ) {
162  $type = $type ? $type : $request->getVal( 'wpSourceType', 'File' );
163 
164  if ( !$type ) {
165  return null;
166  }
167 
168  // Get the upload class
169  $type = ucfirst( $type );
170 
171  // Give hooks the chance to handle this request
172  $className = null;
173  Hooks::run( 'UploadCreateFromRequest', [ $type, &$className ] );
174  if ( is_null( $className ) ) {
175  $className = 'UploadFrom' . $type;
176  wfDebug( __METHOD__ . ": class name: $className\n" );
177  if ( !in_array( $type, self::$uploadHandlers ) ) {
178  return null;
179  }
180  }
181 
182  // Check whether this upload class is enabled
183  if ( !call_user_func( [ $className, 'isEnabled' ] ) ) {
184  return null;
185  }
186 
187  // Check whether the request is valid
188  if ( !call_user_func( [ $className, 'isValidRequest' ], $request ) ) {
189  return null;
190  }
191 
193  $handler = new $className;
194 
195  $handler->initializeFromRequest( $request );
196 
197  return $handler;
198  }
199 
205  public static function isValidRequest( $request ) {
206  return false;
207  }
208 
209  public function __construct() {
210  }
211 
218  public function getSourceType() {
219  return null;
220  }
221 
230  public function initializePathInfo( $name, $tempPath, $fileSize, $removeTempFile = false ) {
231  $this->mDesiredDestName = $name;
232  if ( FileBackend::isStoragePath( $tempPath ) ) {
233  throw new MWException( __METHOD__ . " given storage path `$tempPath`." );
234  }
235 
236  $this->setTempFile( $tempPath, $fileSize );
237  $this->mRemoveTempFile = $removeTempFile;
238  }
239 
245  abstract public function initializeFromRequest( &$request );
246 
251  protected function setTempFile( $tempPath, $fileSize = null ) {
252  $this->mTempPath = $tempPath;
253  $this->mFileSize = $fileSize ?: null;
254  if ( strlen( $this->mTempPath ) && file_exists( $this->mTempPath ) ) {
255  $this->tempFileObj = new TempFSFile( $this->mTempPath );
256  if ( !$fileSize ) {
257  $this->mFileSize = filesize( $this->mTempPath );
258  }
259  } else {
260  $this->tempFileObj = null;
261  }
262  }
263 
268  public function fetchFile() {
269  return Status::newGood();
270  }
271 
276  public function isEmptyFile() {
277  return empty( $this->mFileSize );
278  }
279 
284  public function getFileSize() {
285  return $this->mFileSize;
286  }
287 
292  public function getTempFileSha1Base36() {
293  return FSFile::getSha1Base36FromPath( $this->mTempPath );
294  }
295 
300  function getRealPath( $srcPath ) {
301  $repo = RepoGroup::singleton()->getLocalRepo();
302  if ( $repo->isVirtualUrl( $srcPath ) ) {
306  $tmpFile = $repo->getLocalCopy( $srcPath );
307  if ( $tmpFile ) {
308  $tmpFile->bind( $this ); // keep alive with $this
309  }
310  $path = $tmpFile ? $tmpFile->getPath() : false;
311  } else {
312  $path = $srcPath;
313  }
314 
315  return $path;
316  }
317 
322  public function verifyUpload() {
323 
327  if ( $this->isEmptyFile() ) {
328  return [ 'status' => self::EMPTY_FILE ];
329  }
330 
334  $maxSize = self::getMaxUploadSize( $this->getSourceType() );
335  if ( $this->mFileSize > $maxSize ) {
336  return [
337  'status' => self::FILE_TOO_LARGE,
338  'max' => $maxSize,
339  ];
340  }
341 
347  $verification = $this->verifyFile();
348  if ( $verification !== true ) {
349  return [
350  'status' => self::VERIFICATION_ERROR,
351  'details' => $verification
352  ];
353  }
354 
358  $result = $this->validateName();
359  if ( $result !== true ) {
360  return $result;
361  }
362 
363  $error = '';
364  if ( !Hooks::run( 'UploadVerification',
365  [ $this->mDestName, $this->mTempPath, &$error ], '1.28' )
366  ) {
367  return [ 'status' => self::HOOK_ABORTED, 'error' => $error ];
368  }
369 
370  return [ 'status' => self::OK ];
371  }
372 
379  public function validateName() {
380  $nt = $this->getTitle();
381  if ( is_null( $nt ) ) {
382  $result = [ 'status' => $this->mTitleError ];
383  if ( $this->mTitleError == self::ILLEGAL_FILENAME ) {
384  $result['filtered'] = $this->mFilteredName;
385  }
386  if ( $this->mTitleError == self::FILETYPE_BADTYPE ) {
387  $result['finalExt'] = $this->mFinalExtension;
388  if ( count( $this->mBlackListedExtensions ) ) {
389  $result['blacklistedExt'] = $this->mBlackListedExtensions;
390  }
391  }
392 
393  return $result;
394  }
395  $this->mDestName = $this->getLocalFile()->getName();
396 
397  return true;
398  }
399 
409  protected function verifyMimeType( $mime ) {
411  if ( $wgVerifyMimeType ) {
412  wfDebug( "mime: <$mime> extension: <{$this->mFinalExtension}>\n" );
414  if ( $this->checkFileExtension( $mime, $wgMimeTypeBlacklist ) ) {
415  return [ 'filetype-badmime', $mime ];
416  }
417 
418  # Check what Internet Explorer would detect
419  $fp = fopen( $this->mTempPath, 'rb' );
420  $chunk = fread( $fp, 256 );
421  fclose( $fp );
422 
423  $magic = MimeMagic::singleton();
424  $extMime = $magic->guessTypesForExtension( $this->mFinalExtension );
425  $ieTypes = $magic->getIEMimeTypes( $this->mTempPath, $chunk, $extMime );
426  foreach ( $ieTypes as $ieType ) {
427  if ( $this->checkFileExtension( $ieType, $wgMimeTypeBlacklist ) ) {
428  return [ 'filetype-bad-ie-mime', $ieType ];
429  }
430  }
431  }
432 
433  return true;
434  }
435 
441  protected function verifyFile() {
443 
444  $status = $this->verifyPartialFile();
445  if ( $status !== true ) {
446  return $status;
447  }
448 
449  $this->mFileProps = FSFile::getPropsFromPath( $this->mTempPath, $this->mFinalExtension );
450  $mime = $this->mFileProps['mime'];
451 
452  if ( $wgVerifyMimeType ) {
453  # XXX: Missing extension will be caught by validateName() via getTitle()
454  if ( $this->mFinalExtension != '' && !$this->verifyExtension( $mime, $this->mFinalExtension ) ) {
455  return [ 'filetype-mime-mismatch', $this->mFinalExtension, $mime ];
456  }
457  }
458 
459  # check for htmlish code and javascript
460  if ( !$wgDisableUploadScriptChecks ) {
461  if ( $this->mFinalExtension == 'svg' || $mime == 'image/svg+xml' ) {
462  $svgStatus = $this->detectScriptInSvg( $this->mTempPath, false );
463  if ( $svgStatus !== false ) {
464  return $svgStatus;
465  }
466  }
467  }
468 
470  if ( $handler ) {
471  $handlerStatus = $handler->verifyUpload( $this->mTempPath );
472  if ( !$handlerStatus->isOK() ) {
473  $errors = $handlerStatus->getErrorsArray();
474 
475  return reset( $errors );
476  }
477  }
478 
479  $error = true;
480  Hooks::run( 'UploadVerifyFile', [ $this, $mime, &$error ] );
481  if ( $error !== true ) {
482  if ( !is_array( $error ) ) {
483  $error = [ $error ];
484  }
485  return $error;
486  }
487 
488  wfDebug( __METHOD__ . ": all clear; passing.\n" );
489 
490  return true;
491  }
492 
501  protected function verifyPartialFile() {
503 
504  # getTitle() sets some internal parameters like $this->mFinalExtension
505  $this->getTitle();
506 
507  $this->mFileProps = FSFile::getPropsFromPath( $this->mTempPath, $this->mFinalExtension );
508 
509  # check MIME type, if desired
510  $mime = $this->mFileProps['file-mime'];
511  $status = $this->verifyMimeType( $mime );
512  if ( $status !== true ) {
513  return $status;
514  }
515 
516  # check for htmlish code and javascript
517  if ( !$wgDisableUploadScriptChecks ) {
518  if ( self::detectScript( $this->mTempPath, $mime, $this->mFinalExtension ) ) {
519  return [ 'uploadscripted' ];
520  }
521  if ( $this->mFinalExtension == 'svg' || $mime == 'image/svg+xml' ) {
522  $svgStatus = $this->detectScriptInSvg( $this->mTempPath, true );
523  if ( $svgStatus !== false ) {
524  return $svgStatus;
525  }
526  }
527  }
528 
529  # Check for Java applets, which if uploaded can bypass cross-site
530  # restrictions.
531  if ( !$wgAllowJavaUploads ) {
532  $this->mJavaDetected = false;
533  $zipStatus = ZipDirectoryReader::read( $this->mTempPath,
534  [ $this, 'zipEntryCallback' ] );
535  if ( !$zipStatus->isOK() ) {
536  $errors = $zipStatus->getErrorsArray();
537  $error = reset( $errors );
538  if ( $error[0] !== 'zip-wrong-format' ) {
539  return $error;
540  }
541  }
542  if ( $this->mJavaDetected ) {
543  return [ 'uploadjava' ];
544  }
545  }
546 
547  # Scan the uploaded file for viruses
548  $virus = $this->detectVirus( $this->mTempPath );
549  if ( $virus ) {
550  return [ 'uploadvirus', $virus ];
551  }
552 
553  return true;
554  }
555 
561  function zipEntryCallback( $entry ) {
562  $names = [ $entry['name'] ];
563 
564  // If there is a null character, cut off the name at it, because JDK's
565  // ZIP_GetEntry() uses strcmp() if the name hashes match. If a file name
566  // were constructed which had ".class\0" followed by a string chosen to
567  // make the hash collide with the truncated name, that file could be
568  // returned in response to a request for the .class file.
569  $nullPos = strpos( $entry['name'], "\000" );
570  if ( $nullPos !== false ) {
571  $names[] = substr( $entry['name'], 0, $nullPos );
572  }
573 
574  // If there is a trailing slash in the file name, we have to strip it,
575  // because that's what ZIP_GetEntry() does.
576  if ( preg_grep( '!\.class/?$!', $names ) ) {
577  $this->mJavaDetected = true;
578  }
579  }
580 
590  public function verifyPermissions( $user ) {
591  return $this->verifyTitlePermissions( $user );
592  }
593 
605  public function verifyTitlePermissions( $user ) {
610  $nt = $this->getTitle();
611  if ( is_null( $nt ) ) {
612  return true;
613  }
614  $permErrors = $nt->getUserPermissionsErrors( 'edit', $user );
615  $permErrorsUpload = $nt->getUserPermissionsErrors( 'upload', $user );
616  if ( !$nt->exists() ) {
617  $permErrorsCreate = $nt->getUserPermissionsErrors( 'create', $user );
618  } else {
619  $permErrorsCreate = [];
620  }
621  if ( $permErrors || $permErrorsUpload || $permErrorsCreate ) {
622  $permErrors = array_merge( $permErrors, wfArrayDiff2( $permErrorsUpload, $permErrors ) );
623  $permErrors = array_merge( $permErrors, wfArrayDiff2( $permErrorsCreate, $permErrors ) );
624 
625  return $permErrors;
626  }
627 
628  $overwriteError = $this->checkOverwrite( $user );
629  if ( $overwriteError !== true ) {
630  return [ $overwriteError ];
631  }
632 
633  return true;
634  }
635 
643  public function checkWarnings() {
644  global $wgLang;
645 
646  $warnings = [];
647 
648  $localFile = $this->getLocalFile();
649  $localFile->load( File::READ_LATEST );
650  $filename = $localFile->getName();
651 
656  $comparableName = str_replace( ' ', '_', $this->mDesiredDestName );
657  $comparableName = Title::capitalize( $comparableName, NS_FILE );
658 
659  if ( $this->mDesiredDestName != $filename && $comparableName != $filename ) {
660  $warnings['badfilename'] = $filename;
661  }
662 
663  // Check whether the file extension is on the unwanted list
665  if ( $wgCheckFileExtensions ) {
666  $extensions = array_unique( $wgFileExtensions );
667  if ( !$this->checkFileExtension( $this->mFinalExtension, $extensions ) ) {
668  $warnings['filetype-unwanted-type'] = [ $this->mFinalExtension,
669  $wgLang->commaList( $extensions ), count( $extensions ) ];
670  }
671  }
672 
674  if ( $wgUploadSizeWarning && ( $this->mFileSize > $wgUploadSizeWarning ) ) {
675  $warnings['large-file'] = [ $wgUploadSizeWarning, $this->mFileSize ];
676  }
677 
678  if ( $this->mFileSize == 0 ) {
679  $warnings['empty-file'] = true;
680  }
681 
682  $exists = self::getExistsWarning( $localFile );
683  if ( $exists !== false ) {
684  $warnings['exists'] = $exists;
685  }
686 
687  if ( $localFile->wasDeleted() && !$localFile->exists() ) {
688  $warnings['was-deleted'] = $filename;
689  }
690 
691  // Check dupes against existing files
692  $hash = $this->getTempFileSha1Base36();
693  $dupes = RepoGroup::singleton()->findBySha1( $hash );
694  $title = $this->getTitle();
695  // Remove all matches against self
696  foreach ( $dupes as $key => $dupe ) {
697  if ( $title->equals( $dupe->getTitle() ) ) {
698  unset( $dupes[$key] );
699  }
700  }
701  if ( $dupes ) {
702  $warnings['duplicate'] = $dupes;
703  }
704 
705  // Check dupes against archives
706  $archivedFile = new ArchivedFile( null, 0, '', $hash );
707  if ( $archivedFile->getID() > 0 ) {
708  if ( $archivedFile->userCan( File::DELETED_FILE ) ) {
709  $warnings['duplicate-archive'] = $archivedFile->getName();
710  } else {
711  $warnings['duplicate-archive'] = '';
712  }
713  }
714 
715  return $warnings;
716  }
717 
731  public function performUpload( $comment, $pageText, $watch, $user, $tags = [] ) {
732  $this->getLocalFile()->load( File::READ_LATEST );
733  $props = $this->mFileProps;
734 
735  $error = null;
736  Hooks::run( 'UploadVerifyUpload', [ $this, $user, $props, $comment, $pageText, &$error ] );
737  if ( $error ) {
738  if ( !is_array( $error ) ) {
739  $error = [ $error ];
740  }
741  return call_user_func_array( 'Status::newFatal', $error );
742  }
743 
744  $status = $this->getLocalFile()->upload(
745  $this->mTempPath,
746  $comment,
747  $pageText,
749  $props,
750  false,
751  $user,
752  $tags
753  );
754 
755  if ( $status->isGood() ) {
756  if ( $watch ) {
758  $this->getLocalFile()->getTitle(),
759  $user,
761  );
762  }
763  Hooks::run( 'UploadComplete', [ &$this ] );
764 
765  $this->postProcessUpload();
766  }
767 
768  return $status;
769  }
770 
776  public function postProcessUpload() {
777  }
778 
785  public function getTitle() {
786  if ( $this->mTitle !== false ) {
787  return $this->mTitle;
788  }
789  if ( !is_string( $this->mDesiredDestName ) ) {
790  $this->mTitleError = self::ILLEGAL_FILENAME;
791  $this->mTitle = null;
792 
793  return $this->mTitle;
794  }
795  /* Assume that if a user specified File:Something.jpg, this is an error
796  * and that the namespace prefix needs to be stripped of.
797  */
798  $title = Title::newFromText( $this->mDesiredDestName );
799  if ( $title && $title->getNamespace() == NS_FILE ) {
800  $this->mFilteredName = $title->getDBkey();
801  } else {
802  $this->mFilteredName = $this->mDesiredDestName;
803  }
804 
805  # oi_archive_name is max 255 bytes, which include a timestamp and an
806  # exclamation mark, so restrict file name to 240 bytes.
807  if ( strlen( $this->mFilteredName ) > 240 ) {
808  $this->mTitleError = self::FILENAME_TOO_LONG;
809  $this->mTitle = null;
810 
811  return $this->mTitle;
812  }
813 
819  $this->mFilteredName = wfStripIllegalFilenameChars( $this->mFilteredName );
820  /* Normalize to title form before we do any further processing */
821  $nt = Title::makeTitleSafe( NS_FILE, $this->mFilteredName );
822  if ( is_null( $nt ) ) {
823  $this->mTitleError = self::ILLEGAL_FILENAME;
824  $this->mTitle = null;
825 
826  return $this->mTitle;
827  }
828  $this->mFilteredName = $nt->getDBkey();
829 
834  list( $partname, $ext ) = $this->splitExtensions( $this->mFilteredName );
835 
836  if ( count( $ext ) ) {
837  $this->mFinalExtension = trim( $ext[count( $ext ) - 1] );
838  } else {
839  $this->mFinalExtension = '';
840 
841  # No extension, try guessing one
842  $magic = MimeMagic::singleton();
843  $mime = $magic->guessMimeType( $this->mTempPath );
844  if ( $mime !== 'unknown/unknown' ) {
845  # Get a space separated list of extensions
846  $extList = $magic->getExtensionsForType( $mime );
847  if ( $extList ) {
848  # Set the extension to the canonical extension
849  $this->mFinalExtension = strtok( $extList, ' ' );
850 
851  # Fix up the other variables
852  $this->mFilteredName .= ".{$this->mFinalExtension}";
853  $nt = Title::makeTitleSafe( NS_FILE, $this->mFilteredName );
855  }
856  }
857  }
858 
859  /* Don't allow users to override the blacklist (check file extension) */
862 
863  $blackListedExtensions = $this->checkFileExtensionList( $ext, $wgFileBlacklist );
864 
865  if ( $this->mFinalExtension == '' ) {
866  $this->mTitleError = self::FILETYPE_MISSING;
867  $this->mTitle = null;
868 
869  return $this->mTitle;
870  } elseif ( $blackListedExtensions ||
871  ( $wgCheckFileExtensions && $wgStrictFileExtensions &&
872  !$this->checkFileExtension( $this->mFinalExtension, $wgFileExtensions ) )
873  ) {
874  $this->mBlackListedExtensions = $blackListedExtensions;
875  $this->mTitleError = self::FILETYPE_BADTYPE;
876  $this->mTitle = null;
877 
878  return $this->mTitle;
879  }
880 
881  // Windows may be broken with special characters, see bug 1780
882  if ( !preg_match( '/^[\x0-\x7f]*$/', $nt->getText() )
883  && !RepoGroup::singleton()->getLocalRepo()->backendSupportsUnicodePaths()
884  ) {
885  $this->mTitleError = self::WINDOWS_NONASCII_FILENAME;
886  $this->mTitle = null;
887 
888  return $this->mTitle;
889  }
890 
891  # If there was more than one "extension", reassemble the base
892  # filename to prevent bogus complaints about length
893  if ( count( $ext ) > 1 ) {
894  $iterations = count( $ext ) - 1;
895  for ( $i = 0; $i < $iterations; $i++ ) {
896  $partname .= '.' . $ext[$i];
897  }
898  }
899 
900  if ( strlen( $partname ) < 1 ) {
901  $this->mTitleError = self::MIN_LENGTH_PARTNAME;
902  $this->mTitle = null;
903 
904  return $this->mTitle;
905  }
906 
907  $this->mTitle = $nt;
908 
909  return $this->mTitle;
910  }
911 
917  public function getLocalFile() {
918  if ( is_null( $this->mLocalFile ) ) {
919  $nt = $this->getTitle();
920  $this->mLocalFile = is_null( $nt ) ? null : wfLocalFile( $nt );
921  }
922 
923  return $this->mLocalFile;
924  }
925 
929  public function getStashFile() {
930  return $this->mStashFile;
931  }
932 
944  public function tryStashFile( User $user, $isPartial = false ) {
945  if ( !$isPartial ) {
946  $error = $this->runUploadStashFileHook( $user );
947  if ( $error ) {
948  return call_user_func_array( 'Status::newFatal', $error );
949  }
950  }
951  try {
952  $file = $this->doStashFile( $user );
953  return Status::newGood( $file );
954  } catch ( UploadStashException $e ) {
955  return Status::newFatal( 'uploadstash-exception', get_class( $e ), $e->getMessage() );
956  }
957  }
958 
963  protected function runUploadStashFileHook( User $user ) {
964  $props = $this->mFileProps;
965  $error = null;
966  Hooks::run( 'UploadStashFile', [ $this, $user, $props, &$error ] );
967  if ( $error ) {
968  if ( !is_array( $error ) ) {
969  $error = [ $error ];
970  }
971  }
972  return $error;
973  }
974 
994  public function stashFile( User $user = null ) {
995  return $this->doStashFile( $user );
996  }
997 
1004  protected function doStashFile( User $user = null ) {
1005  $stash = RepoGroup::singleton()->getLocalRepo()->getUploadStash( $user );
1006  $file = $stash->stashFile( $this->mTempPath, $this->getSourceType() );
1007  $this->mStashFile = $file;
1008 
1009  return $file;
1010  }
1011 
1019  public function stashFileGetKey() {
1020  wfDeprecated( __METHOD__, '1.28' );
1021  return $this->doStashFile()->getFileKey();
1022  }
1023 
1030  public function stashSession() {
1031  wfDeprecated( __METHOD__, '1.28' );
1032  return $this->doStashFile()->getFileKey();
1033  }
1034 
1039  public function cleanupTempFile() {
1040  if ( $this->mRemoveTempFile && $this->tempFileObj ) {
1041  // Delete when all relevant TempFSFile handles go out of scope
1042  wfDebug( __METHOD__ . ": Marked temporary file '{$this->mTempPath}' for removal\n" );
1043  $this->tempFileObj->autocollect();
1044  }
1045  }
1046 
1047  public function getTempPath() {
1048  return $this->mTempPath;
1049  }
1050 
1060  public static function splitExtensions( $filename ) {
1061  $bits = explode( '.', $filename );
1062  $basename = array_shift( $bits );
1063 
1064  return [ $basename, $bits ];
1065  }
1066 
1075  public static function checkFileExtension( $ext, $list ) {
1076  return in_array( strtolower( $ext ), $list );
1077  }
1078 
1087  public static function checkFileExtensionList( $ext, $list ) {
1088  return array_intersect( array_map( 'strtolower', $ext ), $list );
1089  }
1090 
1098  public static function verifyExtension( $mime, $extension ) {
1099  $magic = MimeMagic::singleton();
1100 
1101  if ( !$mime || $mime == 'unknown' || $mime == 'unknown/unknown' ) {
1102  if ( !$magic->isRecognizableExtension( $extension ) ) {
1103  wfDebug( __METHOD__ . ": passing file with unknown detected mime type; " .
1104  "unrecognized extension '$extension', can't verify\n" );
1105 
1106  return true;
1107  } else {
1108  wfDebug( __METHOD__ . ": rejecting file with unknown detected mime type; " .
1109  "recognized extension '$extension', so probably invalid file\n" );
1110 
1111  return false;
1112  }
1113  }
1114 
1115  $match = $magic->isMatchingExtension( $extension, $mime );
1116 
1117  if ( $match === null ) {
1118  if ( $magic->getTypesForExtension( $extension ) !== null ) {
1119  wfDebug( __METHOD__ . ": No extension known for $mime, but we know a mime for $extension\n" );
1120 
1121  return false;
1122  } else {
1123  wfDebug( __METHOD__ . ": no file extension known for mime type $mime, passing file\n" );
1124 
1125  return true;
1126  }
1127  } elseif ( $match === true ) {
1128  wfDebug( __METHOD__ . ": mime type $mime matches extension $extension, passing file\n" );
1129 
1131  return true;
1132  } else {
1133  wfDebug( __METHOD__
1134  . ": mime type $mime mismatches file extension $extension, rejecting file\n" );
1135 
1136  return false;
1137  }
1138  }
1139 
1151  public static function detectScript( $file, $mime, $extension ) {
1153 
1154  # ugly hack: for text files, always look at the entire file.
1155  # For binary field, just check the first K.
1156 
1157  if ( strpos( $mime, 'text/' ) === 0 ) {
1158  $chunk = file_get_contents( $file );
1159  } else {
1160  $fp = fopen( $file, 'rb' );
1161  $chunk = fread( $fp, 1024 );
1162  fclose( $fp );
1163  }
1164 
1165  $chunk = strtolower( $chunk );
1166 
1167  if ( !$chunk ) {
1168  return false;
1169  }
1170 
1171  # decode from UTF-16 if needed (could be used for obfuscation).
1172  if ( substr( $chunk, 0, 2 ) == "\xfe\xff" ) {
1173  $enc = 'UTF-16BE';
1174  } elseif ( substr( $chunk, 0, 2 ) == "\xff\xfe" ) {
1175  $enc = 'UTF-16LE';
1176  } else {
1177  $enc = null;
1178  }
1179 
1180  if ( $enc ) {
1181  $chunk = iconv( $enc, "ASCII//IGNORE", $chunk );
1182  }
1183 
1184  $chunk = trim( $chunk );
1185 
1187  wfDebug( __METHOD__ . ": checking for embedded scripts and HTML stuff\n" );
1188 
1189  # check for HTML doctype
1190  if ( preg_match( "/<!DOCTYPE *X?HTML/i", $chunk ) ) {
1191  return true;
1192  }
1193 
1194  // Some browsers will interpret obscure xml encodings as UTF-8, while
1195  // PHP/expat will interpret the given encoding in the xml declaration (bug 47304)
1196  if ( $extension == 'svg' || strpos( $mime, 'image/svg' ) === 0 ) {
1197  if ( self::checkXMLEncodingMissmatch( $file ) ) {
1198  return true;
1199  }
1200  }
1201 
1217  $tags = [
1218  '<a href',
1219  '<body',
1220  '<head',
1221  '<html', # also in safari
1222  '<img',
1223  '<pre',
1224  '<script', # also in safari
1225  '<table'
1226  ];
1227 
1228  if ( !$wgAllowTitlesInSVG && $extension !== 'svg' && $mime !== 'image/svg' ) {
1229  $tags[] = '<title';
1230  }
1231 
1232  foreach ( $tags as $tag ) {
1233  if ( false !== strpos( $chunk, $tag ) ) {
1234  wfDebug( __METHOD__ . ": found something that may make it be mistaken for html: $tag\n" );
1235 
1236  return true;
1237  }
1238  }
1239 
1240  /*
1241  * look for JavaScript
1242  */
1243 
1244  # resolve entity-refs to look at attributes. may be harsh on big files... cache result?
1245  $chunk = Sanitizer::decodeCharReferences( $chunk );
1246 
1247  # look for script-types
1248  if ( preg_match( '!type\s*=\s*[\'"]?\s*(?:\w*/)?(?:ecma|java)!sim', $chunk ) ) {
1249  wfDebug( __METHOD__ . ": found script types\n" );
1250 
1251  return true;
1252  }
1253 
1254  # look for html-style script-urls
1255  if ( preg_match( '!(?:href|src|data)\s*=\s*[\'"]?\s*(?:ecma|java)script:!sim', $chunk ) ) {
1256  wfDebug( __METHOD__ . ": found html-style script urls\n" );
1257 
1258  return true;
1259  }
1260 
1261  # look for css-style script-urls
1262  if ( preg_match( '!url\s*\(\s*[\'"]?\s*(?:ecma|java)script:!sim', $chunk ) ) {
1263  wfDebug( __METHOD__ . ": found css-style script urls\n" );
1264 
1265  return true;
1266  }
1267 
1268  wfDebug( __METHOD__ . ": no scripts found\n" );
1269 
1270  return false;
1271  }
1272 
1280  public static function checkXMLEncodingMissmatch( $file ) {
1282  $contents = file_get_contents( $file, false, null, -1, $wgSVGMetadataCutoff );
1283  $encodingRegex = '!encoding[ \t\n\r]*=[ \t\n\r]*[\'"](.*?)[\'"]!si';
1284 
1285  if ( preg_match( "!<\?xml\b(.*?)\?>!si", $contents, $matches ) ) {
1286  if ( preg_match( $encodingRegex, $matches[1], $encMatch )
1287  && !in_array( strtoupper( $encMatch[1] ), self::$safeXmlEncodings )
1288  ) {
1289  wfDebug( __METHOD__ . ": Found unsafe XML encoding '{$encMatch[1]}'\n" );
1290 
1291  return true;
1292  }
1293  } elseif ( preg_match( "!<\?xml\b!si", $contents ) ) {
1294  // Start of XML declaration without an end in the first $wgSVGMetadataCutoff
1295  // bytes. There shouldn't be a legitimate reason for this to happen.
1296  wfDebug( __METHOD__ . ": Unmatched XML declaration start\n" );
1297 
1298  return true;
1299  } elseif ( substr( $contents, 0, 4 ) == "\x4C\x6F\xA7\x94" ) {
1300  // EBCDIC encoded XML
1301  wfDebug( __METHOD__ . ": EBCDIC Encoded XML\n" );
1302 
1303  return true;
1304  }
1305 
1306  // It's possible the file is encoded with multi-byte encoding, so re-encode attempt to
1307  // detect the encoding in case is specifies an encoding not whitelisted in self::$safeXmlEncodings
1308  $attemptEncodings = [ 'UTF-16', 'UTF-16BE', 'UTF-32', 'UTF-32BE' ];
1309  foreach ( $attemptEncodings as $encoding ) {
1310  MediaWiki\suppressWarnings();
1311  $str = iconv( $encoding, 'UTF-8', $contents );
1312  MediaWiki\restoreWarnings();
1313  if ( $str != '' && preg_match( "!<\?xml\b(.*?)\?>!si", $str, $matches ) ) {
1314  if ( preg_match( $encodingRegex, $matches[1], $encMatch )
1315  && !in_array( strtoupper( $encMatch[1] ), self::$safeXmlEncodings )
1316  ) {
1317  wfDebug( __METHOD__ . ": Found unsafe XML encoding '{$encMatch[1]}'\n" );
1318 
1319  return true;
1320  }
1321  } elseif ( $str != '' && preg_match( "!<\?xml\b!si", $str ) ) {
1322  // Start of XML declaration without an end in the first $wgSVGMetadataCutoff
1323  // bytes. There shouldn't be a legitimate reason for this to happen.
1324  wfDebug( __METHOD__ . ": Unmatched XML declaration start\n" );
1325 
1326  return true;
1327  }
1328  }
1329 
1330  return false;
1331  }
1332 
1338  protected function detectScriptInSvg( $filename, $partial ) {
1339  $this->mSVGNSError = false;
1340  $check = new XmlTypeCheck(
1341  $filename,
1342  [ $this, 'checkSvgScriptCallback' ],
1343  true,
1344  [ 'processing_instruction_handler' => 'UploadBase::checkSvgPICallback' ]
1345  );
1346  if ( $check->wellFormed !== true ) {
1347  // Invalid xml (bug 58553)
1348  // But only when non-partial (bug 65724)
1349  return $partial ? false : [ 'uploadinvalidxml' ];
1350  } elseif ( $check->filterMatch ) {
1351  if ( $this->mSVGNSError ) {
1352  return [ 'uploadscriptednamespace', $this->mSVGNSError ];
1353  }
1354 
1355  return $check->filterMatchType;
1356  }
1357 
1358  return false;
1359  }
1360 
1367  public static function checkSvgPICallback( $target, $data ) {
1368  // Don't allow external stylesheets (bug 57550)
1369  if ( preg_match( '/xml-stylesheet/i', $target ) ) {
1370  return [ 'upload-scripted-pi-callback' ];
1371  }
1372 
1373  return false;
1374  }
1375 
1382  public function checkSvgScriptCallback( $element, $attribs, $data = null ) {
1383 
1384  list( $namespace, $strippedElement ) = $this->splitXmlNamespace( $element );
1385 
1386  // We specifically don't include:
1387  // http://www.w3.org/1999/xhtml (bug 60771)
1388  static $validNamespaces = [
1389  '',
1390  'adobe:ns:meta/',
1391  'http://creativecommons.org/ns#',
1392  'http://inkscape.sourceforge.net/dtd/sodipodi-0.dtd',
1393  'http://ns.adobe.com/adobeillustrator/10.0/',
1394  'http://ns.adobe.com/adobesvgviewerextensions/3.0/',
1395  'http://ns.adobe.com/extensibility/1.0/',
1396  'http://ns.adobe.com/flows/1.0/',
1397  'http://ns.adobe.com/illustrator/1.0/',
1398  'http://ns.adobe.com/imagereplacement/1.0/',
1399  'http://ns.adobe.com/pdf/1.3/',
1400  'http://ns.adobe.com/photoshop/1.0/',
1401  'http://ns.adobe.com/saveforweb/1.0/',
1402  'http://ns.adobe.com/variables/1.0/',
1403  'http://ns.adobe.com/xap/1.0/',
1404  'http://ns.adobe.com/xap/1.0/g/',
1405  'http://ns.adobe.com/xap/1.0/g/img/',
1406  'http://ns.adobe.com/xap/1.0/mm/',
1407  'http://ns.adobe.com/xap/1.0/rights/',
1408  'http://ns.adobe.com/xap/1.0/stype/dimensions#',
1409  'http://ns.adobe.com/xap/1.0/stype/font#',
1410  'http://ns.adobe.com/xap/1.0/stype/manifestitem#',
1411  'http://ns.adobe.com/xap/1.0/stype/resourceevent#',
1412  'http://ns.adobe.com/xap/1.0/stype/resourceref#',
1413  'http://ns.adobe.com/xap/1.0/t/pg/',
1414  'http://purl.org/dc/elements/1.1/',
1415  'http://purl.org/dc/elements/1.1',
1416  'http://schemas.microsoft.com/visio/2003/svgextensions/',
1417  'http://sodipodi.sourceforge.net/dtd/sodipodi-0.dtd',
1418  'http://taptrix.com/inkpad/svg_extensions',
1419  'http://web.resource.org/cc/',
1420  'http://www.freesoftware.fsf.org/bkchem/cdml',
1421  'http://www.inkscape.org/namespaces/inkscape',
1422  'http://www.opengis.net/gml',
1423  'http://www.w3.org/1999/02/22-rdf-syntax-ns#',
1424  'http://www.w3.org/2000/svg',
1425  'http://www.w3.org/tr/rec-rdf-syntax/',
1426  ];
1427 
1428  if ( !in_array( $namespace, $validNamespaces ) ) {
1429  wfDebug( __METHOD__ . ": Non-svg namespace '$namespace' in uploaded file.\n" );
1431  $this->mSVGNSError = $namespace;
1432 
1433  return true;
1434  }
1435 
1436  /*
1437  * check for elements that can contain javascript
1438  */
1439  if ( $strippedElement == 'script' ) {
1440  wfDebug( __METHOD__ . ": Found script element '$element' in uploaded file.\n" );
1441 
1442  return [ 'uploaded-script-svg', $strippedElement ];
1443  }
1444 
1445  # e.g., <svg xmlns="http://www.w3.org/2000/svg">
1446  # <handler xmlns:ev="http://www.w3.org/2001/xml-events" ev:event="load">alert(1)</handler> </svg>
1447  if ( $strippedElement == 'handler' ) {
1448  wfDebug( __METHOD__ . ": Found scriptable element '$element' in uploaded file.\n" );
1449 
1450  return [ 'uploaded-script-svg', $strippedElement ];
1451  }
1452 
1453  # SVG reported in Feb '12 that used xml:stylesheet to generate javascript block
1454  if ( $strippedElement == 'stylesheet' ) {
1455  wfDebug( __METHOD__ . ": Found scriptable element '$element' in uploaded file.\n" );
1456 
1457  return [ 'uploaded-script-svg', $strippedElement ];
1458  }
1459 
1460  # Block iframes, in case they pass the namespace check
1461  if ( $strippedElement == 'iframe' ) {
1462  wfDebug( __METHOD__ . ": iframe in uploaded file.\n" );
1463 
1464  return [ 'uploaded-script-svg', $strippedElement ];
1465  }
1466 
1467  # Check <style> css
1468  if ( $strippedElement == 'style'
1469  && self::checkCssFragment( Sanitizer::normalizeCss( $data ) )
1470  ) {
1471  wfDebug( __METHOD__ . ": hostile css in style element.\n" );
1472  return [ 'uploaded-hostile-svg' ];
1473  }
1474 
1475  foreach ( $attribs as $attrib => $value ) {
1476  $stripped = $this->stripXmlNamespace( $attrib );
1477  $value = strtolower( $value );
1478 
1479  if ( substr( $stripped, 0, 2 ) == 'on' ) {
1480  wfDebug( __METHOD__
1481  . ": Found event-handler attribute '$attrib'='$value' in uploaded file.\n" );
1482 
1483  return [ 'uploaded-event-handler-on-svg', $attrib, $value ];
1484  }
1485 
1486  # Do not allow relative links, or unsafe url schemas.
1487  # For <a> tags, only data:, http: and https: and same-document
1488  # fragment links are allowed. For all other tags, only data:
1489  # and fragment are allowed.
1490  if ( $stripped == 'href'
1491  && strpos( $value, 'data:' ) !== 0
1492  && strpos( $value, '#' ) !== 0
1493  ) {
1494  if ( !( $strippedElement === 'a'
1495  && preg_match( '!^https?://!i', $value ) )
1496  ) {
1497  wfDebug( __METHOD__ . ": Found href attribute <$strippedElement "
1498  . "'$attrib'='$value' in uploaded file.\n" );
1499 
1500  return [ 'uploaded-href-attribute-svg', $strippedElement, $attrib, $value ];
1501  }
1502  }
1503 
1504  # only allow data: targets that should be safe. This prevents vectors like,
1505  # image/svg, text/xml, application/xml, and text/html, which can contain scripts
1506  if ( $stripped == 'href' && strncasecmp( 'data:', $value, 5 ) === 0 ) {
1507  // rfc2397 parameters. This is only slightly slower than (;[\w;]+)*.
1508  // @codingStandardsIgnoreStart Generic.Files.LineLength
1509  $parameters = '(?>;[a-zA-Z0-9\!#$&\'*+.^_`{|}~-]+=(?>[a-zA-Z0-9\!#$&\'*+.^_`{|}~-]+|"(?>[\0-\x0c\x0e-\x21\x23-\x5b\x5d-\x7f]+|\\\\[\0-\x7f])*"))*(?:;base64)?';
1510  // @codingStandardsIgnoreEnd
1511 
1512  if ( !preg_match( "!^data:\s*image/(gif|jpeg|jpg|png)$parameters,!i", $value ) ) {
1513  wfDebug( __METHOD__ . ": Found href to unwhitelisted data: uri "
1514  . "\"<$strippedElement '$attrib'='$value'...\" in uploaded file.\n" );
1515  return [ 'uploaded-href-unsafe-target-svg', $strippedElement, $attrib, $value ];
1516  }
1517  }
1518 
1519  # Change href with animate from (http://html5sec.org/#137).
1520  if ( $stripped === 'attributename'
1521  && $strippedElement === 'animate'
1522  && $this->stripXmlNamespace( $value ) == 'href'
1523  ) {
1524  wfDebug( __METHOD__ . ": Found animate that might be changing href using from "
1525  . "\"<$strippedElement '$attrib'='$value'...\" in uploaded file.\n" );
1526 
1527  return [ 'uploaded-animate-svg', $strippedElement, $attrib, $value ];
1528  }
1529 
1530  # use set/animate to add event-handler attribute to parent
1531  if ( ( $strippedElement == 'set' || $strippedElement == 'animate' )
1532  && $stripped == 'attributename'
1533  && substr( $value, 0, 2 ) == 'on'
1534  ) {
1535  wfDebug( __METHOD__ . ": Found svg setting event-handler attribute with "
1536  . "\"<$strippedElement $stripped='$value'...\" in uploaded file.\n" );
1537 
1538  return [ 'uploaded-setting-event-handler-svg', $strippedElement, $stripped, $value ];
1539  }
1540 
1541  # use set to add href attribute to parent element
1542  if ( $strippedElement == 'set'
1543  && $stripped == 'attributename'
1544  && strpos( $value, 'href' ) !== false
1545  ) {
1546  wfDebug( __METHOD__ . ": Found svg setting href attribute '$value' in uploaded file.\n" );
1547 
1548  return [ 'uploaded-setting-href-svg' ];
1549  }
1550 
1551  # use set to add a remote / data / script target to an element
1552  if ( $strippedElement == 'set'
1553  && $stripped == 'to'
1554  && preg_match( '!(http|https|data|script):!sim', $value )
1555  ) {
1556  wfDebug( __METHOD__ . ": Found svg setting attribute to '$value' in uploaded file.\n" );
1557 
1558  return [ 'uploaded-wrong-setting-svg', $value ];
1559  }
1560 
1561  # use handler attribute with remote / data / script
1562  if ( $stripped == 'handler' && preg_match( '!(http|https|data|script):!sim', $value ) ) {
1563  wfDebug( __METHOD__ . ": Found svg setting handler with remote/data/script "
1564  . "'$attrib'='$value' in uploaded file.\n" );
1565 
1566  return [ 'uploaded-setting-handler-svg', $attrib, $value ];
1567  }
1568 
1569  # use CSS styles to bring in remote code
1570  if ( $stripped == 'style'
1571  && self::checkCssFragment( Sanitizer::normalizeCss( $value ) )
1572  ) {
1573  wfDebug( __METHOD__ . ": Found svg setting a style with "
1574  . "remote url '$attrib'='$value' in uploaded file.\n" );
1575  return [ 'uploaded-remote-url-svg', $attrib, $value ];
1576  }
1577 
1578  # Several attributes can include css, css character escaping isn't allowed
1579  $cssAttrs = [ 'font', 'clip-path', 'fill', 'filter', 'marker',
1580  'marker-end', 'marker-mid', 'marker-start', 'mask', 'stroke' ];
1581  if ( in_array( $stripped, $cssAttrs )
1582  && self::checkCssFragment( $value )
1583  ) {
1584  wfDebug( __METHOD__ . ": Found svg setting a style with "
1585  . "remote url '$attrib'='$value' in uploaded file.\n" );
1586  return [ 'uploaded-remote-url-svg', $attrib, $value ];
1587  }
1588 
1589  # image filters can pull in url, which could be svg that executes scripts
1590  if ( $strippedElement == 'image'
1591  && $stripped == 'filter'
1592  && preg_match( '!url\s*\(!sim', $value )
1593  ) {
1594  wfDebug( __METHOD__ . ": Found image filter with url: "
1595  . "\"<$strippedElement $stripped='$value'...\" in uploaded file.\n" );
1596 
1597  return [ 'uploaded-image-filter-svg', $strippedElement, $stripped, $value ];
1598  }
1599  }
1600 
1601  return false; // No scripts detected
1602  }
1603 
1611  private static function checkCssFragment( $value ) {
1612 
1613  # Forbid external stylesheets, for both reliability and to protect viewer's privacy
1614  if ( stripos( $value, '@import' ) !== false ) {
1615  return true;
1616  }
1617 
1618  # We allow @font-face to embed fonts with data: urls, so we snip the string
1619  # 'url' out so this case won't match when we check for urls below
1620  $pattern = '!(@font-face\s*{[^}]*src:)url(\("data:;base64,)!im';
1621  $value = preg_replace( $pattern, '$1$2', $value );
1622 
1623  # Check for remote and executable CSS. Unlike in Sanitizer::checkCss, the CSS
1624  # properties filter and accelerator don't seem to be useful for xss in SVG files.
1625  # Expression and -o-link don't seem to work either, but filtering them here in case.
1626  # Additionally, we catch remote urls like url("http:..., url('http:..., url(http:...,
1627  # but not local ones such as url("#..., url('#..., url(#....
1628  if ( preg_match( '!expression
1629  | -o-link\s*:
1630  | -o-link-source\s*:
1631  | -o-replace\s*:!imx', $value ) ) {
1632  return true;
1633  }
1634 
1635  if ( preg_match_all(
1636  "!(\s*(url|image|image-set)\s*\(\s*[\"']?\s*[^#]+.*?\))!sim",
1637  $value,
1638  $matches
1639  ) !== 0
1640  ) {
1641  # TODO: redo this in one regex. Until then, url("#whatever") matches the first
1642  foreach ( $matches[1] as $match ) {
1643  if ( !preg_match( "!\s*(url|image|image-set)\s*\(\s*(#|'#|\"#)!im", $match ) ) {
1644  return true;
1645  }
1646  }
1647  }
1648 
1649  if ( preg_match( '/[\000-\010\013\016-\037\177]/', $value ) ) {
1650  return true;
1651  }
1652 
1653  return false;
1654  }
1655 
1661  private static function splitXmlNamespace( $element ) {
1662  // 'http://www.w3.org/2000/svg:script' -> [ 'http://www.w3.org/2000/svg', 'script' ]
1663  $parts = explode( ':', strtolower( $element ) );
1664  $name = array_pop( $parts );
1665  $ns = implode( ':', $parts );
1666 
1667  return [ $ns, $name ];
1668  }
1669 
1674  private function stripXmlNamespace( $name ) {
1675  // 'http://www.w3.org/2000/svg:script' -> 'script'
1676  $parts = explode( ':', strtolower( $name ) );
1677 
1678  return array_pop( $parts );
1679  }
1680 
1691  public static function detectVirus( $file ) {
1693 
1694  if ( !$wgAntivirus ) {
1695  wfDebug( __METHOD__ . ": virus scanner disabled\n" );
1696 
1697  return null;
1698  }
1699 
1700  if ( !$wgAntivirusSetup[$wgAntivirus] ) {
1701  wfDebug( __METHOD__ . ": unknown virus scanner: $wgAntivirus\n" );
1702  $wgOut->wrapWikiMsg( "<div class=\"error\">\n$1\n</div>",
1703  [ 'virus-badscanner', $wgAntivirus ] );
1704 
1705  return wfMessage( 'virus-unknownscanner' )->text() . " $wgAntivirus";
1706  }
1707 
1708  # look up scanner configuration
1709  $command = $wgAntivirusSetup[$wgAntivirus]['command'];
1710  $exitCodeMap = $wgAntivirusSetup[$wgAntivirus]['codemap'];
1711  $msgPattern = isset( $wgAntivirusSetup[$wgAntivirus]['messagepattern'] ) ?
1712  $wgAntivirusSetup[$wgAntivirus]['messagepattern'] : null;
1713 
1714  if ( strpos( $command, "%f" ) === false ) {
1715  # simple pattern: append file to scan
1716  $command .= " " . wfEscapeShellArg( $file );
1717  } else {
1718  # complex pattern: replace "%f" with file to scan
1719  $command = str_replace( "%f", wfEscapeShellArg( $file ), $command );
1720  }
1721 
1722  wfDebug( __METHOD__ . ": running virus scan: $command \n" );
1723 
1724  # execute virus scanner
1725  $exitCode = false;
1726 
1727  # NOTE: there's a 50 line workaround to make stderr redirection work on windows, too.
1728  # that does not seem to be worth the pain.
1729  # Ask me (Duesentrieb) about it if it's ever needed.
1730  $output = wfShellExecWithStderr( $command, $exitCode );
1731 
1732  # map exit code to AV_xxx constants.
1733  $mappedCode = $exitCode;
1734  if ( $exitCodeMap ) {
1735  if ( isset( $exitCodeMap[$exitCode] ) ) {
1736  $mappedCode = $exitCodeMap[$exitCode];
1737  } elseif ( isset( $exitCodeMap["*"] ) ) {
1738  $mappedCode = $exitCodeMap["*"];
1739  }
1740  }
1741 
1742  /* NB: AV_NO_VIRUS is 0 but AV_SCAN_FAILED is false,
1743  * so we need the strict equalities === and thus can't use a switch here
1744  */
1745  if ( $mappedCode === AV_SCAN_FAILED ) {
1746  # scan failed (code was mapped to false by $exitCodeMap)
1747  wfDebug( __METHOD__ . ": failed to scan $file (code $exitCode).\n" );
1748 
1749  $output = $wgAntivirusRequired
1750  ? wfMessage( 'virus-scanfailed', [ $exitCode ] )->text()
1751  : null;
1752  } elseif ( $mappedCode === AV_SCAN_ABORTED ) {
1753  # scan failed because filetype is unknown (probably imune)
1754  wfDebug( __METHOD__ . ": unsupported file type $file (code $exitCode).\n" );
1755  $output = null;
1756  } elseif ( $mappedCode === AV_NO_VIRUS ) {
1757  # no virus found
1758  wfDebug( __METHOD__ . ": file passed virus scan.\n" );
1759  $output = false;
1760  } else {
1761  $output = trim( $output );
1762 
1763  if ( !$output ) {
1764  $output = true; # if there's no output, return true
1765  } elseif ( $msgPattern ) {
1766  $groups = [];
1767  if ( preg_match( $msgPattern, $output, $groups ) ) {
1768  if ( $groups[1] ) {
1769  $output = $groups[1];
1770  }
1771  }
1772  }
1773 
1774  wfDebug( __METHOD__ . ": FOUND VIRUS! scanner feedback: $output \n" );
1775  }
1776 
1777  return $output;
1778  }
1779 
1788  private function checkOverwrite( $user ) {
1789  // First check whether the local file can be overwritten
1790  $file = $this->getLocalFile();
1791  $file->load( File::READ_LATEST );
1792  if ( $file->exists() ) {
1793  if ( !self::userCanReUpload( $user, $file ) ) {
1794  return [ 'fileexists-forbidden', $file->getName() ];
1795  } else {
1796  return true;
1797  }
1798  }
1799 
1800  /* Check shared conflicts: if the local file does not exist, but
1801  * wfFindFile finds a file, it exists in a shared repository.
1802  */
1803  $file = wfFindFile( $this->getTitle(), [ 'latest' => true ] );
1804  if ( $file && !$user->isAllowed( 'reupload-shared' ) ) {
1805  return [ 'fileexists-shared-forbidden', $file->getName() ];
1806  }
1807 
1808  return true;
1809  }
1810 
1818  public static function userCanReUpload( User $user, File $img ) {
1819  if ( $user->isAllowed( 'reupload' ) ) {
1820  return true; // non-conditional
1821  } elseif ( !$user->isAllowed( 'reupload-own' ) ) {
1822  return false;
1823  }
1824 
1825  if ( !( $img instanceof LocalFile ) ) {
1826  return false;
1827  }
1828 
1829  $img->load();
1830 
1831  return $user->getId() == $img->getUser( 'id' );
1832  }
1833 
1845  public static function getExistsWarning( $file ) {
1846  if ( $file->exists() ) {
1847  return [ 'warning' => 'exists', 'file' => $file ];
1848  }
1849 
1850  if ( $file->getTitle()->getArticleID() ) {
1851  return [ 'warning' => 'page-exists', 'file' => $file ];
1852  }
1853 
1854  if ( strpos( $file->getName(), '.' ) == false ) {
1855  $partname = $file->getName();
1856  $extension = '';
1857  } else {
1858  $n = strrpos( $file->getName(), '.' );
1859  $extension = substr( $file->getName(), $n + 1 );
1860  $partname = substr( $file->getName(), 0, $n );
1861  }
1862  $normalizedExtension = File::normalizeExtension( $extension );
1863 
1864  if ( $normalizedExtension != $extension ) {
1865  // We're not using the normalized form of the extension.
1866  // Normal form is lowercase, using most common of alternate
1867  // extensions (eg 'jpg' rather than 'JPEG').
1868 
1869  // Check for another file using the normalized form...
1870  $nt_lc = Title::makeTitle( NS_FILE, "{$partname}.{$normalizedExtension}" );
1871  $file_lc = wfLocalFile( $nt_lc );
1872 
1873  if ( $file_lc->exists() ) {
1874  return [
1875  'warning' => 'exists-normalized',
1876  'file' => $file,
1877  'normalizedFile' => $file_lc
1878  ];
1879  }
1880  }
1881 
1882  // Check for files with the same name but a different extension
1883  $similarFiles = RepoGroup::singleton()->getLocalRepo()->findFilesByPrefix(
1884  "{$partname}.", 1 );
1885  if ( count( $similarFiles ) ) {
1886  return [
1887  'warning' => 'exists-normalized',
1888  'file' => $file,
1889  'normalizedFile' => $similarFiles[0],
1890  ];
1891  }
1892 
1893  if ( self::isThumbName( $file->getName() ) ) {
1894  # Check for filenames like 50px- or 180px-, these are mostly thumbnails
1895  $nt_thb = Title::newFromText(
1896  substr( $partname, strpos( $partname, '-' ) + 1 ) . '.' . $extension,
1897  NS_FILE
1898  );
1899  $file_thb = wfLocalFile( $nt_thb );
1900  if ( $file_thb->exists() ) {
1901  return [
1902  'warning' => 'thumb',
1903  'file' => $file,
1904  'thumbFile' => $file_thb
1905  ];
1906  } else {
1907  // File does not exist, but we just don't like the name
1908  return [
1909  'warning' => 'thumb-name',
1910  'file' => $file,
1911  'thumbFile' => $file_thb
1912  ];
1913  }
1914  }
1915 
1916  foreach ( self::getFilenamePrefixBlacklist() as $prefix ) {
1917  if ( substr( $partname, 0, strlen( $prefix ) ) == $prefix ) {
1918  return [
1919  'warning' => 'bad-prefix',
1920  'file' => $file,
1921  'prefix' => $prefix
1922  ];
1923  }
1924  }
1925 
1926  return false;
1927  }
1928 
1934  public static function isThumbName( $filename ) {
1935  $n = strrpos( $filename, '.' );
1936  $partname = $n ? substr( $filename, 0, $n ) : $filename;
1937 
1938  return (
1939  substr( $partname, 3, 3 ) == 'px-' ||
1940  substr( $partname, 2, 3 ) == 'px-'
1941  ) &&
1942  preg_match( "/[0-9]{2}/", substr( $partname, 0, 2 ) );
1943  }
1944 
1950  public static function getFilenamePrefixBlacklist() {
1951  $blacklist = [];
1952  $message = wfMessage( 'filename-prefix-blacklist' )->inContentLanguage();
1953  if ( !$message->isDisabled() ) {
1954  $lines = explode( "\n", $message->plain() );
1955  foreach ( $lines as $line ) {
1956  // Remove comment lines
1957  $comment = substr( trim( $line ), 0, 1 );
1958  if ( $comment == '#' || $comment == '' ) {
1959  continue;
1960  }
1961  // Remove additional comments after a prefix
1962  $comment = strpos( $line, '#' );
1963  if ( $comment > 0 ) {
1964  $line = substr( $line, 0, $comment - 1 );
1965  }
1966  $blacklist[] = trim( $line );
1967  }
1968  }
1969 
1970  return $blacklist;
1971  }
1972 
1984  public function getImageInfo( $result ) {
1985  $localFile = $this->getLocalFile();
1986  $stashFile = $this->getStashFile();
1987  // Calling a different API module depending on whether the file was stashed is less than optimal.
1988  // In fact, calling API modules here at all is less than optimal. Maybe it should be refactored.
1989  if ( $stashFile ) {
1991  $info = ApiQueryStashImageInfo::getInfo( $stashFile, array_flip( $imParam ), $result );
1992  } else {
1994  $info = ApiQueryImageInfo::getInfo( $localFile, array_flip( $imParam ), $result );
1995  }
1996 
1997  return $info;
1998  }
1999 
2004  public function convertVerifyErrorToStatus( $error ) {
2005  $code = $error['status'];
2006  unset( $code['status'] );
2007 
2008  return Status::newFatal( $this->getVerificationErrorCode( $code ), $error );
2009  }
2010 
2018  public static function getMaxUploadSize( $forType = null ) {
2020 
2021  if ( is_array( $wgMaxUploadSize ) ) {
2022  if ( !is_null( $forType ) && isset( $wgMaxUploadSize[$forType] ) ) {
2023  return $wgMaxUploadSize[$forType];
2024  } else {
2025  return $wgMaxUploadSize['*'];
2026  }
2027  } else {
2028  return intval( $wgMaxUploadSize );
2029  }
2030  }
2031 
2039  public static function getMaxPhpUploadSize() {
2040  $phpMaxFileSize = wfShorthandToInteger(
2041  ini_get( 'upload_max_filesize' ) ?: ini_get( 'hhvm.server.upload.upload_max_file_size' ),
2042  PHP_INT_MAX
2043  );
2044  $phpMaxPostSize = wfShorthandToInteger(
2045  ini_get( 'post_max_size' ) ?: ini_get( 'hhvm.server.max_post_size' ),
2046  PHP_INT_MAX
2047  ) ?: PHP_INT_MAX;
2048  return min( $phpMaxFileSize, $phpMaxPostSize );
2049  }
2050 
2060  public static function getSessionStatus( User $user, $statusKey ) {
2061  $key = wfMemcKey( 'uploadstatus', $user->getId() ?: md5( $user->getName() ), $statusKey );
2062 
2063  return ObjectCache::getMainStashInstance()->get( $key );
2064  }
2065 
2076  public static function setSessionStatus( User $user, $statusKey, $value ) {
2077  $key = wfMemcKey( 'uploadstatus', $user->getId() ?: md5( $user->getName() ), $statusKey );
2078 
2080  if ( $value === false ) {
2081  $cache->delete( $key );
2082  } else {
2083  $cache->set( $key, $value, $cache::TTL_DAY );
2084  }
2085  }
2086 }
$wgStrictFileExtensions
If this is turned off, users may override the warning for files not covered by $wgFileExtensions.
checkSvgScriptCallback($element, $attribs, $data=null)
static checkFileExtensionList($ext, $list)
Perform case-insensitive match against a list of file extensions.
#define the
table suitable for use with IDatabase::select()
getImageInfo($result)
Gets image info about the file just uploaded.
getVerificationErrorCode($error)
Definition: UploadBase.php:86
you don t have to do a grep find to see where the $wgReverseTitle variable is used
Definition: hooks.txt:117
null means default in associative array form
Definition: hooks.txt:1889
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
static read($fileName, $callback, $options=[])
Read a ZIP file and call a function for each file discovered in it.
const FILENAME_TOO_LONG
Definition: UploadBase.php:80
$wgSVGMetadataCutoff
Don't read SVG metadata beyond this point.
$wgDisableUploadScriptChecks
Setting this to true will disable the upload system's checks for HTML/JavaScript. ...
tryStashFile(User $user, $isPartial=false)
Like stashFile(), but respects extensions' wishes to prevent the stashing.
Definition: UploadBase.php:944
wfIsHHVM()
Check if we are running under HHVM.
const SUCCESS
Definition: UploadBase.php:68
static createFromRequest(&$request, $type=null)
Create a form of UploadBase depending on wpSourceType and initializes it.
Definition: UploadBase.php:161
static isAllowed($user)
Returns true if the user can use this upload module or else a string identifying the missing permissi...
Definition: UploadBase.php:131
wfShorthandToInteger($string= '', $default=-1)
Converts shorthand byte notation to integer form.
static singleton()
Get an instance of this class.
Definition: MimeMagic.php:366
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException'returning false will NOT prevent logging $e
Definition: hooks.txt:2054
$command
Definition: cdb.php:65
static checkFileExtension($ext, $list)
Perform case-insensitive match against a list of file extensions.
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:65
static getSessionStatus(User $user, $statusKey)
Get the current status of a chunked upload (used for polling)
const OVERWRITE_EXISTING_FILE
Definition: UploadBase.php:73
static $safeXmlEncodings
Definition: UploadBase.php:51
static isValidRequest($request)
Check whether a request if valid for this handler.
Definition: UploadBase.php:205
This class is used to hold the location and do limited manipulation of files stored temporarily (this...
Definition: TempFSFile.php:30
$comment
null for the local wiki Added in
Definition: hooks.txt:1508
has been added to your &Future changes to this page and its associated Talk page will be listed there
$value
const AV_NO_VIRUS
Definition: Defines.php:138
verifyPermissions($user)
Alias for verifyTitlePermissions.
Definition: UploadBase.php:590
if($ext== 'php'||$ext== 'php5') $mime
Definition: router.php:65
stripXmlNamespace($name)
static splitXmlNamespace($element)
Divide the element name passed by the xml parser to the callback into URI and prifix.
static getMainStashInstance()
Get the cache object for the main stash.
static newFromText($text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:256
const ILLEGAL_FILENAME
Definition: UploadBase.php:72
isEmptyFile()
Return true if the file is empty.
Definition: UploadBase.php:276
const AV_SCAN_FAILED
Definition: Defines.php:141
string $mTempPath
Local file system path to the file to upload (or a local copy)
Definition: UploadBase.php:40
when a variable name is used in a it is silently declared as a new local masking the global
Definition: design.txt:93
static newFatal($message)
Factory function for fatal errors.
Definition: Status.php:89
wfLocalFile($title)
Get an object referring to a locally registered file.
$wgAllowJavaUploads
Allow Java archive uploads.
wfStripIllegalFilenameChars($name)
Replace all invalid characters with '-'.
static checkSvgPICallback($target, $data)
Callback to filter SVG Processing Instructions.
getName()
Get the user name, or the IP of an anonymous user.
Definition: User.php:2101
verifyMimeType($mime)
Verify the MIME type.
Definition: UploadBase.php:409
wfArrayDiff2($a, $b)
Like array_diff( $a, $b ) except that it works with two-dimensional arrays.
wfDebug($text, $dest= 'all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
const AV_SCAN_ABORTED
Definition: Defines.php:140
static getMaxUploadSize($forType=null)
Get the MediaWiki maximum uploaded file size for given type of upload, based on $wgMaxUploadSize.
const DELETED_FILE
Definition: File.php:52
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as $wgLang
Definition: design.txt:56
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. '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 '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. 'LanguageGetMagic':DEPRECATED!Use $magicWords in a file listed in $wgExtensionMessagesFiles instead.Use this to define synonyms of magic words depending of the language &$magicExtensions:associative array of magic words synonyms $lang:language code(string) '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 'LanguageGetSpecialPageAliases':DEPRECATED!Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead.Use to define aliases of special pages names depending of the language &$specialPageAliases:associative array of magic words synonyms $lang:language code(string) '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:Associative array mapping language codes to prefixed links of the form"language:title".&$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!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:1887
setTempFile($tempPath, $fileSize=null)
Definition: UploadBase.php:251
verifyPartialFile()
A verification routine suitable for partial files.
Definition: UploadBase.php:501
$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:47
static decodeCharReferences($text)
Decode any character references, numeric or named entities, in the text and return a UTF-8 string...
Definition: Sanitizer.php:1499
$wgEnableUploads
Uploads have to be specially set up to be secure.
static isThumbName($filename)
Helper function that checks whether the filename looks like a thumbnail.
static isThrottled($user)
Returns true if the user has surpassed the upload rate limit, false otherwise.
Definition: UploadBase.php:147
Class representing a row of the 'filearchive' table.
when a variable name is used in a function
Definition: design.txt:93
zipEntryCallback($entry)
Callback for ZipDirectoryReader to detect Java class files.
Definition: UploadBase.php:561
$wgAntivirusRequired
Determines if a failed virus scan (AV_SCAN_FAILED) will cause the file to be rejected.
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:93
getTempFileSha1Base36()
Get the base 36 SHA1 of the file.
Definition: UploadBase.php:292
stashFileGetKey()
Stash a file in a temporary directory, returning a key which can be used to find the file again...
UploadBase and subclasses are the backend of MediaWiki's file uploads.
Definition: UploadBase.php:38
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 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 unsetoffset-wrap String Wrap the message in html(usually something like"&lt
wfIniGetBool($setting)
Safety wrapper around ini_get() for boolean settings.
static singleton()
Get a RepoGroup instance.
Definition: RepoGroup.php:59
fetchFile()
Fetch the file.
Definition: UploadBase.php:268
static isStoragePath($path)
Check if a given path is a "mwstore://" path.
MediaWiki exception.
Definition: MWException.php:26
stashSession()
alias for stashFileGetKey, for backwards compatibility
postProcessUpload()
Perform extra steps after a successful upload.
Definition: UploadBase.php:776
static getPropertyNames($filter=[])
Returns all possible parameters to iiprop.
$cache
Definition: mcc.php:33
const IGNORE_USER_RIGHTS
Definition: User.php:84
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:785
performUpload($comment, $pageText, $watch, $user, $tags=[])
Really perform the upload.
Definition: UploadBase.php:731
wfDeprecated($function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
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:1889
static detectVirus($file)
Generic wrapper function for a virus scanner program.
static splitExtensions($filename)
Split a file into a base name and all dot-delimited 'extensions' on the end.
static makeTitleSafe($ns, $title, $fragment= '', $interwiki= '')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:527
cleanupTempFile()
If we've modified the upload file we need to manually remove it on exit to clean up.
getSourceType()
Returns the upload type.
Definition: UploadBase.php:218
const FILE_TOO_LARGE
Definition: UploadBase.php:78
Allows to change the fields on the form that will be generated are created Can be used to omit specific feeds from being outputted You must not use this hook to add use OutputPage::addFeedLink() instead.&$feedLinks conditions will AND in the final query as a Content object as a Content object $title
Definition: hooks.txt:302
checkWarnings()
Check for non fatal problems with the file.
Definition: UploadBase.php:643
initializeFromRequest(&$request)
Initialize from a WebRequest.
verifyUpload()
Verify whether the upload is sane.
Definition: UploadBase.php:322
const MIN_LENGTH_PARTNAME
Definition: UploadBase.php:71
static run($event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:131
getFileSize()
Return the file size.
Definition: UploadBase.php:284
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books $tag
Definition: hooks.txt:972
const NS_FILE
Definition: Defines.php:75
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
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:275
const VERIFICATION_ERROR
Definition: UploadBase.php:76
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
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub 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
static isEnabled()
Returns true if uploads are enabled.
Definition: UploadBase.php:112
equals(Content $that=null)
Returns true if this Content objects is conceptually equivalent to the given Content object...
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account $user
Definition: hooks.txt:242
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:379
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object to manipulate or replace but no entry for that model exists in $wgContentHandlers if desired 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 inclusive false for true for descending in case the handler function wants to provide a converted Content object Note that $result getContentModel() must return $toModel. 'CustomEditor'$rcid is used in generating this variable which contains information about the new such as the revision s whether the revision was marked as a minor edit or not
Definition: hooks.txt:1109
const FILETYPE_BADTYPE
Definition: UploadBase.php:75
$wgMaxUploadSize
Max size for uploads, in bytes.
getLocalFile()
Return the local file and initializes if necessary.
Definition: UploadBase.php:917
$wgAntivirusSetup
Configuration for different virus scanners.
const FILETYPE_MISSING
Definition: UploadBase.php:74
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object & $output
Definition: hooks.txt:1011
static normalizeCss($value)
Normalize CSS into a format we can easily search for hostile input.
Definition: Sanitizer.php:893
$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
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.
verifyTitlePermissions($user)
Check whether the user can edit, upload and create the image.
Definition: UploadBase.php:605
$lines
Definition: router.php:66
const HOOK_ABORTED
Definition: UploadBase.php:77
error also a ContextSource you ll probably need to make sure the header is varied on $request
Definition: hooks.txt:2525
stashFile(User $user=null)
If the user does not supply all necessary information in the first upload form submission (either by ...
Definition: UploadBase.php:994
getId()
Get the user's ID.
Definition: User.php:2076
static verifyExtension($mime, $extension)
Checks if the MIME type of the uploaded file matches the file extension.
detectScriptInSvg($filename, $partial)
static detectScript($file, $mime, $extension)
Heuristic for detecting files that could contain JavaScript instructions or things that may look like...
convertVerifyErrorToStatus($error)
$line
Definition: cdb.php:59
static $uploadHandlers
Definition: UploadBase.php:152
const WINDOWS_NONASCII_FILENAME
Definition: UploadBase.php:79
static getHandler($type)
Get a MediaHandler for a given MIME type from the instance cache.
$wgAllowTitlesInSVG
Disallow <title> element in SVG files.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set $status
Definition: hooks.txt:1011
static checkXMLEncodingMissmatch($file)
Check a whitelist of xml encodings that are known not to be interpreted differently by the server's x...
wfEscapeShellArg()
Windows-compatible version of escapeshellarg() Windows doesn't recognise single-quotes in the shell...
static checkCssFragment($value)
Check a block of CSS or CSS fragment for anything that looks like it is bringing in remote code...
static getMaxPhpUploadSize()
Get the PHP maximum uploaded file size, based on ini settings.
wfMemcKey()
Make a cache key for the local wiki.
$wgOut
Definition: Setup.php:793
static setSessionStatus(User $user, $statusKey, $value)
Set the current status of a chunked upload (used for polling)
$extensions
$mBlackListedExtensions
Definition: UploadBase.php:48
TempFSFile null $tempFileObj
Wrapper to handle deleting the temp file.
Definition: UploadBase.php:42
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub 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
$wgMimeTypeBlacklist
Files with these MIME types will never be allowed as uploads if $wgVerifyMimeType is enabled...
wfShellExecWithStderr($cmd, &$retval=null, $environ=[], $limits=[])
Execute a shell command, returning both stdout and stderr.
verifyFile()
Verifies that it's ok to include the uploaded file.
Definition: UploadBase.php:441
const OK
Definition: UploadBase.php:69
$wgVerifyMimeType
Determines if the MIME type of uploaded files should be checked.
$wgFileBlacklist
Files with these extensions will never be allowed as uploads.
static getPropsFromPath($path, $ext=true)
Get an associative array containing information about a file in the local filesystem.
Definition: FSFile.php:259
static getInfo($file, $prop, $result, $thumbParams=null, $opts=false)
Get result information for an image revision.
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached one of or reset my talk page
Definition: hooks.txt:2443
const EMPTY_FILE
Definition: UploadBase.php:70
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached one of or reset my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled allows for interception of redirect as a string mapping parameter names to values & $type
Definition: hooks.txt:2443
static makeTitle($ns, $title, $fragment= '', $interwiki= '')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:503
static capitalize($text, $ns=NS_MAIN)
Capitalize a text string for a title if it belongs to a namespace that capitalizes.
Definition: Title.php:3304
static newGood($value=null)
Factory function for good results.
Definition: Status.php:101
getRealPath($srcPath)
Definition: UploadBase.php:300
initializePathInfo($name, $tempPath, $fileSize, $removeTempFile=false)
Initialize the path information.
Definition: UploadBase.php:230
checkOverwrite($user)
Check if there's an overwrite conflict and, if so, if restrictions forbid this user from performing t...
$wgAntivirus
Internal name of virus scanner.
$matches
runUploadStashFileHook(User $user)
Definition: UploadBase.php:963
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:300