MediaWiki  master
FileRepo.php
Go to the documentation of this file.
1 <?php
37 class FileRepo {
38  const DELETE_SOURCE = 1;
39  const OVERWRITE = 2;
40  const OVERWRITE_SAME = 4;
41  const SKIP_LOCKING = 8;
42 
43  const NAME_AND_TIME_ONLY = 1;
44 
48 
51 
53  protected $hasSha1Storage = false;
54 
56  protected $supportsSha1URLs = false;
57 
59  protected $backend;
60 
62  protected $zones = [];
63 
65  protected $thumbScriptUrl;
66 
69  protected $transformVia404;
70 
74  protected $descBaseUrl;
75 
79  protected $scriptDirUrl;
80 
82  protected $articleUrl;
83 
89  protected $initialCapital;
90 
96  protected $pathDisclosureProtection = 'simple';
97 
99  protected $url;
100 
102  protected $thumbUrl;
103 
105  protected $hashLevels;
106 
109 
114  protected $abbrvThreshold;
115 
117  protected $favicon;
118 
120  protected $isPrivate;
121 
123  protected $fileFactory = [ UnregisteredLocalFile::class, 'newFromTitle' ];
125  protected $oldFileFactory = false;
127  protected $fileFactoryKey = false;
129  protected $oldFileFactoryKey = false;
130 
134  protected $thumbProxyUrl;
136  protected $thumbProxySecret;
137 
142  public function __construct( array $info = null ) {
143  // Verify required settings presence
144  if (
145  $info === null
146  || !array_key_exists( 'name', $info )
147  || !array_key_exists( 'backend', $info )
148  ) {
149  throw new MWException( __CLASS__ .
150  " requires an array of options having both 'name' and 'backend' keys.\n" );
151  }
152 
153  // Required settings
154  $this->name = $info['name'];
155  if ( $info['backend'] instanceof FileBackend ) {
156  $this->backend = $info['backend']; // useful for testing
157  } else {
158  $this->backend = FileBackendGroup::singleton()->get( $info['backend'] );
159  }
160 
161  // Optional settings that can have no value
162  $optionalSettings = [
163  'descBaseUrl', 'scriptDirUrl', 'articleUrl', 'fetchDescription',
164  'thumbScriptUrl', 'pathDisclosureProtection', 'descriptionCacheExpiry',
165  'favicon', 'thumbProxyUrl', 'thumbProxySecret',
166  ];
167  foreach ( $optionalSettings as $var ) {
168  if ( isset( $info[$var] ) ) {
169  $this->$var = $info[$var];
170  }
171  }
172 
173  // Optional settings that have a default
174  $this->initialCapital = isset( $info['initialCapital'] )
175  ? $info['initialCapital']
177  $this->url = isset( $info['url'] )
178  ? $info['url']
179  : false; // a subclass may set the URL (e.g. ForeignAPIRepo)
180  if ( isset( $info['thumbUrl'] ) ) {
181  $this->thumbUrl = $info['thumbUrl'];
182  } else {
183  $this->thumbUrl = $this->url ? "{$this->url}/thumb" : false;
184  }
185  $this->hashLevels = isset( $info['hashLevels'] )
186  ? $info['hashLevels']
187  : 2;
188  $this->deletedHashLevels = isset( $info['deletedHashLevels'] )
189  ? $info['deletedHashLevels']
191  $this->transformVia404 = !empty( $info['transformVia404'] );
192  $this->abbrvThreshold = isset( $info['abbrvThreshold'] )
193  ? $info['abbrvThreshold']
194  : 255;
195  $this->isPrivate = !empty( $info['isPrivate'] );
196  // Give defaults for the basic zones...
197  $this->zones = isset( $info['zones'] ) ? $info['zones'] : [];
198  foreach ( [ 'public', 'thumb', 'transcoded', 'temp', 'deleted' ] as $zone ) {
199  if ( !isset( $this->zones[$zone]['container'] ) ) {
200  $this->zones[$zone]['container'] = "{$this->name}-{$zone}";
201  }
202  if ( !isset( $this->zones[$zone]['directory'] ) ) {
203  $this->zones[$zone]['directory'] = '';
204  }
205  if ( !isset( $this->zones[$zone]['urlsByExt'] ) ) {
206  $this->zones[$zone]['urlsByExt'] = [];
207  }
208  }
209 
210  $this->supportsSha1URLs = !empty( $info['supportsSha1URLs'] );
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 = isset( $options['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 = isset( $options['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 ) {
652  if ( $this->initialCapital != MWNamespace::isCapitalized( NS_FILE ) ) {
653  $name = $title->getUserCaseDBKey();
654  if ( $this->initialCapital ) {
655  $name = $wgContLang->ucfirst( $name );
656  }
657  } else {
658  $name = $title->getDBkey();
659  }
660 
661  return $name;
662  }
663 
669  public function getRootDirectory() {
670  return $this->getZonePath( 'public' );
671  }
672 
680  public function getHashPath( $name ) {
681  return self::getHashPathForLevel( $name, $this->hashLevels );
682  }
683 
691  public function getTempHashPath( $suffix ) {
692  $parts = explode( '!', $suffix, 2 ); // format is <timestamp>!<name> or just <name>
693  $name = isset( $parts[1] ) ? $parts[1] : $suffix; // hash path is not based on timestamp
694  return self::getHashPathForLevel( $name, $this->hashLevels );
695  }
696 
702  protected static function getHashPathForLevel( $name, $levels ) {
703  if ( $levels == 0 ) {
704  return '';
705  } else {
706  $hash = md5( $name );
707  $path = '';
708  for ( $i = 1; $i <= $levels; $i++ ) {
709  $path .= substr( $hash, 0, $i ) . '/';
710  }
711 
712  return $path;
713  }
714  }
715 
721  public function getHashLevels() {
722  return $this->hashLevels;
723  }
724 
730  public function getName() {
731  return $this->name;
732  }
733 
741  public function makeUrl( $query = '', $entry = 'index' ) {
742  if ( isset( $this->scriptDirUrl ) ) {
743  return wfAppendQuery( "{$this->scriptDirUrl}/{$entry}.php", $query );
744  }
745 
746  return false;
747  }
748 
761  public function getDescriptionUrl( $name ) {
762  $encName = wfUrlencode( $name );
763  if ( !is_null( $this->descBaseUrl ) ) {
764  # "http://example.com/wiki/File:"
765  return $this->descBaseUrl . $encName;
766  }
767  if ( !is_null( $this->articleUrl ) ) {
768  # "http://example.com/wiki/$1"
769  # We use "Image:" as the canonical namespace for
770  # compatibility across all MediaWiki versions.
771  return str_replace( '$1',
772  "Image:$encName", $this->articleUrl );
773  }
774  if ( !is_null( $this->scriptDirUrl ) ) {
775  # "http://example.com/w"
776  # We use "Image:" as the canonical namespace for
777  # compatibility across all MediaWiki versions,
778  # and just sort of hope index.php is right. ;)
779  return $this->makeUrl( "title=Image:$encName" );
780  }
781 
782  return false;
783  }
784 
795  public function getDescriptionRenderUrl( $name, $lang = null ) {
796  $query = 'action=render';
797  if ( !is_null( $lang ) ) {
798  $query .= '&uselang=' . urlencode( $lang );
799  }
800  if ( isset( $this->scriptDirUrl ) ) {
801  return $this->makeUrl(
802  'title=' .
803  wfUrlencode( 'Image:' . $name ) .
804  "&$query" );
805  } else {
806  $descUrl = $this->getDescriptionUrl( $name );
807  if ( $descUrl ) {
808  return wfAppendQuery( $descUrl, $query );
809  } else {
810  return false;
811  }
812  }
813  }
814 
820  public function getDescriptionStylesheetUrl() {
821  if ( isset( $this->scriptDirUrl ) ) {
822  return $this->makeUrl( 'title=MediaWiki:Filepage.css&' .
824  }
825 
826  return false;
827  }
828 
842  public function store( $srcPath, $dstZone, $dstRel, $flags = 0 ) {
843  $this->assertWritableRepo(); // fail out if read-only
844 
845  $status = $this->storeBatch( [ [ $srcPath, $dstZone, $dstRel ] ], $flags );
846  if ( $status->successCount == 0 ) {
847  $status->setOK( false );
848  }
849 
850  return $status;
851  }
852 
865  public function storeBatch( array $triplets, $flags = 0 ) {
866  $this->assertWritableRepo(); // fail out if read-only
867 
868  if ( $flags & self::DELETE_SOURCE ) {
869  throw new InvalidArgumentException( "DELETE_SOURCE not supported in " . __METHOD__ );
870  }
871 
872  $status = $this->newGood();
873  $backend = $this->backend; // convenience
874 
875  $operations = [];
876  // Validate each triplet and get the store operation...
877  foreach ( $triplets as $triplet ) {
878  list( $srcPath, $dstZone, $dstRel ) = $triplet;
879  wfDebug( __METHOD__
880  . "( \$src='$srcPath', \$dstZone='$dstZone', \$dstRel='$dstRel' )\n"
881  );
882 
883  // Resolve destination path
884  $root = $this->getZonePath( $dstZone );
885  if ( !$root ) {
886  throw new MWException( "Invalid zone: $dstZone" );
887  }
888  if ( !$this->validateFilename( $dstRel ) ) {
889  throw new MWException( 'Validation error in $dstRel' );
890  }
891  $dstPath = "$root/$dstRel";
892  $dstDir = dirname( $dstPath );
893  // Create destination directories for this triplet
894  if ( !$this->initDirectory( $dstDir )->isOK() ) {
895  return $this->newFatal( 'directorycreateerror', $dstDir );
896  }
897 
898  // Resolve source to a storage path if virtual
899  $srcPath = $this->resolveToStoragePath( $srcPath );
900 
901  // Get the appropriate file operation
902  if ( FileBackend::isStoragePath( $srcPath ) ) {
903  $opName = 'copy';
904  } else {
905  $opName = 'store';
906  }
907  $operations[] = [
908  'op' => $opName,
909  'src' => $srcPath,
910  'dst' => $dstPath,
911  'overwrite' => $flags & self::OVERWRITE,
912  'overwriteSame' => $flags & self::OVERWRITE_SAME,
913  ];
914  }
915 
916  // Execute the store operation for each triplet
917  $opts = [ 'force' => true ];
918  if ( $flags & self::SKIP_LOCKING ) {
919  $opts['nonLocking'] = true;
920  }
921  $status->merge( $backend->doOperations( $operations, $opts ) );
922 
923  return $status;
924  }
925 
936  public function cleanupBatch( array $files, $flags = 0 ) {
937  $this->assertWritableRepo(); // fail out if read-only
938 
939  $status = $this->newGood();
940 
941  $operations = [];
942  foreach ( $files as $path ) {
943  if ( is_array( $path ) ) {
944  // This is a pair, extract it
945  list( $zone, $rel ) = $path;
946  $path = $this->getZonePath( $zone ) . "/$rel";
947  } else {
948  // Resolve source to a storage path if virtual
949  $path = $this->resolveToStoragePath( $path );
950  }
951  $operations[] = [ 'op' => 'delete', 'src' => $path ];
952  }
953  // Actually delete files from storage...
954  $opts = [ 'force' => true ];
955  if ( $flags & self::SKIP_LOCKING ) {
956  $opts['nonLocking'] = true;
957  }
958  $status->merge( $this->backend->doOperations( $operations, $opts ) );
959 
960  return $status;
961  }
962 
976  final public function quickImport( $src, $dst, $options = null ) {
977  return $this->quickImportBatch( [ [ $src, $dst, $options ] ] );
978  }
979 
988  final public function quickPurge( $path ) {
989  return $this->quickPurgeBatch( [ $path ] );
990  }
991 
999  public function quickCleanDir( $dir ) {
1000  $status = $this->newGood();
1001  $status->merge( $this->backend->clean(
1002  [ 'dir' => $this->resolveToStoragePath( $dir ) ] ) );
1003 
1004  return $status;
1005  }
1006 
1019  public function quickImportBatch( array $triples ) {
1020  $status = $this->newGood();
1021  $operations = [];
1022  foreach ( $triples as $triple ) {
1023  list( $src, $dst ) = $triple;
1024  if ( $src instanceof FSFile ) {
1025  $op = 'store';
1026  } else {
1027  $src = $this->resolveToStoragePath( $src );
1028  $op = FileBackend::isStoragePath( $src ) ? 'copy' : 'store';
1029  }
1030  $dst = $this->resolveToStoragePath( $dst );
1031 
1032  if ( !isset( $triple[2] ) ) {
1033  $headers = [];
1034  } elseif ( is_string( $triple[2] ) ) {
1035  // back-compat
1036  $headers = [ 'Content-Disposition' => $triple[2] ];
1037  } elseif ( is_array( $triple[2] ) && isset( $triple[2]['headers'] ) ) {
1038  $headers = $triple[2]['headers'];
1039  } else {
1040  $headers = [];
1041  }
1042 
1043  $operations[] = [
1044  'op' => $op,
1045  'src' => $src,
1046  'dst' => $dst,
1047  'headers' => $headers
1048  ];
1049  $status->merge( $this->initDirectory( dirname( $dst ) ) );
1050  }
1051  $status->merge( $this->backend->doQuickOperations( $operations ) );
1052 
1053  return $status;
1054  }
1055 
1064  public function quickPurgeBatch( array $paths ) {
1065  $status = $this->newGood();
1066  $operations = [];
1067  foreach ( $paths as $path ) {
1068  $operations[] = [
1069  'op' => 'delete',
1070  'src' => $this->resolveToStoragePath( $path ),
1071  'ignoreMissingSource' => true
1072  ];
1073  }
1074  $status->merge( $this->backend->doQuickOperations( $operations ) );
1075 
1076  return $status;
1077  }
1078 
1089  public function storeTemp( $originalName, $srcPath ) {
1090  $this->assertWritableRepo(); // fail out if read-only
1091 
1092  $date = MWTimestamp::getInstance()->format( 'YmdHis' );
1093  $hashPath = $this->getHashPath( $originalName );
1094  $dstUrlRel = $hashPath . $date . '!' . rawurlencode( $originalName );
1095  $virtualUrl = $this->getVirtualUrl( 'temp' ) . '/' . $dstUrlRel;
1096 
1097  $result = $this->quickImport( $srcPath, $virtualUrl );
1098  $result->value = $virtualUrl;
1099 
1100  return $result;
1101  }
1102 
1109  public function freeTemp( $virtualUrl ) {
1110  $this->assertWritableRepo(); // fail out if read-only
1111 
1112  $temp = $this->getVirtualUrl( 'temp' );
1113  if ( substr( $virtualUrl, 0, strlen( $temp ) ) != $temp ) {
1114  wfDebug( __METHOD__ . ": Invalid temp virtual URL\n" );
1115 
1116  return false;
1117  }
1118 
1119  return $this->quickPurge( $virtualUrl )->isOK();
1120  }
1121 
1131  public function concatenate( array $srcPaths, $dstPath, $flags = 0 ) {
1132  $this->assertWritableRepo(); // fail out if read-only
1133 
1134  $status = $this->newGood();
1135 
1136  $sources = [];
1137  foreach ( $srcPaths as $srcPath ) {
1138  // Resolve source to a storage path if virtual
1139  $source = $this->resolveToStoragePath( $srcPath );
1140  $sources[] = $source; // chunk to merge
1141  }
1142 
1143  // Concatenate the chunks into one FS file
1144  $params = [ 'srcs' => $sources, 'dst' => $dstPath ];
1145  $status->merge( $this->backend->concatenate( $params ) );
1146  if ( !$status->isOK() ) {
1147  return $status;
1148  }
1149 
1150  // Delete the sources if required
1151  if ( $flags & self::DELETE_SOURCE ) {
1152  $status->merge( $this->quickPurgeBatch( $srcPaths ) );
1153  }
1154 
1155  // Make sure status is OK, despite any quickPurgeBatch() fatals
1156  $status->setResult( true );
1157 
1158  return $status;
1159  }
1160 
1180  public function publish(
1181  $src, $dstRel, $archiveRel, $flags = 0, array $options = []
1182  ) {
1183  $this->assertWritableRepo(); // fail out if read-only
1184 
1185  $status = $this->publishBatch(
1186  [ [ $src, $dstRel, $archiveRel, $options ] ], $flags );
1187  if ( $status->successCount == 0 ) {
1188  $status->setOK( false );
1189  }
1190  if ( isset( $status->value[0] ) ) {
1191  $status->value = $status->value[0];
1192  } else {
1193  $status->value = false;
1194  }
1195 
1196  return $status;
1197  }
1198 
1209  public function publishBatch( array $ntuples, $flags = 0 ) {
1210  $this->assertWritableRepo(); // fail out if read-only
1211 
1212  $backend = $this->backend; // convenience
1213  // Try creating directories
1214  $status = $this->initZones( 'public' );
1215  if ( !$status->isOK() ) {
1216  return $status;
1217  }
1218 
1219  $status = $this->newGood( [] );
1220 
1221  $operations = [];
1222  $sourceFSFilesToDelete = []; // cleanup for disk source files
1223  // Validate each triplet and get the store operation...
1224  foreach ( $ntuples as $ntuple ) {
1225  list( $src, $dstRel, $archiveRel ) = $ntuple;
1226  $srcPath = ( $src instanceof FSFile ) ? $src->getPath() : $src;
1227 
1228  $options = isset( $ntuple[3] ) ? $ntuple[3] : [];
1229  // Resolve source to a storage path if virtual
1230  $srcPath = $this->resolveToStoragePath( $srcPath );
1231  if ( !$this->validateFilename( $dstRel ) ) {
1232  throw new MWException( 'Validation error in $dstRel' );
1233  }
1234  if ( !$this->validateFilename( $archiveRel ) ) {
1235  throw new MWException( 'Validation error in $archiveRel' );
1236  }
1237 
1238  $publicRoot = $this->getZonePath( 'public' );
1239  $dstPath = "$publicRoot/$dstRel";
1240  $archivePath = "$publicRoot/$archiveRel";
1241 
1242  $dstDir = dirname( $dstPath );
1243  $archiveDir = dirname( $archivePath );
1244  // Abort immediately on directory creation errors since they're likely to be repetitive
1245  if ( !$this->initDirectory( $dstDir )->isOK() ) {
1246  return $this->newFatal( 'directorycreateerror', $dstDir );
1247  }
1248  if ( !$this->initDirectory( $archiveDir )->isOK() ) {
1249  return $this->newFatal( 'directorycreateerror', $archiveDir );
1250  }
1251 
1252  // Set any desired headers to be use in GET/HEAD responses
1253  $headers = isset( $options['headers'] ) ? $options['headers'] : [];
1254 
1255  // Archive destination file if it exists.
1256  // This will check if the archive file also exists and fail if does.
1257  // This is a sanity check to avoid data loss. On Windows and Linux,
1258  // copy() will overwrite, so the existence check is vulnerable to
1259  // race conditions unless a functioning LockManager is used.
1260  // LocalFile also uses SELECT FOR UPDATE for synchronization.
1261  $operations[] = [
1262  'op' => 'copy',
1263  'src' => $dstPath,
1264  'dst' => $archivePath,
1265  'ignoreMissingSource' => true
1266  ];
1267 
1268  // Copy (or move) the source file to the destination
1269  if ( FileBackend::isStoragePath( $srcPath ) ) {
1270  if ( $flags & self::DELETE_SOURCE ) {
1271  $operations[] = [
1272  'op' => 'move',
1273  'src' => $srcPath,
1274  'dst' => $dstPath,
1275  'overwrite' => true, // replace current
1276  'headers' => $headers
1277  ];
1278  } else {
1279  $operations[] = [
1280  'op' => 'copy',
1281  'src' => $srcPath,
1282  'dst' => $dstPath,
1283  'overwrite' => true, // replace current
1284  'headers' => $headers
1285  ];
1286  }
1287  } else { // FS source path
1288  $operations[] = [
1289  'op' => 'store',
1290  'src' => $src, // prefer FSFile objects
1291  'dst' => $dstPath,
1292  'overwrite' => true, // replace current
1293  'headers' => $headers
1294  ];
1295  if ( $flags & self::DELETE_SOURCE ) {
1296  $sourceFSFilesToDelete[] = $srcPath;
1297  }
1298  }
1299  }
1300 
1301  // Execute the operations for each triplet
1302  $status->merge( $backend->doOperations( $operations ) );
1303  // Find out which files were archived...
1304  foreach ( $ntuples as $i => $ntuple ) {
1305  list( , , $archiveRel ) = $ntuple;
1306  $archivePath = $this->getZonePath( 'public' ) . "/$archiveRel";
1307  if ( $this->fileExists( $archivePath ) ) {
1308  $status->value[$i] = 'archived';
1309  } else {
1310  $status->value[$i] = 'new';
1311  }
1312  }
1313  // Cleanup for disk source files...
1314  foreach ( $sourceFSFilesToDelete as $file ) {
1315  Wikimedia\suppressWarnings();
1316  unlink( $file ); // FS cleanup
1317  Wikimedia\restoreWarnings();
1318  }
1319 
1320  return $status;
1321  }
1322 
1330  protected function initDirectory( $dir ) {
1331  $path = $this->resolveToStoragePath( $dir );
1332  list( , $container, ) = FileBackend::splitStoragePath( $path );
1333 
1334  $params = [ 'dir' => $path ];
1335  if ( $this->isPrivate
1336  || $container === $this->zones['deleted']['container']
1337  || $container === $this->zones['temp']['container']
1338  ) {
1339  # Take all available measures to prevent web accessibility of new deleted
1340  # directories, in case the user has not configured offline storage
1341  $params = [ 'noAccess' => true, 'noListing' => true ] + $params;
1342  }
1343 
1344  $status = $this->newGood();
1345  $status->merge( $this->backend->prepare( $params ) );
1346 
1347  return $status;
1348  }
1349 
1356  public function cleanDir( $dir ) {
1357  $this->assertWritableRepo(); // fail out if read-only
1358 
1359  $status = $this->newGood();
1360  $status->merge( $this->backend->clean(
1361  [ 'dir' => $this->resolveToStoragePath( $dir ) ] ) );
1362 
1363  return $status;
1364  }
1365 
1372  public function fileExists( $file ) {
1373  $result = $this->fileExistsBatch( [ $file ] );
1374 
1375  return $result[0];
1376  }
1377 
1384  public function fileExistsBatch( array $files ) {
1385  $paths = array_map( [ $this, 'resolveToStoragePath' ], $files );
1386  $this->backend->preloadFileStat( [ 'srcs' => $paths ] );
1387 
1388  $result = [];
1389  foreach ( $files as $key => $file ) {
1390  $path = $this->resolveToStoragePath( $file );
1391  $result[$key] = $this->backend->fileExists( [ 'src' => $path ] );
1392  }
1393 
1394  return $result;
1395  }
1396 
1407  public function delete( $srcRel, $archiveRel ) {
1408  $this->assertWritableRepo(); // fail out if read-only
1409 
1410  return $this->deleteBatch( [ [ $srcRel, $archiveRel ] ] );
1411  }
1412 
1430  public function deleteBatch( array $sourceDestPairs ) {
1431  $this->assertWritableRepo(); // fail out if read-only
1432 
1433  // Try creating directories
1434  $status = $this->initZones( [ 'public', 'deleted' ] );
1435  if ( !$status->isOK() ) {
1436  return $status;
1437  }
1438 
1439  $status = $this->newGood();
1440 
1441  $backend = $this->backend; // convenience
1442  $operations = [];
1443  // Validate filenames and create archive directories
1444  foreach ( $sourceDestPairs as $pair ) {
1445  list( $srcRel, $archiveRel ) = $pair;
1446  if ( !$this->validateFilename( $srcRel ) ) {
1447  throw new MWException( __METHOD__ . ':Validation error in $srcRel' );
1448  } elseif ( !$this->validateFilename( $archiveRel ) ) {
1449  throw new MWException( __METHOD__ . ':Validation error in $archiveRel' );
1450  }
1451 
1452  $publicRoot = $this->getZonePath( 'public' );
1453  $srcPath = "{$publicRoot}/$srcRel";
1454 
1455  $deletedRoot = $this->getZonePath( 'deleted' );
1456  $archivePath = "{$deletedRoot}/{$archiveRel}";
1457  $archiveDir = dirname( $archivePath ); // does not touch FS
1458 
1459  // Create destination directories
1460  if ( !$this->initDirectory( $archiveDir )->isOK() ) {
1461  return $this->newFatal( 'directorycreateerror', $archiveDir );
1462  }
1463 
1464  $operations[] = [
1465  'op' => 'move',
1466  'src' => $srcPath,
1467  'dst' => $archivePath,
1468  // We may have 2+ identical files being deleted,
1469  // all of which will map to the same destination file
1470  'overwriteSame' => true // also see T33792
1471  ];
1472  }
1473 
1474  // Move the files by execute the operations for each pair.
1475  // We're now committed to returning an OK result, which will
1476  // lead to the files being moved in the DB also.
1477  $opts = [ 'force' => true ];
1478  $status->merge( $backend->doOperations( $operations, $opts ) );
1479 
1480  return $status;
1481  }
1482 
1489  public function cleanupDeletedBatch( array $storageKeys ) {
1490  $this->assertWritableRepo();
1491  }
1492 
1501  public function getDeletedHashPath( $key ) {
1502  if ( strlen( $key ) < 31 ) {
1503  throw new MWException( "Invalid storage key '$key'." );
1504  }
1505  $path = '';
1506  for ( $i = 0; $i < $this->deletedHashLevels; $i++ ) {
1507  $path .= $key[$i] . '/';
1508  }
1509 
1510  return $path;
1511  }
1512 
1521  protected function resolveToStoragePath( $path ) {
1522  if ( $this->isVirtualUrl( $path ) ) {
1523  return $this->resolveVirtualUrl( $path );
1524  }
1525 
1526  return $path;
1527  }
1528 
1536  public function getLocalCopy( $virtualUrl ) {
1537  $path = $this->resolveToStoragePath( $virtualUrl );
1538 
1539  return $this->backend->getLocalCopy( [ 'src' => $path ] );
1540  }
1541 
1550  public function getLocalReference( $virtualUrl ) {
1551  $path = $this->resolveToStoragePath( $virtualUrl );
1552 
1553  return $this->backend->getLocalReference( [ 'src' => $path ] );
1554  }
1555 
1563  public function getFileProps( $virtualUrl ) {
1564  $fsFile = $this->getLocalReference( $virtualUrl );
1565  $mwProps = new MWFileProps( MediaWiki\MediaWikiServices::getInstance()->getMimeAnalyzer() );
1566  if ( $fsFile ) {
1567  $props = $mwProps->getPropsFromPath( $fsFile->getPath(), true );
1568  } else {
1569  $props = $mwProps->newPlaceholderProps();
1570  }
1571 
1572  return $props;
1573  }
1574 
1581  public function getFileTimestamp( $virtualUrl ) {
1582  $path = $this->resolveToStoragePath( $virtualUrl );
1583 
1584  return $this->backend->getFileTimestamp( [ 'src' => $path ] );
1585  }
1586 
1593  public function getFileSize( $virtualUrl ) {
1594  $path = $this->resolveToStoragePath( $virtualUrl );
1595 
1596  return $this->backend->getFileSize( [ 'src' => $path ] );
1597  }
1598 
1605  public function getFileSha1( $virtualUrl ) {
1606  $path = $this->resolveToStoragePath( $virtualUrl );
1607 
1608  return $this->backend->getFileSha1Base36( [ 'src' => $path ] );
1609  }
1610 
1620  public function streamFileWithStatus( $virtualUrl, $headers = [], $optHeaders = [] ) {
1621  $path = $this->resolveToStoragePath( $virtualUrl );
1622  $params = [ 'src' => $path, 'headers' => $headers, 'options' => $optHeaders ];
1623 
1624  // T172851: HHVM does not flush the output properly, causing OOM
1625  ob_start( null, 1048576 );
1626  ob_implicit_flush( true );
1627 
1628  $status = $this->newGood();
1629  $status->merge( $this->backend->streamFile( $params ) );
1630 
1631  // T186565: Close the buffer, unless it has already been closed
1632  // in HTTPFileStreamer::resetOutputBuffers().
1633  if ( ob_get_status() ) {
1634  ob_end_flush();
1635  }
1636 
1637  return $status;
1638  }
1639 
1648  public function streamFile( $virtualUrl, $headers = [] ) {
1649  return $this->streamFileWithStatus( $virtualUrl, $headers )->isOK();
1650  }
1651 
1660  public function enumFiles( $callback ) {
1661  $this->enumFilesInStorage( $callback );
1662  }
1663 
1671  protected function enumFilesInStorage( $callback ) {
1672  $publicRoot = $this->getZonePath( 'public' );
1673  $numDirs = 1 << ( $this->hashLevels * 4 );
1674  // Use a priori assumptions about directory structure
1675  // to reduce the tree height of the scanning process.
1676  for ( $flatIndex = 0; $flatIndex < $numDirs; $flatIndex++ ) {
1677  $hexString = sprintf( "%0{$this->hashLevels}x", $flatIndex );
1678  $path = $publicRoot;
1679  for ( $hexPos = 0; $hexPos < $this->hashLevels; $hexPos++ ) {
1680  $path .= '/' . substr( $hexString, 0, $hexPos + 1 );
1681  }
1682  $iterator = $this->backend->getFileList( [ 'dir' => $path ] );
1683  foreach ( $iterator as $name ) {
1684  // Each item returned is a public file
1685  call_user_func( $callback, "{$path}/{$name}" );
1686  }
1687  }
1688  }
1689 
1696  public function validateFilename( $filename ) {
1697  if ( strval( $filename ) == '' ) {
1698  return false;
1699  }
1700 
1701  return FileBackend::isPathTraversalFree( $filename );
1702  }
1703 
1710  switch ( $this->pathDisclosureProtection ) {
1711  case 'none':
1712  case 'simple': // b/c
1713  $callback = [ $this, 'passThrough' ];
1714  break;
1715  default: // 'paranoid'
1716  $callback = [ $this, 'paranoidClean' ];
1717  }
1718  return $callback;
1719  }
1720 
1727  function paranoidClean( $param ) {
1728  return '[hidden]';
1729  }
1730 
1737  function passThrough( $param ) {
1738  return $param;
1739  }
1740 
1747  public function newFatal( $message /*, parameters...*/ ) {
1748  $status = call_user_func_array( [ Status::class, 'newFatal' ], func_get_args() );
1749  $status->cleanCallback = $this->getErrorCleanupFunction();
1750 
1751  return $status;
1752  }
1753 
1760  public function newGood( $value = null ) {
1762  $status->cleanCallback = $this->getErrorCleanupFunction();
1763 
1764  return $status;
1765  }
1766 
1775  public function checkRedirect( Title $title ) {
1776  return false;
1777  }
1778 
1786  public function invalidateImageRedirect( Title $title ) {
1787  }
1788 
1794  public function getDisplayName() {
1796 
1797  if ( $this->isLocal() ) {
1798  return $wgSitename;
1799  }
1800 
1801  // 'shared-repo-name-wikimediacommons' is used when $wgUseInstantCommons = true
1802  return wfMessageFallback( 'shared-repo-name-' . $this->name, 'shared-repo' )->text();
1803  }
1804 
1812  public function nameForThumb( $name ) {
1813  if ( strlen( $name ) > $this->abbrvThreshold ) {
1815  $name = ( $ext == '' ) ? 'thumbnail' : "thumbnail.$ext";
1816  }
1817 
1818  return $name;
1819  }
1820 
1826  public function isLocal() {
1827  return $this->getName() == 'local';
1828  }
1829 
1838  public function getSharedCacheKey( /*...*/ ) {
1839  return false;
1840  }
1841 
1849  public function getLocalCacheKey( /*...*/ ) {
1850  $args = func_get_args();
1851  array_unshift( $args, 'filerepo', $this->getName() );
1852 
1853  return call_user_func_array( 'wfMemcKey', $args );
1854  }
1855 
1864  public function getTempRepo() {
1865  return new TempFileRepo( [
1866  'name' => "{$this->name}-temp",
1867  'backend' => $this->backend,
1868  'zones' => [
1869  'public' => [
1870  // Same place storeTemp() uses in the base repo, though
1871  // the path hashing is mismatched, which is annoying.
1872  'container' => $this->zones['temp']['container'],
1873  'directory' => $this->zones['temp']['directory']
1874  ],
1875  'thumb' => [
1876  'container' => $this->zones['temp']['container'],
1877  'directory' => $this->zones['temp']['directory'] == ''
1878  ? 'thumb'
1879  : $this->zones['temp']['directory'] . '/thumb'
1880  ],
1881  'transcoded' => [
1882  'container' => $this->zones['temp']['container'],
1883  'directory' => $this->zones['temp']['directory'] == ''
1884  ? 'transcoded'
1885  : $this->zones['temp']['directory'] . '/transcoded'
1886  ]
1887  ],
1888  'hashLevels' => $this->hashLevels, // performance
1889  'isPrivate' => true // all in temp zone
1890  ] );
1891  }
1892 
1899  public function getUploadStash( User $user = null ) {
1900  return new UploadStash( $this, $user );
1901  }
1902 
1910  protected function assertWritableRepo() {
1911  }
1912 
1919  public function getInfo() {
1920  $ret = [
1921  'name' => $this->getName(),
1922  'displayname' => $this->getDisplayName(),
1923  'rootUrl' => $this->getZoneUrl( 'public' ),
1924  'local' => $this->isLocal(),
1925  ];
1926 
1927  $optionalSettings = [
1928  'url', 'thumbUrl', 'initialCapital', 'descBaseUrl', 'scriptDirUrl', 'articleUrl',
1929  'fetchDescription', 'descriptionCacheExpiry', 'favicon'
1930  ];
1931  foreach ( $optionalSettings as $k ) {
1932  if ( isset( $this->$k ) ) {
1933  $ret[$k] = $this->$k;
1934  }
1935  }
1936 
1937  return $ret;
1938  }
1939 
1944  public function hasSha1Storage() {
1945  return $this->hasSha1Storage;
1946  }
1947 
1952  public function supportsSha1URLs() {
1953  return $this->supportsSha1URLs;
1954  }
1955 }
initZones($doZones=[])
Check if a single zone or list of zones is defined for usage.
Definition: FileRepo.php:239
string $favicon
The URL of the repo's favicon, if any.
Definition: FileRepo.php:117
assertWritableRepo()
Throw an exception if this repo is read-only by design.
Definition: FileRepo.php:1910
getHashPath($name)
Get a relative path including trailing slash, e.g.
Definition: FileRepo.php:680
bool $fetchDescription
Whether to fetch commons image description pages and display them on the local wiki.
Definition: FileRepo.php:47
string $scriptDirUrl
URL of the MediaWiki installation, equivalent to $wgScriptPath, e.g.
Definition: FileRepo.php:79
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:184
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:114
getVirtualUrl($suffix=false)
Get a URL referring to this repository, with the private mwrepo protocol.
Definition: FileRepo.php:269
enumFiles($callback)
Call a callback function for every public regular file in the repository.
Definition: FileRepo.php:1660
the array() calling protocol came about after MediaWiki 1.4rc1.
array $zones
Map of zones to config.
Definition: FileRepo.php:62
static getHashPathForLevel($name, $levels)
Definition: FileRepo.php:702
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:1623
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:1864
magic word the default is to use $key to get the and $key value or $key value text $key value html to format the value $key
Definition: hooks.txt:2610
doOperations(array $ops, array $opts=[])
This is the main entry point into the backend for write operations.
getUserCaseDBKey()
Get the DB key with the initial letter case as specified by the user.
Definition: Title.php:956
string $pathDisclosureProtection
May be 'paranoid' to remove all parameters from error messages, 'none' to leave the paths in unchange...
Definition: FileRepo.php:96
$wgSitename
Name of the site.
getRootDirectory()
Get the public zone root storage directory of the repository.
Definition: FileRepo.php:669
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:2019
getUploadStash(User $user=null)
Get an UploadStash associated with this repo.
Definition: FileRepo.php:1899
streamFile($virtualUrl, $headers=[])
Attempt to stream a file with the given virtual URL/storage path.
Definition: FileRepo.php:1648
quickPurge($path)
Purge a file from the repo.
Definition: FileRepo.php:988
if(!isset($args[0])) $lang
string false $url
Public zone URL.
Definition: FileRepo.php:99
const DELETE_SOURCE
Definition: FileRepo.php:38
passThrough($param)
Path disclosure protection function.
Definition: FileRepo.php:1737
resolveToStoragePath($path)
If a path is a virtual URL, resolve it to a storage path.
Definition: FileRepo.php:1521
getZoneLocation($zone)
The the storage container and base path of a zone.
Definition: FileRepo.php:352
checkRedirect(Title $title)
Checks if there is a redirect named as $title.
Definition: FileRepo.php:1775
$source
$value
getLocalCacheKey()
Get a key for this repo in the local cache domain.
Definition: FileRepo.php:1849
getLocalCopy($virtualUrl)
Get a local FS copy of a file with a given virtual URL/storage path.
Definition: FileRepo.php:1536
getDescriptionRenderUrl($name, $lang=null)
Get the URL of the content-only fragment of the description page.
Definition: FileRepo.php:795
static isVirtualUrl($url)
Determine if a string is an mwrepo:// URL.
Definition: FileRepo.php:257
wfMessageFallback()
This function accepts multiple message keys and returns a message instance for the first message whic...
initDirectory($dir)
Creates a directory with the appropriate zone permissions.
Definition: FileRepo.php:1330
getHashLevels()
Get the number of hash directory levels.
Definition: FileRepo.php:721
store($srcPath, $dstZone, $dstRel, $flags=0)
Store a file to a given destination.
Definition: FileRepo.php:842
wfUrlencode($s)
We want some things to be included as literal characters in our title URLs for prettiness, which urlencode encodes by default.
A helper class for throttling authentication attempts.
resolveVirtualUrl($url)
Get the backend storage path corresponding to a virtual URL.
Definition: FileRepo.php:326
when a variable name is used in a it is silently declared as a new local masking the global
Definition: design.txt:93
freeTemp($virtualUrl)
Remove a temporary file or mark it for garbage collection.
Definition: FileRepo.php:1109
static extensionFromPath($path, $case= 'lowercase')
Get the final extension from a storage or FS path.
getTempHashPath($suffix)
Get a relative path including trailing slash, e.g.
Definition: FileRepo.php:691
paranoidClean($param)
Path disclosure protection function.
Definition: FileRepo.php:1727
wfDebug($text, $dest= 'all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
cleanupDeletedBatch(array $storageKeys)
Delete files in the deleted directory if they are not referenced in the filearchive table...
Definition: FileRepo.php:1489
const DELETED_FILE
Definition: File.php:53
getBackend()
Get the file backend instance.
Definition: FileRepo.php:218
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. 'LanguageGetMagic':DEPRECATED!Use $magicWords in a file listed in $wgExtensionMessagesFiles instead.Use this to define synonyms of magic words depending of the language &$magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces.Do not use this hook to add namespaces.Use CanonicalNamespaces for that.&$namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED!Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead.Use to define aliases of special pages names depending of the language &$specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names.&$names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page's language links.This is called in various places to allow extensions to define the effective language links for a page.$title:The page's Title.&$links: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!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:2017
if($line===false) $args
Definition: cdb.php:64
The User object encapsulates all of the user-specific settings (user_id, name, rights, email address, options, last login time).
Definition: User.php:46
static isCapitalized($index)
Is the namespace first-letter capitalized?
makeUrl($query= '', $entry= 'index')
Make an url to this repo.
Definition: FileRepo.php:741
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:2019
getFileTimestamp($virtualUrl)
Get the timestamp of a file with a given virtual URL/storage path.
Definition: FileRepo.php:1581
array $oldFileFactoryKey
callable|bool Override these in the base class
Definition: FileRepo.php:129
const OVERWRITE
Definition: FileRepo.php:39
getFileSha1($virtualUrl)
Get the sha1 (base 36) of a file with a given virtual URL/storage path.
Definition: FileRepo.php:1605
isLocal()
Returns true if this the local file repository.
Definition: FileRepo.php:1826
getReadOnlyReason()
Get an explanatory message if this repo is read-only.
Definition: FileRepo.php:228
string $thumbProxyUrl
URL of where to proxy thumb.php requests to.
Definition: FileRepo.php:134
getThumbProxyUrl()
Get the URL thumb.php requests are being proxied to.
Definition: FileRepo.php:622
getInfo()
Return information about the repository.
Definition: FileRepo.php:1919
wfAppendQuery($url, $query)
Append a query string to an existing URL, which may or may not already have query string parameters a...
string $thumbScriptUrl
URL of thumb.php.
Definition: FileRepo.php:65
getDescriptionStylesheetUrl()
Get the URL of the stylesheet to apply to description pages.
Definition: FileRepo.php:820
getDBkey()
Get the main part with underscores.
Definition: Title.php:947
quickPurgeBatch(array $paths)
Purge a batch of files from the repo.
Definition: FileRepo.php:1064
storeTemp($originalName, $srcPath)
Pick a random name in the temp zone and store a file to it.
Definition: FileRepo.php:1089
getErrorCleanupFunction()
Get a callback function to use for cleaning error message parameters.
Definition: FileRepo.php:1709
static getInstance($ts=false)
Get a timestamp instance in GMT.
Definition: MWTimestamp.php:39
invalidateImageRedirect(Title $title)
Invalidates image redirect cache related to that image Doesn't do anything for repositories that don'...
Definition: FileRepo.php:1786
static isStoragePath($path)
Check if a given path is a "mwstore://" path.
concatenate(array $srcPaths, $dstPath, $flags=0)
Concatenate a list of temporary files into a target file location.
Definition: FileRepo.php:1131
deleteBatch(array $sourceDestPairs)
Move a group of files to the deletion archive.
Definition: FileRepo.php:1430
int $hashLevels
The number of directory levels for hash-based division of files.
Definition: FileRepo.php:105
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:89
newFile($title, $time=false)
Create a new File object from the local repository.
Definition: FileRepo.php:390
getSharedCacheKey()
Get a key on the primary cache for this repository.
Definition: FileRepo.php:1838
nameForThumb($name)
Get the portion of the file that contains the origin file name.
Definition: FileRepo.php:1812
$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:2019
string $articleUrl
Equivalent to $wgArticlePath, e.g.
Definition: FileRepo.php:82
string $thumbUrl
The base thumbnail URL.
Definition: FileRepo.php:102
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
quickImport($src, $dst, $options=null)
Import a file from the local file system into the repo.
Definition: FileRepo.php:976
const ATTR_UNICODE_PATHS
validateFilename($filename)
Determine if a relative path is valid, i.e.
Definition: FileRepo.php:1696
const SKIP_LOCKING
Definition: FileRepo.php:41
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:941
findFiles(array $items, $flags=0)
Find many files at once.
Definition: FileRepo.php:499
static newGood($value=null)
Factory function for good results.
Definition: StatusValue.php:81
fileExists($file)
Checks existence of a a file.
Definition: FileRepo.php:1372
const NS_FILE
Definition: Defines.php:71
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
bool $hasSha1Storage
Definition: FileRepo.php:53
int $descriptionCacheExpiry
Definition: FileRepo.php:50
cleanDir($dir)
Deletes a directory if empty.
Definition: FileRepo.php:1356
string $descBaseUrl
URL of image description pages, e.g.
Definition: FileRepo.php:74
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
getFileProps($virtualUrl)
Get properties of a file with a given virtual URL/storage path.
Definition: FileRepo.php:1563
getNameFromTitle(Title $title)
Get the name of a file from its title object.
Definition: FileRepo.php:650
const NAME_AND_TIME_ONLY
Definition: FileRepo.php:43
string $thumbProxySecret
Secret key to pass as an X-Swift-Secret header to the proxied thumb service.
Definition: FileRepo.php:136
getDescriptionUrl($name)
Get the URL of an image description page.
Definition: FileRepo.php:761
findFilesByPrefix($prefix, $limit)
Return an array of files where the name starts with $prefix.
Definition: FileRepo.php:604
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:936
bool $transformVia404
Whether to skip media file transformation on parse and rely on a 404 handler instead.
Definition: FileRepo.php:69
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
getFileSize($virtualUrl)
Get the size of a file with a given virtual URL/storage path.
Definition: FileRepo.php:1593
Class representing a non-directory file on the file system.
Definition: FSFile.php:29
const OVERWRITE_SAME
Definition: FileRepo.php:40
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
getZoneUrl($zone, $ext=null)
Get the URL corresponding to one of the four basic zones.
Definition: FileRepo.php:285
getDeletedHashPath($key)
Get a relative path for a deletion archive key, e.g.
Definition: FileRepo.php:1501
wfArrayToCgi($array1, $array2=null, $prefix= '')
This function takes one or two arrays as input, and returns a CGI-style string, e.g.
newFatal($message)
Create a new fatal error.
Definition: FileRepo.php:1747
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at name
Definition: design.txt:12
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
getDisplayName()
Get the human-readable name of the repo.
Definition: FileRepo.php:1794
Base class for file repositories.
Definition: FileRepo.php:37
bool $supportsSha1URLs
Definition: FileRepo.php:56
static isPathTraversalFree($path)
Check if a relative path has no directory traversals.
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the local content language as $wgContLang
Definition: design.txt:56
MimeMagic helper wrapper.
Definition: MWFileProps.php:28
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:302
array $fileFactoryKey
callable|bool Override these in the base class
Definition: FileRepo.php:127
array $oldFileFactory
callable|bool Override these in the base class
Definition: FileRepo.php:125
array $fileFactory
callable Override these in the base class
Definition: FileRepo.php:123
storeBatch(array $triplets, $flags=0)
Store a batch of files.
Definition: FileRepo.php:865
enumFilesInStorage($callback)
Call a callback function for every public file in the repository.
Definition: FileRepo.php:1671
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:1180
Status::newGood()`to allow deletion, and then`return false`from the hook function.Ensure you consume the 'ChangeTagAfterDelete'hook to carry out custom deletion actions.$tag:name of the tag $user:user initiating the action &$status:Status object.See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use.&$tags:list of all active tags.Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function.Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action or null $user:User who performed the tagging when the tagging is subsequent to the action or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change.&$allowedTags:List of all the tags the user is allowed to add.Any tags the user wants to add($addTags) that are not in this array will cause it to fail.You may add or remove tags to this array as required.$addTags:List of tags user intends to add.$user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed.$performer:The User who will perform the change $user:The User whose groups will be changed &$add:The groups that will be added &$remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation.$collationName:Name of the collation in question &$collationObject:Null.Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user's email has been confirmed successfully.$user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object.Called by Content::getParserOutput after parsing has finished.Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML).$content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput.May be used to override the normal model-specific rendering of page content.$content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering.To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state.$generateHtml:boolean, indicating whether full HTML should be generated.If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object.&$output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title.May be used to assign a different model for that title.$title:the Title in question &$model:the model name.Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers.Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core.$modeName:the requested content model name &$handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page.This is especially useful to prevent some content models to be used in some special location.$contentModel:ID of the content model in question $title:the Title in question.&$ok:Output parameter, whether it is OK to use $contentModel on $title.Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run &$pager:Pager object for contributions &$queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions &$data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions &$ret:the HTML line $row:the DB row for this line &$classes:the classes to add to the surrounding< li > &$attribs:associative array of other HTML attributes for the< li > element.Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title &$tools:Array of tool links $specialPage:SpecialPage instance for context and services.Can be either SpecialContributions or DeletedContributionsPage.Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested.Handler functions that modify $result should generally return false to disable further attempts at conversion.$content:The Content object to be converted.$toModel:The ID of the content model to convert to.$lossy:boolean indicating whether lossy conversion is allowed.&$result:Output parameter, in case the handler function wants to provide a converted Content object.Note that $result->getContentModel() must return $toModel. 'ContentSecurityPolicyDefaultSource':Modify the allowed CSP load sources.This affects all directives except for the script directive.If you want to add a script source, see ContentSecurityPolicyScriptSource hook.&$defaultSrc:Array of Content-Security-Policy allowed sources $policyConfig:Current configuration for the Content-Security-Policy header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyDirectives':Modify the content security policy directives.Use this only if ContentSecurityPolicyDefaultSource and ContentSecurityPolicyScriptSource do not meet your needs.&$directives:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyScriptSource':Modify the allowed CSP script sources.Note that you also have to use ContentSecurityPolicyDefaultSource if you want non-script sources to be loaded from whatever you add.&$scriptSrc:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g.for a special namespace, etc.$article:Article being edited $user:User performing the edit 'DatabaseOraclePostInit':Called after initialising an Oracle database $db:the DatabaseOracle object 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery &$data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished.Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions &$ret:the HTML line $row:the DB row for this line &$classes:the classes to add to the surrounding< li > &$attribs:associative array of other HTML attributes for the< li > element.Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DeleteUnknownPreferences':Called by the cleanupPreferences.php maintenance script to build a WHERE clause with which to delete preferences that are not known about.This hook is used by extensions that have dynamically-named preferences that should not be deleted in the usual cleanup process.For example, the Gadgets extension creates preferences prefixed with 'gadget-', and so anything with that prefix is excluded from the deletion.&where:An array that will be passed as the $cond parameter to IDatabase::select() to determine what will be deleted from the user_properties table.$db:The IDatabase object, useful for accessing $db->buildLike() etc. 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function.$differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable's value is null.This hook can be used to inject content into said class member variable.$differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the"mark as patrolled"link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink".$differenceEngine:DifferenceEngine object &$markAsPatrolledLink:The"mark as patrolled"link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter.For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions.&$rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision's author, whether the revision was marked as a minor edit or not, etc.$differenceEngine:DifferenceEngine object &$newHeader:The string containing the various#mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
Definition: hooks.txt:1287
FileBackend $backend
Definition: FileRepo.php:59
fileExistsBatch(array $files)
Checks existence of an array of files.
Definition: FileRepo.php:1384
quickImportBatch(array $triples)
Import a batch of files from the local file system into the repo.
Definition: FileRepo.php:1019
getLocalReference($virtualUrl)
Get a local FS file with a given virtual URL/storage path.
Definition: FileRepo.php:1550
static splitStoragePath($storagePath)
Split a storage path into a backend name, a container name, and a relative file path.
static getDynamicStylesheetQuery()
Get the query to generate a dynamic stylesheet.
Definition: Skin.php:423
quickCleanDir($dir)
Deletes a directory if empty.
Definition: FileRepo.php:999
supportsSha1URLs()
Returns whether or not repo supports having originals SHA-1s in the thumb URLs.
Definition: FileRepo.php:1952
int $deletedHashLevels
The number of directory levels for hash-based division of deleted files.
Definition: FileRepo.php:108
$ext
Definition: router.php:55
__construct(array $info=null)
Definition: FileRepo.php:142
getZonePath($zone)
Get the storage path corresponding to one of the zones.
Definition: FileRepo.php:366
hasSha1Storage()
Returns whether or not storage is SHA-1 based.
Definition: FileRepo.php:1944
bool $isPrivate
Whether all zones should be private (e.g.
Definition: FileRepo.php:120
see documentation in includes Linker php for Linker::makeImageLink & $time
Definition: hooks.txt:1827
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account $user
Definition: hooks.txt:244
getThumbProxySecret()
Get the secret key for the proxied thumb service.
Definition: FileRepo.php:631
newGood($value=null)
Create a new good result.
Definition: FileRepo.php:1760
findBySha1($hash)
Get an array or iterator of file objects for files that have a given SHA-1 content hash...
Definition: FileRepo.php:573
getName()
Get the name of this repository, as specified by $info['name]' to the constructor.
Definition: FileRepo.php:730
streamFileWithStatus($virtualUrl, $headers=[], $optHeaders=[])
Attempt to stream a file with the given virtual URL/storage path.
Definition: FileRepo.php:1620
publishBatch(array $ntuples, $flags=0)
Publish a batch of files.
Definition: FileRepo.php:1209