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 
51 
54 
56  protected $hasSha1Storage = false;
57 
59  protected $supportsSha1URLs = false;
60 
62  protected $backend;
63 
65  protected $zones = [];
66 
68  protected $thumbScriptUrl;
69 
73  protected $transformVia404;
74 
78  protected $descBaseUrl;
79 
83  protected $scriptDirUrl;
84 
86  protected $articleUrl;
87 
93  protected $initialCapital;
94 
100  protected $pathDisclosureProtection = 'simple';
101 
103  protected $url;
104 
106  protected $thumbUrl;
107 
109  protected $hashLevels;
110 
113 
118  protected $abbrvThreshold;
119 
121  protected $favicon;
122 
124  protected $isPrivate;
125 
127  protected $fileFactory = [ UnregisteredLocalFile::class, 'newFromTitle' ];
129  protected $oldFileFactory = false;
131  protected $fileFactoryKey = false;
133  protected $oldFileFactoryKey = false;
134 
138  protected $thumbProxyUrl;
140  protected $thumbProxySecret;
141 
143  protected $wanCache;
144 
149  public function __construct( array $info = null ) {
150  // Verify required settings presence
151  if (
152  $info === null
153  || !array_key_exists( 'name', $info )
154  || !array_key_exists( 'backend', $info )
155  ) {
156  throw new MWException( __CLASS__ .
157  " requires an array of options having both 'name' and 'backend' keys.\n" );
158  }
159 
160  // Required settings
161  $this->name = $info['name'];
162  if ( $info['backend'] instanceof FileBackend ) {
163  $this->backend = $info['backend']; // useful for testing
164  } else {
165  $this->backend = FileBackendGroup::singleton()->get( $info['backend'] );
166  }
167 
168  // Optional settings that can have no value
169  $optionalSettings = [
170  'descBaseUrl', 'scriptDirUrl', 'articleUrl', 'fetchDescription',
171  'thumbScriptUrl', 'pathDisclosureProtection', 'descriptionCacheExpiry',
172  'favicon', 'thumbProxyUrl', 'thumbProxySecret',
173  ];
174  foreach ( $optionalSettings as $var ) {
175  if ( isset( $info[$var] ) ) {
176  $this->$var = $info[$var];
177  }
178  }
179 
180  // Optional settings that have a default
181  $this->initialCapital = $info['initialCapital'] ??
182  MediaWikiServices::getInstance()->getNamespaceInfo()->isCapitalized( NS_FILE );
183  $this->url = $info['url'] ?? false; // a subclass may set the URL (e.g. ForeignAPIRepo)
184  if ( isset( $info['thumbUrl'] ) ) {
185  $this->thumbUrl = $info['thumbUrl'];
186  } else {
187  $this->thumbUrl = $this->url ? "{$this->url}/thumb" : false;
188  }
189  $this->hashLevels = $info['hashLevels'] ?? 2;
190  $this->deletedHashLevels = $info['deletedHashLevels'] ?? $this->hashLevels;
191  $this->transformVia404 = !empty( $info['transformVia404'] );
192  $this->abbrvThreshold = $info['abbrvThreshold'] ?? 255;
193  $this->isPrivate = !empty( $info['isPrivate'] );
194  // Give defaults for the basic zones...
195  $this->zones = $info['zones'] ?? [];
196  foreach ( [ 'public', 'thumb', 'transcoded', 'temp', 'deleted' ] as $zone ) {
197  if ( !isset( $this->zones[$zone]['container'] ) ) {
198  $this->zones[$zone]['container'] = "{$this->name}-{$zone}";
199  }
200  if ( !isset( $this->zones[$zone]['directory'] ) ) {
201  $this->zones[$zone]['directory'] = '';
202  }
203  if ( !isset( $this->zones[$zone]['urlsByExt'] ) ) {
204  $this->zones[$zone]['urlsByExt'] = [];
205  }
206  }
207 
208  $this->supportsSha1URLs = !empty( $info['supportsSha1URLs'] );
209 
210  $this->wanCache = $info['wanCache'] ?? WANObjectCache::newEmpty();
211  }
212 
218  public function getBackend() {
219  return $this->backend;
220  }
221 
228  public function getReadOnlyReason() {
229  return $this->backend->getReadOnlyReason();
230  }
231 
239  protected function initZones( $doZones = [] ) {
240  $status = $this->newGood();
241  foreach ( (array)$doZones as $zone ) {
242  $root = $this->getZonePath( $zone );
243  if ( $root === null ) {
244  throw new MWException( "No '$zone' zone defined in the {$this->name} repo." );
245  }
246  }
247 
248  return $status;
249  }
250 
257  public static function isVirtualUrl( $url ) {
258  return substr( $url, 0, 9 ) == 'mwrepo://';
259  }
260 
269  public function getVirtualUrl( $suffix = false ) {
270  $path = 'mwrepo://' . $this->name;
271  if ( $suffix !== false ) {
272  $path .= '/' . rawurlencode( $suffix );
273  }
274 
275  return $path;
276  }
277 
285  public function getZoneUrl( $zone, $ext = null ) {
286  if ( in_array( $zone, [ 'public', 'thumb', 'transcoded' ] ) ) {
287  // standard public zones
288  if ( $ext !== null && isset( $this->zones[$zone]['urlsByExt'][$ext] ) ) {
289  // custom URL for extension/zone
290  return $this->zones[$zone]['urlsByExt'][$ext];
291  } elseif ( isset( $this->zones[$zone]['url'] ) ) {
292  // custom URL for zone
293  return $this->zones[$zone]['url'];
294  }
295  }
296  switch ( $zone ) {
297  case 'public':
298  return $this->url;
299  case 'temp':
300  case 'deleted':
301  return false; // no public URL
302  case 'thumb':
303  return $this->thumbUrl;
304  case 'transcoded':
305  return "{$this->url}/transcoded";
306  default:
307  return false;
308  }
309  }
310 
314  public function backendSupportsUnicodePaths() {
315  return (bool)( $this->getBackend()->getFeatures() & FileBackend::ATTR_UNICODE_PATHS );
316  }
317 
326  public function resolveVirtualUrl( $url ) {
327  if ( substr( $url, 0, 9 ) != 'mwrepo://' ) {
328  throw new MWException( __METHOD__ . ': unknown protocol' );
329  }
330  $bits = explode( '/', substr( $url, 9 ), 3 );
331  if ( count( $bits ) != 3 ) {
332  throw new MWException( __METHOD__ . ": invalid mwrepo URL: $url" );
333  }
334  list( $repo, $zone, $rel ) = $bits;
335  if ( $repo !== $this->name ) {
336  throw new MWException( __METHOD__ . ": fetching from a foreign repo is not supported" );
337  }
338  $base = $this->getZonePath( $zone );
339  if ( !$base ) {
340  throw new MWException( __METHOD__ . ": invalid zone: $zone" );
341  }
342 
343  return $base . '/' . rawurldecode( $rel );
344  }
345 
352  protected function getZoneLocation( $zone ) {
353  if ( !isset( $this->zones[$zone] ) ) {
354  return [ null, null ]; // bogus
355  }
356 
357  return [ $this->zones[$zone]['container'], $this->zones[$zone]['directory'] ];
358  }
359 
366  public function getZonePath( $zone ) {
367  list( $container, $base ) = $this->getZoneLocation( $zone );
368  if ( $container === null || $base === null ) {
369  return null;
370  }
371  $backendName = $this->backend->getName();
372  if ( $base != '' ) { // may not be set
373  $base = "/{$base}";
374  }
375 
376  return "mwstore://$backendName/{$container}{$base}";
377  }
378 
390  public function newFile( $title, $time = false ) {
392  if ( !$title ) {
393  return null;
394  }
395  if ( $time ) {
396  if ( $this->oldFileFactory ) {
397  return call_user_func( $this->oldFileFactory, $title, $this, $time );
398  } else {
399  return null;
400  }
401  } else {
402  return call_user_func( $this->fileFactory, $title, $this );
403  }
404  }
405 
423  public function findFile( $title, $options = [] ) {
425  if ( !$title ) {
426  return false;
427  }
428  if ( isset( $options['bypassCache'] ) ) {
429  $options['latest'] = $options['bypassCache']; // b/c
430  }
431  $time = $options['time'] ?? false;
432  $flags = !empty( $options['latest'] ) ? File::READ_LATEST : 0;
433  # First try the current version of the file to see if it precedes the timestamp
434  $img = $this->newFile( $title );
435  if ( !$img ) {
436  return false;
437  }
438  $img->load( $flags );
439  if ( $img->exists() && ( !$time || $img->getTimestamp() == $time ) ) {
440  return $img;
441  }
442  # Now try an old version of the file
443  if ( $time !== false ) {
444  $img = $this->newFile( $title, $time );
445  if ( $img ) {
446  $img->load( $flags );
447  if ( $img->exists() ) {
448  if ( !$img->isDeleted( File::DELETED_FILE ) ) {
449  return $img; // always OK
450  } elseif ( !empty( $options['private'] ) &&
451  $img->userCan( File::DELETED_FILE,
452  $options['private'] instanceof User ? $options['private'] : null
453  )
454  ) {
455  return $img;
456  }
457  }
458  }
459  }
460 
461  # Now try redirects
462  if ( !empty( $options['ignoreRedirect'] ) ) {
463  return false;
464  }
465  $redir = $this->checkRedirect( $title );
466  if ( $redir && $title->getNamespace() == NS_FILE ) {
467  $img = $this->newFile( $redir );
468  if ( !$img ) {
469  return false;
470  }
471  $img->load( $flags );
472  if ( $img->exists() ) {
473  $img->redirectedFrom( $title->getDBkey() );
474 
475  return $img;
476  }
477  }
478 
479  return false;
480  }
481 
499  public function findFiles( array $items, $flags = 0 ) {
500  $result = [];
501  foreach ( $items as $item ) {
502  if ( is_array( $item ) ) {
503  $title = $item['title'];
504  $options = $item;
505  unset( $options['title'] );
506  } else {
507  $title = $item;
508  $options = [];
509  }
510  $file = $this->findFile( $title, $options );
511  if ( $file ) {
512  $searchName = File::normalizeTitle( $title )->getDBkey(); // must be valid
513  if ( $flags & self::NAME_AND_TIME_ONLY ) {
514  $result[$searchName] = [
515  'title' => $file->getTitle()->getDBkey(),
516  'timestamp' => $file->getTimestamp()
517  ];
518  } else {
519  $result[$searchName] = $file;
520  }
521  }
522  }
523 
524  return $result;
525  }
526 
536  public function findFileFromKey( $sha1, $options = [] ) {
537  $time = $options['time'] ?? false;
538  # First try to find a matching current version of a file...
539  if ( !$this->fileFactoryKey ) {
540  return false; // find-by-sha1 not supported
541  }
542  $img = call_user_func( $this->fileFactoryKey, $sha1, $this, $time );
543  if ( $img && $img->exists() ) {
544  return $img;
545  }
546  # Now try to find a matching old version of a file...
547  if ( $time !== false && $this->oldFileFactoryKey ) { // find-by-sha1 supported?
548  $img = call_user_func( $this->oldFileFactoryKey, $sha1, $this, $time );
549  if ( $img && $img->exists() ) {
550  if ( !$img->isDeleted( File::DELETED_FILE ) ) {
551  return $img; // always OK
552  } elseif ( !empty( $options['private'] ) &&
553  $img->userCan( File::DELETED_FILE,
554  $options['private'] instanceof User ? $options['private'] : null
555  )
556  ) {
557  return $img;
558  }
559  }
560  }
561 
562  return false;
563  }
564 
573  public function findBySha1( $hash ) {
574  return [];
575  }
576 
584  public function findBySha1s( array $hashes ) {
585  $result = [];
586  foreach ( $hashes as $hash ) {
587  $files = $this->findBySha1( $hash );
588  if ( count( $files ) ) {
589  $result[$hash] = $files;
590  }
591  }
592 
593  return $result;
594  }
595 
604  public function findFilesByPrefix( $prefix, $limit ) {
605  return [];
606  }
607 
613  public function getThumbScriptUrl() {
614  return $this->thumbScriptUrl;
615  }
616 
622  public function getThumbProxyUrl() {
623  return $this->thumbProxyUrl;
624  }
625 
631  public function getThumbProxySecret() {
633  }
634 
640  public function canTransformVia404() {
641  return $this->transformVia404;
642  }
643 
650  public function getNameFromTitle( Title $title ) {
651  if (
652  $this->initialCapital !=
653  MediaWikiServices::getInstance()->getNamespaceInfo()->isCapitalized( NS_FILE )
654  ) {
655  $name = $title->getUserCaseDBKey();
656  if ( $this->initialCapital ) {
657  $name = MediaWikiServices::getInstance()->getContentLanguage()->ucfirst( $name );
658  }
659  } else {
660  $name = $title->getDBkey();
661  }
662 
663  return $name;
664  }
665 
671  public function getRootDirectory() {
672  return $this->getZonePath( 'public' );
673  }
674 
682  public function getHashPath( $name ) {
683  return self::getHashPathForLevel( $name, $this->hashLevels );
684  }
685 
693  public function getTempHashPath( $suffix ) {
694  $parts = explode( '!', $suffix, 2 ); // format is <timestamp>!<name> or just <name>
695  $name = $parts[1] ?? $suffix; // hash path is not based on timestamp
696  return self::getHashPathForLevel( $name, $this->hashLevels );
697  }
698 
704  protected static function getHashPathForLevel( $name, $levels ) {
705  if ( $levels == 0 ) {
706  return '';
707  } else {
708  $hash = md5( $name );
709  $path = '';
710  for ( $i = 1; $i <= $levels; $i++ ) {
711  $path .= substr( $hash, 0, $i ) . '/';
712  }
713 
714  return $path;
715  }
716  }
717 
723  public function getHashLevels() {
724  return $this->hashLevels;
725  }
726 
732  public function getName() {
733  return $this->name;
734  }
735 
743  public function makeUrl( $query = '', $entry = 'index' ) {
744  if ( isset( $this->scriptDirUrl ) ) {
745  return wfAppendQuery( "{$this->scriptDirUrl}/{$entry}.php", $query );
746  }
747 
748  return false;
749  }
750 
763  public function getDescriptionUrl( $name ) {
764  $encName = wfUrlencode( $name );
765  if ( !is_null( $this->descBaseUrl ) ) {
766  # "http://example.com/wiki/File:"
767  return $this->descBaseUrl . $encName;
768  }
769  if ( !is_null( $this->articleUrl ) ) {
770  # "http://example.com/wiki/$1"
771  # We use "Image:" as the canonical namespace for
772  # compatibility across all MediaWiki versions.
773  return str_replace( '$1',
774  "Image:$encName", $this->articleUrl );
775  }
776  if ( !is_null( $this->scriptDirUrl ) ) {
777  # "http://example.com/w"
778  # We use "Image:" as the canonical namespace for
779  # compatibility across all MediaWiki versions,
780  # and just sort of hope index.php is right. ;)
781  return $this->makeUrl( "title=Image:$encName" );
782  }
783 
784  return false;
785  }
786 
797  public function getDescriptionRenderUrl( $name, $lang = null ) {
798  $query = 'action=render';
799  if ( !is_null( $lang ) ) {
800  $query .= '&uselang=' . urlencode( $lang );
801  }
802  if ( isset( $this->scriptDirUrl ) ) {
803  return $this->makeUrl(
804  'title=' .
805  wfUrlencode( 'Image:' . $name ) .
806  "&$query" );
807  } else {
808  $descUrl = $this->getDescriptionUrl( $name );
809  if ( $descUrl ) {
810  return wfAppendQuery( $descUrl, $query );
811  } else {
812  return false;
813  }
814  }
815  }
816 
822  public function getDescriptionStylesheetUrl() {
823  if ( isset( $this->scriptDirUrl ) ) {
824  // Must match canonical query parameter order for optimum caching
825  // See Title::getCdnUrls
826  return $this->makeUrl( 'title=MediaWiki:Filepage.css&action=raw&ctype=text/css' );
827  }
828 
829  return false;
830  }
831 
845  public function store( $srcPath, $dstZone, $dstRel, $flags = 0 ) {
846  $this->assertWritableRepo(); // fail out if read-only
847 
848  $status = $this->storeBatch( [ [ $srcPath, $dstZone, $dstRel ] ], $flags );
849  if ( $status->successCount == 0 ) {
850  $status->setOK( false );
851  }
852 
853  return $status;
854  }
855 
868  public function storeBatch( array $triplets, $flags = 0 ) {
869  $this->assertWritableRepo(); // fail out if read-only
870 
871  if ( $flags & self::DELETE_SOURCE ) {
872  throw new InvalidArgumentException( "DELETE_SOURCE not supported in " . __METHOD__ );
873  }
874 
875  $status = $this->newGood();
876  $backend = $this->backend; // convenience
877 
878  $operations = [];
879  // Validate each triplet and get the store operation...
880  foreach ( $triplets as $triplet ) {
881  list( $srcPath, $dstZone, $dstRel ) = $triplet;
882  wfDebug( __METHOD__
883  . "( \$src='$srcPath', \$dstZone='$dstZone', \$dstRel='$dstRel' )\n"
884  );
885 
886  // Resolve destination path
887  $root = $this->getZonePath( $dstZone );
888  if ( !$root ) {
889  throw new MWException( "Invalid zone: $dstZone" );
890  }
891  if ( !$this->validateFilename( $dstRel ) ) {
892  throw new MWException( 'Validation error in $dstRel' );
893  }
894  $dstPath = "$root/$dstRel";
895  $dstDir = dirname( $dstPath );
896  // Create destination directories for this triplet
897  if ( !$this->initDirectory( $dstDir )->isOK() ) {
898  return $this->newFatal( 'directorycreateerror', $dstDir );
899  }
900 
901  // Resolve source to a storage path if virtual
902  $srcPath = $this->resolveToStoragePath( $srcPath );
903 
904  // Get the appropriate file operation
905  if ( FileBackend::isStoragePath( $srcPath ) ) {
906  $opName = 'copy';
907  } else {
908  $opName = 'store';
909  }
910  $operations[] = [
911  'op' => $opName,
912  'src' => $srcPath,
913  'dst' => $dstPath,
914  'overwrite' => $flags & self::OVERWRITE,
915  'overwriteSame' => $flags & self::OVERWRITE_SAME,
916  ];
917  }
918 
919  // Execute the store operation for each triplet
920  $opts = [ 'force' => true ];
921  if ( $flags & self::SKIP_LOCKING ) {
922  $opts['nonLocking'] = true;
923  }
924  $status->merge( $backend->doOperations( $operations, $opts ) );
925 
926  return $status;
927  }
928 
939  public function cleanupBatch( array $files, $flags = 0 ) {
940  $this->assertWritableRepo(); // fail out if read-only
941 
942  $status = $this->newGood();
943 
944  $operations = [];
945  foreach ( $files as $path ) {
946  if ( is_array( $path ) ) {
947  // This is a pair, extract it
948  list( $zone, $rel ) = $path;
949  $path = $this->getZonePath( $zone ) . "/$rel";
950  } else {
951  // Resolve source to a storage path if virtual
952  $path = $this->resolveToStoragePath( $path );
953  }
954  $operations[] = [ 'op' => 'delete', 'src' => $path ];
955  }
956  // Actually delete files from storage...
957  $opts = [ 'force' => true ];
958  if ( $flags & self::SKIP_LOCKING ) {
959  $opts['nonLocking'] = true;
960  }
961  $status->merge( $this->backend->doOperations( $operations, $opts ) );
962 
963  return $status;
964  }
965 
979  final public function quickImport( $src, $dst, $options = null ) {
980  return $this->quickImportBatch( [ [ $src, $dst, $options ] ] );
981  }
982 
991  final public function quickPurge( $path ) {
992  return $this->quickPurgeBatch( [ $path ] );
993  }
994 
1002  public function quickCleanDir( $dir ) {
1003  $status = $this->newGood();
1004  $status->merge( $this->backend->clean(
1005  [ 'dir' => $this->resolveToStoragePath( $dir ) ] ) );
1006 
1007  return $status;
1008  }
1009 
1022  public function quickImportBatch( array $triples ) {
1023  $status = $this->newGood();
1024  $operations = [];
1025  foreach ( $triples as $triple ) {
1026  list( $src, $dst ) = $triple;
1027  if ( $src instanceof FSFile ) {
1028  $op = 'store';
1029  } else {
1030  $src = $this->resolveToStoragePath( $src );
1031  $op = FileBackend::isStoragePath( $src ) ? 'copy' : 'store';
1032  }
1033  $dst = $this->resolveToStoragePath( $dst );
1034 
1035  if ( !isset( $triple[2] ) ) {
1036  $headers = [];
1037  } elseif ( is_string( $triple[2] ) ) {
1038  // back-compat
1039  $headers = [ 'Content-Disposition' => $triple[2] ];
1040  } elseif ( is_array( $triple[2] ) && isset( $triple[2]['headers'] ) ) {
1041  $headers = $triple[2]['headers'];
1042  } else {
1043  $headers = [];
1044  }
1045 
1046  $operations[] = [
1047  'op' => $op,
1048  'src' => $src,
1049  'dst' => $dst,
1050  'headers' => $headers
1051  ];
1052  $status->merge( $this->initDirectory( dirname( $dst ) ) );
1053  }
1054  $status->merge( $this->backend->doQuickOperations( $operations ) );
1055 
1056  return $status;
1057  }
1058 
1067  public function quickPurgeBatch( array $paths ) {
1068  $status = $this->newGood();
1069  $operations = [];
1070  foreach ( $paths as $path ) {
1071  $operations[] = [
1072  'op' => 'delete',
1073  'src' => $this->resolveToStoragePath( $path ),
1074  'ignoreMissingSource' => true
1075  ];
1076  }
1077  $status->merge( $this->backend->doQuickOperations( $operations ) );
1078 
1079  return $status;
1080  }
1081 
1092  public function storeTemp( $originalName, $srcPath ) {
1093  $this->assertWritableRepo(); // fail out if read-only
1094 
1095  $date = MWTimestamp::getInstance()->format( 'YmdHis' );
1096  $hashPath = $this->getHashPath( $originalName );
1097  $dstUrlRel = $hashPath . $date . '!' . rawurlencode( $originalName );
1098  $virtualUrl = $this->getVirtualUrl( 'temp' ) . '/' . $dstUrlRel;
1099 
1100  $result = $this->quickImport( $srcPath, $virtualUrl );
1101  $result->value = $virtualUrl;
1102 
1103  return $result;
1104  }
1105 
1112  public function freeTemp( $virtualUrl ) {
1113  $this->assertWritableRepo(); // fail out if read-only
1114 
1115  $temp = $this->getVirtualUrl( 'temp' );
1116  if ( substr( $virtualUrl, 0, strlen( $temp ) ) != $temp ) {
1117  wfDebug( __METHOD__ . ": Invalid temp virtual URL\n" );
1118 
1119  return false;
1120  }
1121 
1122  return $this->quickPurge( $virtualUrl )->isOK();
1123  }
1124 
1134  public function concatenate( array $srcPaths, $dstPath, $flags = 0 ) {
1135  $this->assertWritableRepo(); // fail out if read-only
1136 
1137  $status = $this->newGood();
1138 
1139  $sources = [];
1140  foreach ( $srcPaths as $srcPath ) {
1141  // Resolve source to a storage path if virtual
1142  $source = $this->resolveToStoragePath( $srcPath );
1143  $sources[] = $source; // chunk to merge
1144  }
1145 
1146  // Concatenate the chunks into one FS file
1147  $params = [ 'srcs' => $sources, 'dst' => $dstPath ];
1148  $status->merge( $this->backend->concatenate( $params ) );
1149  if ( !$status->isOK() ) {
1150  return $status;
1151  }
1152 
1153  // Delete the sources if required
1154  if ( $flags & self::DELETE_SOURCE ) {
1155  $status->merge( $this->quickPurgeBatch( $srcPaths ) );
1156  }
1157 
1158  // Make sure status is OK, despite any quickPurgeBatch() fatals
1159  $status->setResult( true );
1160 
1161  return $status;
1162  }
1163 
1183  public function publish(
1184  $src, $dstRel, $archiveRel, $flags = 0, array $options = []
1185  ) {
1186  $this->assertWritableRepo(); // fail out if read-only
1187 
1188  $status = $this->publishBatch(
1189  [ [ $src, $dstRel, $archiveRel, $options ] ], $flags );
1190  if ( $status->successCount == 0 ) {
1191  $status->setOK( false );
1192  }
1193  $status->value = $status->value[0] ?? false;
1194 
1195  return $status;
1196  }
1197 
1208  public function publishBatch( array $ntuples, $flags = 0 ) {
1209  $this->assertWritableRepo(); // fail out if read-only
1210 
1211  $backend = $this->backend; // convenience
1212  // Try creating directories
1213  $status = $this->initZones( 'public' );
1214  if ( !$status->isOK() ) {
1215  return $status;
1216  }
1217 
1218  $status = $this->newGood( [] );
1219 
1220  $operations = [];
1221  $sourceFSFilesToDelete = []; // cleanup for disk source files
1222  // Validate each triplet and get the store operation...
1223  foreach ( $ntuples as $ntuple ) {
1224  list( $src, $dstRel, $archiveRel ) = $ntuple;
1225  $srcPath = ( $src instanceof FSFile ) ? $src->getPath() : $src;
1226 
1227  $options = $ntuple[3] ?? [];
1228  // Resolve source to a storage path if virtual
1229  $srcPath = $this->resolveToStoragePath( $srcPath );
1230  if ( !$this->validateFilename( $dstRel ) ) {
1231  throw new MWException( 'Validation error in $dstRel' );
1232  }
1233  if ( !$this->validateFilename( $archiveRel ) ) {
1234  throw new MWException( 'Validation error in $archiveRel' );
1235  }
1236 
1237  $publicRoot = $this->getZonePath( 'public' );
1238  $dstPath = "$publicRoot/$dstRel";
1239  $archivePath = "$publicRoot/$archiveRel";
1240 
1241  $dstDir = dirname( $dstPath );
1242  $archiveDir = dirname( $archivePath );
1243  // Abort immediately on directory creation errors since they're likely to be repetitive
1244  if ( !$this->initDirectory( $dstDir )->isOK() ) {
1245  return $this->newFatal( 'directorycreateerror', $dstDir );
1246  }
1247  if ( !$this->initDirectory( $archiveDir )->isOK() ) {
1248  return $this->newFatal( 'directorycreateerror', $archiveDir );
1249  }
1250 
1251  // Set any desired headers to be use in GET/HEAD responses
1252  $headers = $options['headers'] ?? [];
1253 
1254  // Archive destination file if it exists.
1255  // This will check if the archive file also exists and fail if does.
1256  // This is a sanity check to avoid data loss. On Windows and Linux,
1257  // copy() will overwrite, so the existence check is vulnerable to
1258  // race conditions unless a functioning LockManager is used.
1259  // LocalFile also uses SELECT FOR UPDATE for synchronization.
1260  $operations[] = [
1261  'op' => 'copy',
1262  'src' => $dstPath,
1263  'dst' => $archivePath,
1264  'ignoreMissingSource' => true
1265  ];
1266 
1267  // Copy (or move) the source file to the destination
1268  if ( FileBackend::isStoragePath( $srcPath ) ) {
1269  if ( $flags & self::DELETE_SOURCE ) {
1270  $operations[] = [
1271  'op' => 'move',
1272  'src' => $srcPath,
1273  'dst' => $dstPath,
1274  'overwrite' => true, // replace current
1275  'headers' => $headers
1276  ];
1277  } else {
1278  $operations[] = [
1279  'op' => 'copy',
1280  'src' => $srcPath,
1281  'dst' => $dstPath,
1282  'overwrite' => true, // replace current
1283  'headers' => $headers
1284  ];
1285  }
1286  } else { // FS source path
1287  $operations[] = [
1288  'op' => 'store',
1289  'src' => $src, // prefer FSFile objects
1290  'dst' => $dstPath,
1291  'overwrite' => true, // replace current
1292  'headers' => $headers
1293  ];
1294  if ( $flags & self::DELETE_SOURCE ) {
1295  $sourceFSFilesToDelete[] = $srcPath;
1296  }
1297  }
1298  }
1299 
1300  // Execute the operations for each triplet
1301  $status->merge( $backend->doOperations( $operations ) );
1302  // Find out which files were archived...
1303  foreach ( $ntuples as $i => $ntuple ) {
1304  list( , , $archiveRel ) = $ntuple;
1305  $archivePath = $this->getZonePath( 'public' ) . "/$archiveRel";
1306  if ( $this->fileExists( $archivePath ) ) {
1307  $status->value[$i] = 'archived';
1308  } else {
1309  $status->value[$i] = 'new';
1310  }
1311  }
1312  // Cleanup for disk source files...
1313  foreach ( $sourceFSFilesToDelete as $file ) {
1314  Wikimedia\suppressWarnings();
1315  unlink( $file ); // FS cleanup
1316  Wikimedia\restoreWarnings();
1317  }
1318 
1319  return $status;
1320  }
1321 
1329  protected function initDirectory( $dir ) {
1330  $path = $this->resolveToStoragePath( $dir );
1331  list( , $container, ) = FileBackend::splitStoragePath( $path );
1332 
1333  $params = [ 'dir' => $path ];
1334  if ( $this->isPrivate
1335  || $container === $this->zones['deleted']['container']
1336  || $container === $this->zones['temp']['container']
1337  ) {
1338  # Take all available measures to prevent web accessibility of new deleted
1339  # directories, in case the user has not configured offline storage
1340  $params = [ 'noAccess' => true, 'noListing' => true ] + $params;
1341  }
1342 
1343  $status = $this->newGood();
1344  $status->merge( $this->backend->prepare( $params ) );
1345 
1346  return $status;
1347  }
1348 
1355  public function cleanDir( $dir ) {
1356  $this->assertWritableRepo(); // fail out if read-only
1357 
1358  $status = $this->newGood();
1359  $status->merge( $this->backend->clean(
1360  [ 'dir' => $this->resolveToStoragePath( $dir ) ] ) );
1361 
1362  return $status;
1363  }
1364 
1371  public function fileExists( $file ) {
1372  $result = $this->fileExistsBatch( [ $file ] );
1373 
1374  return $result[0];
1375  }
1376 
1383  public function fileExistsBatch( array $files ) {
1384  $paths = array_map( [ $this, 'resolveToStoragePath' ], $files );
1385  $this->backend->preloadFileStat( [ 'srcs' => $paths ] );
1386 
1387  $result = [];
1388  foreach ( $files as $key => $file ) {
1389  $path = $this->resolveToStoragePath( $file );
1390  $result[$key] = $this->backend->fileExists( [ 'src' => $path ] );
1391  }
1392 
1393  return $result;
1394  }
1395 
1406  public function delete( $srcRel, $archiveRel ) {
1407  $this->assertWritableRepo(); // fail out if read-only
1408 
1409  return $this->deleteBatch( [ [ $srcRel, $archiveRel ] ] );
1410  }
1411 
1429  public function deleteBatch( array $sourceDestPairs ) {
1430  $this->assertWritableRepo(); // fail out if read-only
1431 
1432  // Try creating directories
1433  $status = $this->initZones( [ 'public', 'deleted' ] );
1434  if ( !$status->isOK() ) {
1435  return $status;
1436  }
1437 
1438  $status = $this->newGood();
1439 
1440  $backend = $this->backend; // convenience
1441  $operations = [];
1442  // Validate filenames and create archive directories
1443  foreach ( $sourceDestPairs as $pair ) {
1444  list( $srcRel, $archiveRel ) = $pair;
1445  if ( !$this->validateFilename( $srcRel ) ) {
1446  throw new MWException( __METHOD__ . ':Validation error in $srcRel' );
1447  } elseif ( !$this->validateFilename( $archiveRel ) ) {
1448  throw new MWException( __METHOD__ . ':Validation error in $archiveRel' );
1449  }
1450 
1451  $publicRoot = $this->getZonePath( 'public' );
1452  $srcPath = "{$publicRoot}/$srcRel";
1453 
1454  $deletedRoot = $this->getZonePath( 'deleted' );
1455  $archivePath = "{$deletedRoot}/{$archiveRel}";
1456  $archiveDir = dirname( $archivePath ); // does not touch FS
1457 
1458  // Create destination directories
1459  if ( !$this->initDirectory( $archiveDir )->isOK() ) {
1460  return $this->newFatal( 'directorycreateerror', $archiveDir );
1461  }
1462 
1463  $operations[] = [
1464  'op' => 'move',
1465  'src' => $srcPath,
1466  'dst' => $archivePath,
1467  // We may have 2+ identical files being deleted,
1468  // all of which will map to the same destination file
1469  'overwriteSame' => true // also see T33792
1470  ];
1471  }
1472 
1473  // Move the files by execute the operations for each pair.
1474  // We're now committed to returning an OK result, which will
1475  // lead to the files being moved in the DB also.
1476  $opts = [ 'force' => true ];
1477  $status->merge( $backend->doOperations( $operations, $opts ) );
1478 
1479  return $status;
1480  }
1481 
1488  public function cleanupDeletedBatch( array $storageKeys ) {
1489  $this->assertWritableRepo();
1490  }
1491 
1500  public function getDeletedHashPath( $key ) {
1501  if ( strlen( $key ) < 31 ) {
1502  throw new MWException( "Invalid storage key '$key'." );
1503  }
1504  $path = '';
1505  for ( $i = 0; $i < $this->deletedHashLevels; $i++ ) {
1506  $path .= $key[$i] . '/';
1507  }
1508 
1509  return $path;
1510  }
1511 
1520  protected function resolveToStoragePath( $path ) {
1521  if ( self::isVirtualUrl( $path ) ) {
1522  return $this->resolveVirtualUrl( $path );
1523  }
1524 
1525  return $path;
1526  }
1527 
1535  public function getLocalCopy( $virtualUrl ) {
1536  $path = $this->resolveToStoragePath( $virtualUrl );
1537 
1538  return $this->backend->getLocalCopy( [ 'src' => $path ] );
1539  }
1540 
1549  public function getLocalReference( $virtualUrl ) {
1550  $path = $this->resolveToStoragePath( $virtualUrl );
1551 
1552  return $this->backend->getLocalReference( [ 'src' => $path ] );
1553  }
1554 
1562  public function getFileProps( $virtualUrl ) {
1563  $fsFile = $this->getLocalReference( $virtualUrl );
1564  $mwProps = new MWFileProps( MediaWiki\MediaWikiServices::getInstance()->getMimeAnalyzer() );
1565  if ( $fsFile ) {
1566  $props = $mwProps->getPropsFromPath( $fsFile->getPath(), true );
1567  } else {
1568  $props = $mwProps->newPlaceholderProps();
1569  }
1570 
1571  return $props;
1572  }
1573 
1580  public function getFileTimestamp( $virtualUrl ) {
1581  $path = $this->resolveToStoragePath( $virtualUrl );
1582 
1583  return $this->backend->getFileTimestamp( [ 'src' => $path ] );
1584  }
1585 
1592  public function getFileSize( $virtualUrl ) {
1593  $path = $this->resolveToStoragePath( $virtualUrl );
1594 
1595  return $this->backend->getFileSize( [ 'src' => $path ] );
1596  }
1597 
1604  public function getFileSha1( $virtualUrl ) {
1605  $path = $this->resolveToStoragePath( $virtualUrl );
1606 
1607  return $this->backend->getFileSha1Base36( [ 'src' => $path ] );
1608  }
1609 
1619  public function streamFileWithStatus( $virtualUrl, $headers = [], $optHeaders = [] ) {
1620  $path = $this->resolveToStoragePath( $virtualUrl );
1621  $params = [ 'src' => $path, 'headers' => $headers, 'options' => $optHeaders ];
1622 
1623  // T172851: HHVM does not flush the output properly, causing OOM
1624  ob_start( null, 1048576 );
1625  ob_implicit_flush( true );
1626 
1627  $status = $this->newGood();
1628  $status->merge( $this->backend->streamFile( $params ) );
1629 
1630  // T186565: Close the buffer, unless it has already been closed
1631  // in HTTPFileStreamer::resetOutputBuffers().
1632  if ( ob_get_status() ) {
1633  ob_end_flush();
1634  }
1635 
1636  return $status;
1637  }
1638 
1647  public function enumFiles( $callback ) {
1648  $this->enumFilesInStorage( $callback );
1649  }
1650 
1658  protected function enumFilesInStorage( $callback ) {
1659  $publicRoot = $this->getZonePath( 'public' );
1660  $numDirs = 1 << ( $this->hashLevels * 4 );
1661  // Use a priori assumptions about directory structure
1662  // to reduce the tree height of the scanning process.
1663  for ( $flatIndex = 0; $flatIndex < $numDirs; $flatIndex++ ) {
1664  $hexString = sprintf( "%0{$this->hashLevels}x", $flatIndex );
1665  $path = $publicRoot;
1666  for ( $hexPos = 0; $hexPos < $this->hashLevels; $hexPos++ ) {
1667  $path .= '/' . substr( $hexString, 0, $hexPos + 1 );
1668  }
1669  $iterator = $this->backend->getFileList( [ 'dir' => $path ] );
1670  foreach ( $iterator as $name ) {
1671  // Each item returned is a public file
1672  call_user_func( $callback, "{$path}/{$name}" );
1673  }
1674  }
1675  }
1676 
1683  public function validateFilename( $filename ) {
1684  if ( strval( $filename ) == '' ) {
1685  return false;
1686  }
1687 
1688  return FileBackend::isPathTraversalFree( $filename );
1689  }
1690 
1697  switch ( $this->pathDisclosureProtection ) {
1698  case 'none':
1699  case 'simple': // b/c
1700  $callback = [ $this, 'passThrough' ];
1701  break;
1702  default: // 'paranoid'
1703  $callback = [ $this, 'paranoidClean' ];
1704  }
1705  return $callback;
1706  }
1707 
1714  function paranoidClean( $param ) {
1715  return '[hidden]';
1716  }
1717 
1724  function passThrough( $param ) {
1725  return $param;
1726  }
1727 
1734  public function newFatal( $message /*, parameters...*/ ) {
1735  $status = Status::newFatal( ...func_get_args() );
1736  $status->cleanCallback = $this->getErrorCleanupFunction();
1737 
1738  return $status;
1739  }
1740 
1747  public function newGood( $value = null ) {
1749  $status->cleanCallback = $this->getErrorCleanupFunction();
1750 
1751  return $status;
1752  }
1753 
1762  public function checkRedirect( Title $title ) {
1763  return false;
1764  }
1765 
1773  public function invalidateImageRedirect( Title $title ) {
1774  }
1775 
1781  public function getDisplayName() {
1782  global $wgSitename;
1783 
1784  if ( $this->isLocal() ) {
1785  return $wgSitename;
1786  }
1787 
1788  // 'shared-repo-name-wikimediacommons' is used when $wgUseInstantCommons = true
1789  return wfMessageFallback( 'shared-repo-name-' . $this->name, 'shared-repo' )->text();
1790  }
1791 
1799  public function nameForThumb( $name ) {
1800  if ( strlen( $name ) > $this->abbrvThreshold ) {
1802  $name = ( $ext == '' ) ? 'thumbnail' : "thumbnail.$ext";
1803  }
1804 
1805  return $name;
1806  }
1807 
1813  public function isLocal() {
1814  return $this->getName() == 'local';
1815  }
1816 
1825  public function getSharedCacheKey( /*...*/ ) {
1826  return false;
1827  }
1828 
1836  public function getLocalCacheKey( /*...*/ ) {
1837  $args = func_get_args();
1838  array_unshift( $args, 'filerepo', $this->getName() );
1839 
1840  return $this->wanCache->makeKey( ...$args );
1841  }
1842 
1851  public function getTempRepo() {
1852  return new TempFileRepo( [
1853  'name' => "{$this->name}-temp",
1854  'backend' => $this->backend,
1855  'zones' => [
1856  'public' => [
1857  // Same place storeTemp() uses in the base repo, though
1858  // the path hashing is mismatched, which is annoying.
1859  'container' => $this->zones['temp']['container'],
1860  'directory' => $this->zones['temp']['directory']
1861  ],
1862  'thumb' => [
1863  'container' => $this->zones['temp']['container'],
1864  'directory' => $this->zones['temp']['directory'] == ''
1865  ? 'thumb'
1866  : $this->zones['temp']['directory'] . '/thumb'
1867  ],
1868  'transcoded' => [
1869  'container' => $this->zones['temp']['container'],
1870  'directory' => $this->zones['temp']['directory'] == ''
1871  ? 'transcoded'
1872  : $this->zones['temp']['directory'] . '/transcoded'
1873  ]
1874  ],
1875  'hashLevels' => $this->hashLevels, // performance
1876  'isPrivate' => true // all in temp zone
1877  ] );
1878  }
1879 
1886  public function getUploadStash( User $user = null ) {
1887  return new UploadStash( $this, $user );
1888  }
1889 
1897  protected function assertWritableRepo() {
1898  }
1899 
1906  public function getInfo() {
1907  $ret = [
1908  'name' => $this->getName(),
1909  'displayname' => $this->getDisplayName(),
1910  'rootUrl' => $this->getZoneUrl( 'public' ),
1911  'local' => $this->isLocal(),
1912  ];
1913 
1914  $optionalSettings = [
1915  'url', 'thumbUrl', 'initialCapital', 'descBaseUrl', 'scriptDirUrl', 'articleUrl',
1916  'fetchDescription', 'descriptionCacheExpiry', 'favicon'
1917  ];
1918  foreach ( $optionalSettings as $k ) {
1919  if ( isset( $this->$k ) ) {
1920  $ret[$k] = $this->$k;
1921  }
1922  }
1923 
1924  return $ret;
1925  }
1926 
1931  public function hasSha1Storage() {
1932  return $this->hasSha1Storage;
1933  }
1934 
1939  public function supportsSha1URLs() {
1940  return $this->supportsSha1URLs;
1941  }
1942 }
string $favicon
The URL of the repo&#39;s favicon, if any.
Definition: FileRepo.php:121
assertWritableRepo()
Throw an exception if this repo is read-only by design.
Definition: FileRepo.php:1897
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:50
string $scriptDirUrl
URL of the MediaWiki installation, equivalent to $wgScriptPath, e.g.
Definition: FileRepo.php:83
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:118
array $zones
Map of zones to config.
Definition: FileRepo.php:65
return true to allow those checks to and false if checking is done remove or add to the links of a group of changes in EnhancedChangesList Hook subscribers can return false to omit this line from recentchanges use this to change the tables headers change it to an object instance and return false override the list derivative used $groups Array of ChangesListFilterGroup objects(added in 1.34) 'FileDeleteComplete' 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:1529
canTransformVia404()
Returns true if the repository can transform files via a 404 handler.
Definition: FileRepo.php:640
getTempRepo()
Get a temporary private FileRepo associated with this repo.
Definition: FileRepo.php:1851
getVirtualUrl( $suffix=false)
Get a URL referring to this repository, with the private mwrepo protocol.
Definition: FileRepo.php:269
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:1592
getUserCaseDBKey()
Get the DB key with the initial letter case as specified by the user.
Definition: Title.php:1031
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:100
paranoidClean( $param)
Path disclosure protection function.
Definition: FileRepo.php:1714
getDescriptionUrl( $name)
Get the URL of an image description page.
Definition: FileRepo.php:763
$wgSitename
Name of the site.
cleanDir( $dir)
Deletes a directory if empty.
Definition: FileRepo.php:1355
getRootDirectory()
Get the public zone root storage directory of the repository.
Definition: FileRepo.php:671
initDirectory( $dir)
Creates a directory with the appropriate zone permissions.
Definition: FileRepo.php:1329
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:1972
getUploadStash(User $user=null)
Get an UploadStash associated with this repo.
Definition: FileRepo.php:1886
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:743
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:103
nameForThumb( $name)
Get the portion of the file that contains the origin file name.
Definition: FileRepo.php:1799
resolveVirtualUrl( $url)
Get the backend storage path corresponding to a virtual URL.
Definition: FileRepo.php:326
const DELETE_SOURCE
Definition: FileRepo.php:40
WANObjectCache $wanCache
Definition: FileRepo.php:143
checkRedirect(Title $title)
Checks if there is a redirect named as $title.
Definition: FileRepo.php:1762
quickCleanDir( $dir)
Deletes a directory if empty.
Definition: FileRepo.php:1002
$source
$value
getLocalCacheKey()
Get a key for this repo in the local cache domain.
Definition: FileRepo.php:1836
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:723
getZoneUrl( $zone, $ext=null)
Get the URL corresponding to one of the four basic zones.
Definition: FileRepo.php:285
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:979
freeTemp( $virtualUrl)
Remove a temporary file or mark it for garbage collection.
Definition: FileRepo.php:1112
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:1781
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:1183
callable false $oldFileFactory
Override these in the base class.
Definition: FileRepo.php:129
cleanupDeletedBatch(array $storageKeys)
Delete files in the deleted directory if they are not referenced in the filearchive table...
Definition: FileRepo.php:1488
const DELETED_FILE
Definition: File.php:63
getBackend()
Get the file backend instance.
Definition: FileRepo.php:218
fileExists( $file)
Checks existence of a file.
Definition: FileRepo.php:1371
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\*-\*)") will be honored when streaming the file. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. '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:1970
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:51
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:1972
getZoneLocation( $zone)
The the storage container and base path of a zone.
Definition: FileRepo.php:352
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:1647
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:1244
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:1658
isLocal()
Returns true if this the local file repository.
Definition: FileRepo.php:1813
getReadOnlyReason()
Get an explanatory message if this repo is read-only.
Definition: FileRepo.php:228
initZones( $doZones=[])
Check if a single zone or list of zones is defined for usage.
Definition: FileRepo.php:239
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:138
getThumbProxyUrl()
Get the URL thumb.php requests are being proxied to.
Definition: FileRepo.php:622
getInfo()
Return information about the repository.
Definition: FileRepo.php:1906
string $thumbScriptUrl
URL of thumb.php.
Definition: FileRepo.php:68
getDescriptionStylesheetUrl()
Get the URL of the stylesheet to apply to description pages.
Definition: FileRepo.php:822
getDBkey()
Get the main part with underscores.
Definition: Title.php:1021
quickPurgeBatch(array $paths)
Purge a batch of files from the repo.
Definition: FileRepo.php:1067
callable $fileFactory
Override these in the base class.
Definition: FileRepo.php:127
getErrorCleanupFunction()
Get a callback function to use for cleaning error message parameters.
Definition: FileRepo.php:1696
getFileSha1( $virtualUrl)
Get the sha1 (base 36) of a file with a given virtual URL/storage path.
Definition: FileRepo.php:1604
invalidateImageRedirect(Title $title)
Invalidates image redirect cache related to that image Doesn&#39;t do anything for repositories that don&#39;...
Definition: FileRepo.php:1773
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:1134
deleteBatch(array $sourceDestPairs)
Move a group of files to the deletion archive.
Definition: FileRepo.php:1429
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:693
int $hashLevels
The number of directory levels for hash-based division of files.
Definition: FileRepo.php:109
getThumbScriptUrl()
Get the URL of thumb.php.
Definition: FileRepo.php:613
bool $initialCapital
Equivalent to $wgCapitalLinks (or $wgCapitalLinkOverrides[NS_FILE], determines whether filenames impl...
Definition: FileRepo.php:93
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:257
getSharedCacheKey()
Get a key on the primary cache for this repository.
Definition: FileRepo.php:1825
$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:1972
string $articleUrl
Equivalent to $wgArticlePath, e.g.
Definition: FileRepo.php:86
string $thumbUrl
The base thumbnail URL.
Definition: FileRepo.php:106
const ATTR_UNICODE_PATHS
findFilesByPrefix( $prefix, $limit)
Return an array of files where the name starts with $prefix.
Definition: FileRepo.php:604
newFile( $title, $time=false)
Create a new File object from the local repository.
Definition: FileRepo.php:390
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:767
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:912
findFiles(array $items, $flags=0)
Find many files at once.
Definition: FileRepo.php:499
getLocalCopy( $virtualUrl)
Get a local FS copy of a file with a given virtual URL/storage path.
Definition: FileRepo.php:1535
static getHashPathForLevel( $name, $levels)
Definition: FileRepo.php:704
const NS_FILE
Definition: Defines.php:66
bool $hasSha1Storage
Definition: FileRepo.php:56
int $descriptionCacheExpiry
Definition: FileRepo.php:53
getZonePath( $zone)
Get the storage path corresponding to one of the zones.
Definition: FileRepo.php:366
string $descBaseUrl
URL of image description pages, e.g.
Definition: FileRepo.php:78
streamFileWithStatus( $virtualUrl, $headers=[], $optHeaders=[])
Attempt to stream a file with the given virtual URL/storage path.
Definition: FileRepo.php:1619
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:1580
getNameFromTitle(Title $title)
Get the name of a file from its title object.
Definition: FileRepo.php:650
storeTemp( $originalName, $srcPath)
Pick a random name in the temp zone and store a file to it.
Definition: FileRepo.php:1092
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:140
backendSupportsUnicodePaths()
Definition: FileRepo.php:314
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:939
bool $transformVia404
Whether to skip media file transformation on parse and rely on a 404 handler instead.
Definition: FileRepo.php:73
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:423
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:584
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:1562
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:845
findBySha1( $hash)
Get an array or iterator of file objects for files that have a given SHA-1 content hash...
Definition: FileRepo.php:573
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:93
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:536
getDisplayName()
Get the human-readable name of the repo.
Definition: FileRepo.php:1781
if(!is_readable( $file)) $ext
Definition: router.php:48
Base class for file repositories.
Definition: FileRepo.php:39
bool $supportsSha1URLs
Definition: FileRepo.php:59
MimeMagic helper wrapper.
Definition: MWFileProps.php:28
getHashPath( $name)
Get a relative path including trailing slash, e.g.
Definition: FileRepo.php:682
storeBatch(array $triplets, $flags=0)
Store a batch of files.
Definition: FileRepo.php:868
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:1549
FileBackend $backend
Definition: FileRepo.php:62
fileExistsBatch(array $files)
Checks existence of an array of files.
Definition: FileRepo.php:1383
callable false $fileFactoryKey
Override these in the base class.
Definition: FileRepo.php:131
quickImportBatch(array $triples)
Import a batch of files from the local file system into the repo.
Definition: FileRepo.php:1022
quickPurge( $path)
Purge a file from the repo.
Definition: FileRepo.php:991
getDeletedHashPath( $key)
Get a relative path for a deletion archive key, e.g.
Definition: FileRepo.php:1500
passThrough( $param)
Path disclosure protection function.
Definition: FileRepo.php:1724
validateFilename( $filename)
Determine if a relative path is valid, i.e.
Definition: FileRepo.php:1683
supportsSha1URLs()
Returns whether or not repo supports having originals SHA-1s in the thumb URLs.
Definition: FileRepo.php:1939
int $deletedHashLevels
The number of directory levels for hash-based division of deleted files.
Definition: FileRepo.php:112
resolveToStoragePath( $path)
If a path is a virtual URL, resolve it to a storage path.
Definition: FileRepo.php:1520
__construct(array $info=null)
Definition: FileRepo.php:149
hasSha1Storage()
Returns whether or not storage is SHA-1 based.
Definition: FileRepo.php:1931
bool $isPrivate
Whether all zones should be private (e.g.
Definition: FileRepo.php:124
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:194
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1454
getThumbProxySecret()
Get the secret key for the proxied thumb service.
Definition: FileRepo.php:631
getDescriptionRenderUrl( $name, $lang=null)
Get the URL of the content-only fragment of the description page.
Definition: FileRepo.php:797
callable false $oldFileFactoryKey
Override these in the base class.
Definition: FileRepo.php:133
getName()
Get the name of this repository, as specified by $info[&#39;name]&#39; to the constructor.
Definition: FileRepo.php:732
newGood( $value=null)
Create a new good result.
Definition: FileRepo.php:1747
newFatal( $message)
Create a new fatal error.
Definition: FileRepo.php:1734
publishBatch(array $ntuples, $flags=0)
Publish a batch of files.
Definition: FileRepo.php:1208