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  ];
58 
59  const SUCCESS = 0;
60  const OK = 0;
61  const EMPTY_FILE = 3;
63  const ILLEGAL_FILENAME = 5;
64  const OVERWRITE_EXISTING_FILE = 7; # Not used anymore; handled by verifyTitlePermissions()
65  const FILETYPE_MISSING = 8;
66  const FILETYPE_BADTYPE = 9;
67  const VERIFICATION_ERROR = 10;
68  const HOOK_ABORTED = 11;
69  const FILE_TOO_LARGE = 12;
71  const FILENAME_TOO_LONG = 14;
72 
78  $code_to_status = [
79  self::EMPTY_FILE => 'empty-file',
80  self::FILE_TOO_LARGE => 'file-too-large',
81  self::FILETYPE_MISSING => 'filetype-missing',
82  self::FILETYPE_BADTYPE => 'filetype-banned',
83  self::MIN_LENGTH_PARTNAME => 'filename-tooshort',
84  self::ILLEGAL_FILENAME => 'illegal-filename',
85  self::OVERWRITE_EXISTING_FILE => 'overwrite',
86  self::VERIFICATION_ERROR => 'verification-error',
87  self::HOOK_ABORTED => 'hookaborted',
88  self::WINDOWS_NONASCII_FILENAME => 'windows-nonascii-filename',
89  self::FILENAME_TOO_LONG => 'filename-toolong',
90  ];
91  if ( isset( $code_to_status[$error] ) ) {
92  return $code_to_status[$error];
93  }
94 
95  return 'unknown-error';
96  }
97 
103  public static function isEnabled() {
105 
106  if ( !$wgEnableUploads ) {
107  return false;
108  }
109 
110  # Check php's file_uploads setting
111  return wfIsHHVM() || wfIniGetBool( 'file_uploads' );
112  }
113 
122  public static function isAllowed( $user ) {
123  foreach ( [ 'upload', 'edit' ] as $permission ) {
124  if ( !$user->isAllowed( $permission ) ) {
125  return $permission;
126  }
127  }
128 
129  return true;
130  }
131 
138  public static function isThrottled( $user ) {
139  return $user->pingLimiter( 'upload' );
140  }
141 
142  // Upload handlers. Should probably just be a global.
143  private static $uploadHandlers = [ 'Stash', 'File', 'Url' ];
144 
152  public static function createFromRequest( &$request, $type = null ) {
153  $type = $type ? $type : $request->getVal( 'wpSourceType', 'File' );
154 
155  if ( !$type ) {
156  return null;
157  }
158 
159  // Get the upload class
160  $type = ucfirst( $type );
161 
162  // Give hooks the chance to handle this request
163  $className = null;
164  Hooks::run( 'UploadCreateFromRequest', [ $type, &$className ] );
165  if ( is_null( $className ) ) {
166  $className = 'UploadFrom' . $type;
167  wfDebug( __METHOD__ . ": class name: $className\n" );
168  if ( !in_array( $type, self::$uploadHandlers ) ) {
169  return null;
170  }
171  }
172 
173  // Check whether this upload class is enabled
174  if ( !call_user_func( [ $className, 'isEnabled' ] ) ) {
175  return null;
176  }
177 
178  // Check whether the request is valid
179  if ( !call_user_func( [ $className, 'isValidRequest' ], $request ) ) {
180  return null;
181  }
182 
184  $handler = new $className;
185 
186  $handler->initializeFromRequest( $request );
187 
188  return $handler;
189  }
190 
196  public static function isValidRequest( $request ) {
197  return false;
198  }
199 
200  public function __construct() {
201  }
202 
209  public function getSourceType() {
210  return null;
211  }
212 
221  public function initializePathInfo( $name, $tempPath, $fileSize, $removeTempFile = false ) {
222  $this->mDesiredDestName = $name;
223  if ( FileBackend::isStoragePath( $tempPath ) ) {
224  throw new MWException( __METHOD__ . " given storage path `$tempPath`." );
225  }
226 
227  $this->setTempFile( $tempPath, $fileSize );
228  $this->mRemoveTempFile = $removeTempFile;
229  }
230 
236  abstract public function initializeFromRequest( &$request );
237 
242  protected function setTempFile( $tempPath, $fileSize = null ) {
243  $this->mTempPath = $tempPath;
244  $this->mFileSize = $fileSize ?: null;
245  if ( strlen( $this->mTempPath ) && file_exists( $this->mTempPath ) ) {
246  $this->tempFileObj = new TempFSFile( $this->mTempPath );
247  if ( !$fileSize ) {
248  $this->mFileSize = filesize( $this->mTempPath );
249  }
250  } else {
251  $this->tempFileObj = null;
252  }
253  }
254 
259  public function fetchFile() {
260  return Status::newGood();
261  }
262 
267  public function isEmptyFile() {
268  return empty( $this->mFileSize );
269  }
270 
275  public function getFileSize() {
276  return $this->mFileSize;
277  }
278 
283  public function getTempFileSha1Base36() {
284  return FSFile::getSha1Base36FromPath( $this->mTempPath );
285  }
286 
291  function getRealPath( $srcPath ) {
292  $repo = RepoGroup::singleton()->getLocalRepo();
293  if ( $repo->isVirtualUrl( $srcPath ) ) {
297  $tmpFile = $repo->getLocalCopy( $srcPath );
298  if ( $tmpFile ) {
299  $tmpFile->bind( $this ); // keep alive with $this
300  }
301  $path = $tmpFile ? $tmpFile->getPath() : false;
302  } else {
303  $path = $srcPath;
304  }
305 
306  return $path;
307  }
308 
313  public function verifyUpload() {
314 
318  if ( $this->isEmptyFile() ) {
319  return [ 'status' => self::EMPTY_FILE ];
320  }
321 
325  $maxSize = self::getMaxUploadSize( $this->getSourceType() );
326  if ( $this->mFileSize > $maxSize ) {
327  return [
328  'status' => self::FILE_TOO_LARGE,
329  'max' => $maxSize,
330  ];
331  }
332 
338  $verification = $this->verifyFile();
339  if ( $verification !== true ) {
340  return [
341  'status' => self::VERIFICATION_ERROR,
342  'details' => $verification
343  ];
344  }
345 
349  $result = $this->validateName();
350  if ( $result !== true ) {
351  return $result;
352  }
353 
354  $error = '';
355  if ( !Hooks::run( 'UploadVerification',
356  [ $this->mDestName, $this->mTempPath, &$error ] )
357  ) {
358  return [ 'status' => self::HOOK_ABORTED, 'error' => $error ];
359  }
360 
361  return [ 'status' => self::OK ];
362  }
363 
370  public function validateName() {
371  $nt = $this->getTitle();
372  if ( is_null( $nt ) ) {
373  $result = [ 'status' => $this->mTitleError ];
374  if ( $this->mTitleError == self::ILLEGAL_FILENAME ) {
375  $result['filtered'] = $this->mFilteredName;
376  }
377  if ( $this->mTitleError == self::FILETYPE_BADTYPE ) {
378  $result['finalExt'] = $this->mFinalExtension;
379  if ( count( $this->mBlackListedExtensions ) ) {
380  $result['blacklistedExt'] = $this->mBlackListedExtensions;
381  }
382  }
383 
384  return $result;
385  }
386  $this->mDestName = $this->getLocalFile()->getName();
387 
388  return true;
389  }
390 
400  protected function verifyMimeType( $mime ) {
402  if ( $wgVerifyMimeType ) {
403  wfDebug( "mime: <$mime> extension: <{$this->mFinalExtension}>\n" );
405  if ( $this->checkFileExtension( $mime, $wgMimeTypeBlacklist ) ) {
406  return [ 'filetype-badmime', $mime ];
407  }
408 
409  # Check what Internet Explorer would detect
410  $fp = fopen( $this->mTempPath, 'rb' );
411  $chunk = fread( $fp, 256 );
412  fclose( $fp );
413 
414  $magic = MimeMagic::singleton();
415  $extMime = $magic->guessTypesForExtension( $this->mFinalExtension );
416  $ieTypes = $magic->getIEMimeTypes( $this->mTempPath, $chunk, $extMime );
417  foreach ( $ieTypes as $ieType ) {
418  if ( $this->checkFileExtension( $ieType, $wgMimeTypeBlacklist ) ) {
419  return [ 'filetype-bad-ie-mime', $ieType ];
420  }
421  }
422  }
423 
424  return true;
425  }
426 
432  protected function verifyFile() {
434 
435  $status = $this->verifyPartialFile();
436  if ( $status !== true ) {
437  return $status;
438  }
439 
440  $this->mFileProps = FSFile::getPropsFromPath( $this->mTempPath, $this->mFinalExtension );
441  $mime = $this->mFileProps['mime'];
442 
443  if ( $wgVerifyMimeType ) {
444  # XXX: Missing extension will be caught by validateName() via getTitle()
445  if ( $this->mFinalExtension != '' && !$this->verifyExtension( $mime, $this->mFinalExtension ) ) {
446  return [ 'filetype-mime-mismatch', $this->mFinalExtension, $mime ];
447  }
448  }
449 
450  # check for htmlish code and javascript
451  if ( !$wgDisableUploadScriptChecks ) {
452  if ( $this->mFinalExtension == 'svg' || $mime == 'image/svg+xml' ) {
453  $svgStatus = $this->detectScriptInSvg( $this->mTempPath, false );
454  if ( $svgStatus !== false ) {
455  return $svgStatus;
456  }
457  }
458  }
459 
460  $handler = MediaHandler::getHandler( $mime );
461  if ( $handler ) {
462  $handlerStatus = $handler->verifyUpload( $this->mTempPath );
463  if ( !$handlerStatus->isOK() ) {
464  $errors = $handlerStatus->getErrorsArray();
465 
466  return reset( $errors );
467  }
468  }
469 
470  Hooks::run( 'UploadVerifyFile', [ $this, $mime, &$status ] );
471  if ( $status !== true ) {
472  return $status;
473  }
474 
475  wfDebug( __METHOD__ . ": all clear; passing.\n" );
476 
477  return true;
478  }
479 
488  protected function verifyPartialFile() {
490 
491  # getTitle() sets some internal parameters like $this->mFinalExtension
492  $this->getTitle();
493 
494  $this->mFileProps = FSFile::getPropsFromPath( $this->mTempPath, $this->mFinalExtension );
495 
496  # check MIME type, if desired
497  $mime = $this->mFileProps['file-mime'];
498  $status = $this->verifyMimeType( $mime );
499  if ( $status !== true ) {
500  return $status;
501  }
502 
503  # check for htmlish code and javascript
504  if ( !$wgDisableUploadScriptChecks ) {
505  if ( self::detectScript( $this->mTempPath, $mime, $this->mFinalExtension ) ) {
506  return [ 'uploadscripted' ];
507  }
508  if ( $this->mFinalExtension == 'svg' || $mime == 'image/svg+xml' ) {
509  $svgStatus = $this->detectScriptInSvg( $this->mTempPath, true );
510  if ( $svgStatus !== false ) {
511  return $svgStatus;
512  }
513  }
514  }
515 
516  # Check for Java applets, which if uploaded can bypass cross-site
517  # restrictions.
518  if ( !$wgAllowJavaUploads ) {
519  $this->mJavaDetected = false;
520  $zipStatus = ZipDirectoryReader::read( $this->mTempPath,
521  [ $this, 'zipEntryCallback' ] );
522  if ( !$zipStatus->isOK() ) {
523  $errors = $zipStatus->getErrorsArray();
524  $error = reset( $errors );
525  if ( $error[0] !== 'zip-wrong-format' ) {
526  return $error;
527  }
528  }
529  if ( $this->mJavaDetected ) {
530  return [ 'uploadjava' ];
531  }
532  }
533 
534  # Scan the uploaded file for viruses
535  $virus = $this->detectVirus( $this->mTempPath );
536  if ( $virus ) {
537  return [ 'uploadvirus', $virus ];
538  }
539 
540  return true;
541  }
542 
548  function zipEntryCallback( $entry ) {
549  $names = [ $entry['name'] ];
550 
551  // If there is a null character, cut off the name at it, because JDK's
552  // ZIP_GetEntry() uses strcmp() if the name hashes match. If a file name
553  // were constructed which had ".class\0" followed by a string chosen to
554  // make the hash collide with the truncated name, that file could be
555  // returned in response to a request for the .class file.
556  $nullPos = strpos( $entry['name'], "\000" );
557  if ( $nullPos !== false ) {
558  $names[] = substr( $entry['name'], 0, $nullPos );
559  }
560 
561  // If there is a trailing slash in the file name, we have to strip it,
562  // because that's what ZIP_GetEntry() does.
563  if ( preg_grep( '!\.class/?$!', $names ) ) {
564  $this->mJavaDetected = true;
565  }
566  }
567 
577  public function verifyPermissions( $user ) {
578  return $this->verifyTitlePermissions( $user );
579  }
580 
592  public function verifyTitlePermissions( $user ) {
597  $nt = $this->getTitle();
598  if ( is_null( $nt ) ) {
599  return true;
600  }
601  $permErrors = $nt->getUserPermissionsErrors( 'edit', $user );
602  $permErrorsUpload = $nt->getUserPermissionsErrors( 'upload', $user );
603  if ( !$nt->exists() ) {
604  $permErrorsCreate = $nt->getUserPermissionsErrors( 'create', $user );
605  } else {
606  $permErrorsCreate = [];
607  }
608  if ( $permErrors || $permErrorsUpload || $permErrorsCreate ) {
609  $permErrors = array_merge( $permErrors, wfArrayDiff2( $permErrorsUpload, $permErrors ) );
610  $permErrors = array_merge( $permErrors, wfArrayDiff2( $permErrorsCreate, $permErrors ) );
611 
612  return $permErrors;
613  }
614 
615  $overwriteError = $this->checkOverwrite( $user );
616  if ( $overwriteError !== true ) {
617  return [ $overwriteError ];
618  }
619 
620  return true;
621  }
622 
630  public function checkWarnings() {
631  global $wgLang;
632 
633  $warnings = [];
634 
635  $localFile = $this->getLocalFile();
636  $localFile->load( File::READ_LATEST );
637  $filename = $localFile->getName();
638 
643  $comparableName = str_replace( ' ', '_', $this->mDesiredDestName );
644  $comparableName = Title::capitalize( $comparableName, NS_FILE );
645 
646  if ( $this->mDesiredDestName != $filename && $comparableName != $filename ) {
647  $warnings['badfilename'] = $filename;
648  }
649 
650  // Check whether the file extension is on the unwanted list
652  if ( $wgCheckFileExtensions ) {
653  $extensions = array_unique( $wgFileExtensions );
654  if ( !$this->checkFileExtension( $this->mFinalExtension, $extensions ) ) {
655  $warnings['filetype-unwanted-type'] = [ $this->mFinalExtension,
656  $wgLang->commaList( $extensions ), count( $extensions ) ];
657  }
658  }
659 
661  if ( $wgUploadSizeWarning && ( $this->mFileSize > $wgUploadSizeWarning ) ) {
662  $warnings['large-file'] = [ $wgUploadSizeWarning, $this->mFileSize ];
663  }
664 
665  if ( $this->mFileSize == 0 ) {
666  $warnings['empty-file'] = true;
667  }
668 
669  $exists = self::getExistsWarning( $localFile );
670  if ( $exists !== false ) {
671  $warnings['exists'] = $exists;
672  }
673 
674  if ( $localFile->wasDeleted() && !$localFile->exists() ) {
675  $warnings['was-deleted'] = $filename;
676  }
677 
678  // Check dupes against existing files
679  $hash = $this->getTempFileSha1Base36();
680  $dupes = RepoGroup::singleton()->findBySha1( $hash );
681  $title = $this->getTitle();
682  // Remove all matches against self
683  foreach ( $dupes as $key => $dupe ) {
684  if ( $title->equals( $dupe->getTitle() ) ) {
685  unset( $dupes[$key] );
686  }
687  }
688  if ( $dupes ) {
689  $warnings['duplicate'] = $dupes;
690  }
691 
692  // Check dupes against archives
693  $archivedFile = new ArchivedFile( null, 0, '', $hash );
694  if ( $archivedFile->getID() > 0 ) {
695  if ( $archivedFile->userCan( File::DELETED_FILE ) ) {
696  $warnings['duplicate-archive'] = $archivedFile->getName();
697  } else {
698  $warnings['duplicate-archive'] = '';
699  }
700  }
701 
702  return $warnings;
703  }
704 
718  public function performUpload( $comment, $pageText, $watch, $user, $tags = [] ) {
719  $this->getLocalFile()->load( File::READ_LATEST );
720 
721  $status = $this->getLocalFile()->upload(
722  $this->mTempPath,
723  $comment,
724  $pageText,
726  $this->mFileProps,
727  false,
728  $user,
729  $tags
730  );
731 
732  if ( $status->isGood() ) {
733  if ( $watch ) {
735  $this->getLocalFile()->getTitle(),
736  $user,
738  );
739  }
740  Hooks::run( 'UploadComplete', [ &$this ] );
741 
742  $this->postProcessUpload();
743  }
744 
745  return $status;
746  }
747 
753  public function postProcessUpload() {
755 
756  $jobs = [];
757 
759  rsort( $sizes );
760 
761  $file = $this->getLocalFile();
762 
763  foreach ( $sizes as $size ) {
764  if ( $file->isVectorized() || $file->getWidth() > $size ) {
765  $jobs[] = new ThumbnailRenderJob(
766  $file->getTitle(),
767  [ 'transformParams' => [ 'width' => $size ] ]
768  );
769  }
770  }
771 
772  if ( $jobs ) {
773  JobQueueGroup::singleton()->push( $jobs );
774  }
775  }
776 
783  public function getTitle() {
784  if ( $this->mTitle !== false ) {
785  return $this->mTitle;
786  }
787  if ( !is_string( $this->mDesiredDestName ) ) {
788  $this->mTitleError = self::ILLEGAL_FILENAME;
789  $this->mTitle = null;
790 
791  return $this->mTitle;
792  }
793  /* Assume that if a user specified File:Something.jpg, this is an error
794  * and that the namespace prefix needs to be stripped of.
795  */
796  $title = Title::newFromText( $this->mDesiredDestName );
797  if ( $title && $title->getNamespace() == NS_FILE ) {
798  $this->mFilteredName = $title->getDBkey();
799  } else {
800  $this->mFilteredName = $this->mDesiredDestName;
801  }
802 
803  # oi_archive_name is max 255 bytes, which include a timestamp and an
804  # exclamation mark, so restrict file name to 240 bytes.
805  if ( strlen( $this->mFilteredName ) > 240 ) {
806  $this->mTitleError = self::FILENAME_TOO_LONG;
807  $this->mTitle = null;
808 
809  return $this->mTitle;
810  }
811 
817  $this->mFilteredName = wfStripIllegalFilenameChars( $this->mFilteredName );
818  /* Normalize to title form before we do any further processing */
819  $nt = Title::makeTitleSafe( NS_FILE, $this->mFilteredName );
820  if ( is_null( $nt ) ) {
821  $this->mTitleError = self::ILLEGAL_FILENAME;
822  $this->mTitle = null;
823 
824  return $this->mTitle;
825  }
826  $this->mFilteredName = $nt->getDBkey();
827 
832  list( $partname, $ext ) = $this->splitExtensions( $this->mFilteredName );
833 
834  if ( count( $ext ) ) {
835  $this->mFinalExtension = trim( $ext[count( $ext ) - 1] );
836  } else {
837  $this->mFinalExtension = '';
838 
839  # No extension, try guessing one
840  $magic = MimeMagic::singleton();
841  $mime = $magic->guessMimeType( $this->mTempPath );
842  if ( $mime !== 'unknown/unknown' ) {
843  # Get a space separated list of extensions
844  $extList = $magic->getExtensionsForType( $mime );
845  if ( $extList ) {
846  # Set the extension to the canonical extension
847  $this->mFinalExtension = strtok( $extList, ' ' );
848 
849  # Fix up the other variables
850  $this->mFilteredName .= ".{$this->mFinalExtension}";
851  $nt = Title::makeTitleSafe( NS_FILE, $this->mFilteredName );
853  }
854  }
855  }
856 
857  /* Don't allow users to override the blacklist (check file extension) */
860 
861  $blackListedExtensions = $this->checkFileExtensionList( $ext, $wgFileBlacklist );
862 
863  if ( $this->mFinalExtension == '' ) {
864  $this->mTitleError = self::FILETYPE_MISSING;
865  $this->mTitle = null;
866 
867  return $this->mTitle;
868  } elseif ( $blackListedExtensions ||
869  ( $wgCheckFileExtensions && $wgStrictFileExtensions &&
870  !$this->checkFileExtension( $this->mFinalExtension, $wgFileExtensions ) )
871  ) {
872  $this->mBlackListedExtensions = $blackListedExtensions;
873  $this->mTitleError = self::FILETYPE_BADTYPE;
874  $this->mTitle = null;
875 
876  return $this->mTitle;
877  }
878 
879  // Windows may be broken with special characters, see bug 1780
880  if ( !preg_match( '/^[\x0-\x7f]*$/', $nt->getText() )
881  && !RepoGroup::singleton()->getLocalRepo()->backendSupportsUnicodePaths()
882  ) {
883  $this->mTitleError = self::WINDOWS_NONASCII_FILENAME;
884  $this->mTitle = null;
885 
886  return $this->mTitle;
887  }
888 
889  # If there was more than one "extension", reassemble the base
890  # filename to prevent bogus complaints about length
891  if ( count( $ext ) > 1 ) {
892  $iterations = count( $ext ) - 1;
893  for ( $i = 0; $i < $iterations; $i++ ) {
894  $partname .= '.' . $ext[$i];
895  }
896  }
897 
898  if ( strlen( $partname ) < 1 ) {
899  $this->mTitleError = self::MIN_LENGTH_PARTNAME;
900  $this->mTitle = null;
901 
902  return $this->mTitle;
903  }
904 
905  $this->mTitle = $nt;
906 
907  return $this->mTitle;
908  }
909 
915  public function getLocalFile() {
916  if ( is_null( $this->mLocalFile ) ) {
917  $nt = $this->getTitle();
918  $this->mLocalFile = is_null( $nt ) ? null : wfLocalFile( $nt );
919  }
920 
921  return $this->mLocalFile;
922  }
923 
939  public function stashFile( User $user = null ) {
940  // was stashSessionFile
941 
942  $stash = RepoGroup::singleton()->getLocalRepo()->getUploadStash( $user );
943  $file = $stash->stashFile( $this->mTempPath, $this->getSourceType() );
944  $this->mLocalFile = $file;
945 
946  return $file;
947  }
948 
955  public function stashFileGetKey() {
956  return $this->stashFile()->getFileKey();
957  }
958 
964  public function stashSession() {
965  return $this->stashFileGetKey();
966  }
967 
972  public function cleanupTempFile() {
973  if ( $this->mRemoveTempFile && $this->tempFileObj ) {
974  // Delete when all relevant TempFSFile handles go out of scope
975  wfDebug( __METHOD__ . ": Marked temporary file '{$this->mTempPath}' for removal\n" );
976  $this->tempFileObj->autocollect();
977  }
978  }
979 
980  public function getTempPath() {
981  return $this->mTempPath;
982  }
983 
993  public static function splitExtensions( $filename ) {
994  $bits = explode( '.', $filename );
995  $basename = array_shift( $bits );
996 
997  return [ $basename, $bits ];
998  }
999 
1008  public static function checkFileExtension( $ext, $list ) {
1009  return in_array( strtolower( $ext ), $list );
1010  }
1011 
1020  public static function checkFileExtensionList( $ext, $list ) {
1021  return array_intersect( array_map( 'strtolower', $ext ), $list );
1022  }
1023 
1031  public static function verifyExtension( $mime, $extension ) {
1032  $magic = MimeMagic::singleton();
1033 
1034  if ( !$mime || $mime == 'unknown' || $mime == 'unknown/unknown' ) {
1035  if ( !$magic->isRecognizableExtension( $extension ) ) {
1036  wfDebug( __METHOD__ . ": passing file with unknown detected mime type; " .
1037  "unrecognized extension '$extension', can't verify\n" );
1038 
1039  return true;
1040  } else {
1041  wfDebug( __METHOD__ . ": rejecting file with unknown detected mime type; " .
1042  "recognized extension '$extension', so probably invalid file\n" );
1043 
1044  return false;
1045  }
1046  }
1047 
1048  $match = $magic->isMatchingExtension( $extension, $mime );
1049 
1050  if ( $match === null ) {
1051  if ( $magic->getTypesForExtension( $extension ) !== null ) {
1052  wfDebug( __METHOD__ . ": No extension known for $mime, but we know a mime for $extension\n" );
1053 
1054  return false;
1055  } else {
1056  wfDebug( __METHOD__ . ": no file extension known for mime type $mime, passing file\n" );
1057 
1058  return true;
1059  }
1060  } elseif ( $match === true ) {
1061  wfDebug( __METHOD__ . ": mime type $mime matches extension $extension, passing file\n" );
1062 
1064  return true;
1065  } else {
1066  wfDebug( __METHOD__
1067  . ": mime type $mime mismatches file extension $extension, rejecting file\n" );
1068 
1069  return false;
1070  }
1071  }
1072 
1084  public static function detectScript( $file, $mime, $extension ) {
1086 
1087  # ugly hack: for text files, always look at the entire file.
1088  # For binary field, just check the first K.
1089 
1090  if ( strpos( $mime, 'text/' ) === 0 ) {
1091  $chunk = file_get_contents( $file );
1092  } else {
1093  $fp = fopen( $file, 'rb' );
1094  $chunk = fread( $fp, 1024 );
1095  fclose( $fp );
1096  }
1097 
1098  $chunk = strtolower( $chunk );
1099 
1100  if ( !$chunk ) {
1101  return false;
1102  }
1103 
1104  # decode from UTF-16 if needed (could be used for obfuscation).
1105  if ( substr( $chunk, 0, 2 ) == "\xfe\xff" ) {
1106  $enc = 'UTF-16BE';
1107  } elseif ( substr( $chunk, 0, 2 ) == "\xff\xfe" ) {
1108  $enc = 'UTF-16LE';
1109  } else {
1110  $enc = null;
1111  }
1112 
1113  if ( $enc ) {
1114  $chunk = iconv( $enc, "ASCII//IGNORE", $chunk );
1115  }
1116 
1117  $chunk = trim( $chunk );
1118 
1120  wfDebug( __METHOD__ . ": checking for embedded scripts and HTML stuff\n" );
1121 
1122  # check for HTML doctype
1123  if ( preg_match( "/<!DOCTYPE *X?HTML/i", $chunk ) ) {
1124  return true;
1125  }
1126 
1127  // Some browsers will interpret obscure xml encodings as UTF-8, while
1128  // PHP/expat will interpret the given encoding in the xml declaration (bug 47304)
1129  if ( $extension == 'svg' || strpos( $mime, 'image/svg' ) === 0 ) {
1130  if ( self::checkXMLEncodingMissmatch( $file ) ) {
1131  return true;
1132  }
1133  }
1134 
1150  $tags = [
1151  '<a href',
1152  '<body',
1153  '<head',
1154  '<html', # also in safari
1155  '<img',
1156  '<pre',
1157  '<script', # also in safari
1158  '<table'
1159  ];
1160 
1161  if ( !$wgAllowTitlesInSVG && $extension !== 'svg' && $mime !== 'image/svg' ) {
1162  $tags[] = '<title';
1163  }
1164 
1165  foreach ( $tags as $tag ) {
1166  if ( false !== strpos( $chunk, $tag ) ) {
1167  wfDebug( __METHOD__ . ": found something that may make it be mistaken for html: $tag\n" );
1168 
1169  return true;
1170  }
1171  }
1172 
1173  /*
1174  * look for JavaScript
1175  */
1176 
1177  # resolve entity-refs to look at attributes. may be harsh on big files... cache result?
1178  $chunk = Sanitizer::decodeCharReferences( $chunk );
1179 
1180  # look for script-types
1181  if ( preg_match( '!type\s*=\s*[\'"]?\s*(?:\w*/)?(?:ecma|java)!sim', $chunk ) ) {
1182  wfDebug( __METHOD__ . ": found script types\n" );
1183 
1184  return true;
1185  }
1186 
1187  # look for html-style script-urls
1188  if ( preg_match( '!(?:href|src|data)\s*=\s*[\'"]?\s*(?:ecma|java)script:!sim', $chunk ) ) {
1189  wfDebug( __METHOD__ . ": found html-style script urls\n" );
1190 
1191  return true;
1192  }
1193 
1194  # look for css-style script-urls
1195  if ( preg_match( '!url\s*\(\s*[\'"]?\s*(?:ecma|java)script:!sim', $chunk ) ) {
1196  wfDebug( __METHOD__ . ": found css-style script urls\n" );
1197 
1198  return true;
1199  }
1200 
1201  wfDebug( __METHOD__ . ": no scripts found\n" );
1202 
1203  return false;
1204  }
1205 
1213  public static function checkXMLEncodingMissmatch( $file ) {
1215  $contents = file_get_contents( $file, false, null, -1, $wgSVGMetadataCutoff );
1216  $encodingRegex = '!encoding[ \t\n\r]*=[ \t\n\r]*[\'"](.*?)[\'"]!si';
1217 
1218  if ( preg_match( "!<\?xml\b(.*?)\?>!si", $contents, $matches ) ) {
1219  if ( preg_match( $encodingRegex, $matches[1], $encMatch )
1220  && !in_array( strtoupper( $encMatch[1] ), self::$safeXmlEncodings )
1221  ) {
1222  wfDebug( __METHOD__ . ": Found unsafe XML encoding '{$encMatch[1]}'\n" );
1223 
1224  return true;
1225  }
1226  } elseif ( preg_match( "!<\?xml\b!si", $contents ) ) {
1227  // Start of XML declaration without an end in the first $wgSVGMetadataCutoff
1228  // bytes. There shouldn't be a legitimate reason for this to happen.
1229  wfDebug( __METHOD__ . ": Unmatched XML declaration start\n" );
1230 
1231  return true;
1232  } elseif ( substr( $contents, 0, 4 ) == "\x4C\x6F\xA7\x94" ) {
1233  // EBCDIC encoded XML
1234  wfDebug( __METHOD__ . ": EBCDIC Encoded XML\n" );
1235 
1236  return true;
1237  }
1238 
1239  // It's possible the file is encoded with multi-byte encoding, so re-encode attempt to
1240  // detect the encoding in case is specifies an encoding not whitelisted in self::$safeXmlEncodings
1241  $attemptEncodings = [ 'UTF-16', 'UTF-16BE', 'UTF-32', 'UTF-32BE' ];
1242  foreach ( $attemptEncodings as $encoding ) {
1243  MediaWiki\suppressWarnings();
1244  $str = iconv( $encoding, 'UTF-8', $contents );
1245  MediaWiki\restoreWarnings();
1246  if ( $str != '' && preg_match( "!<\?xml\b(.*?)\?>!si", $str, $matches ) ) {
1247  if ( preg_match( $encodingRegex, $matches[1], $encMatch )
1248  && !in_array( strtoupper( $encMatch[1] ), self::$safeXmlEncodings )
1249  ) {
1250  wfDebug( __METHOD__ . ": Found unsafe XML encoding '{$encMatch[1]}'\n" );
1251 
1252  return true;
1253  }
1254  } elseif ( $str != '' && preg_match( "!<\?xml\b!si", $str ) ) {
1255  // Start of XML declaration without an end in the first $wgSVGMetadataCutoff
1256  // bytes. There shouldn't be a legitimate reason for this to happen.
1257  wfDebug( __METHOD__ . ": Unmatched XML declaration start\n" );
1258 
1259  return true;
1260  }
1261  }
1262 
1263  return false;
1264  }
1265 
1271  protected function detectScriptInSvg( $filename, $partial ) {
1272  $this->mSVGNSError = false;
1273  $check = new XmlTypeCheck(
1274  $filename,
1275  [ $this, 'checkSvgScriptCallback' ],
1276  true,
1277  [ 'processing_instruction_handler' => 'UploadBase::checkSvgPICallback' ]
1278  );
1279  if ( $check->wellFormed !== true ) {
1280  // Invalid xml (bug 58553)
1281  // But only when non-partial (bug 65724)
1282  return $partial ? false : [ 'uploadinvalidxml' ];
1283  } elseif ( $check->filterMatch ) {
1284  if ( $this->mSVGNSError ) {
1285  return [ 'uploadscriptednamespace', $this->mSVGNSError ];
1286  }
1287 
1288  return $check->filterMatchType;
1289  }
1290 
1291  return false;
1292  }
1293 
1300  public static function checkSvgPICallback( $target, $data ) {
1301  // Don't allow external stylesheets (bug 57550)
1302  if ( preg_match( '/xml-stylesheet/i', $target ) ) {
1303  return [ 'upload-scripted-pi-callback' ];
1304  }
1305 
1306  return false;
1307  }
1308 
1315  public function checkSvgScriptCallback( $element, $attribs, $data = null ) {
1316 
1317  list( $namespace, $strippedElement ) = $this->splitXmlNamespace( $element );
1318 
1319  // We specifically don't include:
1320  // http://www.w3.org/1999/xhtml (bug 60771)
1321  static $validNamespaces = [
1322  '',
1323  'adobe:ns:meta/',
1324  'http://creativecommons.org/ns#',
1325  'http://inkscape.sourceforge.net/dtd/sodipodi-0.dtd',
1326  'http://ns.adobe.com/adobeillustrator/10.0/',
1327  'http://ns.adobe.com/adobesvgviewerextensions/3.0/',
1328  'http://ns.adobe.com/extensibility/1.0/',
1329  'http://ns.adobe.com/flows/1.0/',
1330  'http://ns.adobe.com/illustrator/1.0/',
1331  'http://ns.adobe.com/imagereplacement/1.0/',
1332  'http://ns.adobe.com/pdf/1.3/',
1333  'http://ns.adobe.com/photoshop/1.0/',
1334  'http://ns.adobe.com/saveforweb/1.0/',
1335  'http://ns.adobe.com/variables/1.0/',
1336  'http://ns.adobe.com/xap/1.0/',
1337  'http://ns.adobe.com/xap/1.0/g/',
1338  'http://ns.adobe.com/xap/1.0/g/img/',
1339  'http://ns.adobe.com/xap/1.0/mm/',
1340  'http://ns.adobe.com/xap/1.0/rights/',
1341  'http://ns.adobe.com/xap/1.0/stype/dimensions#',
1342  'http://ns.adobe.com/xap/1.0/stype/font#',
1343  'http://ns.adobe.com/xap/1.0/stype/manifestitem#',
1344  'http://ns.adobe.com/xap/1.0/stype/resourceevent#',
1345  'http://ns.adobe.com/xap/1.0/stype/resourceref#',
1346  'http://ns.adobe.com/xap/1.0/t/pg/',
1347  'http://purl.org/dc/elements/1.1/',
1348  'http://purl.org/dc/elements/1.1',
1349  'http://schemas.microsoft.com/visio/2003/svgextensions/',
1350  'http://sodipodi.sourceforge.net/dtd/sodipodi-0.dtd',
1351  'http://taptrix.com/inkpad/svg_extensions',
1352  'http://web.resource.org/cc/',
1353  'http://www.freesoftware.fsf.org/bkchem/cdml',
1354  'http://www.inkscape.org/namespaces/inkscape',
1355  'http://www.opengis.net/gml',
1356  'http://www.w3.org/1999/02/22-rdf-syntax-ns#',
1357  'http://www.w3.org/2000/svg',
1358  'http://www.w3.org/tr/rec-rdf-syntax/',
1359  ];
1360 
1361  if ( !in_array( $namespace, $validNamespaces ) ) {
1362  wfDebug( __METHOD__ . ": Non-svg namespace '$namespace' in uploaded file.\n" );
1364  $this->mSVGNSError = $namespace;
1365 
1366  return true;
1367  }
1368 
1369  /*
1370  * check for elements that can contain javascript
1371  */
1372  if ( $strippedElement == 'script' ) {
1373  wfDebug( __METHOD__ . ": Found script element '$element' in uploaded file.\n" );
1374 
1375  return [ 'uploaded-script-svg', $strippedElement ];
1376  }
1377 
1378  # e.g., <svg xmlns="http://www.w3.org/2000/svg">
1379  # <handler xmlns:ev="http://www.w3.org/2001/xml-events" ev:event="load">alert(1)</handler> </svg>
1380  if ( $strippedElement == 'handler' ) {
1381  wfDebug( __METHOD__ . ": Found scriptable element '$element' in uploaded file.\n" );
1382 
1383  return [ 'uploaded-script-svg', $strippedElement ];
1384  }
1385 
1386  # SVG reported in Feb '12 that used xml:stylesheet to generate javascript block
1387  if ( $strippedElement == 'stylesheet' ) {
1388  wfDebug( __METHOD__ . ": Found scriptable element '$element' in uploaded file.\n" );
1389 
1390  return [ 'uploaded-script-svg', $strippedElement ];
1391  }
1392 
1393  # Block iframes, in case they pass the namespace check
1394  if ( $strippedElement == 'iframe' ) {
1395  wfDebug( __METHOD__ . ": iframe in uploaded file.\n" );
1396 
1397  return [ 'uploaded-script-svg', $strippedElement ];
1398  }
1399 
1400  # Check <style> css
1401  if ( $strippedElement == 'style'
1402  && self::checkCssFragment( Sanitizer::normalizeCss( $data ) )
1403  ) {
1404  wfDebug( __METHOD__ . ": hostile css in style element.\n" );
1405  return [ 'uploaded-hostile-svg' ];
1406  }
1407 
1408  foreach ( $attribs as $attrib => $value ) {
1409  $stripped = $this->stripXmlNamespace( $attrib );
1410  $value = strtolower( $value );
1411 
1412  if ( substr( $stripped, 0, 2 ) == 'on' ) {
1413  wfDebug( __METHOD__
1414  . ": Found event-handler attribute '$attrib'='$value' in uploaded file.\n" );
1415 
1416  return [ 'uploaded-event-handler-on-svg', $attrib, $value ];
1417  }
1418 
1419  # href with non-local target (don't allow http://, javascript:, etc)
1420  if ( $stripped == 'href'
1421  && strpos( $value, 'data:' ) !== 0
1422  && strpos( $value, '#' ) !== 0
1423  ) {
1424  if ( !( $strippedElement === 'a'
1425  && preg_match( '!^https?://!im', $value ) )
1426  ) {
1427  wfDebug( __METHOD__ . ": Found href attribute <$strippedElement "
1428  . "'$attrib'='$value' in uploaded file.\n" );
1429 
1430  return [ 'uploaded-href-attribute-svg', $strippedElement, $attrib, $value ];
1431  }
1432  }
1433 
1434  # only allow data: targets that should be safe. This prevents vectors like,
1435  # image/svg, text/xml, application/xml, and text/html, which can contain scripts
1436  if ( $stripped == 'href' && strncasecmp( 'data:', $value, 5 ) === 0 ) {
1437  // rfc2397 parameters. This is only slightly slower than (;[\w;]+)*.
1438  // @codingStandardsIgnoreStart Generic.Files.LineLength
1439  $parameters = '(?>;[a-zA-Z0-9\!#$&\'*+.^_`{|}~-]+=(?>[a-zA-Z0-9\!#$&\'*+.^_`{|}~-]+|"(?>[\0-\x0c\x0e-\x21\x23-\x5b\x5d-\x7f]+|\\\\[\0-\x7f])*"))*(?:;base64)?';
1440  // @codingStandardsIgnoreEnd
1441 
1442  if ( !preg_match( "!^data:\s*image/(gif|jpeg|jpg|png)$parameters,!i", $value ) ) {
1443  wfDebug( __METHOD__ . ": Found href to unwhitelisted data: uri "
1444  . "\"<$strippedElement '$attrib'='$value'...\" in uploaded file.\n" );
1445  return [ 'uploaded-href-unsafe-target-svg', $strippedElement, $attrib, $value ];
1446  }
1447  }
1448 
1449  # Change href with animate from (http://html5sec.org/#137).
1450  if ( $stripped === 'attributename'
1451  && $strippedElement === 'animate'
1452  && $this->stripXmlNamespace( $value ) == 'href'
1453  ) {
1454  wfDebug( __METHOD__ . ": Found animate that might be changing href using from "
1455  . "\"<$strippedElement '$attrib'='$value'...\" in uploaded file.\n" );
1456 
1457  return [ 'uploaded-animate-svg', $strippedElement, $attrib, $value ];
1458  }
1459 
1460  # use set/animate to add event-handler attribute to parent
1461  if ( ( $strippedElement == 'set' || $strippedElement == 'animate' )
1462  && $stripped == 'attributename'
1463  && substr( $value, 0, 2 ) == 'on'
1464  ) {
1465  wfDebug( __METHOD__ . ": Found svg setting event-handler attribute with "
1466  . "\"<$strippedElement $stripped='$value'...\" in uploaded file.\n" );
1467 
1468  return [ 'uploaded-setting-event-handler-svg', $strippedElement, $stripped, $value ];
1469  }
1470 
1471  # use set to add href attribute to parent element
1472  if ( $strippedElement == 'set'
1473  && $stripped == 'attributename'
1474  && strpos( $value, 'href' ) !== false
1475  ) {
1476  wfDebug( __METHOD__ . ": Found svg setting href attribute '$value' in uploaded file.\n" );
1477 
1478  return [ 'uploaded-setting-href-svg' ];
1479  }
1480 
1481  # use set to add a remote / data / script target to an element
1482  if ( $strippedElement == 'set'
1483  && $stripped == 'to'
1484  && preg_match( '!(http|https|data|script):!sim', $value )
1485  ) {
1486  wfDebug( __METHOD__ . ": Found svg setting attribute to '$value' in uploaded file.\n" );
1487 
1488  return [ 'uploaded-wrong-setting-svg', $value ];
1489  }
1490 
1491  # use handler attribute with remote / data / script
1492  if ( $stripped == 'handler' && preg_match( '!(http|https|data|script):!sim', $value ) ) {
1493  wfDebug( __METHOD__ . ": Found svg setting handler with remote/data/script "
1494  . "'$attrib'='$value' in uploaded file.\n" );
1495 
1496  return [ 'uploaded-setting-handler-svg', $attrib, $value ];
1497  }
1498 
1499  # use CSS styles to bring in remote code
1500  if ( $stripped == 'style'
1501  && self::checkCssFragment( Sanitizer::normalizeCss( $value ) )
1502  ) {
1503  wfDebug( __METHOD__ . ": Found svg setting a style with "
1504  . "remote url '$attrib'='$value' in uploaded file.\n" );
1505  return [ 'uploaded-remote-url-svg', $attrib, $value ];
1506  }
1507 
1508  # Several attributes can include css, css character escaping isn't allowed
1509  $cssAttrs = [ 'font', 'clip-path', 'fill', 'filter', 'marker',
1510  'marker-end', 'marker-mid', 'marker-start', 'mask', 'stroke' ];
1511  if ( in_array( $stripped, $cssAttrs )
1512  && self::checkCssFragment( $value )
1513  ) {
1514  wfDebug( __METHOD__ . ": Found svg setting a style with "
1515  . "remote url '$attrib'='$value' in uploaded file.\n" );
1516  return [ 'uploaded-remote-url-svg', $attrib, $value ];
1517  }
1518 
1519  # image filters can pull in url, which could be svg that executes scripts
1520  if ( $strippedElement == 'image'
1521  && $stripped == 'filter'
1522  && preg_match( '!url\s*\(!sim', $value )
1523  ) {
1524  wfDebug( __METHOD__ . ": Found image filter with url: "
1525  . "\"<$strippedElement $stripped='$value'...\" in uploaded file.\n" );
1526 
1527  return [ 'uploaded-image-filter-svg', $strippedElement, $stripped, $value ];
1528  }
1529  }
1530 
1531  return false; // No scripts detected
1532  }
1533 
1541  private static function checkCssFragment( $value ) {
1542 
1543  # Forbid external stylesheets, for both reliability and to protect viewer's privacy
1544  if ( stripos( $value, '@import' ) !== false ) {
1545  return true;
1546  }
1547 
1548  # We allow @font-face to embed fonts with data: urls, so we snip the string
1549  # 'url' out so this case won't match when we check for urls below
1550  $pattern = '!(@font-face\s*{[^}]*src:)url(\("data:;base64,)!im';
1551  $value = preg_replace( $pattern, '$1$2', $value );
1552 
1553  # Check for remote and executable CSS. Unlike in Sanitizer::checkCss, the CSS
1554  # properties filter and accelerator don't seem to be useful for xss in SVG files.
1555  # Expression and -o-link don't seem to work either, but filtering them here in case.
1556  # Additionally, we catch remote urls like url("http:..., url('http:..., url(http:...,
1557  # but not local ones such as url("#..., url('#..., url(#....
1558  if ( preg_match( '!expression
1559  | -o-link\s*:
1560  | -o-link-source\s*:
1561  | -o-replace\s*:!imx', $value ) ) {
1562  return true;
1563  }
1564 
1565  if ( preg_match_all(
1566  "!(\s*(url|image|image-set)\s*\(\s*[\"']?\s*[^#]+.*?\))!sim",
1567  $value,
1568  $matches
1569  ) !== 0
1570  ) {
1571  # TODO: redo this in one regex. Until then, url("#whatever") matches the first
1572  foreach ( $matches[1] as $match ) {
1573  if ( !preg_match( "!\s*(url|image|image-set)\s*\(\s*(#|'#|\"#)!im", $match ) ) {
1574  return true;
1575  }
1576  }
1577  }
1578 
1579  if ( preg_match( '/[\000-\010\013\016-\037\177]/', $value ) ) {
1580  return true;
1581  }
1582 
1583  return false;
1584  }
1585 
1591  private static function splitXmlNamespace( $element ) {
1592  // 'http://www.w3.org/2000/svg:script' -> array( 'http://www.w3.org/2000/svg', 'script' )
1593  $parts = explode( ':', strtolower( $element ) );
1594  $name = array_pop( $parts );
1595  $ns = implode( ':', $parts );
1596 
1597  return [ $ns, $name ];
1598  }
1599 
1604  private function stripXmlNamespace( $name ) {
1605  // 'http://www.w3.org/2000/svg:script' -> 'script'
1606  $parts = explode( ':', strtolower( $name ) );
1607 
1608  return array_pop( $parts );
1609  }
1610 
1621  public static function detectVirus( $file ) {
1623 
1624  if ( !$wgAntivirus ) {
1625  wfDebug( __METHOD__ . ": virus scanner disabled\n" );
1626 
1627  return null;
1628  }
1629 
1630  if ( !$wgAntivirusSetup[$wgAntivirus] ) {
1631  wfDebug( __METHOD__ . ": unknown virus scanner: $wgAntivirus\n" );
1632  $wgOut->wrapWikiMsg( "<div class=\"error\">\n$1\n</div>",
1633  [ 'virus-badscanner', $wgAntivirus ] );
1634 
1635  return wfMessage( 'virus-unknownscanner' )->text() . " $wgAntivirus";
1636  }
1637 
1638  # look up scanner configuration
1639  $command = $wgAntivirusSetup[$wgAntivirus]['command'];
1640  $exitCodeMap = $wgAntivirusSetup[$wgAntivirus]['codemap'];
1641  $msgPattern = isset( $wgAntivirusSetup[$wgAntivirus]['messagepattern'] ) ?
1642  $wgAntivirusSetup[$wgAntivirus]['messagepattern'] : null;
1643 
1644  if ( strpos( $command, "%f" ) === false ) {
1645  # simple pattern: append file to scan
1646  $command .= " " . wfEscapeShellArg( $file );
1647  } else {
1648  # complex pattern: replace "%f" with file to scan
1649  $command = str_replace( "%f", wfEscapeShellArg( $file ), $command );
1650  }
1651 
1652  wfDebug( __METHOD__ . ": running virus scan: $command \n" );
1653 
1654  # execute virus scanner
1655  $exitCode = false;
1656 
1657  # NOTE: there's a 50 line workaround to make stderr redirection work on windows, too.
1658  # that does not seem to be worth the pain.
1659  # Ask me (Duesentrieb) about it if it's ever needed.
1660  $output = wfShellExecWithStderr( $command, $exitCode );
1661 
1662  # map exit code to AV_xxx constants.
1663  $mappedCode = $exitCode;
1664  if ( $exitCodeMap ) {
1665  if ( isset( $exitCodeMap[$exitCode] ) ) {
1666  $mappedCode = $exitCodeMap[$exitCode];
1667  } elseif ( isset( $exitCodeMap["*"] ) ) {
1668  $mappedCode = $exitCodeMap["*"];
1669  }
1670  }
1671 
1672  /* NB: AV_NO_VIRUS is 0 but AV_SCAN_FAILED is false,
1673  * so we need the strict equalities === and thus can't use a switch here
1674  */
1675  if ( $mappedCode === AV_SCAN_FAILED ) {
1676  # scan failed (code was mapped to false by $exitCodeMap)
1677  wfDebug( __METHOD__ . ": failed to scan $file (code $exitCode).\n" );
1678 
1679  $output = $wgAntivirusRequired
1680  ? wfMessage( 'virus-scanfailed', [ $exitCode ] )->text()
1681  : null;
1682  } elseif ( $mappedCode === AV_SCAN_ABORTED ) {
1683  # scan failed because filetype is unknown (probably imune)
1684  wfDebug( __METHOD__ . ": unsupported file type $file (code $exitCode).\n" );
1685  $output = null;
1686  } elseif ( $mappedCode === AV_NO_VIRUS ) {
1687  # no virus found
1688  wfDebug( __METHOD__ . ": file passed virus scan.\n" );
1689  $output = false;
1690  } else {
1691  $output = trim( $output );
1692 
1693  if ( !$output ) {
1694  $output = true; # if there's no output, return true
1695  } elseif ( $msgPattern ) {
1696  $groups = [];
1697  if ( preg_match( $msgPattern, $output, $groups ) ) {
1698  if ( $groups[1] ) {
1699  $output = $groups[1];
1700  }
1701  }
1702  }
1703 
1704  wfDebug( __METHOD__ . ": FOUND VIRUS! scanner feedback: $output \n" );
1705  }
1706 
1707  return $output;
1708  }
1709 
1718  private function checkOverwrite( $user ) {
1719  // First check whether the local file can be overwritten
1720  $file = $this->getLocalFile();
1721  $file->load( File::READ_LATEST );
1722  if ( $file->exists() ) {
1723  if ( !self::userCanReUpload( $user, $file ) ) {
1724  return [ 'fileexists-forbidden', $file->getName() ];
1725  } else {
1726  return true;
1727  }
1728  }
1729 
1730  /* Check shared conflicts: if the local file does not exist, but
1731  * wfFindFile finds a file, it exists in a shared repository.
1732  */
1733  $file = wfFindFile( $this->getTitle(), [ 'latest' => true ] );
1734  if ( $file && !$user->isAllowed( 'reupload-shared' ) ) {
1735  return [ 'fileexists-shared-forbidden', $file->getName() ];
1736  }
1737 
1738  return true;
1739  }
1740 
1748  public static function userCanReUpload( User $user, File $img ) {
1749  if ( $user->isAllowed( 'reupload' ) ) {
1750  return true; // non-conditional
1751  } elseif ( !$user->isAllowed( 'reupload-own' ) ) {
1752  return false;
1753  }
1754 
1755  if ( !( $img instanceof LocalFile ) ) {
1756  return false;
1757  }
1758 
1759  $img->load();
1760 
1761  return $user->getId() == $img->getUser( 'id' );
1762  }
1763 
1775  public static function getExistsWarning( $file ) {
1776  if ( $file->exists() ) {
1777  return [ 'warning' => 'exists', 'file' => $file ];
1778  }
1779 
1780  if ( $file->getTitle()->getArticleID() ) {
1781  return [ 'warning' => 'page-exists', 'file' => $file ];
1782  }
1783 
1784  if ( strpos( $file->getName(), '.' ) == false ) {
1785  $partname = $file->getName();
1786  $extension = '';
1787  } else {
1788  $n = strrpos( $file->getName(), '.' );
1789  $extension = substr( $file->getName(), $n + 1 );
1790  $partname = substr( $file->getName(), 0, $n );
1791  }
1792  $normalizedExtension = File::normalizeExtension( $extension );
1793 
1794  if ( $normalizedExtension != $extension ) {
1795  // We're not using the normalized form of the extension.
1796  // Normal form is lowercase, using most common of alternate
1797  // extensions (eg 'jpg' rather than 'JPEG').
1798 
1799  // Check for another file using the normalized form...
1800  $nt_lc = Title::makeTitle( NS_FILE, "{$partname}.{$normalizedExtension}" );
1801  $file_lc = wfLocalFile( $nt_lc );
1802 
1803  if ( $file_lc->exists() ) {
1804  return [
1805  'warning' => 'exists-normalized',
1806  'file' => $file,
1807  'normalizedFile' => $file_lc
1808  ];
1809  }
1810  }
1811 
1812  // Check for files with the same name but a different extension
1813  $similarFiles = RepoGroup::singleton()->getLocalRepo()->findFilesByPrefix(
1814  "{$partname}.", 1 );
1815  if ( count( $similarFiles ) ) {
1816  return [
1817  'warning' => 'exists-normalized',
1818  'file' => $file,
1819  'normalizedFile' => $similarFiles[0],
1820  ];
1821  }
1822 
1823  if ( self::isThumbName( $file->getName() ) ) {
1824  # Check for filenames like 50px- or 180px-, these are mostly thumbnails
1825  $nt_thb = Title::newFromText(
1826  substr( $partname, strpos( $partname, '-' ) + 1 ) . '.' . $extension,
1827  NS_FILE
1828  );
1829  $file_thb = wfLocalFile( $nt_thb );
1830  if ( $file_thb->exists() ) {
1831  return [
1832  'warning' => 'thumb',
1833  'file' => $file,
1834  'thumbFile' => $file_thb
1835  ];
1836  } else {
1837  // File does not exist, but we just don't like the name
1838  return [
1839  'warning' => 'thumb-name',
1840  'file' => $file,
1841  'thumbFile' => $file_thb
1842  ];
1843  }
1844  }
1845 
1846  foreach ( self::getFilenamePrefixBlacklist() as $prefix ) {
1847  if ( substr( $partname, 0, strlen( $prefix ) ) == $prefix ) {
1848  return [
1849  'warning' => 'bad-prefix',
1850  'file' => $file,
1851  'prefix' => $prefix
1852  ];
1853  }
1854  }
1855 
1856  return false;
1857  }
1858 
1864  public static function isThumbName( $filename ) {
1865  $n = strrpos( $filename, '.' );
1866  $partname = $n ? substr( $filename, 0, $n ) : $filename;
1867 
1868  return (
1869  substr( $partname, 3, 3 ) == 'px-' ||
1870  substr( $partname, 2, 3 ) == 'px-'
1871  ) &&
1872  preg_match( "/[0-9]{2}/", substr( $partname, 0, 2 ) );
1873  }
1874 
1880  public static function getFilenamePrefixBlacklist() {
1881  $blacklist = [];
1882  $message = wfMessage( 'filename-prefix-blacklist' )->inContentLanguage();
1883  if ( !$message->isDisabled() ) {
1884  $lines = explode( "\n", $message->plain() );
1885  foreach ( $lines as $line ) {
1886  // Remove comment lines
1887  $comment = substr( trim( $line ), 0, 1 );
1888  if ( $comment == '#' || $comment == '' ) {
1889  continue;
1890  }
1891  // Remove additional comments after a prefix
1892  $comment = strpos( $line, '#' );
1893  if ( $comment > 0 ) {
1894  $line = substr( $line, 0, $comment - 1 );
1895  }
1896  $blacklist[] = trim( $line );
1897  }
1898  }
1899 
1900  return $blacklist;
1901  }
1902 
1914  public function getImageInfo( $result ) {
1915  $file = $this->getLocalFile();
1921  if ( $file instanceof UploadStashFile ) {
1923  $info = ApiQueryStashImageInfo::getInfo( $file, array_flip( $imParam ), $result );
1924  } else {
1926  $info = ApiQueryImageInfo::getInfo( $file, array_flip( $imParam ), $result );
1927  }
1928 
1929  return $info;
1930  }
1931 
1936  public function convertVerifyErrorToStatus( $error ) {
1937  $code = $error['status'];
1938  unset( $code['status'] );
1939 
1940  return Status::newFatal( $this->getVerificationErrorCode( $code ), $error );
1941  }
1942 
1950  public static function getMaxUploadSize( $forType = null ) {
1952 
1953  if ( is_array( $wgMaxUploadSize ) ) {
1954  if ( !is_null( $forType ) && isset( $wgMaxUploadSize[$forType] ) ) {
1955  return $wgMaxUploadSize[$forType];
1956  } else {
1957  return $wgMaxUploadSize['*'];
1958  }
1959  } else {
1960  return intval( $wgMaxUploadSize );
1961  }
1962  }
1963 
1971  public static function getMaxPhpUploadSize() {
1972  $phpMaxFileSize = wfShorthandToInteger(
1973  ini_get( 'upload_max_filesize' ) ?: ini_get( 'hhvm.server.upload.upload_max_file_size' ),
1974  PHP_INT_MAX
1975  );
1976  $phpMaxPostSize = wfShorthandToInteger(
1977  ini_get( 'post_max_size' ) ?: ini_get( 'hhvm.server.max_post_size' ),
1978  PHP_INT_MAX
1979  ) ?: PHP_INT_MAX;
1980  return min( $phpMaxFileSize, $phpMaxPostSize );
1981  }
1982 
1992  public static function getSessionStatus( User $user, $statusKey ) {
1993  $key = wfMemcKey( 'uploadstatus', $user->getId() ?: md5( $user->getName() ), $statusKey );
1994 
1995  return ObjectCache::getMainStashInstance()->get( $key );
1996  }
1997 
2008  public static function setSessionStatus( User $user, $statusKey, $value ) {
2009  $key = wfMemcKey( 'uploadstatus', $user->getId() ?: md5( $user->getName() ), $statusKey );
2010 
2012  if ( $value === false ) {
2013  $cache->delete( $key );
2014  } else {
2015  $cache->set( $key, $value, $cache::TTL_DAY );
2016  }
2017  }
2018 }
$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:77
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:1771
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:71
$wgSVGMetadataCutoff
Don't read SVG metadata beyond this point.
$wgDisableUploadScriptChecks
Setting this to true will disable the upload system's checks for HTML/JavaScript. ...
magic word the default is to use $key to get the and $key value or $key value text $key value html to format the value $key
Definition: hooks.txt:2299
wfIsHHVM()
Check if we are running under HHVM.
const SUCCESS
Definition: UploadBase.php:59
static createFromRequest(&$request, $type=null)
Create a form of UploadBase depending on wpSourceType and initializes it.
Definition: UploadBase.php:152
static isAllowed($user)
Returns true if the user can use this upload module or else a string identifying the missing permissi...
Definition: UploadBase.php:122
wfShorthandToInteger($string= '', $default=-1)
Converts shorthand byte notation to integer form.
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:312
static singleton()
Get an instance of this class.
Definition: MimeMagic.php:366
$command
Definition: cdb.php:65
namespace and then decline to actually register it file or subcat img or subcat 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:977
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:64
static $safeXmlEncodings
Definition: UploadBase.php:51
static isValidRequest($request)
Check whether a request if valid for this handler.
Definition: UploadBase.php:196
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:1391
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:577
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:277
const ILLEGAL_FILENAME
Definition: UploadBase.php:63
isEmptyFile()
Return true if the file is empty.
Definition: UploadBase.php:267
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 - Additional characters can be defined in $wgIllegalFileChars (se...
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:2098
verifyMimeType($mime)
Verify the MIME type.
Definition: UploadBase.php:400
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':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:1769
setTempFile($tempPath, $fileSize=null)
Definition: UploadBase.php:242
verifyPartialFile()
A verification routine suitable for partial files.
Definition: UploadBase.php:488
$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:44
static decodeCharReferences($text)
Decode any character references, numeric or named entities, in the text and return a UTF-8 string...
Definition: Sanitizer.php:1461
$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:138
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:548
namespace and then decline to actually register it file or subcat img or subcat 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:891
$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:283
stashFileGetKey()
Stash a file in a temporary directory, returning a key which can be used to find the file again...
Definition: UploadBase.php:955
UploadBase and subclasses are the backend of MediaWiki's file uploads.
Definition: UploadBase.php:38
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:259
static isStoragePath($path)
Check if a given path is a "mwstore://" path.
$wgUploadThumbnailRenderMap
When defined, is an array of thumbnail widths to be rendered at upload time.
MediaWiki exception.
Definition: MWException.php:26
stashSession()
alias for stashFileGetKey, for backwards compatibility
Definition: UploadBase.php:964
postProcessUpload()
Perform extra steps after a successful upload.
Definition: UploadBase.php:753
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 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
static getPropertyNames($filter=[])
Returns all possible parameters to iiprop.
$cache
Definition: mcc.php:33
const IGNORE_USER_RIGHTS
Definition: User.php:81
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:783
performUpload($comment, $pageText, $watch, $user, $tags=[])
Really perform the upload.
Definition: UploadBase.php:718
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.
Definition: UploadBase.php:993
static makeTitleSafe($ns, $title, $fragment= '', $interwiki= '')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:548
cleanupTempFile()
If we've modified the upload file we need to manually remove it on exit to clean up.
Definition: UploadBase.php:972
getSourceType()
Returns the upload type.
Definition: UploadBase.php:209
const FILE_TOO_LARGE
Definition: UploadBase.php:69
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:314
checkWarnings()
Check for non fatal problems with the file.
Definition: UploadBase.php:630
initializeFromRequest(&$request)
Initialize from a WebRequest.
verifyUpload()
Verify whether the upload is sane.
Definition: UploadBase.php:313
const MIN_LENGTH_PARTNAME
Definition: UploadBase.php:62
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:275
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:67
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
static isEnabled()
Returns true if uploads are enabled.
Definition: UploadBase.php:103
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:241
validateName()
Verify that the name is valid and, if necessary, that we can overwrite.
Definition: UploadBase.php:370
const FILETYPE_BADTYPE
Definition: UploadBase.php:66
$wgMaxUploadSize
Max size for uploads, in bytes.
getLocalFile()
Return the local file and initializes if necessary.
Definition: UploadBase.php:915
static singleton($wiki=false)
$wgAntivirusSetup
Configuration for different virus scanners.
const FILETYPE_MISSING
Definition: UploadBase.php:65
namespace and then decline to actually register it file or subcat img or subcat 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:977
static normalizeCss($value)
Normalize CSS into a format we can easily search for hostile input.
Definition: Sanitizer.php:861
$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:592
$lines
Definition: router.php:66
const HOOK_ABORTED
Definition: UploadBase.php:68
stashFile(User $user=null)
If the user does not supply all necessary information in the first upload form submission (either by ...
Definition: UploadBase.php:939
getId()
Get the user's ID.
Definition: User.php:2073
static verifyExtension($mime, $extension)
Checks if the MIME type of the uploaded file matches the file extension.
detectScriptInSvg($filename, $partial)
Job for asynchronous rendering of thumbnails.
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:143
const WINDOWS_NONASCII_FILENAME
Definition: UploadBase.php:70
static getHandler($type)
Get a MediaHandler for a given MIME type from the instance cache.
$wgAllowTitlesInSVG
Disallow <title> element in SVG files.
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:789
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
$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:432
const OK
Definition: UploadBase.php:60
$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:2316
const EMPTY_FILE
Definition: UploadBase.php:61
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:2316
static capitalize($text, $ns=NS_MAIN)
Capitalize a text string for a title if it belongs to a namespace that capitalizes.
Definition: Title.php:3302
static & makeTitle($ns, $title, $fragment= '', $interwiki= '')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:524
static newGood($value=null)
Factory function for good results.
Definition: Status.php:101
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:1771
getRealPath($srcPath)
Definition: UploadBase.php:291
initializePathInfo($name, $tempPath, $fileSize, $removeTempFile=false)
Initialize the path information.
Definition: UploadBase.php:221
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