Localisation updates from http://translatewiki.net.
[mediawiki.git] / maintenance / rebuildImages.php
blob53bf823f0fdc4cbf4f65c56418ce6f78a079bf9c
1 <?php
2 /**
3 * Update image metadata records.
5 * Usage: php rebuildImages.php [--missing] [--dry-run]
6 * Options:
7 * --missing Crawl the uploads dir for images without records, and
8 * add them only.
10 * Copyright © 2005 Brion Vibber <brion@pobox.com>
11 * http://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
28 * @file
29 * @author Brion Vibber <brion at pobox.com>
30 * @ingroup Maintenance
33 require_once __DIR__ . '/Maintenance.php';
35 /**
36 * Maintenance script to update image metadata records.
38 * @ingroup Maintenance
40 class ImageBuilder extends Maintenance {
42 /**
43 * @var DatabaseBase
45 protected $dbw;
47 function __construct() {
48 parent::__construct();
50 global $wgUpdateCompatibleMetadata;
51 //make sure to update old, but compatible img_metadata fields.
52 $wgUpdateCompatibleMetadata = true;
54 $this->mDescription = 'Script to update image metadata records';
56 $this->addOption( 'missing', 'Check for files without associated database record' );
57 $this->addOption( 'dry-run', 'Only report, don\'t update the database' );
60 public function execute() {
61 $this->dbw = wfGetDB( DB_MASTER );
62 $this->maxLag = 10; # if slaves are lagged more than 10 secs, wait
63 $this->dryrun = $this->hasOption( 'dry-run' );
64 if ( $this->dryrun ) {
65 $GLOBALS['wgReadOnly'] = 'Dry run mode, image upgrades are suppressed';
68 if ( $this->hasOption( 'missing' ) ) {
69 $this->crawlMissing();
70 } else {
71 $this->build();
75 /**
76 * @return FileRepo
78 function getRepo() {
79 if ( !isset( $this->repo ) ) {
80 $this->repo = RepoGroup::singleton()->getLocalRepo();
82 return $this->repo;
85 function build() {
86 $this->buildImage();
87 $this->buildOldImage();
90 function init( $count, $table ) {
91 $this->processed = 0;
92 $this->updated = 0;
93 $this->count = $count;
94 $this->startTime = microtime( true );
95 $this->table = $table;
98 function progress( $updated ) {
99 $this->updated += $updated;
100 $this->processed++;
101 if ( $this->processed % 100 != 0 ) {
102 return;
104 $portion = $this->processed / $this->count;
105 $updateRate = $this->updated / $this->processed;
107 $now = microtime( true );
108 $delta = $now - $this->startTime;
109 $estimatedTotalTime = $delta / $portion;
110 $eta = $this->startTime + $estimatedTotalTime;
111 $rate = $this->processed / $delta;
113 $this->output( sprintf( "%s: %6.2f%% done on %s; ETA %s [%d/%d] %.2f/sec <%.2f%% updated>\n",
114 wfTimestamp( TS_DB, intval( $now ) ),
115 $portion * 100.0,
116 $this->table,
117 wfTimestamp( TS_DB, intval( $eta ) ),
118 $this->processed,
119 $this->count,
120 $rate,
121 $updateRate * 100.0 ) );
122 flush();
125 function buildTable( $table, $key, $callback ) {
126 $count = $this->dbw->selectField( $table, 'count(*)', '', __METHOD__ );
127 $this->init( $count, $table );
128 $this->output( "Processing $table...\n" );
130 $result = wfGetDB( DB_SLAVE )->select( $table, '*', array(), __METHOD__ );
132 foreach ( $result as $row ) {
133 $update = call_user_func( $callback, $row, null );
134 if ( $update ) {
135 $this->progress( 1 );
136 } else {
137 $this->progress( 0 );
140 $this->output( "Finished $table... $this->updated of $this->processed rows updated\n" );
143 function buildImage() {
144 $callback = array( $this, 'imageCallback' );
145 $this->buildTable( 'image', 'img_name', $callback );
148 function imageCallback( $row, $copy ) {
149 // Create a File object from the row
150 // This will also upgrade it
151 $file = $this->getRepo()->newFileFromRow( $row );
152 return $file->getUpgraded();
155 function buildOldImage() {
156 $this->buildTable( 'oldimage', 'oi_archive_name', array( $this, 'oldimageCallback' ) );
159 function oldimageCallback( $row, $copy ) {
160 // Create a File object from the row
161 // This will also upgrade it
162 if ( $row->oi_archive_name == '' ) {
163 $this->output( "Empty oi_archive_name for oi_name={$row->oi_name}\n" );
164 return false;
166 $file = $this->getRepo()->newFileFromRow( $row );
167 return $file->getUpgraded();
170 function crawlMissing() {
171 $this->getRepo()->enumFiles( array( $this, 'checkMissingImage' ) );
174 function checkMissingImage( $fullpath ) {
175 $filename = wfBaseName( $fullpath );
176 $row = $this->dbw->selectRow( 'image',
177 array( 'img_name' ),
178 array( 'img_name' => $filename ),
179 __METHOD__ );
181 if ( !$row ) { // file not registered
182 $this->addMissingImage( $filename, $fullpath );
186 function addMissingImage( $filename, $fullpath ) {
187 global $wgContLang;
189 $timestamp = $this->dbw->timestamp( $this->getRepo()->getFileTimestamp( $fullpath ) );
191 $altname = $wgContLang->checkTitleEncoding( $filename );
192 if ( $altname != $filename ) {
193 if ( $this->dryrun ) {
194 $filename = $altname;
195 $this->output( "Estimating transcoding... $altname\n" );
196 } else {
197 # @todo FIXME: create renameFile()
198 $filename = $this->renameFile( $filename );
202 if ( $filename == '' ) {
203 $this->output( "Empty filename for $fullpath\n" );
204 return;
206 if ( !$this->dryrun ) {
207 $file = wfLocalFile( $filename );
208 if ( !$file->recordUpload( '', '(recovered file, missing upload log entry)', '', '', '',
209 false, $timestamp ) )
211 $this->output( "Error uploading file $fullpath\n" );
212 return;
215 $this->output( $fullpath . "\n" );
219 $maintClass = 'ImageBuilder';
220 require_once RUN_MAINTENANCE_IF_MAIN;