MediaWiki REL1_27
UploadBase.php
Go to the documentation of this file.
1<?php
38abstract class UploadBase {
40 protected $mTempPath;
42 protected $tempFileObj;
43
45 protected $mTitle = false, $mTitleError = 0;
50
51 protected static $safeXmlEncodings = [
52 'UTF-8',
53 'ISO-8859-1',
54 'ISO-8859-2',
55 'UTF-16',
56 'UTF-32'
57 ];
58
59 const SUCCESS = 0;
60 const OK = 0;
61 const EMPTY_FILE = 3;
64 const OVERWRITE_EXISTING_FILE = 7; # Not used anymore; handled by verifyTitlePermissions()
68 const HOOK_ABORTED = 11;
69 const FILE_TOO_LARGE = 12;
72
78 $code_to_status = [
79 self::EMPTY_FILE => 'empty-file',
80 self::FILE_TOO_LARGE => 'file-too-large',
81 self::FILETYPE_MISSING => 'filetype-missing',
82 self::FILETYPE_BADTYPE => 'filetype-banned',
83 self::MIN_LENGTH_PARTNAME => 'filename-tooshort',
84 self::ILLEGAL_FILENAME => 'illegal-filename',
85 self::OVERWRITE_EXISTING_FILE => 'overwrite',
86 self::VERIFICATION_ERROR => 'verification-error',
87 self::HOOK_ABORTED => 'hookaborted',
88 self::WINDOWS_NONASCII_FILENAME => 'windows-nonascii-filename',
89 self::FILENAME_TOO_LONG => 'filename-toolong',
90 ];
91 if ( isset( $code_to_status[$error] ) ) {
92 return $code_to_status[$error];
93 }
94
95 return 'unknown-error';
96 }
97
103 public static function isEnabled() {
105
106 if ( !$wgEnableUploads ) {
107 return false;
108 }
109
110 # Check php's file_uploads setting
111 return wfIsHHVM() || wfIniGetBool( 'file_uploads' );
112 }
113
122 public static function isAllowed( $user ) {
123 foreach ( [ 'upload', 'edit' ] as $permission ) {
124 if ( !$user->isAllowed( $permission ) ) {
125 return $permission;
126 }
127 }
128
129 return true;
130 }
131
138 public static function isThrottled( $user ) {
139 return $user->pingLimiter( 'upload' );
140 }
141
142 // Upload handlers. Should probably just be a global.
143 private static $uploadHandlers = [ 'Stash', 'File', 'Url' ];
144
152 public static function createFromRequest( &$request, $type = null ) {
153 $type = $type ? $type : $request->getVal( 'wpSourceType', 'File' );
154
155 if ( !$type ) {
156 return null;
157 }
158
159 // Get the upload class
160 $type = ucfirst( $type );
161
162 // Give hooks the chance to handle this request
163 $className = null;
164 Hooks::run( 'UploadCreateFromRequest', [ $type, &$className ] );
165 if ( is_null( $className ) ) {
166 $className = 'UploadFrom' . $type;
167 wfDebug( __METHOD__ . ": class name: $className\n" );
168 if ( !in_array( $type, self::$uploadHandlers ) ) {
169 return null;
170 }
171 }
172
173 // Check whether this upload class is enabled
174 if ( !call_user_func( [ $className, 'isEnabled' ] ) ) {
175 return null;
176 }
177
178 // Check whether the request is valid
179 if ( !call_user_func( [ $className, 'isValidRequest' ], $request ) ) {
180 return null;
181 }
182
184 $handler = new $className;
185
186 $handler->initializeFromRequest( $request );
187
188 return $handler;
189 }
190
196 public static function isValidRequest( $request ) {
197 return false;
198 }
199
200 public function __construct() {
201 }
202
209 public function getSourceType() {
210 return null;
211 }
212
221 public function initializePathInfo( $name, $tempPath, $fileSize, $removeTempFile = false ) {
222 $this->mDesiredDestName = $name;
223 if ( FileBackend::isStoragePath( $tempPath ) ) {
224 throw new MWException( __METHOD__ . " given storage path `$tempPath`." );
225 }
226
227 $this->setTempFile( $tempPath, $fileSize );
228 $this->mRemoveTempFile = $removeTempFile;
229 }
230
236 abstract public function initializeFromRequest( &$request );
237
242 protected function setTempFile( $tempPath, $fileSize = null ) {
243 $this->mTempPath = $tempPath;
244 $this->mFileSize = $fileSize ?: null;
245 if ( strlen( $this->mTempPath ) && file_exists( $this->mTempPath ) ) {
246 $this->tempFileObj = new TempFSFile( $this->mTempPath );
247 if ( !$fileSize ) {
248 $this->mFileSize = filesize( $this->mTempPath );
249 }
250 } else {
251 $this->tempFileObj = null;
252 }
253 }
254
259 public function fetchFile() {
260 return Status::newGood();
261 }
262
267 public function isEmptyFile() {
268 return empty( $this->mFileSize );
269 }
270
275 public function getFileSize() {
276 return $this->mFileSize;
277 }
278
283 public function getTempFileSha1Base36() {
284 return FSFile::getSha1Base36FromPath( $this->mTempPath );
285 }
286
291 function getRealPath( $srcPath ) {
292 $repo = RepoGroup::singleton()->getLocalRepo();
293 if ( $repo->isVirtualUrl( $srcPath ) ) {
297 $tmpFile = $repo->getLocalCopy( $srcPath );
298 if ( $tmpFile ) {
299 $tmpFile->bind( $this ); // keep alive with $this
300 }
301 $path = $tmpFile ? $tmpFile->getPath() : false;
302 } else {
303 $path = $srcPath;
304 }
305
306 return $path;
307 }
308
313 public function verifyUpload() {
314
318 if ( $this->isEmptyFile() ) {
319 return [ 'status' => self::EMPTY_FILE ];
320 }
321
325 $maxSize = self::getMaxUploadSize( $this->getSourceType() );
326 if ( $this->mFileSize > $maxSize ) {
327 return [
328 'status' => self::FILE_TOO_LARGE,
329 'max' => $maxSize,
330 ];
331 }
332
338 $verification = $this->verifyFile();
339 if ( $verification !== true ) {
340 return [
341 'status' => self::VERIFICATION_ERROR,
342 'details' => $verification
343 ];
344 }
345
349 $result = $this->validateName();
350 if ( $result !== true ) {
351 return $result;
352 }
353
354 $error = '';
355 if ( !Hooks::run( 'UploadVerification',
356 [ $this->mDestName, $this->mTempPath, &$error ] )
357 ) {
358 return [ 'status' => self::HOOK_ABORTED, 'error' => $error ];
359 }
360
361 return [ 'status' => self::OK ];
362 }
363
370 public function validateName() {
371 $nt = $this->getTitle();
372 if ( is_null( $nt ) ) {
373 $result = [ 'status' => $this->mTitleError ];
374 if ( $this->mTitleError == self::ILLEGAL_FILENAME ) {
375 $result['filtered'] = $this->mFilteredName;
376 }
377 if ( $this->mTitleError == self::FILETYPE_BADTYPE ) {
378 $result['finalExt'] = $this->mFinalExtension;
379 if ( count( $this->mBlackListedExtensions ) ) {
380 $result['blacklistedExt'] = $this->mBlackListedExtensions;
381 }
382 }
383
384 return $result;
385 }
386 $this->mDestName = $this->getLocalFile()->getName();
387
388 return true;
389 }
390
400 protected function verifyMimeType( $mime ) {
402 if ( $wgVerifyMimeType ) {
403 wfDebug( "mime: <$mime> extension: <{$this->mFinalExtension}>\n" );
405 if ( $this->checkFileExtension( $mime, $wgMimeTypeBlacklist ) ) {
406 return [ 'filetype-badmime', $mime ];
407 }
408
409 # Check what Internet Explorer would detect
410 $fp = fopen( $this->mTempPath, 'rb' );
411 $chunk = fread( $fp, 256 );
412 fclose( $fp );
413
414 $magic = MimeMagic::singleton();
415 $extMime = $magic->guessTypesForExtension( $this->mFinalExtension );
416 $ieTypes = $magic->getIEMimeTypes( $this->mTempPath, $chunk, $extMime );
417 foreach ( $ieTypes as $ieType ) {
418 if ( $this->checkFileExtension( $ieType, $wgMimeTypeBlacklist ) ) {
419 return [ 'filetype-bad-ie-mime', $ieType ];
420 }
421 }
422 }
423
424 return true;
425 }
426
432 protected function verifyFile() {
434
435 $status = $this->verifyPartialFile();
436 if ( $status !== true ) {
437 return $status;
438 }
439
440 $this->mFileProps = FSFile::getPropsFromPath( $this->mTempPath, $this->mFinalExtension );
441 $mime = $this->mFileProps['mime'];
442
443 if ( $wgVerifyMimeType ) {
444 # XXX: Missing extension will be caught by validateName() via getTitle()
445 if ( $this->mFinalExtension != '' && !$this->verifyExtension( $mime, $this->mFinalExtension ) ) {
446 return [ 'filetype-mime-mismatch', $this->mFinalExtension, $mime ];
447 }
448 }
449
450 # check for htmlish code and javascript
452 if ( $this->mFinalExtension == 'svg' || $mime == 'image/svg+xml' ) {
453 $svgStatus = $this->detectScriptInSvg( $this->mTempPath, false );
454 if ( $svgStatus !== false ) {
455 return $svgStatus;
456 }
457 }
458 }
459
461 if ( $handler ) {
462 $handlerStatus = $handler->verifyUpload( $this->mTempPath );
463 if ( !$handlerStatus->isOK() ) {
464 $errors = $handlerStatus->getErrorsArray();
465
466 return reset( $errors );
467 }
468 }
469
470 Hooks::run( 'UploadVerifyFile', [ $this, $mime, &$status ] );
471 if ( $status !== true ) {
472 return $status;
473 }
474
475 wfDebug( __METHOD__ . ": all clear; passing.\n" );
476
477 return true;
478 }
479
488 protected function verifyPartialFile() {
490
491 # getTitle() sets some internal parameters like $this->mFinalExtension
492 $this->getTitle();
493
494 $this->mFileProps = FSFile::getPropsFromPath( $this->mTempPath, $this->mFinalExtension );
495
496 # check MIME type, if desired
497 $mime = $this->mFileProps['file-mime'];
498 $status = $this->verifyMimeType( $mime );
499 if ( $status !== true ) {
500 return $status;
501 }
502
503 # check for htmlish code and javascript
505 if ( self::detectScript( $this->mTempPath, $mime, $this->mFinalExtension ) ) {
506 return [ 'uploadscripted' ];
507 }
508 if ( $this->mFinalExtension == 'svg' || $mime == 'image/svg+xml' ) {
509 $svgStatus = $this->detectScriptInSvg( $this->mTempPath, true );
510 if ( $svgStatus !== false ) {
511 return $svgStatus;
512 }
513 }
514 }
515
516 # Check for Java applets, which if uploaded can bypass cross-site
517 # restrictions.
518 if ( !$wgAllowJavaUploads ) {
519 $this->mJavaDetected = false;
520 $zipStatus = ZipDirectoryReader::read( $this->mTempPath,
521 [ $this, 'zipEntryCallback' ] );
522 if ( !$zipStatus->isOK() ) {
523 $errors = $zipStatus->getErrorsArray();
524 $error = reset( $errors );
525 if ( $error[0] !== 'zip-wrong-format' ) {
526 return $error;
527 }
528 }
529 if ( $this->mJavaDetected ) {
530 return [ 'uploadjava' ];
531 }
532 }
533
534 # Scan the uploaded file for viruses
535 $virus = $this->detectVirus( $this->mTempPath );
536 if ( $virus ) {
537 return [ 'uploadvirus', $virus ];
538 }
539
540 return true;
541 }
542
548 function zipEntryCallback( $entry ) {
549 $names = [ $entry['name'] ];
550
551 // If there is a null character, cut off the name at it, because JDK's
552 // ZIP_GetEntry() uses strcmp() if the name hashes match. If a file name
553 // were constructed which had ".class\0" followed by a string chosen to
554 // make the hash collide with the truncated name, that file could be
555 // returned in response to a request for the .class file.
556 $nullPos = strpos( $entry['name'], "\000" );
557 if ( $nullPos !== false ) {
558 $names[] = substr( $entry['name'], 0, $nullPos );
559 }
560
561 // If there is a trailing slash in the file name, we have to strip it,
562 // because that's what ZIP_GetEntry() does.
563 if ( preg_grep( '!\.class/?$!', $names ) ) {
564 $this->mJavaDetected = true;
565 }
566 }
567
577 public function verifyPermissions( $user ) {
578 return $this->verifyTitlePermissions( $user );
579 }
580
592 public function verifyTitlePermissions( $user ) {
597 $nt = $this->getTitle();
598 if ( is_null( $nt ) ) {
599 return true;
600 }
601 $permErrors = $nt->getUserPermissionsErrors( 'edit', $user );
602 $permErrorsUpload = $nt->getUserPermissionsErrors( 'upload', $user );
603 if ( !$nt->exists() ) {
604 $permErrorsCreate = $nt->getUserPermissionsErrors( 'create', $user );
605 } else {
606 $permErrorsCreate = [];
607 }
608 if ( $permErrors || $permErrorsUpload || $permErrorsCreate ) {
609 $permErrors = array_merge( $permErrors, wfArrayDiff2( $permErrorsUpload, $permErrors ) );
610 $permErrors = array_merge( $permErrors, wfArrayDiff2( $permErrorsCreate, $permErrors ) );
611
612 return $permErrors;
613 }
614
615 $overwriteError = $this->checkOverwrite( $user );
616 if ( $overwriteError !== true ) {
617 return [ $overwriteError ];
618 }
619
620 return true;
621 }
622
630 public function checkWarnings() {
632
633 $warnings = [];
634
635 $localFile = $this->getLocalFile();
636 $localFile->load( File::READ_LATEST );
637 $filename = $localFile->getName();
638
643 $comparableName = str_replace( ' ', '_', $this->mDesiredDestName );
644 $comparableName = Title::capitalize( $comparableName, NS_FILE );
645
646 if ( $this->mDesiredDestName != $filename && $comparableName != $filename ) {
647 $warnings['badfilename'] = $filename;
648 }
649
650 // Check whether the file extension is on the unwanted list
653 $extensions = array_unique( $wgFileExtensions );
654 if ( !$this->checkFileExtension( $this->mFinalExtension, $extensions ) ) {
655 $warnings['filetype-unwanted-type'] = [ $this->mFinalExtension,
656 $wgLang->commaList( $extensions ), count( $extensions ) ];
657 }
658 }
659
661 if ( $wgUploadSizeWarning && ( $this->mFileSize > $wgUploadSizeWarning ) ) {
662 $warnings['large-file'] = [ $wgUploadSizeWarning, $this->mFileSize ];
663 }
664
665 if ( $this->mFileSize == 0 ) {
666 $warnings['empty-file'] = true;
667 }
668
669 $exists = self::getExistsWarning( $localFile );
670 if ( $exists !== false ) {
671 $warnings['exists'] = $exists;
672 }
673
674 if ( $localFile->wasDeleted() && !$localFile->exists() ) {
675 $warnings['was-deleted'] = $filename;
676 }
677
678 // Check dupes against existing files
679 $hash = $this->getTempFileSha1Base36();
680 $dupes = RepoGroup::singleton()->findBySha1( $hash );
681 $title = $this->getTitle();
682 // Remove all matches against self
683 foreach ( $dupes as $key => $dupe ) {
684 if ( $title->equals( $dupe->getTitle() ) ) {
685 unset( $dupes[$key] );
686 }
687 }
688 if ( $dupes ) {
689 $warnings['duplicate'] = $dupes;
690 }
691
692 // Check dupes against archives
693 $archivedFile = new ArchivedFile( null, 0, '', $hash );
694 if ( $archivedFile->getID() > 0 ) {
695 if ( $archivedFile->userCan( File::DELETED_FILE ) ) {
696 $warnings['duplicate-archive'] = $archivedFile->getName();
697 } else {
698 $warnings['duplicate-archive'] = '';
699 }
700 }
701
702 return $warnings;
703 }
704
718 public function performUpload( $comment, $pageText, $watch, $user, $tags = [] ) {
719 $this->getLocalFile()->load( File::READ_LATEST );
720
721 $status = $this->getLocalFile()->upload(
722 $this->mTempPath,
723 $comment,
724 $pageText,
726 $this->mFileProps,
727 false,
728 $user,
729 $tags
730 );
731
732 if ( $status->isGood() ) {
733 if ( $watch ) {
735 $this->getLocalFile()->getTitle(),
736 $user,
737 User::IGNORE_USER_RIGHTS
738 );
739 }
740 // Avoid PHP 7.1 warning of passing $this by reference
741 $uploadBase = $this;
742 Hooks::run( 'UploadComplete', [ &$uploadBase ] );
743
744 $this->postProcessUpload();
745 }
746
747 return $status;
748 }
749
755 public function postProcessUpload() {
757
758 $jobs = [];
759
761 rsort( $sizes );
762
763 $file = $this->getLocalFile();
764
765 foreach ( $sizes as $size ) {
766 if ( $file->isVectorized() || $file->getWidth() > $size ) {
767 $jobs[] = new ThumbnailRenderJob(
768 $file->getTitle(),
769 [ 'transformParams' => [ 'width' => $size ] ]
770 );
771 }
772 }
773
774 if ( $jobs ) {
775 JobQueueGroup::singleton()->push( $jobs );
776 }
777 }
778
785 public function getTitle() {
786 if ( $this->mTitle !== false ) {
787 return $this->mTitle;
788 }
789 if ( !is_string( $this->mDesiredDestName ) ) {
790 $this->mTitleError = self::ILLEGAL_FILENAME;
791 $this->mTitle = null;
792
793 return $this->mTitle;
794 }
795 /* Assume that if a user specified File:Something.jpg, this is an error
796 * and that the namespace prefix needs to be stripped of.
797 */
798 $title = Title::newFromText( $this->mDesiredDestName );
799 if ( $title && $title->getNamespace() == NS_FILE ) {
800 $this->mFilteredName = $title->getDBkey();
801 } else {
802 $this->mFilteredName = $this->mDesiredDestName;
803 }
804
805 # oi_archive_name is max 255 bytes, which include a timestamp and an
806 # exclamation mark, so restrict file name to 240 bytes.
807 if ( strlen( $this->mFilteredName ) > 240 ) {
808 $this->mTitleError = self::FILENAME_TOO_LONG;
809 $this->mTitle = null;
810
811 return $this->mTitle;
812 }
813
819 $this->mFilteredName = wfStripIllegalFilenameChars( $this->mFilteredName );
820 /* Normalize to title form before we do any further processing */
821 $nt = Title::makeTitleSafe( NS_FILE, $this->mFilteredName );
822 if ( is_null( $nt ) ) {
823 $this->mTitleError = self::ILLEGAL_FILENAME;
824 $this->mTitle = null;
825
826 return $this->mTitle;
827 }
828 $this->mFilteredName = $nt->getDBkey();
829
834 list( $partname, $ext ) = $this->splitExtensions( $this->mFilteredName );
835
836 if ( count( $ext ) ) {
837 $this->mFinalExtension = trim( $ext[count( $ext ) - 1] );
838 } else {
839 $this->mFinalExtension = '';
840
841 # No extension, try guessing one
842 $magic = MimeMagic::singleton();
843 $mime = $magic->guessMimeType( $this->mTempPath );
844 if ( $mime !== 'unknown/unknown' ) {
845 # Get a space separated list of extensions
846 $extList = $magic->getExtensionsForType( $mime );
847 if ( $extList ) {
848 # Set the extension to the canonical extension
849 $this->mFinalExtension = strtok( $extList, ' ' );
850
851 # Fix up the other variables
852 $this->mFilteredName .= ".{$this->mFinalExtension}";
853 $nt = Title::makeTitleSafe( NS_FILE, $this->mFilteredName );
855 }
856 }
857 }
858
859 /* Don't allow users to override the blacklist (check file extension) */
862
863 $blackListedExtensions = $this->checkFileExtensionList( $ext, $wgFileBlacklist );
864
865 if ( $this->mFinalExtension == '' ) {
866 $this->mTitleError = self::FILETYPE_MISSING;
867 $this->mTitle = null;
868
869 return $this->mTitle;
870 } elseif ( $blackListedExtensions ||
872 !$this->checkFileExtension( $this->mFinalExtension, $wgFileExtensions ) )
873 ) {
874 $this->mBlackListedExtensions = $blackListedExtensions;
875 $this->mTitleError = self::FILETYPE_BADTYPE;
876 $this->mTitle = null;
877
878 return $this->mTitle;
879 }
880
881 // Windows may be broken with special characters, see bug 1780
882 if ( !preg_match( '/^[\x0-\x7f]*$/', $nt->getText() )
883 && !RepoGroup::singleton()->getLocalRepo()->backendSupportsUnicodePaths()
884 ) {
885 $this->mTitleError = self::WINDOWS_NONASCII_FILENAME;
886 $this->mTitle = null;
887
888 return $this->mTitle;
889 }
890
891 # If there was more than one "extension", reassemble the base
892 # filename to prevent bogus complaints about length
893 if ( count( $ext ) > 1 ) {
894 $iterations = count( $ext ) - 1;
895 for ( $i = 0; $i < $iterations; $i++ ) {
896 $partname .= '.' . $ext[$i];
897 }
898 }
899
900 if ( strlen( $partname ) < 1 ) {
901 $this->mTitleError = self::MIN_LENGTH_PARTNAME;
902 $this->mTitle = null;
903
904 return $this->mTitle;
905 }
906
907 $this->mTitle = $nt;
908
909 return $this->mTitle;
910 }
911
917 public function getLocalFile() {
918 if ( is_null( $this->mLocalFile ) ) {
919 $nt = $this->getTitle();
920 $this->mLocalFile = is_null( $nt ) ? null : wfLocalFile( $nt );
921 }
922
923 return $this->mLocalFile;
924 }
925
941 public function stashFile( User $user = null ) {
942 // was stashSessionFile
943
944 $stash = RepoGroup::singleton()->getLocalRepo()->getUploadStash( $user );
945 $file = $stash->stashFile( $this->mTempPath, $this->getSourceType() );
946 $this->mLocalFile = $file;
947
948 return $file;
949 }
950
957 public function stashFileGetKey() {
958 return $this->stashFile()->getFileKey();
959 }
960
966 public function stashSession() {
967 return $this->stashFileGetKey();
968 }
969
974 public function cleanupTempFile() {
975 if ( $this->mRemoveTempFile && $this->tempFileObj ) {
976 // Delete when all relevant TempFSFile handles go out of scope
977 wfDebug( __METHOD__ . ": Marked temporary file '{$this->mTempPath}' for removal\n" );
978 $this->tempFileObj->autocollect();
979 }
980 }
981
982 public function getTempPath() {
983 return $this->mTempPath;
984 }
985
995 public static function splitExtensions( $filename ) {
996 $bits = explode( '.', $filename );
997 $basename = array_shift( $bits );
998
999 return [ $basename, $bits ];
1000 }
1001
1010 public static function checkFileExtension( $ext, $list ) {
1011 return in_array( strtolower( $ext ), $list );
1012 }
1013
1022 public static function checkFileExtensionList( $ext, $list ) {
1023 return array_intersect( array_map( 'strtolower', $ext ), $list );
1024 }
1025
1033 public static function verifyExtension( $mime, $extension ) {
1034 $magic = MimeMagic::singleton();
1035
1036 if ( !$mime || $mime == 'unknown' || $mime == 'unknown/unknown' ) {
1037 if ( !$magic->isRecognizableExtension( $extension ) ) {
1038 wfDebug( __METHOD__ . ": passing file with unknown detected mime type; " .
1039 "unrecognized extension '$extension', can't verify\n" );
1040
1041 return true;
1042 } else {
1043 wfDebug( __METHOD__ . ": rejecting file with unknown detected mime type; " .
1044 "recognized extension '$extension', so probably invalid file\n" );
1045
1046 return false;
1047 }
1048 }
1049
1050 $match = $magic->isMatchingExtension( $extension, $mime );
1051
1052 if ( $match === null ) {
1053 if ( $magic->getTypesForExtension( $extension ) !== null ) {
1054 wfDebug( __METHOD__ . ": No extension known for $mime, but we know a mime for $extension\n" );
1055
1056 return false;
1057 } else {
1058 wfDebug( __METHOD__ . ": no file extension known for mime type $mime, passing file\n" );
1059
1060 return true;
1061 }
1062 } elseif ( $match === true ) {
1063 wfDebug( __METHOD__ . ": mime type $mime matches extension $extension, passing file\n" );
1064
1066 return true;
1067 } else {
1068 wfDebug( __METHOD__
1069 . ": mime type $mime mismatches file extension $extension, rejecting file\n" );
1070
1071 return false;
1072 }
1073 }
1074
1086 public static function detectScript( $file, $mime, $extension ) {
1088
1089 # ugly hack: for text files, always look at the entire file.
1090 # For binary field, just check the first K.
1091
1092 if ( strpos( $mime, 'text/' ) === 0 ) {
1093 $chunk = file_get_contents( $file );
1094 } else {
1095 $fp = fopen( $file, 'rb' );
1096 $chunk = fread( $fp, 1024 );
1097 fclose( $fp );
1098 }
1099
1100 $chunk = strtolower( $chunk );
1101
1102 if ( !$chunk ) {
1103 return false;
1104 }
1105
1106 # decode from UTF-16 if needed (could be used for obfuscation).
1107 if ( substr( $chunk, 0, 2 ) == "\xfe\xff" ) {
1108 $enc = 'UTF-16BE';
1109 } elseif ( substr( $chunk, 0, 2 ) == "\xff\xfe" ) {
1110 $enc = 'UTF-16LE';
1111 } else {
1112 $enc = null;
1113 }
1114
1115 if ( $enc ) {
1116 $chunk = iconv( $enc, "ASCII//IGNORE", $chunk );
1117 }
1118
1119 $chunk = trim( $chunk );
1120
1122 wfDebug( __METHOD__ . ": checking for embedded scripts and HTML stuff\n" );
1123
1124 # check for HTML doctype
1125 if ( preg_match( "/<!DOCTYPE *X?HTML/i", $chunk ) ) {
1126 return true;
1127 }
1128
1129 // Some browsers will interpret obscure xml encodings as UTF-8, while
1130 // PHP/expat will interpret the given encoding in the xml declaration (bug 47304)
1131 if ( $extension == 'svg' || strpos( $mime, 'image/svg' ) === 0 ) {
1132 if ( self::checkXMLEncodingMissmatch( $file ) ) {
1133 return true;
1134 }
1135 }
1136
1152 $tags = [
1153 '<a href',
1154 '<body',
1155 '<head',
1156 '<html', # also in safari
1157 '<img',
1158 '<pre',
1159 '<script', # also in safari
1160 '<table'
1161 ];
1162
1163 if ( !$wgAllowTitlesInSVG && $extension !== 'svg' && $mime !== 'image/svg' ) {
1164 $tags[] = '<title';
1165 }
1166
1167 foreach ( $tags as $tag ) {
1168 if ( false !== strpos( $chunk, $tag ) ) {
1169 wfDebug( __METHOD__ . ": found something that may make it be mistaken for html: $tag\n" );
1170
1171 return true;
1172 }
1173 }
1174
1175 /*
1176 * look for JavaScript
1177 */
1178
1179 # resolve entity-refs to look at attributes. may be harsh on big files... cache result?
1180 $chunk = Sanitizer::decodeCharReferences( $chunk );
1181
1182 # look for script-types
1183 if ( preg_match( '!type\s*=\s*[\'"]?\s*(?:\w*/)?(?:ecma|java)!sim', $chunk ) ) {
1184 wfDebug( __METHOD__ . ": found script types\n" );
1185
1186 return true;
1187 }
1188
1189 # look for html-style script-urls
1190 if ( preg_match( '!(?:href|src|data)\s*=\s*[\'"]?\s*(?:ecma|java)script:!sim', $chunk ) ) {
1191 wfDebug( __METHOD__ . ": found html-style script urls\n" );
1192
1193 return true;
1194 }
1195
1196 # look for css-style script-urls
1197 if ( preg_match( '!url\s*\‍(\s*[\'"]?\s*(?:ecma|java)script:!sim', $chunk ) ) {
1198 wfDebug( __METHOD__ . ": found css-style script urls\n" );
1199
1200 return true;
1201 }
1202
1203 wfDebug( __METHOD__ . ": no scripts found\n" );
1204
1205 return false;
1206 }
1207
1215 public static function checkXMLEncodingMissmatch( $file ) {
1217 $contents = file_get_contents( $file, false, null, -1, $wgSVGMetadataCutoff );
1218 $encodingRegex = '!encoding[ \t\n\r]*=[ \t\n\r]*[\'"](.*?)[\'"]!si';
1219
1220 if ( preg_match( "!<\?xml\b(.*?)\?>!si", $contents, $matches ) ) {
1221 if ( preg_match( $encodingRegex, $matches[1], $encMatch )
1222 && !in_array( strtoupper( $encMatch[1] ), self::$safeXmlEncodings )
1223 ) {
1224 wfDebug( __METHOD__ . ": Found unsafe XML encoding '{$encMatch[1]}'\n" );
1225
1226 return true;
1227 }
1228 } elseif ( preg_match( "!<\?xml\b!si", $contents ) ) {
1229 // Start of XML declaration without an end in the first $wgSVGMetadataCutoff
1230 // bytes. There shouldn't be a legitimate reason for this to happen.
1231 wfDebug( __METHOD__ . ": Unmatched XML declaration start\n" );
1232
1233 return true;
1234 } elseif ( substr( $contents, 0, 4 ) == "\x4C\x6F\xA7\x94" ) {
1235 // EBCDIC encoded XML
1236 wfDebug( __METHOD__ . ": EBCDIC Encoded XML\n" );
1237
1238 return true;
1239 }
1240
1241 // It's possible the file is encoded with multi-byte encoding, so re-encode attempt to
1242 // detect the encoding in case is specifies an encoding not whitelisted in self::$safeXmlEncodings
1243 $attemptEncodings = [ 'UTF-16', 'UTF-16BE', 'UTF-32', 'UTF-32BE' ];
1244 foreach ( $attemptEncodings as $encoding ) {
1245 MediaWiki\suppressWarnings();
1246 $str = iconv( $encoding, 'UTF-8', $contents );
1247 MediaWiki\restoreWarnings();
1248 if ( $str != '' && preg_match( "!<\?xml\b(.*?)\?>!si", $str, $matches ) ) {
1249 if ( preg_match( $encodingRegex, $matches[1], $encMatch )
1250 && !in_array( strtoupper( $encMatch[1] ), self::$safeXmlEncodings )
1251 ) {
1252 wfDebug( __METHOD__ . ": Found unsafe XML encoding '{$encMatch[1]}'\n" );
1253
1254 return true;
1255 }
1256 } elseif ( $str != '' && preg_match( "!<\?xml\b!si", $str ) ) {
1257 // Start of XML declaration without an end in the first $wgSVGMetadataCutoff
1258 // bytes. There shouldn't be a legitimate reason for this to happen.
1259 wfDebug( __METHOD__ . ": Unmatched XML declaration start\n" );
1260
1261 return true;
1262 }
1263 }
1264
1265 return false;
1266 }
1267
1273 protected function detectScriptInSvg( $filename, $partial ) {
1274 $this->mSVGNSError = false;
1275 $check = new XmlTypeCheck(
1276 $filename,
1277 [ $this, 'checkSvgScriptCallback' ],
1278 true,
1279 [
1280 'processing_instruction_handler' => 'UploadBase::checkSvgPICallback',
1281 'external_dtd_handler' => 'UploadBase::checkSvgExternalDTD',
1282 ]
1283 );
1284 if ( $check->wellFormed !== true ) {
1285 // Invalid xml (bug 58553)
1286 // But only when non-partial (bug 65724)
1287 return $partial ? false : [ 'uploadinvalidxml' ];
1288 } elseif ( $check->filterMatch ) {
1289 if ( $this->mSVGNSError ) {
1290 return [ 'uploadscriptednamespace', $this->mSVGNSError ];
1291 }
1292
1293 return $check->filterMatchType;
1294 }
1295
1296 return false;
1297 }
1298
1305 public static function checkSvgPICallback( $target, $data ) {
1306 // Don't allow external stylesheets (bug 57550)
1307 if ( preg_match( '/xml-stylesheet/i', $target ) ) {
1308 return [ 'upload-scripted-pi-callback' ];
1309 }
1310
1311 return false;
1312 }
1313
1324 public static function checkSvgExternalDTD( $type, $publicId, $systemId ) {
1325 // This doesn't include the XHTML+MathML+SVG doctype since we don't
1326 // allow XHTML anyways.
1327 $allowedDTDs = [
1328 'http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd',
1329 'http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd',
1330 'http://www.w3.org/Graphics/SVG/1.1/DTD/svg11-basic.dtd',
1331 'http://www.w3.org/Graphics/SVG/1.1/DTD/svg11-tiny.dtd',
1332 // https://phabricator.wikimedia.org/T168856
1333 'http://www.w3.org/TR/2001/PR-SVG-20010719/DTD/svg10.dtd',
1334 ];
1335 if ( $type !== 'PUBLIC'
1336 || !in_array( $systemId, $allowedDTDs )
1337 || strpos( $publicId, "-//W3C//" ) !== 0
1338 ) {
1339 return [ 'upload-scripted-dtd' ];
1340 }
1341 return false;
1342 }
1343
1350 public function checkSvgScriptCallback( $element, $attribs, $data = null ) {
1351
1352 list( $namespace, $strippedElement ) = $this->splitXmlNamespace( $element );
1353
1354 // We specifically don't include:
1355 // http://www.w3.org/1999/xhtml (bug 60771)
1356 static $validNamespaces = [
1357 '',
1358 'adobe:ns:meta/',
1359 'http://creativecommons.org/ns#',
1360 'http://inkscape.sourceforge.net/dtd/sodipodi-0.dtd',
1361 'http://ns.adobe.com/adobeillustrator/10.0/',
1362 'http://ns.adobe.com/adobesvgviewerextensions/3.0/',
1363 'http://ns.adobe.com/extensibility/1.0/',
1364 'http://ns.adobe.com/flows/1.0/',
1365 'http://ns.adobe.com/illustrator/1.0/',
1366 'http://ns.adobe.com/imagereplacement/1.0/',
1367 'http://ns.adobe.com/pdf/1.3/',
1368 'http://ns.adobe.com/photoshop/1.0/',
1369 'http://ns.adobe.com/saveforweb/1.0/',
1370 'http://ns.adobe.com/variables/1.0/',
1371 'http://ns.adobe.com/xap/1.0/',
1372 'http://ns.adobe.com/xap/1.0/g/',
1373 'http://ns.adobe.com/xap/1.0/g/img/',
1374 'http://ns.adobe.com/xap/1.0/mm/',
1375 'http://ns.adobe.com/xap/1.0/rights/',
1376 'http://ns.adobe.com/xap/1.0/stype/dimensions#',
1377 'http://ns.adobe.com/xap/1.0/stype/font#',
1378 'http://ns.adobe.com/xap/1.0/stype/manifestitem#',
1379 'http://ns.adobe.com/xap/1.0/stype/resourceevent#',
1380 'http://ns.adobe.com/xap/1.0/stype/resourceref#',
1381 'http://ns.adobe.com/xap/1.0/t/pg/',
1382 'http://purl.org/dc/elements/1.1/',
1383 'http://purl.org/dc/elements/1.1',
1384 'http://schemas.microsoft.com/visio/2003/svgextensions/',
1385 'http://sodipodi.sourceforge.net/dtd/sodipodi-0.dtd',
1386 'http://taptrix.com/inkpad/svg_extensions',
1387 'http://web.resource.org/cc/',
1388 'http://www.freesoftware.fsf.org/bkchem/cdml',
1389 'http://www.inkscape.org/namespaces/inkscape',
1390 'http://www.opengis.net/gml',
1391 'http://www.w3.org/1999/02/22-rdf-syntax-ns#',
1392 'http://www.w3.org/2000/svg',
1393 'http://www.w3.org/tr/rec-rdf-syntax/',
1394 ];
1395
1396 if ( !in_array( $namespace, $validNamespaces ) ) {
1397 wfDebug( __METHOD__ . ": Non-svg namespace '$namespace' in uploaded file.\n" );
1399 $this->mSVGNSError = $namespace;
1400
1401 return true;
1402 }
1403
1404 /*
1405 * check for elements that can contain javascript
1406 */
1407 if ( $strippedElement == 'script' ) {
1408 wfDebug( __METHOD__ . ": Found script element '$element' in uploaded file.\n" );
1409
1410 return [ 'uploaded-script-svg', $strippedElement ];
1411 }
1412
1413 # e.g., <svg xmlns="http://www.w3.org/2000/svg">
1414 # <handler xmlns:ev="http://www.w3.org/2001/xml-events" ev:event="load">alert(1)</handler> </svg>
1415 if ( $strippedElement == 'handler' ) {
1416 wfDebug( __METHOD__ . ": Found scriptable element '$element' in uploaded file.\n" );
1417
1418 return [ 'uploaded-script-svg', $strippedElement ];
1419 }
1420
1421 # SVG reported in Feb '12 that used xml:stylesheet to generate javascript block
1422 if ( $strippedElement == 'stylesheet' ) {
1423 wfDebug( __METHOD__ . ": Found scriptable element '$element' in uploaded file.\n" );
1424
1425 return [ 'uploaded-script-svg', $strippedElement ];
1426 }
1427
1428 # Block iframes, in case they pass the namespace check
1429 if ( $strippedElement == 'iframe' ) {
1430 wfDebug( __METHOD__ . ": iframe in uploaded file.\n" );
1431
1432 return [ 'uploaded-script-svg', $strippedElement ];
1433 }
1434
1435 # Check <style> css
1436 if ( $strippedElement == 'style'
1437 && self::checkCssFragment( Sanitizer::normalizeCss( $data ) )
1438 ) {
1439 wfDebug( __METHOD__ . ": hostile css in style element.\n" );
1440 return [ 'uploaded-hostile-svg' ];
1441 }
1442
1443 foreach ( $attribs as $attrib => $value ) {
1444 $stripped = $this->stripXmlNamespace( $attrib );
1445 $value = strtolower( $value );
1446
1447 if ( substr( $stripped, 0, 2 ) == 'on' ) {
1448 wfDebug( __METHOD__
1449 . ": Found event-handler attribute '$attrib'='$value' in uploaded file.\n" );
1450
1451 return [ 'uploaded-event-handler-on-svg', $attrib, $value ];
1452 }
1453
1454 # href with non-local target (don't allow http://, javascript:, etc)
1455 if ( $stripped == 'href'
1456 && strpos( $value, 'data:' ) !== 0
1457 && strpos( $value, '#' ) !== 0
1458 ) {
1459 if ( !( $strippedElement === 'a'
1460 && preg_match( '!^https?://!i', $value ) )
1461 ) {
1462 wfDebug( __METHOD__ . ": Found href attribute <$strippedElement "
1463 . "'$attrib'='$value' in uploaded file.\n" );
1464
1465 return [ 'uploaded-href-attribute-svg', $strippedElement, $attrib, $value ];
1466 }
1467 }
1468
1469 # only allow data: targets that should be safe. This prevents vectors like,
1470 # image/svg, text/xml, application/xml, and text/html, which can contain scripts
1471 if ( $stripped == 'href' && strncasecmp( 'data:', $value, 5 ) === 0 ) {
1472 // rfc2397 parameters. This is only slightly slower than (;[\w;]+)*.
1473 // @codingStandardsIgnoreStart Generic.Files.LineLength
1474 $parameters = '(?>;[a-zA-Z0-9\!#$&\'*+.^_`{|}~-]+=(?>[a-zA-Z0-9\!#$&\'*+.^_`{|}~-]+|"(?>[\0-\x0c\x0e-\x21\x23-\x5b\x5d-\x7f]+|\\\\[\0-\x7f])*"))*(?:;base64)?';
1475 // @codingStandardsIgnoreEnd
1476
1477 if ( !preg_match( "!^data:\s*image/(gif|jpeg|jpg|png)$parameters,!i", $value ) ) {
1478 wfDebug( __METHOD__ . ": Found href to unwhitelisted data: uri "
1479 . "\"<$strippedElement '$attrib'='$value'...\" in uploaded file.\n" );
1480 return [ 'uploaded-href-unsafe-target-svg', $strippedElement, $attrib, $value ];
1481 }
1482 }
1483
1484 # Change href with animate from (http://html5sec.org/#137).
1485 if ( $stripped === 'attributename'
1486 && $strippedElement === 'animate'
1487 && $this->stripXmlNamespace( $value ) == 'href'
1488 ) {
1489 wfDebug( __METHOD__ . ": Found animate that might be changing href using from "
1490 . "\"<$strippedElement '$attrib'='$value'...\" in uploaded file.\n" );
1491
1492 return [ 'uploaded-animate-svg', $strippedElement, $attrib, $value ];
1493 }
1494
1495 # use set/animate to add event-handler attribute to parent
1496 if ( ( $strippedElement == 'set' || $strippedElement == 'animate' )
1497 && $stripped == 'attributename'
1498 && substr( $value, 0, 2 ) == 'on'
1499 ) {
1500 wfDebug( __METHOD__ . ": Found svg setting event-handler attribute with "
1501 . "\"<$strippedElement $stripped='$value'...\" in uploaded file.\n" );
1502
1503 return [ 'uploaded-setting-event-handler-svg', $strippedElement, $stripped, $value ];
1504 }
1505
1506 # use set to add href attribute to parent element
1507 if ( $strippedElement == 'set'
1508 && $stripped == 'attributename'
1509 && strpos( $value, 'href' ) !== false
1510 ) {
1511 wfDebug( __METHOD__ . ": Found svg setting href attribute '$value' in uploaded file.\n" );
1512
1513 return [ 'uploaded-setting-href-svg' ];
1514 }
1515
1516 # use set to add a remote / data / script target to an element
1517 if ( $strippedElement == 'set'
1518 && $stripped == 'to'
1519 && preg_match( '!(http|https|data|script):!sim', $value )
1520 ) {
1521 wfDebug( __METHOD__ . ": Found svg setting attribute to '$value' in uploaded file.\n" );
1522
1523 return [ 'uploaded-wrong-setting-svg', $value ];
1524 }
1525
1526 # use handler attribute with remote / data / script
1527 if ( $stripped == 'handler' && preg_match( '!(http|https|data|script):!sim', $value ) ) {
1528 wfDebug( __METHOD__ . ": Found svg setting handler with remote/data/script "
1529 . "'$attrib'='$value' in uploaded file.\n" );
1530
1531 return [ 'uploaded-setting-handler-svg', $attrib, $value ];
1532 }
1533
1534 # use CSS styles to bring in remote code
1535 if ( $stripped == 'style'
1536 && self::checkCssFragment( Sanitizer::normalizeCss( $value ) )
1537 ) {
1538 wfDebug( __METHOD__ . ": Found svg setting a style with "
1539 . "remote url '$attrib'='$value' in uploaded file.\n" );
1540 return [ 'uploaded-remote-url-svg', $attrib, $value ];
1541 }
1542
1543 # Several attributes can include css, css character escaping isn't allowed
1544 $cssAttrs = [ 'font', 'clip-path', 'fill', 'filter', 'marker',
1545 'marker-end', 'marker-mid', 'marker-start', 'mask', 'stroke' ];
1546 if ( in_array( $stripped, $cssAttrs )
1547 && self::checkCssFragment( $value )
1548 ) {
1549 wfDebug( __METHOD__ . ": Found svg setting a style with "
1550 . "remote url '$attrib'='$value' in uploaded file.\n" );
1551 return [ 'uploaded-remote-url-svg', $attrib, $value ];
1552 }
1553
1554 # image filters can pull in url, which could be svg that executes scripts
1555 if ( $strippedElement == 'image'
1556 && $stripped == 'filter'
1557 && preg_match( '!url\s*\‍(!sim', $value )
1558 ) {
1559 wfDebug( __METHOD__ . ": Found image filter with url: "
1560 . "\"<$strippedElement $stripped='$value'...\" in uploaded file.\n" );
1561
1562 return [ 'uploaded-image-filter-svg', $strippedElement, $stripped, $value ];
1563 }
1564 }
1565
1566 return false; // No scripts detected
1567 }
1568
1576 private static function checkCssFragment( $value ) {
1577
1578 # Forbid external stylesheets, for both reliability and to protect viewer's privacy
1579 if ( stripos( $value, '@import' ) !== false ) {
1580 return true;
1581 }
1582
1583 # We allow @font-face to embed fonts with data: urls, so we snip the string
1584 # 'url' out so this case won't match when we check for urls below
1585 $pattern = '!(@font-face\s*{[^}]*src:)url(\‍("data:;base64,)!im';
1586 $value = preg_replace( $pattern, '$1$2', $value );
1587
1588 # Check for remote and executable CSS. Unlike in Sanitizer::checkCss, the CSS
1589 # properties filter and accelerator don't seem to be useful for xss in SVG files.
1590 # Expression and -o-link don't seem to work either, but filtering them here in case.
1591 # Additionally, we catch remote urls like url("http:..., url('http:..., url(http:...,
1592 # but not local ones such as url("#..., url('#..., url(#....
1593 if ( preg_match( '!expression
1594 | -o-link\s*:
1595 | -o-link-source\s*:
1596 | -o-replace\s*:!imx', $value ) ) {
1597 return true;
1598 }
1599
1600 if ( preg_match_all(
1601 "!(\s*(url|image|image-set)\s*\‍(\s*[\"']?\s*[^#]+.*?\‍))!sim",
1602 $value,
1603 $matches
1604 ) !== 0
1605 ) {
1606 # TODO: redo this in one regex. Until then, url("#whatever") matches the first
1607 foreach ( $matches[1] as $match ) {
1608 if ( !preg_match( "!\s*(url|image|image-set)\s*\‍(\s*(#|'#|\"#)!im", $match ) ) {
1609 return true;
1610 }
1611 }
1612 }
1613
1614 if ( preg_match( '/[\000-\010\013\016-\037\177]/', $value ) ) {
1615 return true;
1616 }
1617
1618 return false;
1619 }
1620
1626 private static function splitXmlNamespace( $element ) {
1627 // 'http://www.w3.org/2000/svg:script' -> array( 'http://www.w3.org/2000/svg', 'script' )
1628 $parts = explode( ':', strtolower( $element ) );
1629 $name = array_pop( $parts );
1630 $ns = implode( ':', $parts );
1631
1632 return [ $ns, $name ];
1633 }
1634
1639 private function stripXmlNamespace( $name ) {
1640 // 'http://www.w3.org/2000/svg:script' -> 'script'
1641 $parts = explode( ':', strtolower( $name ) );
1642
1643 return array_pop( $parts );
1644 }
1645
1656 public static function detectVirus( $file ) {
1658
1659 if ( !$wgAntivirus ) {
1660 wfDebug( __METHOD__ . ": virus scanner disabled\n" );
1661
1662 return null;
1663 }
1664
1666 wfDebug( __METHOD__ . ": unknown virus scanner: $wgAntivirus\n" );
1667 $wgOut->wrapWikiMsg( "<div class=\"error\">\n$1\n</div>",
1668 [ 'virus-badscanner', $wgAntivirus ] );
1669
1670 return wfMessage( 'virus-unknownscanner' )->text() . " $wgAntivirus";
1671 }
1672
1673 # look up scanner configuration
1675 $exitCodeMap = $wgAntivirusSetup[$wgAntivirus]['codemap'];
1676 $msgPattern = isset( $wgAntivirusSetup[$wgAntivirus]['messagepattern'] ) ?
1677 $wgAntivirusSetup[$wgAntivirus]['messagepattern'] : null;
1678
1679 if ( strpos( $command, "%f" ) === false ) {
1680 # simple pattern: append file to scan
1681 $command .= " " . wfEscapeShellArg( $file );
1682 } else {
1683 # complex pattern: replace "%f" with file to scan
1684 $command = str_replace( "%f", wfEscapeShellArg( $file ), $command );
1685 }
1686
1687 wfDebug( __METHOD__ . ": running virus scan: $command \n" );
1688
1689 # execute virus scanner
1690 $exitCode = false;
1691
1692 # NOTE: there's a 50 line workaround to make stderr redirection work on windows, too.
1693 # that does not seem to be worth the pain.
1694 # Ask me (Duesentrieb) about it if it's ever needed.
1695 $output = wfShellExecWithStderr( $command, $exitCode );
1696
1697 # map exit code to AV_xxx constants.
1698 $mappedCode = $exitCode;
1699 if ( $exitCodeMap ) {
1700 if ( isset( $exitCodeMap[$exitCode] ) ) {
1701 $mappedCode = $exitCodeMap[$exitCode];
1702 } elseif ( isset( $exitCodeMap["*"] ) ) {
1703 $mappedCode = $exitCodeMap["*"];
1704 }
1705 }
1706
1707 /* NB: AV_NO_VIRUS is 0 but AV_SCAN_FAILED is false,
1708 * so we need the strict equalities === and thus can't use a switch here
1709 */
1710 if ( $mappedCode === AV_SCAN_FAILED ) {
1711 # scan failed (code was mapped to false by $exitCodeMap)
1712 wfDebug( __METHOD__ . ": failed to scan $file (code $exitCode).\n" );
1713
1715 ? wfMessage( 'virus-scanfailed', [ $exitCode ] )->text()
1716 : null;
1717 } elseif ( $mappedCode === AV_SCAN_ABORTED ) {
1718 # scan failed because filetype is unknown (probably imune)
1719 wfDebug( __METHOD__ . ": unsupported file type $file (code $exitCode).\n" );
1720 $output = null;
1721 } elseif ( $mappedCode === AV_NO_VIRUS ) {
1722 # no virus found
1723 wfDebug( __METHOD__ . ": file passed virus scan.\n" );
1724 $output = false;
1725 } else {
1726 $output = trim( $output );
1727
1728 if ( !$output ) {
1729 $output = true; # if there's no output, return true
1730 } elseif ( $msgPattern ) {
1731 $groups = [];
1732 if ( preg_match( $msgPattern, $output, $groups ) ) {
1733 if ( $groups[1] ) {
1734 $output = $groups[1];
1735 }
1736 }
1737 }
1738
1739 wfDebug( __METHOD__ . ": FOUND VIRUS! scanner feedback: $output \n" );
1740 }
1741
1742 return $output;
1743 }
1744
1753 private function checkOverwrite( $user ) {
1754 // First check whether the local file can be overwritten
1755 $file = $this->getLocalFile();
1756 $file->load( File::READ_LATEST );
1757 if ( $file->exists() ) {
1758 if ( !self::userCanReUpload( $user, $file ) ) {
1759 return [ 'fileexists-forbidden', $file->getName() ];
1760 } else {
1761 return true;
1762 }
1763 }
1764
1765 /* Check shared conflicts: if the local file does not exist, but
1766 * wfFindFile finds a file, it exists in a shared repository.
1767 */
1768 $file = wfFindFile( $this->getTitle(), [ 'latest' => true ] );
1769 if ( $file && !$user->isAllowed( 'reupload-shared' ) ) {
1770 return [ 'fileexists-shared-forbidden', $file->getName() ];
1771 }
1772
1773 return true;
1774 }
1775
1783 public static function userCanReUpload( User $user, File $img ) {
1784 if ( $user->isAllowed( 'reupload' ) ) {
1785 return true; // non-conditional
1786 } elseif ( !$user->isAllowed( 'reupload-own' ) ) {
1787 return false;
1788 }
1789
1790 if ( !( $img instanceof LocalFile ) ) {
1791 return false;
1792 }
1793
1794 $img->load();
1795
1796 return $user->getId() == $img->getUser( 'id' );
1797 }
1798
1810 public static function getExistsWarning( $file ) {
1811 if ( $file->exists() ) {
1812 return [ 'warning' => 'exists', 'file' => $file ];
1813 }
1814
1815 if ( $file->getTitle()->getArticleID() ) {
1816 return [ 'warning' => 'page-exists', 'file' => $file ];
1817 }
1818
1819 if ( strpos( $file->getName(), '.' ) == false ) {
1820 $partname = $file->getName();
1821 $extension = '';
1822 } else {
1823 $n = strrpos( $file->getName(), '.' );
1824 $extension = substr( $file->getName(), $n + 1 );
1825 $partname = substr( $file->getName(), 0, $n );
1826 }
1827 $normalizedExtension = File::normalizeExtension( $extension );
1828
1829 if ( $normalizedExtension != $extension ) {
1830 // We're not using the normalized form of the extension.
1831 // Normal form is lowercase, using most common of alternate
1832 // extensions (eg 'jpg' rather than 'JPEG').
1833
1834 // Check for another file using the normalized form...
1835 $nt_lc = Title::makeTitle( NS_FILE, "{$partname}.{$normalizedExtension}" );
1836 $file_lc = wfLocalFile( $nt_lc );
1837
1838 if ( $file_lc->exists() ) {
1839 return [
1840 'warning' => 'exists-normalized',
1841 'file' => $file,
1842 'normalizedFile' => $file_lc
1843 ];
1844 }
1845 }
1846
1847 // Check for files with the same name but a different extension
1848 $similarFiles = RepoGroup::singleton()->getLocalRepo()->findFilesByPrefix(
1849 "{$partname}.", 1 );
1850 if ( count( $similarFiles ) ) {
1851 return [
1852 'warning' => 'exists-normalized',
1853 'file' => $file,
1854 'normalizedFile' => $similarFiles[0],
1855 ];
1856 }
1857
1858 if ( self::isThumbName( $file->getName() ) ) {
1859 # Check for filenames like 50px- or 180px-, these are mostly thumbnails
1860 $nt_thb = Title::newFromText(
1861 substr( $partname, strpos( $partname, '-' ) + 1 ) . '.' . $extension,
1862 NS_FILE
1863 );
1864 $file_thb = wfLocalFile( $nt_thb );
1865 if ( $file_thb->exists() ) {
1866 return [
1867 'warning' => 'thumb',
1868 'file' => $file,
1869 'thumbFile' => $file_thb
1870 ];
1871 } else {
1872 // File does not exist, but we just don't like the name
1873 return [
1874 'warning' => 'thumb-name',
1875 'file' => $file,
1876 'thumbFile' => $file_thb
1877 ];
1878 }
1879 }
1880
1881 foreach ( self::getFilenamePrefixBlacklist() as $prefix ) {
1882 if ( substr( $partname, 0, strlen( $prefix ) ) == $prefix ) {
1883 return [
1884 'warning' => 'bad-prefix',
1885 'file' => $file,
1886 'prefix' => $prefix
1887 ];
1888 }
1889 }
1890
1891 return false;
1892 }
1893
1899 public static function isThumbName( $filename ) {
1900 $n = strrpos( $filename, '.' );
1901 $partname = $n ? substr( $filename, 0, $n ) : $filename;
1902
1903 return (
1904 substr( $partname, 3, 3 ) == 'px-' ||
1905 substr( $partname, 2, 3 ) == 'px-'
1906 ) &&
1907 preg_match( "/[0-9]{2}/", substr( $partname, 0, 2 ) );
1908 }
1909
1915 public static function getFilenamePrefixBlacklist() {
1916 $blacklist = [];
1917 $message = wfMessage( 'filename-prefix-blacklist' )->inContentLanguage();
1918 if ( !$message->isDisabled() ) {
1919 $lines = explode( "\n", $message->plain() );
1920 foreach ( $lines as $line ) {
1921 // Remove comment lines
1922 $comment = substr( trim( $line ), 0, 1 );
1923 if ( $comment == '#' || $comment == '' ) {
1924 continue;
1925 }
1926 // Remove additional comments after a prefix
1927 $comment = strpos( $line, '#' );
1928 if ( $comment > 0 ) {
1929 $line = substr( $line, 0, $comment - 1 );
1930 }
1931 $blacklist[] = trim( $line );
1932 }
1933 }
1934
1935 return $blacklist;
1936 }
1937
1949 public function getImageInfo( $result ) {
1950 $file = $this->getLocalFile();
1956 if ( $file instanceof UploadStashFile ) {
1958 $info = ApiQueryStashImageInfo::getInfo( $file, array_flip( $imParam ), $result );
1959 } else {
1961 $info = ApiQueryImageInfo::getInfo( $file, array_flip( $imParam ), $result );
1962 }
1963
1964 return $info;
1965 }
1966
1971 public function convertVerifyErrorToStatus( $error ) {
1972 $code = $error['status'];
1973 unset( $code['status'] );
1974
1975 return Status::newFatal( $this->getVerificationErrorCode( $code ), $error );
1976 }
1977
1985 public static function getMaxUploadSize( $forType = null ) {
1987
1988 if ( is_array( $wgMaxUploadSize ) ) {
1989 if ( !is_null( $forType ) && isset( $wgMaxUploadSize[$forType] ) ) {
1990 return $wgMaxUploadSize[$forType];
1991 } else {
1992 return $wgMaxUploadSize['*'];
1993 }
1994 } else {
1995 return intval( $wgMaxUploadSize );
1996 }
1997 }
1998
2006 public static function getMaxPhpUploadSize() {
2007 $phpMaxFileSize = wfShorthandToInteger(
2008 ini_get( 'upload_max_filesize' ) ?: ini_get( 'hhvm.server.upload.upload_max_file_size' ),
2009 PHP_INT_MAX
2010 );
2011 $phpMaxPostSize = wfShorthandToInteger(
2012 ini_get( 'post_max_size' ) ?: ini_get( 'hhvm.server.max_post_size' ),
2013 PHP_INT_MAX
2014 ) ?: PHP_INT_MAX;
2015 return min( $phpMaxFileSize, $phpMaxPostSize );
2016 }
2017
2027 public static function getSessionStatus( User $user, $statusKey ) {
2028 $key = wfMemcKey( 'uploadstatus', $user->getId() ?: md5( $user->getName() ), $statusKey );
2029
2030 return ObjectCache::getMainStashInstance()->get( $key );
2031 }
2032
2043 public static function setSessionStatus( User $user, $statusKey, $value ) {
2044 $key = wfMemcKey( 'uploadstatus', $user->getId() ?: md5( $user->getName() ), $statusKey );
2045
2047 if ( $value === false ) {
2048 $cache->delete( $key );
2049 } else {
2050 $cache->set( $key, $value, $cache::TTL_DAY );
2051 }
2052 }
2053}
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
$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
Uploads have to be specially set up to be secure.
$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.
$wgUploadThumbnailRenderMap
When defined, is an array of thumbnail widths to be rendered at upload time.
$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.
wfIniGetBool( $setting)
Safety wrapper around ini_get() for boolean settings.
wfLocalFile( $title)
Get an object referring to a locally registered file.
wfMemcKey()
Make a cache key for the local wiki.
wfEscapeShellArg()
Windows-compatible version of escapeshellarg() Windows doesn't recognise single-quotes in the shell,...
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 - Additional characters can be defined in $wgIllegalFileChars (se...
wfShorthandToInteger( $string='', $default=-1)
Converts shorthand byte notation to integer form.
wfIsHHVM()
Check if we are running under HHVM.
$i
Definition Parser.php:1694
$wgOut
Definition Setup.php:804
$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:275
static getPropsFromPath( $path, $ext=true)
Get an associative array containing information about a file in the local filesystem.
Definition FSFile.php:259
static isStoragePath( $path)
Check if a given path is a "mwstore://" path.
const DELETE_SOURCE
Definition File.php:65
const DELETED_FILE
Definition File.php:52
getName()
Returns the name of the action this object responds to.
static singleton( $wiki=false)
MediaWiki exception.
static getHandler( $type)
Get a MediaHandler for a given MIME type from the instance cache.
static getMainStashInstance()
Get the cache object for the main stash.
static singleton()
Get a RepoGroup instance.
Definition RepoGroup.php:59
static decodeCharReferences( $text)
Decode any character references, numeric or named entities, in the text and return a UTF-8 string.
static normalizeCss( $value)
Normalize CSS into a format we can easily search for hostile input.
This class is used to hold the location and do limited manipulation of files stored temporarily (this...
Job for asynchronous rendering of thumbnails.
static & makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition Title.php:524
static capitalize( $text, $ns=NS_MAIN)
Capitalize a text string for a title if it belongs to a namespace that capitalizes.
Definition Title.php:3362
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition Title.php:277
static makeTitleSafe( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition Title.php:548
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)
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)
$mBlackListedExtensions
getRealPath( $srcPath)
static createFromRequest(&$request, $type=null)
Create a form of UploadBase depending on wpSourceType and initializes it.
verifyPermissions( $user)
Alias for verifyTitlePermissions.
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]].
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
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.
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
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.
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...
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.
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition User.php:47
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
when a variable name is used in a function
Definition design.txt:94
when a variable name is used in a it is silently declared as a new local masking the global
Definition design.txt:95
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as $wgLang
Definition design.txt:56
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:142
const NS_FILE
Definition Defines.php:76
const AV_SCAN_ABORTED
Definition Defines.php:141
const AV_NO_VIRUS
Definition Defines.php:139
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set $status
Definition hooks.txt:1007
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object & $output
Definition hooks.txt:1048
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:249
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:1819
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Associative array mapping language codes to prefixed links of the form "language:title". & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition hooks.txt:1799
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to 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
null means default in associative array form
Definition hooks.txt:1802
you don t have to do a grep find to see where the $wgReverseTitle variable is used
Definition hooks.txt:117
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached one of or reset my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled allows for interception of redirect as a string mapping parameter names to values & $type
Definition hooks.txt:2413
namespace and then decline to actually register it file or subcat img or subcat $title
Definition hooks.txt:944
null for the local wiki Added in
Definition hooks.txt:1421
error also a ContextSource you ll probably need to make sure the header is varied on $request
Definition hooks.txt:2530
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books $tag
Definition hooks.txt:991
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached one of or reset my talk page
Definition hooks.txt:2388
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:108
Allows to change the fields on the form that will be generated $name
Definition hooks.txt:314
processing should stop and the error should be shown to the user * false
Definition hooks.txt:189
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:885
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:847
$comment
$extensions
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
#define the
table suitable for use with IDatabase::select()
if( $ext=='php'|| $ext=='php5') $mime
Definition router.php:65
$lines
Definition router.php:66