3 * Update image metadata records.
5 * Usage: php rebuildImages.php [--missing] [--dry-run]
7 * --missing Crawl the uploads dir for images without records, and
10 * Copyright © 2005 Brion Vibber <brion@pobox.com>
11 * https://www.mediawiki.org/
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation; either version 2 of the License, or
16 * (at your option) any later version.
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
23 * You should have received a copy of the GNU General Public License along
24 * with this program; if not, write to the Free Software Foundation, Inc.,
25 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
26 * http://www.gnu.org/copyleft/gpl.html
29 * @author Brion Vibber <brion at pobox.com>
30 * @ingroup Maintenance
33 require_once __DIR__
. '/Maintenance.php';
35 use MediaWiki\MediaWikiServices
;
36 use Wikimedia\Rdbms\IMaintainableDatabase
;
39 * Maintenance script to update image metadata records.
41 * @ingroup Maintenance
43 class ImageBuilder
extends Maintenance
{
46 * @var IMaintainableDatabase
50 function __construct() {
51 parent
::__construct();
53 global $wgUpdateCompatibleMetadata;
54 // make sure to update old, but compatible img_metadata fields.
55 $wgUpdateCompatibleMetadata = true;
57 $this->addDescription( 'Script to update image metadata records' );
59 $this->addOption( 'missing', 'Check for files without associated database record' );
60 $this->addOption( 'dry-run', 'Only report, don\'t update the database' );
63 public function execute() {
64 $this->dbw
= $this->getDB( DB_MASTER
);
65 $this->dryrun
= $this->hasOption( 'dry-run' );
66 if ( $this->dryrun
) {
67 MediaWiki\MediaWikiServices
::getInstance()->getReadOnlyMode()
68 ->setReason( 'Dry run mode, image upgrades are suppressed' );
71 if ( $this->hasOption( 'missing' ) ) {
72 $this->crawlMissing();
82 if ( !isset( $this->repo
) ) {
83 $this->repo
= RepoGroup
::singleton()->getLocalRepo();
91 $this->buildOldImage();
94 function init( $count, $table ) {
97 $this->count
= $count;
98 $this->startTime
= microtime( true );
99 $this->table
= $table;
102 function progress( $updated ) {
103 $this->updated +
= $updated;
105 if ( $this->processed %
100 != 0 ) {
108 $portion = $this->processed
/ $this->count
;
109 $updateRate = $this->updated
/ $this->processed
;
111 $now = microtime( true );
112 $delta = $now - $this->startTime
;
113 $estimatedTotalTime = $delta / $portion;
114 $eta = $this->startTime +
$estimatedTotalTime;
115 $rate = $this->processed
/ $delta;
117 $this->output( sprintf( "%s: %6.2f%% done on %s; ETA %s [%d/%d] %.2f/sec <%.2f%% updated>\n",
118 wfTimestamp( TS_DB
, intval( $now ) ),
121 wfTimestamp( TS_DB
, intval( $eta ) ),
125 $updateRate * 100.0 ) );
129 function buildTable( $table, $key, $queryInfo, $callback ) {
130 $count = $this->dbw
->selectField( $table, 'count(*)', '', __METHOD__
);
131 $this->init( $count, $table );
132 $this->output( "Processing $table...\n" );
134 $result = $this->getDB( DB_REPLICA
)->select(
135 $queryInfo['tables'], $queryInfo['fields'], [], __METHOD__
, [], $queryInfo['joins']
138 foreach ( $result as $row ) {
139 $update = call_user_func( $callback, $row, null );
141 $this->progress( 1 );
143 $this->progress( 0 );
146 $this->output( "Finished $table... $this->updated of $this->processed rows updated\n" );
149 function buildImage() {
150 $callback = [ $this, 'imageCallback' ];
151 $this->buildTable( 'image', 'img_name', LocalFile
::getQueryInfo(), $callback );
154 function imageCallback( $row, $copy ) {
155 // Create a File object from the row
156 // This will also upgrade it
157 $file = $this->getRepo()->newFileFromRow( $row );
159 return $file->getUpgraded();
162 function buildOldImage() {
163 $this->buildTable( 'oldimage', 'oi_archive_name', OldLocalFile
::getQueryInfo(),
164 [ $this, 'oldimageCallback' ] );
167 function oldimageCallback( $row, $copy ) {
168 // Create a File object from the row
169 // This will also upgrade it
170 if ( $row->oi_archive_name
== '' ) {
171 $this->output( "Empty oi_archive_name for oi_name={$row->oi_name}\n" );
175 $file = $this->getRepo()->newFileFromRow( $row );
177 return $file->getUpgraded();
180 function crawlMissing() {
181 $this->getRepo()->enumFiles( [ $this, 'checkMissingImage' ] );
184 function checkMissingImage( $fullpath ) {
185 $filename = wfBaseName( $fullpath );
186 $row = $this->dbw
->selectRow( 'image',
188 [ 'img_name' => $filename ],
191 if ( !$row ) { // file not registered
192 $this->addMissingImage( $filename, $fullpath );
196 function addMissingImage( $filename, $fullpath ) {
197 $timestamp = $this->dbw
->timestamp( $this->getRepo()->getFileTimestamp( $fullpath ) );
198 $services = MediaWikiServices
::getInstance();
200 $altname = $services->getContentLanguage()->checkTitleEncoding( $filename );
201 if ( $altname != $filename ) {
202 if ( $this->dryrun
) {
203 $filename = $altname;
204 $this->output( "Estimating transcoding... $altname\n" );
206 # @todo FIXME: create renameFile()
207 $filename = $this->renameFile( $filename );
211 if ( $filename == '' ) {
212 $this->output( "Empty filename for $fullpath\n" );
216 if ( !$this->dryrun
) {
217 $file = $services->getRepoGroup()->getLocalRepo()->newFile( $filename );
218 if ( !$file->recordUpload(
220 '(recovered file, missing upload log entry)',
227 $this->output( "Error uploading file $fullpath\n" );
232 $this->output( $fullpath . "\n" );
236 $maintClass = ImageBuilder
::class;
237 require_once RUN_MAINTENANCE_IF_MAIN
;