MediaWiki  1.27.2
refreshFileHeaders.php
Go to the documentation of this file.
1 <?php
27 require_once __DIR__ . '/Maintenance.php';
28 
35  function __construct() {
36  parent::__construct();
37  $this->addDescription( 'Script to update file HTTP headers' );
38  $this->addOption( 'verbose', 'Output information about each file.', false, false, 'v' );
39  $this->addOption( 'start', 'Name of file to start with', false, true );
40  $this->addOption( 'end', 'Name of file to end with', false, true );
41  $this->setBatchSize( 200 );
42  }
43 
44  public function execute() {
45  $repo = RepoGroup::singleton()->getLocalRepo();
46  $start = str_replace( ' ', '_', $this->getOption( 'start', '' ) ); // page on img_name
47  $end = str_replace( ' ', '_', $this->getOption( 'end', '' ) ); // page on img_name
48 
49  $count = 0;
50  $dbr = $this->getDB( DB_SLAVE );
51  do {
52  $conds = [ "img_name > {$dbr->addQuotes( $start )}" ];
53  if ( strlen( $end ) ) {
54  $conds[] = "img_name <= {$dbr->addQuotes( $end )}";
55  }
56  $res = $dbr->select( 'image', '*', $conds,
57  __METHOD__, [ 'LIMIT' => $this->mBatchSize, 'ORDER BY' => 'img_name ASC' ] );
58  foreach ( $res as $row ) {
59  $file = $repo->newFileFromRow( $row );
60  $headers = $file->getStreamHeaders();
61  if ( count( $headers ) ) {
62  $this->updateFileHeaders( $file, $headers );
63  }
64  // Do all of the older file versions...
65  foreach ( $file->getHistory() as $oldFile ) {
66  $headers = $oldFile->getStreamHeaders();
67  if ( count( $headers ) ) {
68  $this->updateFileHeaders( $oldFile, $headers );
69  }
70  }
71  if ( $this->hasOption( 'verbose' ) ) {
72  $this->output( "Updated headers for file '{$row->img_name}'.\n" );
73  }
74  ++$count;
75  $start = $row->img_name; // advance
76  }
77  } while ( $res->numRows() > 0 );
78 
79  $this->output( "Done. Updated headers for $count file(s).\n" );
80  }
81 
82  protected function updateFileHeaders( File $file, array $headers ) {
83  $status = $file->getRepo()->getBackend()->describe( [
84  'src' => $file->getPath(), 'headers' => $headers
85  ] );
86  if ( !$status->isGood() ) {
87  $this->error( "Encountered error: " . print_r( $status, true ) );
88  }
89  }
90 }
91 
92 $maintClass = 'RefreshFileHeaders';
93 require_once RUN_MAINTENANCE_IF_MAIN;
the array() calling protocol came about after MediaWiki 1.4rc1.
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
Definition: maintenance.txt:39
getDB($db, $groups=[], $wiki=false)
Returns a database to be used by current maintenance script.
hasOption($name)
Checks to see if a particular param exists.
getRepo()
Returns the repository.
Definition: File.php:1854
require_once RUN_MAINTENANCE_IF_MAIN
Definition: maintenance.txt:50
Maintenance script to refresh file headers from metadata.
getPath()
Return the storage path to the file.
Definition: File.php:416
addOption($name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
$res
Definition: database.txt:21
static singleton()
Get a RepoGroup instance.
Definition: RepoGroup.php:59
const DB_SLAVE
Definition: Defines.php:46
addDescription($text)
Set the description text.
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
getOption($name, $default=null)
Get an option, or return the default.
output($out, $channel=null)
Throw some output to the user.
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
error($err, $die=0)
Throw an error to the user.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set $status
Definition: hooks.txt:1004
$count
setBatchSize($s=0)
Set the batch size.
Implements some public methods and some protected utility functions which are required by multiple ch...
Definition: File.php:50
updateFileHeaders(File $file, array $headers)