MediaWiki  REL1_31
populateFilearchiveSha1.php
Go to the documentation of this file.
1 <?php
24 require_once __DIR__ . '/Maintenance.php';
25 
33  public function __construct() {
34  parent::__construct();
35  $this->addDescription( 'Populate the fa_sha1 field from fa_storage_key' );
36  }
37 
38  protected function getUpdateKey() {
39  return 'populate fa_sha1';
40  }
41 
42  protected function updateSkippedMessage() {
43  return 'fa_sha1 column of filearchive table already populated.';
44  }
45 
46  public function doDBUpdates() {
47  $startTime = microtime( true );
48  $dbw = $this->getDB( DB_MASTER );
49  $table = 'filearchive';
50  $conds = [ 'fa_sha1' => '', 'fa_storage_key IS NOT NULL' ];
51 
52  if ( !$dbw->fieldExists( $table, 'fa_sha1', __METHOD__ ) ) {
53  $this->output( "fa_sha1 column does not exist\n\n", true );
54 
55  return false;
56  }
57 
58  $this->output( "Populating fa_sha1 field from fa_storage_key\n" );
59  $endId = $dbw->selectField( $table, 'MAX(fa_id)', '', __METHOD__ );
60 
61  $batchSize = $this->getBatchSize();
62  $done = 0;
63 
64  do {
65  $res = $dbw->select(
66  $table,
67  [ 'fa_id', 'fa_storage_key' ],
68  $conds,
69  __METHOD__,
70  [ 'LIMIT' => $batchSize ]
71  );
72 
73  $i = 0;
74  foreach ( $res as $row ) {
75  if ( $row->fa_storage_key == '' ) {
76  // Revision was missing pre-deletion
77  continue;
78  }
79  $sha1 = LocalRepo::getHashFromKey( $row->fa_storage_key );
80  $dbw->update( $table,
81  [ 'fa_sha1' => $sha1 ],
82  [ 'fa_id' => $row->fa_id ],
83  __METHOD__
84  );
85  $lastId = $row->fa_id;
86  $i++;
87  }
88 
89  $done += $i;
90  if ( $i !== $batchSize ) {
91  break;
92  }
93 
94  // print status and let replica DBs catch up
95  $this->output( sprintf(
96  "id %d done (up to %d), %5.3f%% \r", $lastId, $endId, $lastId / $endId * 100 ) );
98  } while ( true );
99 
100  $processingTime = microtime( true ) - $startTime;
101  $this->output( sprintf( "\nDone %d files in %.1f seconds\n", $done, $processingTime ) );
102 
103  return true; // we only updated *some* files, don't log
104  }
105 }
106 
108 require_once RUN_MAINTENANCE_IF_MAIN;
PopulateFilearchiveSha1\updateSkippedMessage
updateSkippedMessage()
Message to show that the update was done already and was just skipped.
Definition: populateFilearchiveSha1.php:42
PopulateFilearchiveSha1\getUpdateKey
getUpdateKey()
Get the update key name to go in the update log table.
Definition: populateFilearchiveSha1.php:38
Maintenance\addDescription
addDescription( $text)
Set the description text.
Definition: Maintenance.php:291
RUN_MAINTENANCE_IF_MAIN
require_once RUN_MAINTENANCE_IF_MAIN
Definition: maintenance.txt:50
$res
$res
Definition: database.txt:21
wfWaitForSlaves
wfWaitForSlaves( $ifWritesSince=null, $wiki=false, $cluster=false, $timeout=null)
Waits for the replica DBs to catch up to the master position.
Definition: GlobalFunctions.php:2966
LocalRepo\getHashFromKey
static getHashFromKey( $key)
Gets the SHA1 hash from a storage key.
Definition: LocalRepo.php:181
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:37
PopulateFilearchiveSha1\__construct
__construct()
Default constructor.
Definition: populateFilearchiveSha1.php:33
PopulateFilearchiveSha1\doDBUpdates
doDBUpdates()
Do the actual work.
Definition: populateFilearchiveSha1.php:46
LoggedUpdateMaintenance
Class for scripts that perform database maintenance and want to log the update in updatelog so we can...
Definition: Maintenance.php:1640
DB_MASTER
const DB_MASTER
Definition: defines.php:29
$maintClass
$maintClass
Definition: populateFilearchiveSha1.php:107
PopulateFilearchiveSha1
Maintenance script to populate the fa_sha1 field.
Definition: populateFilearchiveSha1.php:32
Maintenance\getBatchSize
getBatchSize()
Returns batch size.
Definition: Maintenance.php:321
as
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:22
Maintenance\getDB
getDB( $db, $groups=[], $wiki=false)
Returns a database to be used by current maintenance script.
Definition: Maintenance.php:1309
Maintenance\output
output( $out, $channel=null)
Throw some output to the user.
Definition: Maintenance.php:388
class
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:56