MediaWiki REL1_32
UploadBase.php
Go to the documentation of this file.
1<?php
24
39abstract class UploadBase {
41 protected $mTempPath;
43 protected $tempFileObj;
44
46 protected $mTitle = false, $mTitleError = 0;
51
52 protected static $safeXmlEncodings = [
53 'UTF-8',
54 'ISO-8859-1',
55 'ISO-8859-2',
56 'UTF-16',
57 'UTF-32',
58 'WINDOWS-1250',
59 'WINDOWS-1251',
60 'WINDOWS-1252',
61 'WINDOWS-1253',
62 'WINDOWS-1254',
63 'WINDOWS-1255',
64 'WINDOWS-1256',
65 'WINDOWS-1257',
66 'WINDOWS-1258',
67 ];
68
69 const SUCCESS = 0;
70 const OK = 0;
71 const EMPTY_FILE = 3;
74 const OVERWRITE_EXISTING_FILE = 7; # Not used anymore; handled by verifyTitlePermissions()
78 const HOOK_ABORTED = 11;
79 const FILE_TOO_LARGE = 12;
82
88 $code_to_status = [
89 self::EMPTY_FILE => 'empty-file',
90 self::FILE_TOO_LARGE => 'file-too-large',
91 self::FILETYPE_MISSING => 'filetype-missing',
92 self::FILETYPE_BADTYPE => 'filetype-banned',
93 self::MIN_LENGTH_PARTNAME => 'filename-tooshort',
94 self::ILLEGAL_FILENAME => 'illegal-filename',
95 self::OVERWRITE_EXISTING_FILE => 'overwrite',
96 self::VERIFICATION_ERROR => 'verification-error',
97 self::HOOK_ABORTED => 'hookaborted',
98 self::WINDOWS_NONASCII_FILENAME => 'windows-nonascii-filename',
99 self::FILENAME_TOO_LONG => 'filename-toolong',
100 ];
101 if ( isset( $code_to_status[$error] ) ) {
102 return $code_to_status[$error];
103 }
104
105 return 'unknown-error';
106 }
107
113 public static function isEnabled() {
114 global $wgEnableUploads;
115
116 if ( !$wgEnableUploads ) {
117 return false;
118 }
119
120 # Check php's file_uploads setting
121 return wfIsHHVM() || wfIniGetBool( 'file_uploads' );
122 }
123
132 public static function isAllowed( $user ) {
133 foreach ( [ 'upload', 'edit' ] as $permission ) {
134 if ( !$user->isAllowed( $permission ) ) {
135 return $permission;
136 }
137 }
138
139 return true;
140 }
141
148 public static function isThrottled( $user ) {
149 return $user->pingLimiter( 'upload' );
150 }
151
152 // Upload handlers. Should probably just be a global.
153 private static $uploadHandlers = [ 'Stash', 'File', 'Url' ];
154
162 public static function createFromRequest( &$request, $type = null ) {
163 $type = $type ?: $request->getVal( 'wpSourceType', 'File' );
164
165 if ( !$type ) {
166 return null;
167 }
168
169 // Get the upload class
170 $type = ucfirst( $type );
171
172 // Give hooks the chance to handle this request
173 $className = null;
174 Hooks::run( 'UploadCreateFromRequest', [ $type, &$className ] );
175 if ( is_null( $className ) ) {
176 $className = 'UploadFrom' . $type;
177 wfDebug( __METHOD__ . ": class name: $className\n" );
178 if ( !in_array( $type, self::$uploadHandlers ) ) {
179 return null;
180 }
181 }
182
183 // Check whether this upload class is enabled
184 if ( !call_user_func( [ $className, 'isEnabled' ] ) ) {
185 return null;
186 }
187
188 // Check whether the request is valid
189 if ( !call_user_func( [ $className, 'isValidRequest' ], $request ) ) {
190 return null;
191 }
192
194 $handler = new $className;
195
196 $handler->initializeFromRequest( $request );
197
198 return $handler;
199 }
200
206 public static function isValidRequest( $request ) {
207 return false;
208 }
209
210 public function __construct() {
211 }
212
219 public function getSourceType() {
220 return null;
221 }
222
231 public function initializePathInfo( $name, $tempPath, $fileSize, $removeTempFile = false ) {
232 $this->mDesiredDestName = $name;
233 if ( FileBackend::isStoragePath( $tempPath ) ) {
234 throw new MWException( __METHOD__ . " given storage path `$tempPath`." );
235 }
236
237 $this->setTempFile( $tempPath, $fileSize );
238 $this->mRemoveTempFile = $removeTempFile;
239 }
240
246 abstract public function initializeFromRequest( &$request );
247
252 protected function setTempFile( $tempPath, $fileSize = null ) {
253 $this->mTempPath = $tempPath;
254 $this->mFileSize = $fileSize ?: null;
255 if ( strlen( $this->mTempPath ) && file_exists( $this->mTempPath ) ) {
256 $this->tempFileObj = new TempFSFile( $this->mTempPath );
257 if ( !$fileSize ) {
258 $this->mFileSize = filesize( $this->mTempPath );
259 }
260 } else {
261 $this->tempFileObj = null;
262 }
263 }
264
269 public function fetchFile() {
270 return Status::newGood();
271 }
272
277 public function isEmptyFile() {
278 return empty( $this->mFileSize );
279 }
280
285 public function getFileSize() {
286 return $this->mFileSize;
287 }
288
293 public function getTempFileSha1Base36() {
294 return FSFile::getSha1Base36FromPath( $this->mTempPath );
295 }
296
301 public function getRealPath( $srcPath ) {
302 $repo = RepoGroup::singleton()->getLocalRepo();
303 if ( $repo->isVirtualUrl( $srcPath ) ) {
307 $tmpFile = $repo->getLocalCopy( $srcPath );
308 if ( $tmpFile ) {
309 $tmpFile->bind( $this ); // keep alive with $this
310 }
311 $path = $tmpFile ? $tmpFile->getPath() : false;
312 } else {
313 $path = $srcPath;
314 }
315
316 return $path;
317 }
318
323 public function verifyUpload() {
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 ) {
410 global $wgVerifyMimeType;
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 = MediaWiki\MediaWikiServices::getInstance()->getMimeAnalyzer();
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 $mwProps = new MWFileProps( MediaWiki\MediaWikiServices::getInstance()->getMimeAnalyzer() );
450 $this->mFileProps = $mwProps->getPropsFromPath( $this->mTempPath, $this->mFinalExtension );
451 $mime = $this->mFileProps['mime'];
452
453 if ( $wgVerifyMimeType ) {
454 # XXX: Missing extension will be caught by validateName() via getTitle()
455 if ( $this->mFinalExtension != '' && !$this->verifyExtension( $mime, $this->mFinalExtension ) ) {
456 return [ 'filetype-mime-mismatch', $this->mFinalExtension, $mime ];
457 }
458 }
459
460 # check for htmlish code and javascript
462 if ( $this->mFinalExtension == 'svg' || $mime == 'image/svg+xml' ) {
463 $svgStatus = $this->detectScriptInSvg( $this->mTempPath, false );
464 if ( $svgStatus !== false ) {
465 return $svgStatus;
466 }
467 }
468 }
469
471 if ( $handler ) {
472 $handlerStatus = $handler->verifyUpload( $this->mTempPath );
473 if ( !$handlerStatus->isOK() ) {
474 $errors = $handlerStatus->getErrorsArray();
475
476 return reset( $errors );
477 }
478 }
479
480 $error = true;
481 Hooks::run( 'UploadVerifyFile', [ $this, $mime, &$error ] );
482 if ( $error !== true ) {
483 if ( !is_array( $error ) ) {
484 $error = [ $error ];
485 }
486 return $error;
487 }
488
489 wfDebug( __METHOD__ . ": all clear; passing.\n" );
490
491 return true;
492 }
493
502 protected function verifyPartialFile() {
504
505 # getTitle() sets some internal parameters like $this->mFinalExtension
506 $this->getTitle();
507
508 $mwProps = new MWFileProps( MediaWiki\MediaWikiServices::getInstance()->getMimeAnalyzer() );
509 $this->mFileProps = $mwProps->getPropsFromPath( $this->mTempPath, $this->mFinalExtension );
510
511 # check MIME type, if desired
512 $mime = $this->mFileProps['file-mime'];
513 $status = $this->verifyMimeType( $mime );
514 if ( $status !== true ) {
515 return $status;
516 }
517
518 # check for htmlish code and javascript
520 if ( self::detectScript( $this->mTempPath, $mime, $this->mFinalExtension ) ) {
521 return [ 'uploadscripted' ];
522 }
523 if ( $this->mFinalExtension == 'svg' || $mime == 'image/svg+xml' ) {
524 $svgStatus = $this->detectScriptInSvg( $this->mTempPath, true );
525 if ( $svgStatus !== false ) {
526 return $svgStatus;
527 }
528 }
529 }
530
531 # Check for Java applets, which if uploaded can bypass cross-site
532 # restrictions.
533 if ( !$wgAllowJavaUploads ) {
534 $this->mJavaDetected = false;
535 $zipStatus = ZipDirectoryReader::read( $this->mTempPath,
536 [ $this, 'zipEntryCallback' ] );
537 if ( !$zipStatus->isOK() ) {
538 $errors = $zipStatus->getErrorsArray();
539 $error = reset( $errors );
540 if ( $error[0] !== 'zip-wrong-format' ) {
541 return $error;
542 }
543 }
544 if ( $this->mJavaDetected ) {
545 return [ 'uploadjava' ];
546 }
547 }
548
549 # Scan the uploaded file for viruses
550 $virus = $this->detectVirus( $this->mTempPath );
551 if ( $virus ) {
552 return [ 'uploadvirus', $virus ];
553 }
554
555 return true;
556 }
557
563 public function zipEntryCallback( $entry ) {
564 $names = [ $entry['name'] ];
565
566 // If there is a null character, cut off the name at it, because JDK's
567 // ZIP_GetEntry() uses strcmp() if the name hashes match. If a file name
568 // were constructed which had ".class\0" followed by a string chosen to
569 // make the hash collide with the truncated name, that file could be
570 // returned in response to a request for the .class file.
571 $nullPos = strpos( $entry['name'], "\000" );
572 if ( $nullPos !== false ) {
573 $names[] = substr( $entry['name'], 0, $nullPos );
574 }
575
576 // If there is a trailing slash in the file name, we have to strip it,
577 // because that's what ZIP_GetEntry() does.
578 if ( preg_grep( '!\.class/?$!', $names ) ) {
579 $this->mJavaDetected = true;
580 }
581 }
582
592 public function verifyPermissions( $user ) {
593 return $this->verifyTitlePermissions( $user );
594 }
595
607 public function verifyTitlePermissions( $user ) {
612 $nt = $this->getTitle();
613 if ( is_null( $nt ) ) {
614 return true;
615 }
616 $permErrors = $nt->getUserPermissionsErrors( 'edit', $user );
617 $permErrorsUpload = $nt->getUserPermissionsErrors( 'upload', $user );
618 if ( !$nt->exists() ) {
619 $permErrorsCreate = $nt->getUserPermissionsErrors( 'create', $user );
620 } else {
621 $permErrorsCreate = [];
622 }
623 if ( $permErrors || $permErrorsUpload || $permErrorsCreate ) {
624 $permErrors = array_merge( $permErrors, wfArrayDiff2( $permErrorsUpload, $permErrors ) );
625 $permErrors = array_merge( $permErrors, wfArrayDiff2( $permErrorsCreate, $permErrors ) );
626
627 return $permErrors;
628 }
629
630 $overwriteError = $this->checkOverwrite( $user );
631 if ( $overwriteError !== true ) {
632 return [ $overwriteError ];
633 }
634
635 return true;
636 }
637
645 public function checkWarnings() {
646 $warnings = [];
647
648 $localFile = $this->getLocalFile();
649 $localFile->load( File::READ_LATEST );
650 $filename = $localFile->getName();
651 $hash = $this->getTempFileSha1Base36();
652
653 $badFileName = $this->checkBadFileName( $filename, $this->mDesiredDestName );
654 if ( $badFileName !== null ) {
655 $warnings['badfilename'] = $badFileName;
656 }
657
658 $unwantedFileExtensionDetails = $this->checkUnwantedFileExtensions( $this->mFinalExtension );
659 if ( $unwantedFileExtensionDetails !== null ) {
660 $warnings['filetype-unwanted-type'] = $unwantedFileExtensionDetails;
661 }
662
663 $fileSizeWarnings = $this->checkFileSize( $this->mFileSize );
664 if ( $fileSizeWarnings ) {
665 $warnings = array_merge( $warnings, $fileSizeWarnings );
666 }
667
668 $localFileExistsWarnings = $this->checkLocalFileExists( $localFile, $hash );
669 if ( $localFileExistsWarnings ) {
670 $warnings = array_merge( $warnings, $localFileExistsWarnings );
671 }
672
673 if ( $this->checkLocalFileWasDeleted( $localFile ) ) {
674 $warnings['was-deleted'] = $filename;
675 }
676
677 // If a file with the same name exists locally then the local file has already been tested
678 // for duplication of content
679 $ignoreLocalDupes = isset( $warnings[ 'exists '] );
680 $dupes = $this->checkAgainstExistingDupes( $hash, $ignoreLocalDupes );
681 if ( $dupes ) {
682 $warnings['duplicate'] = $dupes;
683 }
684
685 $archivedDupes = $this->checkAgainstArchiveDupes( $hash );
686 if ( $archivedDupes !== null ) {
687 $warnings['duplicate-archive'] = $archivedDupes;
688 }
689
690 return $warnings;
691 }
692
702 private function checkBadFileName( $filename, $desiredFileName ) {
703 $comparableName = str_replace( ' ', '_', $desiredFileName );
704 $comparableName = Title::capitalize( $comparableName, NS_FILE );
705
706 if ( $desiredFileName != $filename && $comparableName != $filename ) {
707 return $filename;
708 }
709
710 return null;
711 }
712
721 private function checkUnwantedFileExtensions( $fileExtension ) {
723
725 $extensions = array_unique( $wgFileExtensions );
726 if ( !$this->checkFileExtension( $fileExtension, $extensions ) ) {
727 return [
728 $fileExtension,
729 $wgLang->commaList( $extensions ),
730 count( $extensions )
731 ];
732 }
733 }
734
735 return null;
736 }
737
743 private function checkFileSize( $fileSize ) {
745
746 $warnings = [];
747
748 if ( $wgUploadSizeWarning && ( $fileSize > $wgUploadSizeWarning ) ) {
749 $warnings['large-file'] = [ $wgUploadSizeWarning, $fileSize ];
750 }
751
752 if ( $fileSize == 0 ) {
753 $warnings['empty-file'] = true;
754 }
755
756 return $warnings;
757 }
758
765 private function checkLocalFileExists( LocalFile $localFile, $hash ) {
766 $warnings = [];
767
768 $exists = self::getExistsWarning( $localFile );
769 if ( $exists !== false ) {
770 $warnings['exists'] = $exists;
771
772 // check if file is an exact duplicate of current file version
773 if ( $hash === $localFile->getSha1() ) {
774 $warnings['no-change'] = $localFile;
775 }
776
777 // check if file is an exact duplicate of older versions of this file
778 $history = $localFile->getHistory();
779 foreach ( $history as $oldFile ) {
780 if ( $hash === $oldFile->getSha1() ) {
781 $warnings['duplicate-version'][] = $oldFile;
782 }
783 }
784 }
785
786 return $warnings;
787 }
788
789 private function checkLocalFileWasDeleted( LocalFile $localFile ) {
790 return $localFile->wasDeleted() && !$localFile->exists();
791 }
792
799 private function checkAgainstExistingDupes( $hash, $ignoreLocalDupes ) {
800 $dupes = RepoGroup::singleton()->findBySha1( $hash );
801 $title = $this->getTitle();
802 foreach ( $dupes as $key => $dupe ) {
803 if (
804 ( $dupe instanceof LocalFile ) &&
805 $ignoreLocalDupes &&
806 $title->equals( $dupe->getTitle() )
807 ) {
808 unset( $dupes[$key] );
809 }
810 }
811
812 return $dupes;
813 }
814
821 private function checkAgainstArchiveDupes( $hash ) {
822 $archivedFile = new ArchivedFile( null, 0, '', $hash );
823 if ( $archivedFile->getID() > 0 ) {
824 if ( $archivedFile->userCan( File::DELETED_FILE ) ) {
825 return $archivedFile->getName();
826 } else {
827 return '';
828 }
829 }
830
831 return null;
832 }
833
847 public function performUpload( $comment, $pageText, $watch, $user, $tags = [] ) {
848 $this->getLocalFile()->load( File::READ_LATEST );
849 $props = $this->mFileProps;
850
851 $error = null;
852 Hooks::run( 'UploadVerifyUpload', [ $this, $user, $props, $comment, $pageText, &$error ] );
853 if ( $error ) {
854 if ( !is_array( $error ) ) {
855 $error = [ $error ];
856 }
857 return Status::newFatal( ...$error );
858 }
859
860 $status = $this->getLocalFile()->upload(
861 $this->mTempPath,
862 $comment,
863 $pageText,
865 $props,
866 false,
867 $user,
868 $tags
869 );
870
871 if ( $status->isGood() ) {
872 if ( $watch ) {
874 $this->getLocalFile()->getTitle(),
875 $user,
877 );
878 }
879 // Avoid PHP 7.1 warning of passing $this by reference
880 $uploadBase = $this;
881 Hooks::run( 'UploadComplete', [ &$uploadBase ] );
882
883 $this->postProcessUpload();
884 }
885
886 return $status;
887 }
888
894 public function postProcessUpload() {
895 }
896
903 public function getTitle() {
904 if ( $this->mTitle !== false ) {
905 return $this->mTitle;
906 }
907 if ( !is_string( $this->mDesiredDestName ) ) {
908 $this->mTitleError = self::ILLEGAL_FILENAME;
909 $this->mTitle = null;
910
911 return $this->mTitle;
912 }
913 /* Assume that if a user specified File:Something.jpg, this is an error
914 * and that the namespace prefix needs to be stripped of.
915 */
916 $title = Title::newFromText( $this->mDesiredDestName );
917 if ( $title && $title->getNamespace() == NS_FILE ) {
918 $this->mFilteredName = $title->getDBkey();
919 } else {
920 $this->mFilteredName = $this->mDesiredDestName;
921 }
922
923 # oi_archive_name is max 255 bytes, which include a timestamp and an
924 # exclamation mark, so restrict file name to 240 bytes.
925 if ( strlen( $this->mFilteredName ) > 240 ) {
926 $this->mTitleError = self::FILENAME_TOO_LONG;
927 $this->mTitle = null;
928
929 return $this->mTitle;
930 }
931
937 $this->mFilteredName = wfStripIllegalFilenameChars( $this->mFilteredName );
938 /* Normalize to title form before we do any further processing */
939 $nt = Title::makeTitleSafe( NS_FILE, $this->mFilteredName );
940 if ( is_null( $nt ) ) {
941 $this->mTitleError = self::ILLEGAL_FILENAME;
942 $this->mTitle = null;
943
944 return $this->mTitle;
945 }
946 $this->mFilteredName = $nt->getDBkey();
947
952 list( $partname, $ext ) = $this->splitExtensions( $this->mFilteredName );
953
954 if ( count( $ext ) ) {
955 $this->mFinalExtension = trim( $ext[count( $ext ) - 1] );
956 } else {
957 $this->mFinalExtension = '';
958
959 # No extension, try guessing one
960 $magic = MediaWiki\MediaWikiServices::getInstance()->getMimeAnalyzer();
961 $mime = $magic->guessMimeType( $this->mTempPath );
962 if ( $mime !== 'unknown/unknown' ) {
963 # Get a space separated list of extensions
964 $extList = $magic->getExtensionsForType( $mime );
965 if ( $extList ) {
966 # Set the extension to the canonical extension
967 $this->mFinalExtension = strtok( $extList, ' ' );
968
969 # Fix up the other variables
970 $this->mFilteredName .= ".{$this->mFinalExtension}";
971 $nt = Title::makeTitleSafe( NS_FILE, $this->mFilteredName );
973 }
974 }
975 }
976
977 /* Don't allow users to override the blacklist (check file extension) */
980
981 $blackListedExtensions = $this->checkFileExtensionList( $ext, $wgFileBlacklist );
982
983 if ( $this->mFinalExtension == '' ) {
984 $this->mTitleError = self::FILETYPE_MISSING;
985 $this->mTitle = null;
986
987 return $this->mTitle;
988 } elseif ( $blackListedExtensions ||
990 !$this->checkFileExtension( $this->mFinalExtension, $wgFileExtensions ) )
991 ) {
992 $this->mBlackListedExtensions = $blackListedExtensions;
993 $this->mTitleError = self::FILETYPE_BADTYPE;
994 $this->mTitle = null;
995
996 return $this->mTitle;
997 }
998
999 // Windows may be broken with special characters, see T3780
1000 if ( !preg_match( '/^[\x0-\x7f]*$/', $nt->getText() )
1001 && !RepoGroup::singleton()->getLocalRepo()->backendSupportsUnicodePaths()
1002 ) {
1003 $this->mTitleError = self::WINDOWS_NONASCII_FILENAME;
1004 $this->mTitle = null;
1005
1006 return $this->mTitle;
1007 }
1008
1009 # If there was more than one "extension", reassemble the base
1010 # filename to prevent bogus complaints about length
1011 if ( count( $ext ) > 1 ) {
1012 $iterations = count( $ext ) - 1;
1013 for ( $i = 0; $i < $iterations; $i++ ) {
1014 $partname .= '.' . $ext[$i];
1015 }
1016 }
1017
1018 if ( strlen( $partname ) < 1 ) {
1019 $this->mTitleError = self::MIN_LENGTH_PARTNAME;
1020 $this->mTitle = null;
1021
1022 return $this->mTitle;
1023 }
1024
1025 $this->mTitle = $nt;
1026
1027 return $this->mTitle;
1028 }
1029
1035 public function getLocalFile() {
1036 if ( is_null( $this->mLocalFile ) ) {
1037 $nt = $this->getTitle();
1038 $this->mLocalFile = is_null( $nt ) ? null : wfLocalFile( $nt );
1039 }
1040
1041 return $this->mLocalFile;
1042 }
1043
1047 public function getStashFile() {
1048 return $this->mStashFile;
1049 }
1050
1062 public function tryStashFile( User $user, $isPartial = false ) {
1063 if ( !$isPartial ) {
1064 $error = $this->runUploadStashFileHook( $user );
1065 if ( $error ) {
1066 return Status::newFatal( ...$error );
1067 }
1068 }
1069 try {
1070 $file = $this->doStashFile( $user );
1071 return Status::newGood( $file );
1072 } catch ( UploadStashException $e ) {
1073 return Status::newFatal( 'uploadstash-exception', get_class( $e ), $e->getMessage() );
1074 }
1075 }
1076
1081 protected function runUploadStashFileHook( User $user ) {
1082 $props = $this->mFileProps;
1083 $error = null;
1084 Hooks::run( 'UploadStashFile', [ $this, $user, $props, &$error ] );
1085 if ( $error ) {
1086 if ( !is_array( $error ) ) {
1087 $error = [ $error ];
1088 }
1089 }
1090 return $error;
1091 }
1092
1112 public function stashFile( User $user = null ) {
1113 return $this->doStashFile( $user );
1114 }
1115
1122 protected function doStashFile( User $user = null ) {
1123 $stash = RepoGroup::singleton()->getLocalRepo()->getUploadStash( $user );
1124 $file = $stash->stashFile( $this->mTempPath, $this->getSourceType() );
1125 $this->mStashFile = $file;
1126
1127 return $file;
1128 }
1129
1137 public function stashFileGetKey() {
1138 wfDeprecated( __METHOD__, '1.28' );
1139 return $this->doStashFile()->getFileKey();
1140 }
1141
1148 public function stashSession() {
1149 wfDeprecated( __METHOD__, '1.28' );
1150 return $this->doStashFile()->getFileKey();
1151 }
1152
1157 public function cleanupTempFile() {
1158 if ( $this->mRemoveTempFile && $this->tempFileObj ) {
1159 // Delete when all relevant TempFSFile handles go out of scope
1160 wfDebug( __METHOD__ . ": Marked temporary file '{$this->mTempPath}' for removal\n" );
1161 $this->tempFileObj->autocollect();
1162 }
1163 }
1164
1165 public function getTempPath() {
1166 return $this->mTempPath;
1167 }
1168
1178 public static function splitExtensions( $filename ) {
1179 $bits = explode( '.', $filename );
1180 $basename = array_shift( $bits );
1181
1182 return [ $basename, $bits ];
1183 }
1184
1193 public static function checkFileExtension( $ext, $list ) {
1194 return in_array( strtolower( $ext ), $list );
1195 }
1196
1205 public static function checkFileExtensionList( $ext, $list ) {
1206 return array_intersect( array_map( 'strtolower', $ext ), $list );
1207 }
1208
1216 public static function verifyExtension( $mime, $extension ) {
1217 $magic = MediaWiki\MediaWikiServices::getInstance()->getMimeAnalyzer();
1218
1219 if ( !$mime || $mime == 'unknown' || $mime == 'unknown/unknown' ) {
1220 if ( !$magic->isRecognizableExtension( $extension ) ) {
1221 wfDebug( __METHOD__ . ": passing file with unknown detected mime type; " .
1222 "unrecognized extension '$extension', can't verify\n" );
1223
1224 return true;
1225 } else {
1226 wfDebug( __METHOD__ . ": rejecting file with unknown detected mime type; " .
1227 "recognized extension '$extension', so probably invalid file\n" );
1228
1229 return false;
1230 }
1231 }
1232
1233 $match = $magic->isMatchingExtension( $extension, $mime );
1234
1235 if ( $match === null ) {
1236 if ( $magic->getTypesForExtension( $extension ) !== null ) {
1237 wfDebug( __METHOD__ . ": No extension known for $mime, but we know a mime for $extension\n" );
1238
1239 return false;
1240 } else {
1241 wfDebug( __METHOD__ . ": no file extension known for mime type $mime, passing file\n" );
1242
1243 return true;
1244 }
1245 } elseif ( $match === true ) {
1246 wfDebug( __METHOD__ . ": mime type $mime matches extension $extension, passing file\n" );
1247
1249 return true;
1250 } else {
1251 wfDebug( __METHOD__
1252 . ": mime type $mime mismatches file extension $extension, rejecting file\n" );
1253
1254 return false;
1255 }
1256 }
1257
1269 public static function detectScript( $file, $mime, $extension ) {
1270 global $wgAllowTitlesInSVG;
1271
1272 # ugly hack: for text files, always look at the entire file.
1273 # For binary field, just check the first K.
1274
1275 if ( strpos( $mime, 'text/' ) === 0 ) {
1276 $chunk = file_get_contents( $file );
1277 } else {
1278 $fp = fopen( $file, 'rb' );
1279 $chunk = fread( $fp, 1024 );
1280 fclose( $fp );
1281 }
1282
1283 $chunk = strtolower( $chunk );
1284
1285 if ( !$chunk ) {
1286 return false;
1287 }
1288
1289 # decode from UTF-16 if needed (could be used for obfuscation).
1290 if ( substr( $chunk, 0, 2 ) == "\xfe\xff" ) {
1291 $enc = 'UTF-16BE';
1292 } elseif ( substr( $chunk, 0, 2 ) == "\xff\xfe" ) {
1293 $enc = 'UTF-16LE';
1294 } else {
1295 $enc = null;
1296 }
1297
1298 if ( $enc ) {
1299 $chunk = iconv( $enc, "ASCII//IGNORE", $chunk );
1300 }
1301
1302 $chunk = trim( $chunk );
1303
1305 wfDebug( __METHOD__ . ": checking for embedded scripts and HTML stuff\n" );
1306
1307 # check for HTML doctype
1308 if ( preg_match( "/<!DOCTYPE *X?HTML/i", $chunk ) ) {
1309 return true;
1310 }
1311
1312 // Some browsers will interpret obscure xml encodings as UTF-8, while
1313 // PHP/expat will interpret the given encoding in the xml declaration (T49304)
1314 if ( $extension == 'svg' || strpos( $mime, 'image/svg' ) === 0 ) {
1315 if ( self::checkXMLEncodingMissmatch( $file ) ) {
1316 return true;
1317 }
1318 }
1319
1335 $tags = [
1336 '<a href',
1337 '<body',
1338 '<head',
1339 '<html', # also in safari
1340 '<img',
1341 '<pre',
1342 '<script', # also in safari
1343 '<table'
1344 ];
1345
1346 if ( !$wgAllowTitlesInSVG && $extension !== 'svg' && $mime !== 'image/svg' ) {
1347 $tags[] = '<title';
1348 }
1349
1350 foreach ( $tags as $tag ) {
1351 if ( false !== strpos( $chunk, $tag ) ) {
1352 wfDebug( __METHOD__ . ": found something that may make it be mistaken for html: $tag\n" );
1353
1354 return true;
1355 }
1356 }
1357
1358 /*
1359 * look for JavaScript
1360 */
1361
1362 # resolve entity-refs to look at attributes. may be harsh on big files... cache result?
1363 $chunk = Sanitizer::decodeCharReferences( $chunk );
1364
1365 # look for script-types
1366 if ( preg_match( '!type\s*=\s*[\'"]?\s*(?:\w*/)?(?:ecma|java)!sim', $chunk ) ) {
1367 wfDebug( __METHOD__ . ": found script types\n" );
1368
1369 return true;
1370 }
1371
1372 # look for html-style script-urls
1373 if ( preg_match( '!(?:href|src|data)\s*=\s*[\'"]?\s*(?:ecma|java)script:!sim', $chunk ) ) {
1374 wfDebug( __METHOD__ . ": found html-style script urls\n" );
1375
1376 return true;
1377 }
1378
1379 # look for css-style script-urls
1380 if ( preg_match( '!url\s*\‍(\s*[\'"]?\s*(?:ecma|java)script:!sim', $chunk ) ) {
1381 wfDebug( __METHOD__ . ": found css-style script urls\n" );
1382
1383 return true;
1384 }
1385
1386 wfDebug( __METHOD__ . ": no scripts found\n" );
1387
1388 return false;
1389 }
1390
1398 public static function checkXMLEncodingMissmatch( $file ) {
1399 global $wgSVGMetadataCutoff;
1400 $contents = file_get_contents( $file, false, null, 0, $wgSVGMetadataCutoff );
1401 $encodingRegex = '!encoding[ \t\n\r]*=[ \t\n\r]*[\'"](.*?)[\'"]!si';
1402
1403 if ( preg_match( "!<\?xml\b(.*?)\?>!si", $contents, $matches ) ) {
1404 if ( preg_match( $encodingRegex, $matches[1], $encMatch )
1405 && !in_array( strtoupper( $encMatch[1] ), self::$safeXmlEncodings )
1406 ) {
1407 wfDebug( __METHOD__ . ": Found unsafe XML encoding '{$encMatch[1]}'\n" );
1408
1409 return true;
1410 }
1411 } elseif ( preg_match( "!<\?xml\b!si", $contents ) ) {
1412 // Start of XML declaration without an end in the first $wgSVGMetadataCutoff
1413 // bytes. There shouldn't be a legitimate reason for this to happen.
1414 wfDebug( __METHOD__ . ": Unmatched XML declaration start\n" );
1415
1416 return true;
1417 } elseif ( substr( $contents, 0, 4 ) == "\x4C\x6F\xA7\x94" ) {
1418 // EBCDIC encoded XML
1419 wfDebug( __METHOD__ . ": EBCDIC Encoded XML\n" );
1420
1421 return true;
1422 }
1423
1424 // It's possible the file is encoded with multi-byte encoding, so re-encode attempt to
1425 // detect the encoding in case is specifies an encoding not whitelisted in self::$safeXmlEncodings
1426 $attemptEncodings = [ 'UTF-16', 'UTF-16BE', 'UTF-32', 'UTF-32BE' ];
1427 foreach ( $attemptEncodings as $encoding ) {
1428 Wikimedia\suppressWarnings();
1429 $str = iconv( $encoding, 'UTF-8', $contents );
1430 Wikimedia\restoreWarnings();
1431 if ( $str != '' && preg_match( "!<\?xml\b(.*?)\?>!si", $str, $matches ) ) {
1432 if ( preg_match( $encodingRegex, $matches[1], $encMatch )
1433 && !in_array( strtoupper( $encMatch[1] ), self::$safeXmlEncodings )
1434 ) {
1435 wfDebug( __METHOD__ . ": Found unsafe XML encoding '{$encMatch[1]}'\n" );
1436
1437 return true;
1438 }
1439 } elseif ( $str != '' && preg_match( "!<\?xml\b!si", $str ) ) {
1440 // Start of XML declaration without an end in the first $wgSVGMetadataCutoff
1441 // bytes. There shouldn't be a legitimate reason for this to happen.
1442 wfDebug( __METHOD__ . ": Unmatched XML declaration start\n" );
1443
1444 return true;
1445 }
1446 }
1447
1448 return false;
1449 }
1450
1456 protected function detectScriptInSvg( $filename, $partial ) {
1457 $this->mSVGNSError = false;
1458 $check = new XmlTypeCheck(
1459 $filename,
1460 [ $this, 'checkSvgScriptCallback' ],
1461 true,
1462 [
1463 'processing_instruction_handler' => 'UploadBase::checkSvgPICallback',
1464 'external_dtd_handler' => 'UploadBase::checkSvgExternalDTD',
1465 ]
1466 );
1467 if ( $check->wellFormed !== true ) {
1468 // Invalid xml (T60553)
1469 // But only when non-partial (T67724)
1470 return $partial ? false : [ 'uploadinvalidxml' ];
1471 } elseif ( $check->filterMatch ) {
1472 if ( $this->mSVGNSError ) {
1473 return [ 'uploadscriptednamespace', $this->mSVGNSError ];
1474 }
1475
1476 return $check->filterMatchType;
1477 }
1478
1479 return false;
1480 }
1481
1488 public static function checkSvgPICallback( $target, $data ) {
1489 // Don't allow external stylesheets (T59550)
1490 if ( preg_match( '/xml-stylesheet/i', $target ) ) {
1491 return [ 'upload-scripted-pi-callback' ];
1492 }
1493
1494 return false;
1495 }
1496
1508 public static function checkSvgExternalDTD( $type, $publicId, $systemId ) {
1509 // This doesn't include the XHTML+MathML+SVG doctype since we don't
1510 // allow XHTML anyways.
1511 $allowedDTDs = [
1512 'http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd',
1513 'http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd',
1514 'http://www.w3.org/Graphics/SVG/1.1/DTD/svg11-basic.dtd',
1515 'http://www.w3.org/Graphics/SVG/1.1/DTD/svg11-tiny.dtd',
1516 // https://phabricator.wikimedia.org/T168856
1517 'http://www.w3.org/TR/2001/PR-SVG-20010719/DTD/svg10.dtd',
1518 ];
1519 if ( $type !== 'PUBLIC'
1520 || !in_array( $systemId, $allowedDTDs )
1521 || strpos( $publicId, "-//W3C//" ) !== 0
1522 ) {
1523 return [ 'upload-scripted-dtd' ];
1524 }
1525 return false;
1526 }
1527
1535 public function checkSvgScriptCallback( $element, $attribs, $data = null ) {
1536 list( $namespace, $strippedElement ) = $this->splitXmlNamespace( $element );
1537
1538 // We specifically don't include:
1539 // http://www.w3.org/1999/xhtml (T62771)
1540 static $validNamespaces = [
1541 '',
1542 'adobe:ns:meta/',
1543 'http://creativecommons.org/ns#',
1544 'http://inkscape.sourceforge.net/dtd/sodipodi-0.dtd',
1545 'http://ns.adobe.com/adobeillustrator/10.0/',
1546 'http://ns.adobe.com/adobesvgviewerextensions/3.0/',
1547 'http://ns.adobe.com/extensibility/1.0/',
1548 'http://ns.adobe.com/flows/1.0/',
1549 'http://ns.adobe.com/illustrator/1.0/',
1550 'http://ns.adobe.com/imagereplacement/1.0/',
1551 'http://ns.adobe.com/pdf/1.3/',
1552 'http://ns.adobe.com/photoshop/1.0/',
1553 'http://ns.adobe.com/saveforweb/1.0/',
1554 'http://ns.adobe.com/variables/1.0/',
1555 'http://ns.adobe.com/xap/1.0/',
1556 'http://ns.adobe.com/xap/1.0/g/',
1557 'http://ns.adobe.com/xap/1.0/g/img/',
1558 'http://ns.adobe.com/xap/1.0/mm/',
1559 'http://ns.adobe.com/xap/1.0/rights/',
1560 'http://ns.adobe.com/xap/1.0/stype/dimensions#',
1561 'http://ns.adobe.com/xap/1.0/stype/font#',
1562 'http://ns.adobe.com/xap/1.0/stype/manifestitem#',
1563 'http://ns.adobe.com/xap/1.0/stype/resourceevent#',
1564 'http://ns.adobe.com/xap/1.0/stype/resourceref#',
1565 'http://ns.adobe.com/xap/1.0/t/pg/',
1566 'http://purl.org/dc/elements/1.1/',
1567 'http://purl.org/dc/elements/1.1',
1568 'http://schemas.microsoft.com/visio/2003/svgextensions/',
1569 'http://sodipodi.sourceforge.net/dtd/sodipodi-0.dtd',
1570 'http://taptrix.com/inkpad/svg_extensions',
1571 'http://web.resource.org/cc/',
1572 'http://www.freesoftware.fsf.org/bkchem/cdml',
1573 'http://www.inkscape.org/namespaces/inkscape',
1574 'http://www.opengis.net/gml',
1575 'http://www.w3.org/1999/02/22-rdf-syntax-ns#',
1576 'http://www.w3.org/2000/svg',
1577 'http://www.w3.org/tr/rec-rdf-syntax/',
1578 'http://www.w3.org/2000/01/rdf-schema#',
1579 ];
1580
1581 // Inkscape mangles namespace definitions created by Adobe Illustrator.
1582 // This is nasty but harmless. (T144827)
1583 $isBuggyInkscape = preg_match( '/^&(#38;)*ns_[a-z_]+;$/', $namespace );
1584
1585 if ( !( $isBuggyInkscape || in_array( $namespace, $validNamespaces ) ) ) {
1586 wfDebug( __METHOD__ . ": Non-svg namespace '$namespace' in uploaded file.\n" );
1588 $this->mSVGNSError = $namespace;
1589
1590 return true;
1591 }
1592
1593 /*
1594 * check for elements that can contain javascript
1595 */
1596 if ( $strippedElement == 'script' ) {
1597 wfDebug( __METHOD__ . ": Found script element '$element' in uploaded file.\n" );
1598
1599 return [ 'uploaded-script-svg', $strippedElement ];
1600 }
1601
1602 # e.g., <svg xmlns="http://www.w3.org/2000/svg">
1603 # <handler xmlns:ev="http://www.w3.org/2001/xml-events" ev:event="load">alert(1)</handler> </svg>
1604 if ( $strippedElement == 'handler' ) {
1605 wfDebug( __METHOD__ . ": Found scriptable element '$element' in uploaded file.\n" );
1606
1607 return [ 'uploaded-script-svg', $strippedElement ];
1608 }
1609
1610 # SVG reported in Feb '12 that used xml:stylesheet to generate javascript block
1611 if ( $strippedElement == 'stylesheet' ) {
1612 wfDebug( __METHOD__ . ": Found scriptable element '$element' in uploaded file.\n" );
1613
1614 return [ 'uploaded-script-svg', $strippedElement ];
1615 }
1616
1617 # Block iframes, in case they pass the namespace check
1618 if ( $strippedElement == 'iframe' ) {
1619 wfDebug( __METHOD__ . ": iframe in uploaded file.\n" );
1620
1621 return [ 'uploaded-script-svg', $strippedElement ];
1622 }
1623
1624 # Check <style> css
1625 if ( $strippedElement == 'style'
1626 && self::checkCssFragment( Sanitizer::normalizeCss( $data ) )
1627 ) {
1628 wfDebug( __METHOD__ . ": hostile css in style element.\n" );
1629 return [ 'uploaded-hostile-svg' ];
1630 }
1631
1632 foreach ( $attribs as $attrib => $value ) {
1633 $stripped = $this->stripXmlNamespace( $attrib );
1634 $value = strtolower( $value );
1635
1636 if ( substr( $stripped, 0, 2 ) == 'on' ) {
1637 wfDebug( __METHOD__
1638 . ": Found event-handler attribute '$attrib'='$value' in uploaded file.\n" );
1639
1640 return [ 'uploaded-event-handler-on-svg', $attrib, $value ];
1641 }
1642
1643 # Do not allow relative links, or unsafe url schemas.
1644 # For <a> tags, only data:, http: and https: and same-document
1645 # fragment links are allowed. For all other tags, only data:
1646 # and fragment are allowed.
1647 if ( $stripped == 'href'
1648 && $value !== ''
1649 && strpos( $value, 'data:' ) !== 0
1650 && strpos( $value, '#' ) !== 0
1651 ) {
1652 if ( !( $strippedElement === 'a'
1653 && preg_match( '!^https?://!i', $value ) )
1654 ) {
1655 wfDebug( __METHOD__ . ": Found href attribute <$strippedElement "
1656 . "'$attrib'='$value' in uploaded file.\n" );
1657
1658 return [ 'uploaded-href-attribute-svg', $strippedElement, $attrib, $value ];
1659 }
1660 }
1661
1662 # only allow data: targets that should be safe. This prevents vectors like,
1663 # image/svg, text/xml, application/xml, and text/html, which can contain scripts
1664 if ( $stripped == 'href' && strncasecmp( 'data:', $value, 5 ) === 0 ) {
1665 // rfc2397 parameters. This is only slightly slower than (;[\w;]+)*.
1666 // phpcs:ignore Generic.Files.LineLength
1667 $parameters = '(?>;[a-zA-Z0-9\!#$&\'*+.^_`{|}~-]+=(?>[a-zA-Z0-9\!#$&\'*+.^_`{|}~-]+|"(?>[\0-\x0c\x0e-\x21\x23-\x5b\x5d-\x7f]+|\\\\[\0-\x7f])*"))*(?:;base64)?';
1668
1669 if ( !preg_match( "!^data:\s*image/(gif|jpeg|jpg|png)$parameters,!i", $value ) ) {
1670 wfDebug( __METHOD__ . ": Found href to unwhitelisted data: uri "
1671 . "\"<$strippedElement '$attrib'='$value'...\" in uploaded file.\n" );
1672 return [ 'uploaded-href-unsafe-target-svg', $strippedElement, $attrib, $value ];
1673 }
1674 }
1675
1676 # Change href with animate from (http://html5sec.org/#137).
1677 if ( $stripped === 'attributename'
1678 && $strippedElement === 'animate'
1679 && $this->stripXmlNamespace( $value ) == 'href'
1680 ) {
1681 wfDebug( __METHOD__ . ": Found animate that might be changing href using from "
1682 . "\"<$strippedElement '$attrib'='$value'...\" in uploaded file.\n" );
1683
1684 return [ 'uploaded-animate-svg', $strippedElement, $attrib, $value ];
1685 }
1686
1687 # use set/animate to add event-handler attribute to parent
1688 if ( ( $strippedElement == 'set' || $strippedElement == 'animate' )
1689 && $stripped == 'attributename'
1690 && substr( $value, 0, 2 ) == 'on'
1691 ) {
1692 wfDebug( __METHOD__ . ": Found svg setting event-handler attribute with "
1693 . "\"<$strippedElement $stripped='$value'...\" in uploaded file.\n" );
1694
1695 return [ 'uploaded-setting-event-handler-svg', $strippedElement, $stripped, $value ];
1696 }
1697
1698 # use set to add href attribute to parent element
1699 if ( $strippedElement == 'set'
1700 && $stripped == 'attributename'
1701 && strpos( $value, 'href' ) !== false
1702 ) {
1703 wfDebug( __METHOD__ . ": Found svg setting href attribute '$value' in uploaded file.\n" );
1704
1705 return [ 'uploaded-setting-href-svg' ];
1706 }
1707
1708 # use set to add a remote / data / script target to an element
1709 if ( $strippedElement == 'set'
1710 && $stripped == 'to'
1711 && preg_match( '!(http|https|data|script):!sim', $value )
1712 ) {
1713 wfDebug( __METHOD__ . ": Found svg setting attribute to '$value' in uploaded file.\n" );
1714
1715 return [ 'uploaded-wrong-setting-svg', $value ];
1716 }
1717
1718 # use handler attribute with remote / data / script
1719 if ( $stripped == 'handler' && preg_match( '!(http|https|data|script):!sim', $value ) ) {
1720 wfDebug( __METHOD__ . ": Found svg setting handler with remote/data/script "
1721 . "'$attrib'='$value' in uploaded file.\n" );
1722
1723 return [ 'uploaded-setting-handler-svg', $attrib, $value ];
1724 }
1725
1726 # use CSS styles to bring in remote code
1727 if ( $stripped == 'style'
1728 && self::checkCssFragment( Sanitizer::normalizeCss( $value ) )
1729 ) {
1730 wfDebug( __METHOD__ . ": Found svg setting a style with "
1731 . "remote url '$attrib'='$value' in uploaded file.\n" );
1732 return [ 'uploaded-remote-url-svg', $attrib, $value ];
1733 }
1734
1735 # Several attributes can include css, css character escaping isn't allowed
1736 $cssAttrs = [ 'font', 'clip-path', 'fill', 'filter', 'marker',
1737 'marker-end', 'marker-mid', 'marker-start', 'mask', 'stroke' ];
1738 if ( in_array( $stripped, $cssAttrs )
1739 && self::checkCssFragment( $value )
1740 ) {
1741 wfDebug( __METHOD__ . ": Found svg setting a style with "
1742 . "remote url '$attrib'='$value' in uploaded file.\n" );
1743 return [ 'uploaded-remote-url-svg', $attrib, $value ];
1744 }
1745
1746 # image filters can pull in url, which could be svg that executes scripts
1747 if ( $strippedElement == 'image'
1748 && $stripped == 'filter'
1749 && preg_match( '!url\s*\‍(!sim', $value )
1750 ) {
1751 wfDebug( __METHOD__ . ": Found image filter with url: "
1752 . "\"<$strippedElement $stripped='$value'...\" in uploaded file.\n" );
1753
1754 return [ 'uploaded-image-filter-svg', $strippedElement, $stripped, $value ];
1755 }
1756 }
1757
1758 return false; // No scripts detected
1759 }
1760
1768 private static function checkCssFragment( $value ) {
1769 # Forbid external stylesheets, for both reliability and to protect viewer's privacy
1770 if ( stripos( $value, '@import' ) !== false ) {
1771 return true;
1772 }
1773
1774 # We allow @font-face to embed fonts with data: urls, so we snip the string
1775 # 'url' out so this case won't match when we check for urls below
1776 $pattern = '!(@font-face\s*{[^}]*src:)url(\‍("data:;base64,)!im';
1777 $value = preg_replace( $pattern, '$1$2', $value );
1778
1779 # Check for remote and executable CSS. Unlike in Sanitizer::checkCss, the CSS
1780 # properties filter and accelerator don't seem to be useful for xss in SVG files.
1781 # Expression and -o-link don't seem to work either, but filtering them here in case.
1782 # Additionally, we catch remote urls like url("http:..., url('http:..., url(http:...,
1783 # but not local ones such as url("#..., url('#..., url(#....
1784 if ( preg_match( '!expression
1785 | -o-link\s*:
1786 | -o-link-source\s*:
1787 | -o-replace\s*:!imx', $value ) ) {
1788 return true;
1789 }
1790
1791 if ( preg_match_all(
1792 "!(\s*(url|image|image-set)\s*\‍(\s*[\"']?\s*[^#]+.*?\‍))!sim",
1793 $value,
1794 $matches
1795 ) !== 0
1796 ) {
1797 # TODO: redo this in one regex. Until then, url("#whatever") matches the first
1798 foreach ( $matches[1] as $match ) {
1799 if ( !preg_match( "!\s*(url|image|image-set)\s*\‍(\s*(#|'#|\"#)!im", $match ) ) {
1800 return true;
1801 }
1802 }
1803 }
1804
1805 if ( preg_match( '/[\000-\010\013\016-\037\177]/', $value ) ) {
1806 return true;
1807 }
1808
1809 return false;
1810 }
1811
1817 private static function splitXmlNamespace( $element ) {
1818 // 'http://www.w3.org/2000/svg:script' -> [ 'http://www.w3.org/2000/svg', 'script' ]
1819 $parts = explode( ':', strtolower( $element ) );
1820 $name = array_pop( $parts );
1821 $ns = implode( ':', $parts );
1822
1823 return [ $ns, $name ];
1824 }
1825
1830 private function stripXmlNamespace( $name ) {
1831 // 'http://www.w3.org/2000/svg:script' -> 'script'
1832 $parts = explode( ':', strtolower( $name ) );
1833
1834 return array_pop( $parts );
1835 }
1836
1847 public static function detectVirus( $file ) {
1849
1850 if ( !$wgAntivirus ) {
1851 wfDebug( __METHOD__ . ": virus scanner disabled\n" );
1852
1853 return null;
1854 }
1855
1857 wfDebug( __METHOD__ . ": unknown virus scanner: $wgAntivirus\n" );
1858 $wgOut->wrapWikiMsg( "<div class=\"error\">\n$1\n</div>",
1859 [ 'virus-badscanner', $wgAntivirus ] );
1860
1861 return wfMessage( 'virus-unknownscanner' )->text() . " $wgAntivirus";
1862 }
1863
1864 # look up scanner configuration
1866 $exitCodeMap = $wgAntivirusSetup[$wgAntivirus]['codemap'];
1867 $msgPattern = $wgAntivirusSetup[$wgAntivirus]['messagepattern'] ?? null;
1868
1869 if ( strpos( $command, "%f" ) === false ) {
1870 # simple pattern: append file to scan
1871 $command .= " " . wfEscapeShellArg( $file );
1872 } else {
1873 # complex pattern: replace "%f" with file to scan
1874 $command = str_replace( "%f", wfEscapeShellArg( $file ), $command );
1875 }
1876
1877 wfDebug( __METHOD__ . ": running virus scan: $command \n" );
1878
1879 # execute virus scanner
1880 $exitCode = false;
1881
1882 # NOTE: there's a 50 line workaround to make stderr redirection work on windows, too.
1883 # that does not seem to be worth the pain.
1884 # Ask me (Duesentrieb) about it if it's ever needed.
1885 $output = wfShellExecWithStderr( $command, $exitCode );
1886
1887 # map exit code to AV_xxx constants.
1888 $mappedCode = $exitCode;
1889 if ( $exitCodeMap ) {
1890 if ( isset( $exitCodeMap[$exitCode] ) ) {
1891 $mappedCode = $exitCodeMap[$exitCode];
1892 } elseif ( isset( $exitCodeMap["*"] ) ) {
1893 $mappedCode = $exitCodeMap["*"];
1894 }
1895 }
1896
1897 /* NB: AV_NO_VIRUS is 0 but AV_SCAN_FAILED is false,
1898 * so we need the strict equalities === and thus can't use a switch here
1899 */
1900 if ( $mappedCode === AV_SCAN_FAILED ) {
1901 # scan failed (code was mapped to false by $exitCodeMap)
1902 wfDebug( __METHOD__ . ": failed to scan $file (code $exitCode).\n" );
1903
1905 ? wfMessage( 'virus-scanfailed', [ $exitCode ] )->text()
1906 : null;
1907 } elseif ( $mappedCode === AV_SCAN_ABORTED ) {
1908 # scan failed because filetype is unknown (probably imune)
1909 wfDebug( __METHOD__ . ": unsupported file type $file (code $exitCode).\n" );
1910 $output = null;
1911 } elseif ( $mappedCode === AV_NO_VIRUS ) {
1912 # no virus found
1913 wfDebug( __METHOD__ . ": file passed virus scan.\n" );
1914 $output = false;
1915 } else {
1916 $output = trim( $output );
1917
1918 if ( !$output ) {
1919 $output = true; # if there's no output, return true
1920 } elseif ( $msgPattern ) {
1921 $groups = [];
1922 if ( preg_match( $msgPattern, $output, $groups ) ) {
1923 if ( $groups[1] ) {
1924 $output = $groups[1];
1925 }
1926 }
1927 }
1928
1929 wfDebug( __METHOD__ . ": FOUND VIRUS! scanner feedback: $output \n" );
1930 }
1931
1932 return $output;
1933 }
1934
1943 private function checkOverwrite( $user ) {
1944 // First check whether the local file can be overwritten
1945 $file = $this->getLocalFile();
1946 $file->load( File::READ_LATEST );
1947 if ( $file->exists() ) {
1948 if ( !self::userCanReUpload( $user, $file ) ) {
1949 return [ 'fileexists-forbidden', $file->getName() ];
1950 } else {
1951 return true;
1952 }
1953 }
1954
1955 /* Check shared conflicts: if the local file does not exist, but
1956 * wfFindFile finds a file, it exists in a shared repository.
1957 */
1958 $file = wfFindFile( $this->getTitle(), [ 'latest' => true ] );
1959 if ( $file && !$user->isAllowed( 'reupload-shared' ) ) {
1960 return [ 'fileexists-shared-forbidden', $file->getName() ];
1961 }
1962
1963 return true;
1964 }
1965
1973 public static function userCanReUpload( User $user, File $img ) {
1974 if ( $user->isAllowed( 'reupload' ) ) {
1975 return true; // non-conditional
1976 } elseif ( !$user->isAllowed( 'reupload-own' ) ) {
1977 return false;
1978 }
1979
1980 if ( !( $img instanceof LocalFile ) ) {
1981 return false;
1982 }
1983
1984 $img->load();
1985
1986 return $user->getId() == $img->getUser( 'id' );
1987 }
1988
2000 public static function getExistsWarning( $file ) {
2001 if ( $file->exists() ) {
2002 return [ 'warning' => 'exists', 'file' => $file ];
2003 }
2004
2005 if ( $file->getTitle()->getArticleID() ) {
2006 return [ 'warning' => 'page-exists', 'file' => $file ];
2007 }
2008
2009 if ( strpos( $file->getName(), '.' ) == false ) {
2010 $partname = $file->getName();
2011 $extension = '';
2012 } else {
2013 $n = strrpos( $file->getName(), '.' );
2014 $extension = substr( $file->getName(), $n + 1 );
2015 $partname = substr( $file->getName(), 0, $n );
2016 }
2017 $normalizedExtension = File::normalizeExtension( $extension );
2018
2019 if ( $normalizedExtension != $extension ) {
2020 // We're not using the normalized form of the extension.
2021 // Normal form is lowercase, using most common of alternate
2022 // extensions (eg 'jpg' rather than 'JPEG').
2023
2024 // Check for another file using the normalized form...
2025 $nt_lc = Title::makeTitle( NS_FILE, "{$partname}.{$normalizedExtension}" );
2026 $file_lc = wfLocalFile( $nt_lc );
2027
2028 if ( $file_lc->exists() ) {
2029 return [
2030 'warning' => 'exists-normalized',
2031 'file' => $file,
2032 'normalizedFile' => $file_lc
2033 ];
2034 }
2035 }
2036
2037 // Check for files with the same name but a different extension
2038 $similarFiles = RepoGroup::singleton()->getLocalRepo()->findFilesByPrefix(
2039 "{$partname}.", 1 );
2040 if ( count( $similarFiles ) ) {
2041 return [
2042 'warning' => 'exists-normalized',
2043 'file' => $file,
2044 'normalizedFile' => $similarFiles[0],
2045 ];
2046 }
2047
2048 if ( self::isThumbName( $file->getName() ) ) {
2049 # Check for filenames like 50px- or 180px-, these are mostly thumbnails
2050 $nt_thb = Title::newFromText(
2051 substr( $partname, strpos( $partname, '-' ) + 1 ) . '.' . $extension,
2052 NS_FILE
2053 );
2054 $file_thb = wfLocalFile( $nt_thb );
2055 if ( $file_thb->exists() ) {
2056 return [
2057 'warning' => 'thumb',
2058 'file' => $file,
2059 'thumbFile' => $file_thb
2060 ];
2061 } else {
2062 // File does not exist, but we just don't like the name
2063 return [
2064 'warning' => 'thumb-name',
2065 'file' => $file,
2066 'thumbFile' => $file_thb
2067 ];
2068 }
2069 }
2070
2071 foreach ( self::getFilenamePrefixBlacklist() as $prefix ) {
2072 if ( substr( $partname, 0, strlen( $prefix ) ) == $prefix ) {
2073 return [
2074 'warning' => 'bad-prefix',
2075 'file' => $file,
2076 'prefix' => $prefix
2077 ];
2078 }
2079 }
2080
2081 return false;
2082 }
2083
2089 public static function isThumbName( $filename ) {
2090 $n = strrpos( $filename, '.' );
2091 $partname = $n ? substr( $filename, 0, $n ) : $filename;
2092
2093 return (
2094 substr( $partname, 3, 3 ) == 'px-' ||
2095 substr( $partname, 2, 3 ) == 'px-'
2096 ) &&
2097 preg_match( "/[0-9]{2}/", substr( $partname, 0, 2 ) );
2098 }
2099
2105 public static function getFilenamePrefixBlacklist() {
2106 $blacklist = [];
2107 $message = wfMessage( 'filename-prefix-blacklist' )->inContentLanguage();
2108 if ( !$message->isDisabled() ) {
2109 $lines = explode( "\n", $message->plain() );
2110 foreach ( $lines as $line ) {
2111 // Remove comment lines
2112 $comment = substr( trim( $line ), 0, 1 );
2113 if ( $comment == '#' || $comment == '' ) {
2114 continue;
2115 }
2116 // Remove additional comments after a prefix
2117 $comment = strpos( $line, '#' );
2118 if ( $comment > 0 ) {
2119 $line = substr( $line, 0, $comment - 1 );
2120 }
2121 $blacklist[] = trim( $line );
2122 }
2123 }
2124
2125 return $blacklist;
2126 }
2127
2139 public function getImageInfo( $result ) {
2140 $localFile = $this->getLocalFile();
2141 $stashFile = $this->getStashFile();
2142 // Calling a different API module depending on whether the file was stashed is less than optimal.
2143 // In fact, calling API modules here at all is less than optimal. Maybe it should be refactored.
2144 if ( $stashFile ) {
2146 $info = ApiQueryStashImageInfo::getInfo( $stashFile, array_flip( $imParam ), $result );
2147 } else {
2149 $info = ApiQueryImageInfo::getInfo( $localFile, array_flip( $imParam ), $result );
2150 }
2151
2152 return $info;
2153 }
2154
2159 public function convertVerifyErrorToStatus( $error ) {
2160 $code = $error['status'];
2161 unset( $code['status'] );
2162
2163 return Status::newFatal( $this->getVerificationErrorCode( $code ), $error );
2164 }
2165
2173 public static function getMaxUploadSize( $forType = null ) {
2174 global $wgMaxUploadSize;
2175
2176 if ( is_array( $wgMaxUploadSize ) ) {
2177 if ( !is_null( $forType ) && isset( $wgMaxUploadSize[$forType] ) ) {
2178 return $wgMaxUploadSize[$forType];
2179 } else {
2180 return $wgMaxUploadSize['*'];
2181 }
2182 } else {
2183 return intval( $wgMaxUploadSize );
2184 }
2185 }
2186
2194 public static function getMaxPhpUploadSize() {
2195 $phpMaxFileSize = wfShorthandToInteger(
2196 ini_get( 'upload_max_filesize' ) ?: ini_get( 'hhvm.server.upload.upload_max_file_size' ),
2197 PHP_INT_MAX
2198 );
2199 $phpMaxPostSize = wfShorthandToInteger(
2200 ini_get( 'post_max_size' ) ?: ini_get( 'hhvm.server.max_post_size' ),
2201 PHP_INT_MAX
2202 ) ?: PHP_INT_MAX;
2203 return min( $phpMaxFileSize, $phpMaxPostSize );
2204 }
2205
2215 public static function getSessionStatus( User $user, $statusKey ) {
2216 $cache = MediaWikiServices::getInstance()->getMainObjectStash();
2217 $key = $cache->makeKey( 'uploadstatus', $user->getId() ?: md5( $user->getName() ), $statusKey );
2218
2219 return $cache->get( $key );
2220 }
2221
2232 public static function setSessionStatus( User $user, $statusKey, $value ) {
2233 $cache = MediaWikiServices::getInstance()->getMainObjectStash();
2234 $key = $cache->makeKey( 'uploadstatus', $user->getId() ?: md5( $user->getName() ), $statusKey );
2235
2236 if ( $value === false ) {
2237 $cache->delete( $key );
2238 } else {
2239 $cache->set( $key, $value, $cache::TTL_DAY );
2240 }
2241 }
2242}
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
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
has been added to your &Future changes to this page and its associated Talk page will be listed there
target page
$wgAntivirus
Internal name of virus scanner.
$wgFileExtensions
This is the list of preferred extensions for uploading files.
$wgCheckFileExtensions
This is a flag to determine whether or not to check file extensions on upload.
$wgAntivirusRequired
Determines if a failed virus scan (AV_SCAN_FAILED) will cause the file to be rejected.
$wgUploadSizeWarning
Warn if uploaded files are larger than this (in bytes), or false to disable.
$wgDisableUploadScriptChecks
Setting this to true will disable the upload system's checks for HTML/JavaScript.
$wgVerifyMimeType
Determines if the MIME type of uploaded files should be checked.
$wgAntivirusSetup
Configuration for different virus scanners.
$wgFileBlacklist
Files with these extensions will never be allowed as uploads.
$wgEnableUploads
Allow users to upload files.
$wgAllowJavaUploads
Allow Java archive uploads.
$wgStrictFileExtensions
If this is turned off, users may override the warning for files not covered by $wgFileExtensions.
$wgMimeTypeBlacklist
Files with these MIME types will never be allowed as uploads if $wgVerifyMimeType is enabled.
$wgMaxUploadSize
Max size for uploads, in bytes.
$wgSVGMetadataCutoff
Don't read SVG metadata beyond this point.
$wgAllowTitlesInSVG
Disallow <title> element in SVG files.
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
wfEscapeShellArg(... $args)
Version of escapeshellarg() that works better on Windows.
wfIniGetBool( $setting)
Safety wrapper around ini_get() for boolean settings.
wfLocalFile( $title)
Get an object referring to a locally registered file.
wfArrayDiff2( $a, $b)
Like array_diff( $a, $b ) except that it works with two-dimensional arrays.
wfShellExecWithStderr( $cmd, &$retval=null, $environ=[], $limits=[])
Execute a shell command, returning both stdout and stderr.
wfStripIllegalFilenameChars( $name)
Replace all invalid characters with '-'.
wfShorthandToInteger( $string='', $default=-1)
Converts shorthand byte notation to integer form.
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
wfIsHHVM()
Check if we are running under HHVM.
$wgOut
Definition Setup.php:915
$wgLang
Definition Setup.php:910
$line
Definition cdb.php:59
$command
Definition cdb.php:65
static getPropertyNames( $filter=[])
Returns all possible parameters to iiprop.
static getInfo( $file, $prop, $result, $thumbParams=null, $opts=false)
Get result information for an image revision.
Class representing a row of the 'filearchive' table.
static getSha1Base36FromPath( $path)
Get a SHA-1 hash of a file in the local filesystem, in base-36 lower case encoding,...
Definition FSFile.php:218
static isStoragePath( $path)
Check if a given path is a "mwstore://" path.
const DELETE_SOURCE
Definition File.php:66
const DELETED_FILE
Definition File.php:53
wasDeleted()
Was this file ever deleted from the wiki?
Definition File.php:1913
Class to represent a local file in the wiki's own database.
Definition LocalFile.php:46
exists()
canRender inherited
getHistory( $limit=null, $start=null, $end=null, $inc=true)
purgeDescription inherited
MediaWiki exception.
MimeMagic helper wrapper.
static getHandler( $type)
Get a MediaHandler for a given MIME type from the instance cache.
MediaWikiServices is the service locator for the application scope of MediaWiki.
static singleton()
Get a RepoGroup instance.
Definition RepoGroup.php:59
This class is used to hold the location and do limited manipulation of files stored temporarily (this...
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition Title.php:280
UploadBase and subclasses are the backend of MediaWiki's file uploads.
getSourceType()
Returns the upload type.
checkOverwrite( $user)
Check if there's an overwrite conflict and, if so, if restrictions forbid this user from performing t...
const EMPTY_FILE
static verifyExtension( $mime, $extension)
Checks if the MIME type of the uploaded file matches the file extension.
postProcessUpload()
Perform extra steps after a successful upload.
verifyTitlePermissions( $user)
Check whether the user can edit, upload and create the image.
checkSvgScriptCallback( $element, $attribs, $data=null)
checkLocalFileExists(LocalFile $localFile, $hash)
getLocalFile()
Return the local file and initializes if necessary.
const SUCCESS
stripXmlNamespace( $name)
string $mTempPath
Local file system path to the file to upload (or a local copy)
checkBadFileName( $filename, $desiredFileName)
Check whether the resulting filename is different from the desired one, but ignore things like ucfirs...
$mBlackListedExtensions
getRealPath( $srcPath)
static createFromRequest(&$request, $type=null)
Create a form of UploadBase depending on wpSourceType and initializes it.
verifyPermissions( $user)
Alias for verifyTitlePermissions.
runUploadStashFileHook(User $user)
static getSessionStatus(User $user, $statusKey)
Get the current status of a chunked upload (used for polling)
zipEntryCallback( $entry)
Callback for ZipDirectoryReader to detect Java class files.
static checkSvgPICallback( $target, $data)
Callback to filter SVG Processing Instructions.
static isValidRequest( $request)
Check whether a request if valid for this handler.
const FILETYPE_MISSING
convertVerifyErrorToStatus( $error)
verifyPartialFile()
A verification routine suitable for partial files.
static detectScript( $file, $mime, $extension)
Heuristic for detecting files that could contain JavaScript instructions or things that may look like...
verifyFile()
Verifies that it's ok to include the uploaded file.
static isEnabled()
Returns true if uploads are enabled.
static isThumbName( $filename)
Helper function that checks whether the filename looks like a thumbnail.
getVerificationErrorCode( $error)
static checkCssFragment( $value)
Check a block of CSS or CSS fragment for anything that looks like it is bringing in remote code.
static getFilenamePrefixBlacklist()
Get a list of blacklisted filename prefixes from [[MediaWiki:Filename-prefix-blacklist]].
checkAgainstArchiveDupes( $hash)
const OVERWRITE_EXISTING_FILE
setTempFile( $tempPath, $fileSize=null)
stashSession()
alias for stashFileGetKey, for backwards compatibility
static checkXMLEncodingMissmatch( $file)
Check a whitelist of xml encodings that are known not to be interpreted differently by the server's x...
static $uploadHandlers
doStashFile(User $user=null)
Implementation for stashFile() and tryStashFile().
const HOOK_ABORTED
const VERIFICATION_ERROR
const WINDOWS_NONASCII_FILENAME
cleanupTempFile()
If we've modified the upload file we need to manually remove it on exit to clean up.
validateName()
Verify that the name is valid and, if necessary, that we can overwrite.
checkFileSize( $fileSize)
isEmptyFile()
Return true if the file is empty.
static checkFileExtension( $ext, $list)
Perform case-insensitive match against a list of file extensions.
const FILETYPE_BADTYPE
tryStashFile(User $user, $isPartial=false)
Like stashFile(), but respects extensions' wishes to prevent the stashing.
getTitle()
Returns the title of the file to be uploaded.
initializePathInfo( $name, $tempPath, $fileSize, $removeTempFile=false)
Initialize the path information.
static getMaxUploadSize( $forType=null)
Get the MediaWiki maximum uploaded file size for given type of upload, based on $wgMaxUploadSize.
static checkSvgExternalDTD( $type, $publicId, $systemId)
Verify that DTD urls referenced are only the standard dtds.
getTempFileSha1Base36()
Get the base 36 SHA1 of the file.
static splitXmlNamespace( $element)
Divide the element name passed by the xml parser to the callback into URI and prifix.
getImageInfo( $result)
Gets image info about the file just uploaded.
detectScriptInSvg( $filename, $partial)
static splitExtensions( $filename)
Split a file into a base name and all dot-delimited 'extensions' on the end.
fetchFile()
Fetch the file.
const FILE_TOO_LARGE
static isThrottled( $user)
Returns true if the user has surpassed the upload rate limit, false otherwise.
checkLocalFileWasDeleted(LocalFile $localFile)
stashFileGetKey()
Stash a file in a temporary directory, returning a key which can be used to find the file again.
performUpload( $comment, $pageText, $watch, $user, $tags=[])
Really perform the upload.
getFileSize()
Return the file size.
verifyUpload()
Verify whether the upload is sane.
stashFile(User $user=null)
If the user does not supply all necessary information in the first upload form submission (either by ...
const ILLEGAL_FILENAME
const MIN_LENGTH_PARTNAME
static checkFileExtensionList( $ext, $list)
Perform case-insensitive match against a list of file extensions.
checkWarnings()
Check for non fatal problems with the file.
static detectVirus( $file)
Generic wrapper function for a virus scanner program.
static isAllowed( $user)
Returns true if the user can use this upload module or else a string identifying the missing permissi...
checkUnwantedFileExtensions( $fileExtension)
TempFSFile null $tempFileObj
Wrapper to handle deleting the temp file.
static getExistsWarning( $file)
Helper function that does various existence checks for a file.
const FILENAME_TOO_LONG
static getMaxPhpUploadSize()
Get the PHP maximum uploaded file size, based on ini settings.
static $safeXmlEncodings
verifyMimeType( $mime)
Verify the MIME type.
static setSessionStatus(User $user, $statusKey, $value)
Set the current status of a chunked upload (used for polling)
initializeFromRequest(&$request)
Initialize from a WebRequest.
checkAgainstExistingDupes( $hash, $ignoreLocalDupes)
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition User.php:47
const IGNORE_USER_RIGHTS
Definition User.php:84
static doWatch(Title $title, User $user, $checkRights=User::CHECK_USER_RIGHTS)
Watch a page.
static read( $fileName, $callback, $options=[])
Read a ZIP file and call a function for each file discovered in it.
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
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
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 AV_SCAN_FAILED
Definition Defines.php:114
const NS_FILE
Definition Defines.php:70
const AV_SCAN_ABORTED
Definition Defines.php:113
const AV_NO_VIRUS
Definition Defines.php:111
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on $request
Definition hooks.txt:2880
this hook is for auditing only RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your own(ChangesListBooleanFilterGroup or ChangesListStringOptionsFilterGroup). If you create new groups
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\d*-\d*)") will be honored when streaming the file. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED since 1.16! 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:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED since 1.28! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition hooks.txt:2042
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action, or null $user:User who performed the tagging when the tagging is subsequent to the action, or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, whether it is OK to use $contentModel on $title. Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy:boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'ContentSecurityPolicyDefaultSource':Modify the allowed CSP load sources. This affects all directives except for the script directive. If you want to add a script source, see ContentSecurityPolicyScriptSource hook. & $defaultSrc:Array of Content-Security-Policy allowed sources $policyConfig:Current configuration for the Content-Security-Policy header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyDirectives':Modify the content security policy directives. Use this only if ContentSecurityPolicyDefaultSource and ContentSecurityPolicyScriptSource do not meet your needs. & $directives:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyScriptSource':Modify the allowed CSP script sources. Note that you also have to use ContentSecurityPolicyDefaultSource if you want non-script sources to be loaded from whatever you add. & $scriptSrc:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit 'DatabaseOraclePostInit':Called after initialising an Oracle database $db:the DatabaseOracle object 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DeleteUnknownPreferences':Called by the cleanupPreferences.php maintenance script to build a WHERE clause with which to delete preferences that are not known about. This hook is used by extensions that have dynamically-named preferences that should not be deleted in the usual cleanup process. For example, the Gadgets extension creates preferences prefixed with 'gadget-', and so anything with that prefix is excluded from the deletion. &where:An array that will be passed as the $cond parameter to IDatabase::select() to determine what will be deleted from the user_properties table. $db:The IDatabase object, useful for accessing $db->buildLike() etc. 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function. $differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable 's value is null. This hook can be used to inject content into said class member variable. $differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the "mark as patrolled" link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink". $differenceEngine:DifferenceEngine object & $markAsPatrolledLink:The "mark as patrolled" link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter. For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions. & $rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision 's author, whether the revision was marked as a minor edit or not, etc. $differenceEngine:DifferenceEngine object & $newHeader:The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
Definition hooks.txt:1305
null means default in associative array form
Definition hooks.txt:2045
namespace and then decline to actually register it file or subcat img or subcat $title
Definition hooks.txt:994
null for the local wiki Added in
Definition hooks.txt:1627
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:895
you don t have to do a grep find to see where the $wgReverseTitle variable is used
Definition hooks.txt:115
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation use $formDescriptor instead default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "&lt;div ...>$1&lt;/div>"). - flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException':Called before an exception(or PHP error) is logged. This is meant for integration with external error aggregation services
Allows to change the fields on the form that will be generated $name
Definition hooks.txt:302
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:2063
Using a hook running we can avoid having all this option specific stuff in our mainline code Using the function We ve cleaned up the code here by removing clumps of infrequently used code and moving them off somewhere else It s much easier for someone working with this code to see what s _really_ going and make changes or fix bugs In we can take all the code that deals with the little used title reversing we can concentrate it all in an extension file
Definition hooks.txt:106
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:933
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title e g db for database replication lag or jobqueue for job queue size converted to pseudo seconds It is possible to add more fields and they will be returned to the user in the API response after the basic globals have been set but before ordinary actions take place $output
Definition hooks.txt:2317
processing should stop and the error should be shown to the user * false
Definition hooks.txt:187
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:247
returning false will NOT prevent logging $e
Definition hooks.txt:2226
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback function
Definition injection.txt:30
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:37
$cache
Definition mcc.php:33
A helper class for throttling authentication attempts.
if( $ext=='php'|| $ext=='php5') $mime
Definition router.php:59
$lines
Definition router.php:61
if(!is_readable( $file)) $ext
Definition router.php:55