MediaWiki  master
FileRepo.php
Go to the documentation of this file.
1 <?php
11 
39 class FileRepo {
40  const DELETE_SOURCE = 1;
41  const OVERWRITE = 2;
42  const OVERWRITE_SAME = 4;
43  const SKIP_LOCKING = 8;
44 
45  const NAME_AND_TIME_ONLY = 1;
46 
50 
53 
55  protected $hasSha1Storage = false;
56 
58  protected $supportsSha1URLs = false;
59 
61  protected $backend;
62 
64  protected $zones = [];
65 
67  protected $thumbScriptUrl;
68 
71  protected $transformVia404;
72 
76  protected $descBaseUrl;
77 
81  protected $scriptDirUrl;
82 
84  protected $articleUrl;
85 
91  protected $initialCapital;
92 
98  protected $pathDisclosureProtection = 'simple';
99 
101  protected $url;
102 
104  protected $thumbUrl;
105 
107  protected $hashLevels;
108 
111 
116  protected $abbrvThreshold;
117 
119  protected $favicon;
120 
122  protected $isPrivate;
123 
125  protected $fileFactory = [ UnregisteredLocalFile::class, 'newFromTitle' ];
127  protected $oldFileFactory = false;
129  protected $fileFactoryKey = false;
131  protected $oldFileFactoryKey = false;
132 
136  protected $thumbProxyUrl;
138  protected $thumbProxySecret;
139 
141  protected $wanCache;
142 
147  public function __construct( array $info = null ) {
148  // Verify required settings presence
149  if (
150  $info === null
151  || !array_key_exists( 'name', $info )
152  || !array_key_exists( 'backend', $info )
153  ) {
154  throw new MWException( __CLASS__ .
155  " requires an array of options having both 'name' and 'backend' keys.\n" );
156  }
157 
158  // Required settings
159  $this->name = $info['name'];
160  if ( $info['backend'] instanceof FileBackend ) {
161  $this->backend = $info['backend']; // useful for testing
162  } else {
163  $this->backend = FileBackendGroup::singleton()->get( $info['backend'] );
164  }
165 
166  // Optional settings that can have no value
167  $optionalSettings = [
168  'descBaseUrl', 'scriptDirUrl', 'articleUrl', 'fetchDescription',
169  'thumbScriptUrl', 'pathDisclosureProtection', 'descriptionCacheExpiry',
170  'favicon', 'thumbProxyUrl', 'thumbProxySecret',
171  ];
172  foreach ( $optionalSettings as $var ) {
173  if ( isset( $info[$var] ) ) {
174  $this->$var = $info[$var];
175  }
176  }
177 
178  // Optional settings that have a default
179  $this->initialCapital = $info['initialCapital'] ?? MWNamespace::isCapitalized( NS_FILE );
180  $this->url = $info['url'] ?? false; // a subclass may set the URL (e.g. ForeignAPIRepo)
181  if ( isset( $info['thumbUrl'] ) ) {
182  $this->thumbUrl = $info['thumbUrl'];
183  } else {
184  $this->thumbUrl = $this->url ? "{$this->url}/thumb" : false;
185  }
186  $this->hashLevels = $info['hashLevels'] ?? 2;
187  $this->deletedHashLevels = $info['deletedHashLevels'] ?? $this->hashLevels;
188  $this->transformVia404 = !empty( $info['transformVia404'] );
189  $this->abbrvThreshold = $info['abbrvThreshold'] ?? 255;
190  $this->isPrivate = !empty( $info['isPrivate'] );
191  // Give defaults for the basic zones...
192  $this->zones = $info['zones'] ?? [];
193  foreach ( [ 'public', 'thumb', 'transcoded', 'temp', 'deleted' ] as $zone ) {
194  if ( !isset( $this->zones[$zone]['container'] ) ) {
195  $this->zones[$zone]['container'] = "{$this->name}-{$zone}";
196  }
197  if ( !isset( $this->zones[$zone]['directory'] ) ) {
198  $this->zones[$zone]['directory'] = '';
199  }
200  if ( !isset( $this->zones[$zone]['urlsByExt'] ) ) {
201  $this->zones[$zone]['urlsByExt'] = [];
202  }
203  }
204 
205  $this->supportsSha1URLs = !empty( $info['supportsSha1URLs'] );
206 
207  $this->wanCache = $info['wanCache'] ?? WANObjectCache::newEmpty();
208  }
209 
215  public function getBackend() {
216  return $this->backend;
217  }
218 
225  public function getReadOnlyReason() {
226  return $this->backend->getReadOnlyReason();
227  }
228 
236  protected function initZones( $doZones = [] ) {
237  $status = $this->newGood();
238  foreach ( (array)$doZones as $zone ) {
239  $root = $this->getZonePath( $zone );
240  if ( $root === null ) {
241  throw new MWException( "No '$zone' zone defined in the {$this->name} repo." );
242  }
243  }
244 
245  return $status;
246  }
247 
254  public static function isVirtualUrl( $url ) {
255  return substr( $url, 0, 9 ) == 'mwrepo://';
256  }
257 
266  public function getVirtualUrl( $suffix = false ) {
267  $path = 'mwrepo://' . $this->name;
268  if ( $suffix !== false ) {
269  $path .= '/' . rawurlencode( $suffix );
270  }
271 
272  return $path;
273  }
274 
282  public function getZoneUrl( $zone, $ext = null ) {
283  if ( in_array( $zone, [ 'public', 'thumb', 'transcoded' ] ) ) {
284  // standard public zones
285  if ( $ext !== null && isset( $this->zones[$zone]['urlsByExt'][$ext] ) ) {
286  // custom URL for extension/zone
287  return $this->zones[$zone]['urlsByExt'][$ext];
288  } elseif ( isset( $this->zones[$zone]['url'] ) ) {
289  // custom URL for zone
290  return $this->zones[$zone]['url'];
291  }
292  }
293  switch ( $zone ) {
294  case 'public':
295  return $this->url;
296  case 'temp':
297  case 'deleted':
298  return false; // no public URL
299  case 'thumb':
300  return $this->thumbUrl;
301  case 'transcoded':
302  return "{$this->url}/transcoded";
303  default:
304  return false;
305  }
306  }
307 
311  public function backendSupportsUnicodePaths() {
312  return (bool)( $this->getBackend()->getFeatures() & FileBackend::ATTR_UNICODE_PATHS );
313  }
314 
323  public function resolveVirtualUrl( $url ) {
324  if ( substr( $url, 0, 9 ) != 'mwrepo://' ) {
325  throw new MWException( __METHOD__ . ': unknown protocol' );
326  }
327  $bits = explode( '/', substr( $url, 9 ), 3 );
328  if ( count( $bits ) != 3 ) {
329  throw new MWException( __METHOD__ . ": invalid mwrepo URL: $url" );
330  }
331  list( $repo, $zone, $rel ) = $bits;
332  if ( $repo !== $this->name ) {
333  throw new MWException( __METHOD__ . ": fetching from a foreign repo is not supported" );
334  }
335  $base = $this->getZonePath( $zone );
336  if ( !$base ) {
337  throw new MWException( __METHOD__ . ": invalid zone: $zone" );
338  }
339 
340  return $base . '/' . rawurldecode( $rel );
341  }
342 
349  protected function getZoneLocation( $zone ) {
350  if ( !isset( $this->zones[$zone] ) ) {
351  return [ null, null ]; // bogus
352  }
353 
354  return [ $this->zones[$zone]['container'], $this->zones[$zone]['directory'] ];
355  }
356 
363  public function getZonePath( $zone ) {
364  list( $container, $base ) = $this->getZoneLocation( $zone );
365  if ( $container === null || $base === null ) {
366  return null;
367  }
368  $backendName = $this->backend->getName();
369  if ( $base != '' ) { // may not be set
370  $base = "/{$base}";
371  }
372 
373  return "mwstore://$backendName/{$container}{$base}";
374  }
375 
387  public function newFile( $title, $time = false ) {
389  if ( !$title ) {
390  return null;
391  }
392  if ( $time ) {
393  if ( $this->oldFileFactory ) {
394  return call_user_func( $this->oldFileFactory, $title, $this, $time );
395  } else {
396  return null;
397  }
398  } else {
399  return call_user_func( $this->fileFactory, $title, $this );
400  }
401  }
402 
420  public function findFile( $title, $options = [] ) {
422  if ( !$title ) {
423  return false;
424  }
425  if ( isset( $options['bypassCache'] ) ) {
426  $options['latest'] = $options['bypassCache']; // b/c
427  }
428  $time = $options['time'] ?? false;
429  $flags = !empty( $options['latest'] ) ? File::READ_LATEST : 0;
430  # First try the current version of the file to see if it precedes the timestamp
431  $img = $this->newFile( $title );
432  if ( !$img ) {
433  return false;
434  }
435  $img->load( $flags );
436  if ( $img->exists() && ( !$time || $img->getTimestamp() == $time ) ) {
437  return $img;
438  }
439  # Now try an old version of the file
440  if ( $time !== false ) {
441  $img = $this->newFile( $title, $time );
442  if ( $img ) {
443  $img->load( $flags );
444  if ( $img->exists() ) {
445  if ( !$img->isDeleted( File::DELETED_FILE ) ) {
446  return $img; // always OK
447  } elseif ( !empty( $options['private'] ) &&
448  $img->userCan( File::DELETED_FILE,
449  $options['private'] instanceof User ? $options['private'] : null
450  )
451  ) {
452  return $img;
453  }
454  }
455  }
456  }
457 
458  # Now try redirects
459  if ( !empty( $options['ignoreRedirect'] ) ) {
460  return false;
461  }
462  $redir = $this->checkRedirect( $title );
463  if ( $redir && $title->getNamespace() == NS_FILE ) {
464  $img = $this->newFile( $redir );
465  if ( !$img ) {
466  return false;
467  }
468  $img->load( $flags );
469  if ( $img->exists() ) {
470  $img->redirectedFrom( $title->getDBkey() );
471 
472  return $img;
473  }
474  }
475 
476  return false;
477  }
478 
496  public function findFiles( array $items, $flags = 0 ) {
497  $result = [];
498  foreach ( $items as $item ) {
499  if ( is_array( $item ) ) {
500  $title = $item['title'];
501  $options = $item;
502  unset( $options['title'] );
503  } else {
504  $title = $item;
505  $options = [];
506  }
507  $file = $this->findFile( $title, $options );
508  if ( $file ) {
509  $searchName = File::normalizeTitle( $title )->getDBkey(); // must be valid
510  if ( $flags & self::NAME_AND_TIME_ONLY ) {
511  $result[$searchName] = [
512  'title' => $file->getTitle()->getDBkey(),
513  'timestamp' => $file->getTimestamp()
514  ];
515  } else {
516  $result[$searchName] = $file;
517  }
518  }
519  }
520 
521  return $result;
522  }
523 
533  public function findFileFromKey( $sha1, $options = [] ) {
534  $time = $options['time'] ?? false;
535  # First try to find a matching current version of a file...
536  if ( !$this->fileFactoryKey ) {
537  return false; // find-by-sha1 not supported
538  }
539  $img = call_user_func( $this->fileFactoryKey, $sha1, $this, $time );
540  if ( $img && $img->exists() ) {
541  return $img;
542  }
543  # Now try to find a matching old version of a file...
544  if ( $time !== false && $this->oldFileFactoryKey ) { // find-by-sha1 supported?
545  $img = call_user_func( $this->oldFileFactoryKey, $sha1, $this, $time );
546  if ( $img && $img->exists() ) {
547  if ( !$img->isDeleted( File::DELETED_FILE ) ) {
548  return $img; // always OK
549  } elseif ( !empty( $options['private'] ) &&
550  $img->userCan( File::DELETED_FILE,
551  $options['private'] instanceof User ? $options['private'] : null
552  )
553  ) {
554  return $img;
555  }
556  }
557  }
558 
559  return false;
560  }
561 
570  public function findBySha1( $hash ) {
571  return [];
572  }
573 
581  public function findBySha1s( array $hashes ) {
582  $result = [];
583  foreach ( $hashes as $hash ) {
584  $files = $this->findBySha1( $hash );
585  if ( count( $files ) ) {
586  $result[$hash] = $files;
587  }
588  }
589 
590  return $result;
591  }
592 
601  public function findFilesByPrefix( $prefix, $limit ) {
602  return [];
603  }
604 
610  public function getThumbScriptUrl() {
611  return $this->thumbScriptUrl;
612  }
613 
619  public function getThumbProxyUrl() {
620  return $this->thumbProxyUrl;
621  }
622 
628  public function getThumbProxySecret() {
630  }
631 
637  public function canTransformVia404() {
638  return $this->transformVia404;
639  }
640 
647  public function getNameFromTitle( Title $title ) {
648  if ( $this->initialCapital != MWNamespace::isCapitalized( NS_FILE ) ) {
649  $name = $title->getUserCaseDBKey();
650  if ( $this->initialCapital ) {
651  $name = MediaWikiServices::getInstance()->getContentLanguage()->ucfirst( $name );
652  }
653  } else {
654  $name = $title->getDBkey();
655  }
656 
657  return $name;
658  }
659 
665  public function getRootDirectory() {
666  return $this->getZonePath( 'public' );
667  }
668 
676  public function getHashPath( $name ) {
677  return self::getHashPathForLevel( $name, $this->hashLevels );
678  }
679 
687  public function getTempHashPath( $suffix ) {
688  $parts = explode( '!', $suffix, 2 ); // format is <timestamp>!<name> or just <name>
689  $name = $parts[1] ?? $suffix; // hash path is not based on timestamp
690  return self::getHashPathForLevel( $name, $this->hashLevels );
691  }
692 
698  protected static function getHashPathForLevel( $name, $levels ) {
699  if ( $levels == 0 ) {
700  return '';
701  } else {
702  $hash = md5( $name );
703  $path = '';
704  for ( $i = 1; $i <= $levels; $i++ ) {
705  $path .= substr( $hash, 0, $i ) . '/';
706  }
707 
708  return $path;
709  }
710  }
711 
717  public function getHashLevels() {
718  return $this->hashLevels;
719  }
720 
726  public function getName() {
727  return $this->name;
728  }
729 
737  public function makeUrl( $query = '', $entry = 'index' ) {
738  if ( isset( $this->scriptDirUrl ) ) {
739  return wfAppendQuery( "{$this->scriptDirUrl}/{$entry}.php", $query );
740  }
741 
742  return false;
743  }
744 
757  public function getDescriptionUrl( $name ) {
758  $encName = wfUrlencode( $name );
759  if ( !is_null( $this->descBaseUrl ) ) {
760  # "http://example.com/wiki/File:"
761  return $this->descBaseUrl . $encName;
762  }
763  if ( !is_null( $this->articleUrl ) ) {
764  # "http://example.com/wiki/$1"
765  # We use "Image:" as the canonical namespace for
766  # compatibility across all MediaWiki versions.
767  return str_replace( '$1',
768  "Image:$encName", $this->articleUrl );
769  }
770  if ( !is_null( $this->scriptDirUrl ) ) {
771  # "http://example.com/w"
772  # We use "Image:" as the canonical namespace for
773  # compatibility across all MediaWiki versions,
774  # and just sort of hope index.php is right. ;)
775  return $this->makeUrl( "title=Image:$encName" );
776  }
777 
778  return false;
779  }
780 
791  public function getDescriptionRenderUrl( $name, $lang = null ) {
792  $query = 'action=render';
793  if ( !is_null( $lang ) ) {
794  $query .= '&uselang=' . urlencode( $lang );
795  }
796  if ( isset( $this->scriptDirUrl ) ) {
797  return $this->makeUrl(
798  'title=' .
799  wfUrlencode( 'Image:' . $name ) .
800  "&$query" );
801  } else {
802  $descUrl = $this->getDescriptionUrl( $name );
803  if ( $descUrl ) {
804  return wfAppendQuery( $descUrl, $query );
805  } else {
806  return false;
807  }
808  }
809  }
810 
816  public function getDescriptionStylesheetUrl() {
817  if ( isset( $this->scriptDirUrl ) ) {
818  // Must match canonical query parameter order for optimum caching
819  // See Title::getCdnUrls
820  return $this->makeUrl( 'title=MediaWiki:Filepage.css&action=raw&ctype=text/css' );
821  }
822 
823  return false;
824  }
825 
839  public function store( $srcPath, $dstZone, $dstRel, $flags = 0 ) {
840  $this->assertWritableRepo(); // fail out if read-only
841 
842  $status = $this->storeBatch( [ [ $srcPath, $dstZone, $dstRel ] ], $flags );
843  if ( $status->successCount == 0 ) {
844  $status->setOK( false );
845  }
846 
847  return $status;
848  }
849 
862  public function storeBatch( array $triplets, $flags = 0 ) {
863  $this->assertWritableRepo(); // fail out if read-only
864 
865  if ( $flags & self::DELETE_SOURCE ) {
866  throw new InvalidArgumentException( "DELETE_SOURCE not supported in " . __METHOD__ );
867  }
868 
869  $status = $this->newGood();
870  $backend = $this->backend; // convenience
871 
872  $operations = [];
873  // Validate each triplet and get the store operation...
874  foreach ( $triplets as $triplet ) {
875  list( $srcPath, $dstZone, $dstRel ) = $triplet;
876  wfDebug( __METHOD__
877  . "( \$src='$srcPath', \$dstZone='$dstZone', \$dstRel='$dstRel' )\n"
878  );
879 
880  // Resolve destination path
881  $root = $this->getZonePath( $dstZone );
882  if ( !$root ) {
883  throw new MWException( "Invalid zone: $dstZone" );
884  }
885  if ( !$this->validateFilename( $dstRel ) ) {
886  throw new MWException( 'Validation error in $dstRel' );
887  }
888  $dstPath = "$root/$dstRel";
889  $dstDir = dirname( $dstPath );
890  // Create destination directories for this triplet
891  if ( !$this->initDirectory( $dstDir )->isOK() ) {
892  return $this->newFatal( 'directorycreateerror', $dstDir );
893  }
894 
895  // Resolve source to a storage path if virtual
896  $srcPath = $this->resolveToStoragePath( $srcPath );
897 
898  // Get the appropriate file operation
899  if ( FileBackend::isStoragePath( $srcPath ) ) {
900  $opName = 'copy';
901  } else {
902  $opName = 'store';
903  }
904  $operations[] = [
905  'op' => $opName,
906  'src' => $srcPath,
907  'dst' => $dstPath,
908  'overwrite' => $flags & self::OVERWRITE,
909  'overwriteSame' => $flags & self::OVERWRITE_SAME,
910  ];
911  }
912 
913  // Execute the store operation for each triplet
914  $opts = [ 'force' => true ];
915  if ( $flags & self::SKIP_LOCKING ) {
916  $opts['nonLocking'] = true;
917  }
918  $status->merge( $backend->doOperations( $operations, $opts ) );
919 
920  return $status;
921  }
922 
933  public function cleanupBatch( array $files, $flags = 0 ) {
934  $this->assertWritableRepo(); // fail out if read-only
935 
936  $status = $this->newGood();
937 
938  $operations = [];
939  foreach ( $files as $path ) {
940  if ( is_array( $path ) ) {
941  // This is a pair, extract it
942  list( $zone, $rel ) = $path;
943  $path = $this->getZonePath( $zone ) . "/$rel";
944  } else {
945  // Resolve source to a storage path if virtual
946  $path = $this->resolveToStoragePath( $path );
947  }
948  $operations[] = [ 'op' => 'delete', 'src' => $path ];
949  }
950  // Actually delete files from storage...
951  $opts = [ 'force' => true ];
952  if ( $flags & self::SKIP_LOCKING ) {
953  $opts['nonLocking'] = true;
954  }
955  $status->merge( $this->backend->doOperations( $operations, $opts ) );
956 
957  return $status;
958  }
959 
973  final public function quickImport( $src, $dst, $options = null ) {
974  return $this->quickImportBatch( [ [ $src, $dst, $options ] ] );
975  }
976 
985  final public function quickPurge( $path ) {
986  return $this->quickPurgeBatch( [ $path ] );
987  }
988 
996  public function quickCleanDir( $dir ) {
997  $status = $this->newGood();
998  $status->merge( $this->backend->clean(
999  [ 'dir' => $this->resolveToStoragePath( $dir ) ] ) );
1000 
1001  return $status;
1002  }
1003 
1016  public function quickImportBatch( array $triples ) {
1017  $status = $this->newGood();
1018  $operations = [];
1019  foreach ( $triples as $triple ) {
1020  list( $src, $dst ) = $triple;
1021  if ( $src instanceof FSFile ) {
1022  $op = 'store';
1023  } else {
1024  $src = $this->resolveToStoragePath( $src );
1025  $op = FileBackend::isStoragePath( $src ) ? 'copy' : 'store';
1026  }
1027  $dst = $this->resolveToStoragePath( $dst );
1028 
1029  if ( !isset( $triple[2] ) ) {
1030  $headers = [];
1031  } elseif ( is_string( $triple[2] ) ) {
1032  // back-compat
1033  $headers = [ 'Content-Disposition' => $triple[2] ];
1034  } elseif ( is_array( $triple[2] ) && isset( $triple[2]['headers'] ) ) {
1035  $headers = $triple[2]['headers'];
1036  } else {
1037  $headers = [];
1038  }
1039 
1040  $operations[] = [
1041  'op' => $op,
1042  'src' => $src,
1043  'dst' => $dst,
1044  'headers' => $headers
1045  ];
1046  $status->merge( $this->initDirectory( dirname( $dst ) ) );
1047  }
1048  $status->merge( $this->backend->doQuickOperations( $operations ) );
1049 
1050  return $status;
1051  }
1052 
1061  public function quickPurgeBatch( array $paths ) {
1062  $status = $this->newGood();
1063  $operations = [];
1064  foreach ( $paths as $path ) {
1065  $operations[] = [
1066  'op' => 'delete',
1067  'src' => $this->resolveToStoragePath( $path ),
1068  'ignoreMissingSource' => true
1069  ];
1070  }
1071  $status->merge( $this->backend->doQuickOperations( $operations ) );
1072 
1073  return $status;
1074  }
1075 
1086  public function storeTemp( $originalName, $srcPath ) {
1087  $this->assertWritableRepo(); // fail out if read-only
1088 
1089  $date = MWTimestamp::getInstance()->format( 'YmdHis' );
1090  $hashPath = $this->getHashPath( $originalName );
1091  $dstUrlRel = $hashPath . $date . '!' . rawurlencode( $originalName );
1092  $virtualUrl = $this->getVirtualUrl( 'temp' ) . '/' . $dstUrlRel;
1093 
1094  $result = $this->quickImport( $srcPath, $virtualUrl );
1095  $result->value = $virtualUrl;
1096 
1097  return $result;
1098  }
1099 
1106  public function freeTemp( $virtualUrl ) {
1107  $this->assertWritableRepo(); // fail out if read-only
1108 
1109  $temp = $this->getVirtualUrl( 'temp' );
1110  if ( substr( $virtualUrl, 0, strlen( $temp ) ) != $temp ) {
1111  wfDebug( __METHOD__ . ": Invalid temp virtual URL\n" );
1112 
1113  return false;
1114  }
1115 
1116  return $this->quickPurge( $virtualUrl )->isOK();
1117  }
1118 
1128  public function concatenate( array $srcPaths, $dstPath, $flags = 0 ) {
1129  $this->assertWritableRepo(); // fail out if read-only
1130 
1131  $status = $this->newGood();
1132 
1133  $sources = [];
1134  foreach ( $srcPaths as $srcPath ) {
1135  // Resolve source to a storage path if virtual
1136  $source = $this->resolveToStoragePath( $srcPath );
1137  $sources[] = $source; // chunk to merge
1138  }
1139 
1140  // Concatenate the chunks into one FS file
1141  $params = [ 'srcs' => $sources, 'dst' => $dstPath ];
1142  $status->merge( $this->backend->concatenate( $params ) );
1143  if ( !$status->isOK() ) {
1144  return $status;
1145  }
1146 
1147  // Delete the sources if required
1148  if ( $flags & self::DELETE_SOURCE ) {
1149  $status->merge( $this->quickPurgeBatch( $srcPaths ) );
1150  }
1151 
1152  // Make sure status is OK, despite any quickPurgeBatch() fatals
1153  $status->setResult( true );
1154 
1155  return $status;
1156  }
1157 
1177  public function publish(
1178  $src, $dstRel, $archiveRel, $flags = 0, array $options = []
1179  ) {
1180  $this->assertWritableRepo(); // fail out if read-only
1181 
1182  $status = $this->publishBatch(
1183  [ [ $src, $dstRel, $archiveRel, $options ] ], $flags );
1184  if ( $status->successCount == 0 ) {
1185  $status->setOK( false );
1186  }
1187  $status->value = $status->value[0] ?? false;
1188 
1189  return $status;
1190  }
1191 
1202  public function publishBatch( array $ntuples, $flags = 0 ) {
1203  $this->assertWritableRepo(); // fail out if read-only
1204 
1205  $backend = $this->backend; // convenience
1206  // Try creating directories
1207  $status = $this->initZones( 'public' );
1208  if ( !$status->isOK() ) {
1209  return $status;
1210  }
1211 
1212  $status = $this->newGood( [] );
1213 
1214  $operations = [];
1215  $sourceFSFilesToDelete = []; // cleanup for disk source files
1216  // Validate each triplet and get the store operation...
1217  foreach ( $ntuples as $ntuple ) {
1218  list( $src, $dstRel, $archiveRel ) = $ntuple;
1219  $srcPath = ( $src instanceof FSFile ) ? $src->getPath() : $src;
1220 
1221  $options = $ntuple[3] ?? [];
1222  // Resolve source to a storage path if virtual
1223  $srcPath = $this->resolveToStoragePath( $srcPath );
1224  if ( !$this->validateFilename( $dstRel ) ) {
1225  throw new MWException( 'Validation error in $dstRel' );
1226  }
1227  if ( !$this->validateFilename( $archiveRel ) ) {
1228  throw new MWException( 'Validation error in $archiveRel' );
1229  }
1230 
1231  $publicRoot = $this->getZonePath( 'public' );
1232  $dstPath = "$publicRoot/$dstRel";
1233  $archivePath = "$publicRoot/$archiveRel";
1234 
1235  $dstDir = dirname( $dstPath );
1236  $archiveDir = dirname( $archivePath );
1237  // Abort immediately on directory creation errors since they're likely to be repetitive
1238  if ( !$this->initDirectory( $dstDir )->isOK() ) {
1239  return $this->newFatal( 'directorycreateerror', $dstDir );
1240  }
1241  if ( !$this->initDirectory( $archiveDir )->isOK() ) {
1242  return $this->newFatal( 'directorycreateerror', $archiveDir );
1243  }
1244 
1245  // Set any desired headers to be use in GET/HEAD responses
1246  $headers = $options['headers'] ?? [];
1247 
1248  // Archive destination file if it exists.
1249  // This will check if the archive file also exists and fail if does.
1250  // This is a sanity check to avoid data loss. On Windows and Linux,
1251  // copy() will overwrite, so the existence check is vulnerable to
1252  // race conditions unless a functioning LockManager is used.
1253  // LocalFile also uses SELECT FOR UPDATE for synchronization.
1254  $operations[] = [
1255  'op' => 'copy',
1256  'src' => $dstPath,
1257  'dst' => $archivePath,
1258  'ignoreMissingSource' => true
1259  ];
1260 
1261  // Copy (or move) the source file to the destination
1262  if ( FileBackend::isStoragePath( $srcPath ) ) {
1263  if ( $flags & self::DELETE_SOURCE ) {
1264  $operations[] = [
1265  'op' => 'move',
1266  'src' => $srcPath,
1267  'dst' => $dstPath,
1268  'overwrite' => true, // replace current
1269  'headers' => $headers
1270  ];
1271  } else {
1272  $operations[] = [
1273  'op' => 'copy',
1274  'src' => $srcPath,
1275  'dst' => $dstPath,
1276  'overwrite' => true, // replace current
1277  'headers' => $headers
1278  ];
1279  }
1280  } else { // FS source path
1281  $operations[] = [
1282  'op' => 'store',
1283  'src' => $src, // prefer FSFile objects
1284  'dst' => $dstPath,
1285  'overwrite' => true, // replace current
1286  'headers' => $headers
1287  ];
1288  if ( $flags & self::DELETE_SOURCE ) {
1289  $sourceFSFilesToDelete[] = $srcPath;
1290  }
1291  }
1292  }
1293 
1294  // Execute the operations for each triplet
1295  $status->merge( $backend->doOperations( $operations ) );
1296  // Find out which files were archived...
1297  foreach ( $ntuples as $i => $ntuple ) {
1298  list( , , $archiveRel ) = $ntuple;
1299  $archivePath = $this->getZonePath( 'public' ) . "/$archiveRel";
1300  if ( $this->fileExists( $archivePath ) ) {
1301  $status->value[$i] = 'archived';
1302  } else {
1303  $status->value[$i] = 'new';
1304  }
1305  }
1306  // Cleanup for disk source files...
1307  foreach ( $sourceFSFilesToDelete as $file ) {
1308  Wikimedia\suppressWarnings();
1309  unlink( $file ); // FS cleanup
1310  Wikimedia\restoreWarnings();
1311  }
1312 
1313  return $status;
1314  }
1315 
1323  protected function initDirectory( $dir ) {
1324  $path = $this->resolveToStoragePath( $dir );
1325  list( , $container, ) = FileBackend::splitStoragePath( $path );
1326 
1327  $params = [ 'dir' => $path ];
1328  if ( $this->isPrivate
1329  || $container === $this->zones['deleted']['container']
1330  || $container === $this->zones['temp']['container']
1331  ) {
1332  # Take all available measures to prevent web accessibility of new deleted
1333  # directories, in case the user has not configured offline storage
1334  $params = [ 'noAccess' => true, 'noListing' => true ] + $params;
1335  }
1336 
1337  $status = $this->newGood();
1338  $status->merge( $this->backend->prepare( $params ) );
1339 
1340  return $status;
1341  }
1342 
1349  public function cleanDir( $dir ) {
1350  $this->assertWritableRepo(); // fail out if read-only
1351 
1352  $status = $this->newGood();
1353  $status->merge( $this->backend->clean(
1354  [ 'dir' => $this->resolveToStoragePath( $dir ) ] ) );
1355 
1356  return $status;
1357  }
1358 
1365  public function fileExists( $file ) {
1366  $result = $this->fileExistsBatch( [ $file ] );
1367 
1368  return $result[0];
1369  }
1370 
1377  public function fileExistsBatch( array $files ) {
1378  $paths = array_map( [ $this, 'resolveToStoragePath' ], $files );
1379  $this->backend->preloadFileStat( [ 'srcs' => $paths ] );
1380 
1381  $result = [];
1382  foreach ( $files as $key => $file ) {
1383  $path = $this->resolveToStoragePath( $file );
1384  $result[$key] = $this->backend->fileExists( [ 'src' => $path ] );
1385  }
1386 
1387  return $result;
1388  }
1389 
1400  public function delete( $srcRel, $archiveRel ) {
1401  $this->assertWritableRepo(); // fail out if read-only
1402 
1403  return $this->deleteBatch( [ [ $srcRel, $archiveRel ] ] );
1404  }
1405 
1423  public function deleteBatch( array $sourceDestPairs ) {
1424  $this->assertWritableRepo(); // fail out if read-only
1425 
1426  // Try creating directories
1427  $status = $this->initZones( [ 'public', 'deleted' ] );
1428  if ( !$status->isOK() ) {
1429  return $status;
1430  }
1431 
1432  $status = $this->newGood();
1433 
1434  $backend = $this->backend; // convenience
1435  $operations = [];
1436  // Validate filenames and create archive directories
1437  foreach ( $sourceDestPairs as $pair ) {
1438  list( $srcRel, $archiveRel ) = $pair;
1439  if ( !$this->validateFilename( $srcRel ) ) {
1440  throw new MWException( __METHOD__ . ':Validation error in $srcRel' );
1441  } elseif ( !$this->validateFilename( $archiveRel ) ) {
1442  throw new MWException( __METHOD__ . ':Validation error in $archiveRel' );
1443  }
1444 
1445  $publicRoot = $this->getZonePath( 'public' );
1446  $srcPath = "{$publicRoot}/$srcRel";
1447 
1448  $deletedRoot = $this->getZonePath( 'deleted' );
1449  $archivePath = "{$deletedRoot}/{$archiveRel}";
1450  $archiveDir = dirname( $archivePath ); // does not touch FS
1451 
1452  // Create destination directories
1453  if ( !$this->initDirectory( $archiveDir )->isOK() ) {
1454  return $this->newFatal( 'directorycreateerror', $archiveDir );
1455  }
1456 
1457  $operations[] = [
1458  'op' => 'move',
1459  'src' => $srcPath,
1460  'dst' => $archivePath,
1461  // We may have 2+ identical files being deleted,
1462  // all of which will map to the same destination file
1463  'overwriteSame' => true // also see T33792
1464  ];
1465  }
1466 
1467  // Move the files by execute the operations for each pair.
1468  // We're now committed to returning an OK result, which will
1469  // lead to the files being moved in the DB also.
1470  $opts = [ 'force' => true ];
1471  $status->merge( $backend->doOperations( $operations, $opts ) );
1472 
1473  return $status;
1474  }
1475 
1482  public function cleanupDeletedBatch( array $storageKeys ) {
1483  $this->assertWritableRepo();
1484  }
1485 
1494  public function getDeletedHashPath( $key ) {
1495  if ( strlen( $key ) < 31 ) {
1496  throw new MWException( "Invalid storage key '$key'." );
1497  }
1498  $path = '';
1499  for ( $i = 0; $i < $this->deletedHashLevels; $i++ ) {
1500  $path .= $key[$i] . '/';
1501  }
1502 
1503  return $path;
1504  }
1505 
1514  protected function resolveToStoragePath( $path ) {
1515  if ( self::isVirtualUrl( $path ) ) {
1516  return $this->resolveVirtualUrl( $path );
1517  }
1518 
1519  return $path;
1520  }
1521 
1529  public function getLocalCopy( $virtualUrl ) {
1530  $path = $this->resolveToStoragePath( $virtualUrl );
1531 
1532  return $this->backend->getLocalCopy( [ 'src' => $path ] );
1533  }
1534 
1543  public function getLocalReference( $virtualUrl ) {
1544  $path = $this->resolveToStoragePath( $virtualUrl );
1545 
1546  return $this->backend->getLocalReference( [ 'src' => $path ] );
1547  }
1548 
1556  public function getFileProps( $virtualUrl ) {
1557  $fsFile = $this->getLocalReference( $virtualUrl );
1558  $mwProps = new MWFileProps( MediaWiki\MediaWikiServices::getInstance()->getMimeAnalyzer() );
1559  if ( $fsFile ) {
1560  $props = $mwProps->getPropsFromPath( $fsFile->getPath(), true );
1561  } else {
1562  $props = $mwProps->newPlaceholderProps();
1563  }
1564 
1565  return $props;
1566  }
1567 
1574  public function getFileTimestamp( $virtualUrl ) {
1575  $path = $this->resolveToStoragePath( $virtualUrl );
1576 
1577  return $this->backend->getFileTimestamp( [ 'src' => $path ] );
1578  }
1579 
1586  public function getFileSize( $virtualUrl ) {
1587  $path = $this->resolveToStoragePath( $virtualUrl );
1588 
1589  return $this->backend->getFileSize( [ 'src' => $path ] );
1590  }
1591 
1598  public function getFileSha1( $virtualUrl ) {
1599  $path = $this->resolveToStoragePath( $virtualUrl );
1600 
1601  return $this->backend->getFileSha1Base36( [ 'src' => $path ] );
1602  }
1603 
1613  public function streamFileWithStatus( $virtualUrl, $headers = [], $optHeaders = [] ) {
1614  $path = $this->resolveToStoragePath( $virtualUrl );
1615  $params = [ 'src' => $path, 'headers' => $headers, 'options' => $optHeaders ];
1616 
1617  // T172851: HHVM does not flush the output properly, causing OOM
1618  ob_start( null, 1048576 );
1619  ob_implicit_flush( true );
1620 
1621  $status = $this->newGood();
1622  $status->merge( $this->backend->streamFile( $params ) );
1623 
1624  // T186565: Close the buffer, unless it has already been closed
1625  // in HTTPFileStreamer::resetOutputBuffers().
1626  if ( ob_get_status() ) {
1627  ob_end_flush();
1628  }
1629 
1630  return $status;
1631  }
1632 
1641  public function streamFile( $virtualUrl, $headers = [] ) {
1642  return $this->streamFileWithStatus( $virtualUrl, $headers )->isOK();
1643  }
1644 
1653  public function enumFiles( $callback ) {
1654  $this->enumFilesInStorage( $callback );
1655  }
1656 
1664  protected function enumFilesInStorage( $callback ) {
1665  $publicRoot = $this->getZonePath( 'public' );
1666  $numDirs = 1 << ( $this->hashLevels * 4 );
1667  // Use a priori assumptions about directory structure
1668  // to reduce the tree height of the scanning process.
1669  for ( $flatIndex = 0; $flatIndex < $numDirs; $flatIndex++ ) {
1670  $hexString = sprintf( "%0{$this->hashLevels}x", $flatIndex );
1671  $path = $publicRoot;
1672  for ( $hexPos = 0; $hexPos < $this->hashLevels; $hexPos++ ) {
1673  $path .= '/' . substr( $hexString, 0, $hexPos + 1 );
1674  }
1675  $iterator = $this->backend->getFileList( [ 'dir' => $path ] );
1676  foreach ( $iterator as $name ) {
1677  // Each item returned is a public file
1678  call_user_func( $callback, "{$path}/{$name}" );
1679  }
1680  }
1681  }
1682 
1689  public function validateFilename( $filename ) {
1690  if ( strval( $filename ) == '' ) {
1691  return false;
1692  }
1693 
1694  return FileBackend::isPathTraversalFree( $filename );
1695  }
1696 
1703  switch ( $this->pathDisclosureProtection ) {
1704  case 'none':
1705  case 'simple': // b/c
1706  $callback = [ $this, 'passThrough' ];
1707  break;
1708  default: // 'paranoid'
1709  $callback = [ $this, 'paranoidClean' ];
1710  }
1711  return $callback;
1712  }
1713 
1720  function paranoidClean( $param ) {
1721  return '[hidden]';
1722  }
1723 
1730  function passThrough( $param ) {
1731  return $param;
1732  }
1733 
1740  public function newFatal( $message /*, parameters...*/ ) {
1741  $status = Status::newFatal( ...func_get_args() );
1742  $status->cleanCallback = $this->getErrorCleanupFunction();
1743 
1744  return $status;
1745  }
1746 
1753  public function newGood( $value = null ) {
1755  $status->cleanCallback = $this->getErrorCleanupFunction();
1756 
1757  return $status;
1758  }
1759 
1768  public function checkRedirect( Title $title ) {
1769  return false;
1770  }
1771 
1779  public function invalidateImageRedirect( Title $title ) {
1780  }
1781 
1787  public function getDisplayName() {
1788  global $wgSitename;
1789 
1790  if ( $this->isLocal() ) {
1791  return $wgSitename;
1792  }
1793 
1794  // 'shared-repo-name-wikimediacommons' is used when $wgUseInstantCommons = true
1795  return wfMessageFallback( 'shared-repo-name-' . $this->name, 'shared-repo' )->text();
1796  }
1797 
1805  public function nameForThumb( $name ) {
1806  if ( strlen( $name ) > $this->abbrvThreshold ) {
1808  $name = ( $ext == '' ) ? 'thumbnail' : "thumbnail.$ext";
1809  }
1810 
1811  return $name;
1812  }
1813 
1819  public function isLocal() {
1820  return $this->getName() == 'local';
1821  }
1822 
1831  public function getSharedCacheKey( /*...*/ ) {
1832  return false;
1833  }
1834 
1842  public function getLocalCacheKey( /*...*/ ) {
1843  $args = func_get_args();
1844  array_unshift( $args, 'filerepo', $this->getName() );
1845 
1846  return $this->wanCache->makeKey( ...$args );
1847  }
1848 
1857  public function getTempRepo() {
1858  return new TempFileRepo( [
1859  'name' => "{$this->name}-temp",
1860  'backend' => $this->backend,
1861  'zones' => [
1862  'public' => [
1863  // Same place storeTemp() uses in the base repo, though
1864  // the path hashing is mismatched, which is annoying.
1865  'container' => $this->zones['temp']['container'],
1866  'directory' => $this->zones['temp']['directory']
1867  ],
1868  'thumb' => [
1869  'container' => $this->zones['temp']['container'],
1870  'directory' => $this->zones['temp']['directory'] == ''
1871  ? 'thumb'
1872  : $this->zones['temp']['directory'] . '/thumb'
1873  ],
1874  'transcoded' => [
1875  'container' => $this->zones['temp']['container'],
1876  'directory' => $this->zones['temp']['directory'] == ''
1877  ? 'transcoded'
1878  : $this->zones['temp']['directory'] . '/transcoded'
1879  ]
1880  ],
1881  'hashLevels' => $this->hashLevels, // performance
1882  'isPrivate' => true // all in temp zone
1883  ] );
1884  }
1885 
1892  public function getUploadStash( User $user = null ) {
1893  return new UploadStash( $this, $user );
1894  }
1895 
1903  protected function assertWritableRepo() {
1904  }
1905 
1912  public function getInfo() {
1913  $ret = [
1914  'name' => $this->getName(),
1915  'displayname' => $this->getDisplayName(),
1916  'rootUrl' => $this->getZoneUrl( 'public' ),
1917  'local' => $this->isLocal(),
1918  ];
1919 
1920  $optionalSettings = [
1921  'url', 'thumbUrl', 'initialCapital', 'descBaseUrl', 'scriptDirUrl', 'articleUrl',
1922  'fetchDescription', 'descriptionCacheExpiry', 'favicon'
1923  ];
1924  foreach ( $optionalSettings as $k ) {
1925  if ( isset( $this->$k ) ) {
1926  $ret[$k] = $this->$k;
1927  }
1928  }
1929 
1930  return $ret;
1931  }
1932 
1937  public function hasSha1Storage() {
1938  return $this->hasSha1Storage;
1939  }
1940 
1945  public function supportsSha1URLs() {
1946  return $this->supportsSha1URLs;
1947  }
1948 }
string $favicon
The URL of the repo&#39;s favicon, if any.
Definition: FileRepo.php:119
assertWritableRepo()
Throw an exception if this repo is read-only by design.
Definition: FileRepo.php:1903
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))
static isPathTraversalFree( $path)
Check if a relative path has no directory traversals.
bool $fetchDescription
Whether to fetch commons image description pages and display them on the local wiki.
Definition: FileRepo.php:49
string $scriptDirUrl
URL of the MediaWiki installation, equivalent to $wgScriptPath, e.g.
Definition: FileRepo.php:81
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
int $abbrvThreshold
File names over this size will use the short form of thumbnail names.
Definition: FileRepo.php:116
array $zones
Map of zones to config.
Definition: FileRepo.php:64
null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify $query
Definition: hooks.txt:1585
canTransformVia404()
Returns true if the repository can transform files via a 404 handler.
Definition: FileRepo.php:637
getTempRepo()
Get a temporary private FileRepo associated with this repo.
Definition: FileRepo.php:1857
getVirtualUrl( $suffix=false)
Get a URL referring to this repository, with the private mwrepo protocol.
Definition: FileRepo.php:266
static splitStoragePath( $storagePath)
Split a storage path into a backend name, a container name, and a relative file path.
doOperations(array $ops, array $opts=[])
This is the main entry point into the backend for write operations.
getFileSize( $virtualUrl)
Get the size of a file with a given virtual URL/storage path.
Definition: FileRepo.php:1586
getUserCaseDBKey()
Get the DB key with the initial letter case as specified by the user.
Definition: Title.php:1011
string $pathDisclosureProtection
May be &#39;paranoid&#39; to remove all parameters from error messages, &#39;none&#39; to leave the paths in unchange...
Definition: FileRepo.php:98
paranoidClean( $param)
Path disclosure protection function.
Definition: FileRepo.php:1720
getDescriptionUrl( $name)
Get the URL of an image description page.
Definition: FileRepo.php:757
$wgSitename
Name of the site.
cleanDir( $dir)
Deletes a directory if empty.
Definition: FileRepo.php:1349
getRootDirectory()
Get the public zone root storage directory of the repository.
Definition: FileRepo.php:665
initDirectory( $dir)
Creates a directory with the appropriate zone permissions.
Definition: FileRepo.php:1323
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 & $ret
Definition: hooks.txt:1982
getUploadStash(User $user=null)
Get an UploadStash associated with this repo.
Definition: FileRepo.php:1892
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
makeUrl( $query='', $entry='index')
Make an url to this repo.
Definition: FileRepo.php:737
if(PHP_SAPI !='cli-server') if(!isset( $_SERVER['SCRIPT_FILENAME'])) $file
Definition: router.php:42
if(!isset( $args[0])) $lang
string false $url
Public zone URL.
Definition: FileRepo.php:101
nameForThumb( $name)
Get the portion of the file that contains the origin file name.
Definition: FileRepo.php:1805
resolveVirtualUrl( $url)
Get the backend storage path corresponding to a virtual URL.
Definition: FileRepo.php:323
const DELETE_SOURCE
Definition: FileRepo.php:40
WANObjectCache $wanCache
Definition: FileRepo.php:141
checkRedirect(Title $title)
Checks if there is a redirect named as $title.
Definition: FileRepo.php:1768
quickCleanDir( $dir)
Deletes a directory if empty.
Definition: FileRepo.php:996
$source
$value
getLocalCacheKey()
Get a key for this repo in the local cache domain.
Definition: FileRepo.php:1842
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 MediaWikiServices
Definition: injection.txt:23
getHashLevels()
Get the number of hash directory levels.
Definition: FileRepo.php:717
getZoneUrl( $zone, $ext=null)
Get the URL corresponding to one of the four basic zones.
Definition: FileRepo.php:282
A helper class for throttling authentication attempts.
quickImport( $src, $dst, $options=null)
Import a file from the local file system into the repo.
Definition: FileRepo.php:973
freeTemp( $virtualUrl)
Remove a temporary file or mark it for garbage collection.
Definition: FileRepo.php:1106
static extensionFromPath( $path, $case='lowercase')
Get the final extension from a storage or FS path.
static isStoragePath( $path)
Check if a given path is a "mwstore://" path.
see documentation in includes Linker php for Linker::makeImageLink & $time
Definition: hooks.txt:1799
publish( $src, $dstRel, $archiveRel, $flags=0, array $options=[])
Copy or move a file either from a storage path, virtual URL, or file system path, into this repositor...
Definition: FileRepo.php:1177
cleanupDeletedBatch(array $storageKeys)
Delete files in the deleted directory if they are not referenced in the filearchive table...
Definition: FileRepo.php:1482
const DELETED_FILE
Definition: File.php:54
getBackend()
Get the file backend instance.
Definition: FileRepo.php:215
fileExists( $file)
Checks existence of a file.
Definition: FileRepo.php:1365
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 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED since 1.28! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1980
if( $line===false) $args
Definition: cdb.php:64
and how to run hooks for an and one after Each event has a name
Definition: hooks.txt:6
The User object encapsulates all of the user-specific settings (user_id, name, rights, email address, options, last login time).
Definition: User.php:48
static getInstance( $ts=false)
Get a timestamp instance in GMT.
Definition: MWTimestamp.php:39
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 true
Definition: hooks.txt:1982
getZoneLocation( $zone)
The the storage container and base path of a zone.
Definition: FileRepo.php:349
array $oldFileFactoryKey
callable|bool Override these in the base class
Definition: FileRepo.php:131
wfAppendQuery( $url, $query)
Append a query string to an existing URL, which may or may not already have query string parameters a...
enumFiles( $callback)
Call a callback function for every public regular file in the repository.
Definition: FileRepo.php:1653
static newFatal( $message)
Factory function for fatal errors.
Definition: StatusValue.php:68
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action, or null $user:User who performed the tagging when the tagging is subsequent to the action, or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, whether it is OK to use $contentModel on $title. Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy:boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'ContentSecurityPolicyDefaultSource':Modify the allowed CSP load sources. This affects all directives except for the script directive. If you want to add a script source, see ContentSecurityPolicyScriptSource hook. & $defaultSrc:Array of Content-Security-Policy allowed sources $policyConfig:Current configuration for the Content-Security-Policy header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyDirectives':Modify the content security policy directives. Use this only if ContentSecurityPolicyDefaultSource and ContentSecurityPolicyScriptSource do not meet your needs. & $directives:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyScriptSource':Modify the allowed CSP script sources. Note that you also have to use ContentSecurityPolicyDefaultSource if you want non-script sources to be loaded from whatever you add. & $scriptSrc:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DeleteUnknownPreferences':Called by the cleanupPreferences.php maintenance script to build a WHERE clause with which to delete preferences that are not known about. This hook is used by extensions that have dynamically-named preferences that should not be deleted in the usual cleanup process. For example, the Gadgets extension creates preferences prefixed with 'gadget-', and so anything with that prefix is excluded from the deletion. &where:An array that will be passed as the $cond parameter to IDatabase::select() to determine what will be deleted from the user_properties table. $db:The IDatabase object, useful for accessing $db->buildLike() etc. 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function. $differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable 's value is null. This hook can be used to inject content into said class member variable. $differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the "mark as patrolled" link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink". $differenceEngine:DifferenceEngine object & $markAsPatrolledLink:The "mark as patrolled" link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter. For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions. & $rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision 's author, whether the revision was marked as a minor edit or not, etc. $differenceEngine:DifferenceEngine object & $newHeader:The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
Definition: hooks.txt:1263
static newEmpty()
Get an instance that wraps EmptyBagOStuff.
const OVERWRITE
Definition: FileRepo.php:41
enumFilesInStorage( $callback)
Call a callback function for every public file in the repository.
Definition: FileRepo.php:1664
isLocal()
Returns true if this the local file repository.
Definition: FileRepo.php:1819
getReadOnlyReason()
Get an explanatory message if this repo is read-only.
Definition: FileRepo.php:225
initZones( $doZones=[])
Check if a single zone or list of zones is defined for usage.
Definition: FileRepo.php:236
wfUrlencode( $s)
We want some things to be included as literal characters in our title URLs for prettiness, which urlencode encodes by default.
string $thumbProxyUrl
URL of where to proxy thumb.php requests to.
Definition: FileRepo.php:136
getThumbProxyUrl()
Get the URL thumb.php requests are being proxied to.
Definition: FileRepo.php:619
getInfo()
Return information about the repository.
Definition: FileRepo.php:1912
string $thumbScriptUrl
URL of thumb.php.
Definition: FileRepo.php:67
getDescriptionStylesheetUrl()
Get the URL of the stylesheet to apply to description pages.
Definition: FileRepo.php:816
getDBkey()
Get the main part with underscores.
Definition: Title.php:1001
quickPurgeBatch(array $paths)
Purge a batch of files from the repo.
Definition: FileRepo.php:1061
getErrorCleanupFunction()
Get a callback function to use for cleaning error message parameters.
Definition: FileRepo.php:1702
getFileSha1( $virtualUrl)
Get the sha1 (base 36) of a file with a given virtual URL/storage path.
Definition: FileRepo.php:1598
invalidateImageRedirect(Title $title)
Invalidates image redirect cache related to that image Doesn&#39;t do anything for repositories that don&#39;...
Definition: FileRepo.php:1779
static newGood( $value=null)
Factory function for good results.
Definition: StatusValue.php:81
concatenate(array $srcPaths, $dstPath, $flags=0)
Concatenate a list of temporary files into a target file location.
Definition: FileRepo.php:1128
deleteBatch(array $sourceDestPairs)
Move a group of files to the deletion archive.
Definition: FileRepo.php:1423
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
getTempHashPath( $suffix)
Get a relative path including trailing slash, e.g.
Definition: FileRepo.php:687
int $hashLevels
The number of directory levels for hash-based division of files.
Definition: FileRepo.php:107
getThumbScriptUrl()
Get the URL of thumb.php.
Definition: FileRepo.php:610
bool $initialCapital
Equivalent to $wgCapitalLinks (or $wgCapitalLinkOverrides[NS_FILE], determines whether filenames impl...
Definition: FileRepo.php:91
wfMessageFallback(... $keys)
This function accepts multiple message keys and returns a message instance for the first message whic...
static isVirtualUrl( $url)
Determine if a string is an mwrepo:// URL.
Definition: FileRepo.php:254
getSharedCacheKey()
Get a key on the primary cache for this repository.
Definition: FileRepo.php:1831
$params
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 & $options
Definition: hooks.txt:1982
string $articleUrl
Equivalent to $wgArticlePath, e.g.
Definition: FileRepo.php:84
string $thumbUrl
The base thumbnail URL.
Definition: FileRepo.php:104
const ATTR_UNICODE_PATHS
findFilesByPrefix( $prefix, $limit)
Return an array of files where the name starts with $prefix.
Definition: FileRepo.php:601
newFile( $title, $time=false)
Create a new File object from the local repository.
Definition: FileRepo.php:387
const SKIP_LOCKING
Definition: FileRepo.php:43
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:780
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:925
findFiles(array $items, $flags=0)
Find many files at once.
Definition: FileRepo.php:496
getLocalCopy( $virtualUrl)
Get a local FS copy of a file with a given virtual URL/storage path.
Definition: FileRepo.php:1529
static getHashPathForLevel( $name, $levels)
Definition: FileRepo.php:698
const NS_FILE
Definition: Defines.php:70
bool $hasSha1Storage
Definition: FileRepo.php:55
int $descriptionCacheExpiry
Definition: FileRepo.php:52
getZonePath( $zone)
Get the storage path corresponding to one of the zones.
Definition: FileRepo.php:363
string $descBaseUrl
URL of image description pages, e.g.
Definition: FileRepo.php:76
streamFileWithStatus( $virtualUrl, $headers=[], $optHeaders=[])
Attempt to stream a file with the given virtual URL/storage path.
Definition: FileRepo.php:1613
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
getFileTimestamp( $virtualUrl)
Get the timestamp of a file with a given virtual URL/storage path.
Definition: FileRepo.php:1574
getNameFromTitle(Title $title)
Get the name of a file from its title object.
Definition: FileRepo.php:647
storeTemp( $originalName, $srcPath)
Pick a random name in the temp zone and store a file to it.
Definition: FileRepo.php:1086
const NAME_AND_TIME_ONLY
Definition: FileRepo.php:45
string $thumbProxySecret
Secret key to pass as an X-Swift-Secret header to the proxied thumb service.
Definition: FileRepo.php:138
backendSupportsUnicodePaths()
Definition: FileRepo.php:311
static isCapitalized( $index)
Is the namespace first-letter capitalized?
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
UploadStash is intended to accomplish a few things:
Definition: UploadStash.php:53
cleanupBatch(array $files, $flags=0)
Deletes a batch of files.
Definition: FileRepo.php:933
bool $transformVia404
Whether to skip media file transformation on parse and rely on a 404 handler instead.
Definition: FileRepo.php:71
findFile( $title, $options=[])
Find an instance of the named file created at the specified time Returns false if the file does not e...
Definition: FileRepo.php:420
findBySha1s(array $hashes)
Get an array of arrays or iterators of file objects for files that have the given SHA-1 content hashe...
Definition: FileRepo.php:581
Class representing a non-directory file on the file system.
Definition: FSFile.php:29
const OVERWRITE_SAME
Definition: FileRepo.php:42
getFileProps( $virtualUrl)
Get properties of a file with a given virtual URL/storage path.
Definition: FileRepo.php:1556
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:52
store( $srcPath, $dstZone, $dstRel, $flags=0)
Store a file to a given destination.
Definition: FileRepo.php:839
findBySha1( $hash)
Get an array or iterator of file objects for files that have a given SHA-1 content hash...
Definition: FileRepo.php:570
FileRepo for temporary files created via FileRepo::getTempRepo()
Definition: TempFileRepo.php:5
Base class for all file backend classes (including multi-write backends).
Definition: FileBackend.php:92
findFileFromKey( $sha1, $options=[])
Find an instance of the file with this key, created at the specified time Returns false if the file d...
Definition: FileRepo.php:533
getDisplayName()
Get the human-readable name of the repo.
Definition: FileRepo.php:1787
if(!is_readable( $file)) $ext
Definition: router.php:48
Base class for file repositories.
Definition: FileRepo.php:39
bool $supportsSha1URLs
Definition: FileRepo.php:58
MimeMagic helper wrapper.
Definition: MWFileProps.php:28
array $fileFactoryKey
callable|bool Override these in the base class
Definition: FileRepo.php:129
array $oldFileFactory
callable|bool Override these in the base class
Definition: FileRepo.php:127
getHashPath( $name)
Get a relative path including trailing slash, e.g.
Definition: FileRepo.php:676
array $fileFactory
callable Override these in the base class
Definition: FileRepo.php:125
storeBatch(array $triplets, $flags=0)
Store a batch of files.
Definition: FileRepo.php:862
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
getLocalReference( $virtualUrl)
Get a local FS file with a given virtual URL/storage path.
Definition: FileRepo.php:1543
FileBackend $backend
Definition: FileRepo.php:61
fileExistsBatch(array $files)
Checks existence of an array of files.
Definition: FileRepo.php:1377
quickImportBatch(array $triples)
Import a batch of files from the local file system into the repo.
Definition: FileRepo.php:1016
quickPurge( $path)
Purge a file from the repo.
Definition: FileRepo.php:985
getDeletedHashPath( $key)
Get a relative path for a deletion archive key, e.g.
Definition: FileRepo.php:1494
passThrough( $param)
Path disclosure protection function.
Definition: FileRepo.php:1730
validateFilename( $filename)
Determine if a relative path is valid, i.e.
Definition: FileRepo.php:1689
supportsSha1URLs()
Returns whether or not repo supports having originals SHA-1s in the thumb URLs.
Definition: FileRepo.php:1945
streamFile( $virtualUrl, $headers=[])
Attempt to stream a file with the given virtual URL/storage path.
Definition: FileRepo.php:1641
int $deletedHashLevels
The number of directory levels for hash-based division of deleted files.
Definition: FileRepo.php:110
resolveToStoragePath( $path)
If a path is a virtual URL, resolve it to a storage path.
Definition: FileRepo.php:1514
__construct(array $info=null)
Definition: FileRepo.php:147
hasSha1Storage()
Returns whether or not storage is SHA-1 based.
Definition: FileRepo.php:1937
bool $isPrivate
Whether all zones should be private (e.g.
Definition: FileRepo.php:122
static normalizeTitle( $title, $exception=false)
Given a string or Title object return either a valid Title object with namespace NS_FILE or null...
Definition: File.php:185
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1473
getThumbProxySecret()
Get the secret key for the proxied thumb service.
Definition: FileRepo.php:628
getDescriptionRenderUrl( $name, $lang=null)
Get the URL of the content-only fragment of the description page.
Definition: FileRepo.php:791
getName()
Get the name of this repository, as specified by $info[&#39;name]&#39; to the constructor.
Definition: FileRepo.php:726
newGood( $value=null)
Create a new good result.
Definition: FileRepo.php:1753
newFatal( $message)
Create a new fatal error.
Definition: FileRepo.php:1740
publishBatch(array $ntuples, $flags=0)
Publish a batch of files.
Definition: FileRepo.php:1202