maintenance/populateImageSha1.php

   1 <?php
   2 /**
   3  * Optional upgrade script to populate the img_sha1 field
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @ingroup Maintenance
  22  */
  23
  24 require_once __DIR__ . '/Maintenance.php';
  25
  26 /**
  27  * Maintenance script to populate the img_sha1 field.
  28  *
  29  * @ingroup Maintenance
  30  */
  31 class PopulateImageSha1 extends LoggedUpdateMaintenance {
  32         public function __construct() {
  33                 parent::__construct();
  34                 $this->addDescription( 'Populate the img_sha1 field' );
  35                 $this->addOption( 'force', "Recalculate sha1 for rows that already have a value" );
  36                 $this->addOption( 'multiversiononly', "Calculate only for files with several versions" );
  37                 $this->addOption( 'method', "Use 'pipe' to pipe to mysql command line,\n" .
  38                         "\t\tdefault uses Database class", false, true );
  39                 $this->addOption(
  40                         'file',
  41                         'Fix for a specific file, without File: namespace prefixed',
  42                         false,
  43                         true
  44                 );
  45         }
  46
  47         protected function getUpdateKey() {
  48                 return 'populate img_sha1';
  49         }
  50
  51         protected function updateSkippedMessage() {
  52                 return 'img_sha1 column of image table already populated.';
  53         }
  54
  55         public function execute() {
  56                 if ( $this->getOption( 'file' ) || $this->hasOption( 'multiversiononly' ) ) {
  57                         $this->doDBUpdates(); // skip update log checks/saves
  58                 } else {
  59                         parent::execute();
  60                 }
  61         }
  62
  63         public function doDBUpdates() {
  64                 $method = $this->getOption( 'method', 'normal' );
  65                 $file = $this->getOption( 'file', '' );
  66                 $force = $this->getOption( 'force' );
  67                 $isRegen = ( $force || $file != '' ); // forced recalculation?
  68
  69                 $t = -microtime( true );
  70                 $dbw = $this->getDB( DB_MASTER );
  71                 if ( $file != '' ) {
  72                         $res = $dbw->select(
  73                                 'image',
  74                                 [ 'img_name' ],
  75                                 [ 'img_name' => $file ],
  76                                 __METHOD__
  77                         );
  78                         if ( !$res ) {
  79                                 $this->fatalError( "No such file: $file" );
  80                         }
  81                         $this->output( "Populating img_sha1 field for specified files\n" );
  82                 } else {
  83                         if ( $this->hasOption( 'multiversiononly' ) ) {
  84                                 $conds = [];
  85                                 $this->output( "Populating and recalculating img_sha1 field for versioned files\n" );
  86                         } elseif ( $force ) {
  87                                 $conds = [];
  88                                 $this->output( "Populating and recalculating img_sha1 field\n" );
  89                         } else {
  90                                 $conds = [ 'img_sha1' => '' ];
  91                                 $this->output( "Populating img_sha1 field\n" );
  92                         }
  93                         if ( $this->hasOption( 'multiversiononly' ) ) {
  94                                 $res = $dbw->select( 'oldimage',
  95                                         [ 'img_name' => 'DISTINCT(oi_name)' ], $conds, __METHOD__ );
  96                         } else {
  97                                 $res = $dbw->select( 'image', [ 'img_name' ], $conds, __METHOD__ );
  98                         }
  99                 }
 100
 101                 $imageTable = $dbw->tableName( 'image' );
 102                 $oldImageTable = $dbw->tableName( 'oldimage' );
 103
 104                 if ( $method == 'pipe' ) {
 105                         // Opening a pipe allows the SHA-1 operation to be done in parallel
 106                         // with the database write operation, because the writes are queued
 107                         // in the pipe buffer. This can improve performance by up to a
 108                         // factor of 2.
 109                         global $wgDBuser, $wgDBserver, $wgDBpassword, $wgDBname;
 110                         $cmd = 'mysql -u' . wfEscapeShellArg( $wgDBuser ) .
 111                                 ' -h' . wfEscapeShellArg( $wgDBserver ) .
 112                                 ' -p' . wfEscapeShellArg( $wgDBpassword, $wgDBname );
 113                         $this->output( "Using pipe method\n" );
 114                         $pipe = popen( $cmd, 'w' );
 115                 }
 116
 117                 $numRows = $res->numRows();
 118                 $i = 0;
 119                 foreach ( $res as $row ) {
 120                         if ( $i % $this->getBatchSize() == 0 ) {
 121                                 $this->output( sprintf(
 122                                         "Done %d of %d, %5.3f%%  \r", $i, $numRows, $i / $numRows * 100 ) );
 123                                 wfWaitForSlaves();
 124                         }
 125
 126                         $file = wfLocalFile( $row->img_name );
 127                         if ( !$file ) {
 128                                 continue;
 129                         }
 130
 131                         // Upgrade the current file version...
 132                         $sha1 = $file->getRepo()->getFileSha1( $file->getPath() );
 133                         if ( strval( $sha1 ) !== '' ) { // file on disk and hashed properly
 134                                 if ( $isRegen && $file->getSha1() !== $sha1 ) {
 135                                         // The population was probably done already. If the old SHA1
 136                                         // does not match, then both fix the SHA1 and the metadata.
 137                                         $file->upgradeRow();
 138                                 } else {
 139                                         $sql = "UPDATE $imageTable SET img_sha1=" . $dbw->addQuotes( $sha1 ) .
 140                                                 " WHERE img_name=" . $dbw->addQuotes( $file->getName() );
 141                                         if ( $method == 'pipe' ) {
 142                                                 fwrite( $pipe, "$sql;\n" );
 143                                         } else {
 144                                                 $dbw->query( $sql, __METHOD__ );
 145                                         }
 146                                 }
 147                         }
 148                         // Upgrade the old file versions...
 149                         foreach ( $file->getHistory() as $oldFile ) {
 150                                 $sha1 = $oldFile->getRepo()->getFileSha1( $oldFile->getPath() );
 151                                 if ( strval( $sha1 ) !== '' ) { // file on disk and hashed properly
 152                                         if ( $isRegen && $oldFile->getSha1() !== $sha1 ) {
 153                                                 // The population was probably done already. If the old SHA1
 154                                                 // does not match, then both fix the SHA1 and the metadata.
 155                                                 $oldFile->upgradeRow();
 156                                         } else {
 157                                                 $sql = "UPDATE $oldImageTable SET oi_sha1=" . $dbw->addQuotes( $sha1 ) .
 158                                                         " WHERE (oi_name=" . $dbw->addQuotes( $oldFile->getName() ) . " AND" .
 159                                                         " oi_archive_name=" . $dbw->addQuotes( $oldFile->getArchiveName() ) . ")";
 160                                                 if ( $method == 'pipe' ) {
 161                                                         fwrite( $pipe, "$sql;\n" );
 162                                                 } else {
 163                                                         $dbw->query( $sql, __METHOD__ );
 164                                                 }
 165                                         }
 166                                 }
 167                         }
 168                         $i++;
 169                 }
 170                 if ( $method == 'pipe' ) {
 171                         fflush( $pipe );
 172                         pclose( $pipe );
 173                 }
 174                 $t += microtime( true );
 175                 $this->output( sprintf( "\nDone %d files in %.1f seconds\n", $numRows, $t ) );
 176
 177                 return !$file; // we only updated *some* files, don't log
 178         }
 179 }
 180
 181 $maintClass = "PopulateImageSha1";
 182 require_once RUN_MAINTENANCE_IF_MAIN;