MediaWiki 1.30.2

[autoinstallsdev/mediawiki.git] / maintenance / rebuildImages.php

diff --git a/maintenance/rebuildImages.php b/maintenance/rebuildImages.php
index c61d948087b5a93b956eb0dfc048dec08ec3f7ba..109350cd74687dc372bee0d48ea8152ee7f71bc4 100644 (file)
--- a/maintenance/rebuildImages.php
+++ b/maintenance/rebuildImages.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * Script to update image metadata records
+ * Update image metadata records.
  *
  * Usage: php rebuildImages.php [--missing] [--dry-run]
  * Options:
@@ -8,7 +8,7 @@
  *              add them only.
  *
  * Copyright © 2005 Brion Vibber <brion@pobox.com>
- * http://www.mediawiki.org/
+ * https://www.mediawiki.org/
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -27,27 +27,44 @@
  *
  * @file
  * @author Brion Vibber <brion at pobox.com>
- * @ingroup maintenance
+ * @ingroup Maintenance
  */
 
-require_once( dirname( __FILE__ ) . '/Maintenance.php' );
+require_once __DIR__ . '/Maintenance.php';
 
+use Wikimedia\Rdbms\IMaintainableDatabase;
+
+/**
+ * Maintenance script to update image metadata records.
+ *
+ * @ingroup Maintenance
+ */
 class ImageBuilder extends Maintenance {
+
+       /**
+        * @var IMaintainableDatabase
+        */
+       protected $dbw;
+
        function __construct() {
                parent::__construct();
 
-               $this->mDescription = 'Script to update image metadata records';
+               global $wgUpdateCompatibleMetadata;
+               // make sure to update old, but compatible img_metadata fields.
+               $wgUpdateCompatibleMetadata = true;
+
+               $this->addDescription( 'Script to update image metadata records' );
 
                $this->addOption( 'missing', 'Check for files without associated database record' );
                $this->addOption( 'dry-run', 'Only report, don\'t update the database' );
        }
 
        public function execute() {
-               $this->dbw = wfGetDB( DB_MASTER );
-               $this->maxLag = 10; # if slaves are lagged more than 10 secs, wait
+               $this->dbw = $this->getDB( DB_MASTER );
                $this->dryrun = $this->hasOption( 'dry-run' );
                if ( $this->dryrun ) {
-                       $GLOBALS['wgReadOnly'] = 'Dry run mode, image upgrades are suppressed';
+                       MediaWiki\MediaWikiServices::getInstance()->getReadOnlyMode()
+                               ->setReason( 'Dry run mode, image upgrades are suppressed' );
                }
 
                if ( $this->hasOption( 'missing' ) ) {
@@ -57,10 +74,14 @@ class ImageBuilder extends Maintenance {
                }
        }
 
+       /**
+        * @return FileRepo
+        */
        function getRepo() {
                if ( !isset( $this->repo ) ) {
                        $this->repo = RepoGroup::singleton()->getLocalRepo();
                }
+
                return $this->repo;
        }
 
@@ -73,7 +94,7 @@ class ImageBuilder extends Maintenance {
                $this->processed = 0;
                $this->updated = 0;
                $this->count = $count;
-               $this->startTime = wfTime();
+               $this->startTime = microtime( true );
                $this->table = $table;
        }
 
@@ -86,7 +107,7 @@ class ImageBuilder extends Maintenance {
                $portion = $this->processed / $this->count;
                $updateRate = $this->updated / $this->processed;
 
-               $now = wfTime();
+               $now = microtime( true );
                $delta = $now - $this->startTime;
                $estimatedTotalTime = $delta / $portion;
                $eta = $this->startTime + $estimatedTotalTime;
@@ -109,7 +130,7 @@ class ImageBuilder extends Maintenance {
                $this->init( $count, $table );
                $this->output( "Processing $table...\n" );
 
-               $result = wfGetDB( DB_SLAVE )->select( $table, '*', array(), __METHOD__ );
+               $result = $this->getDB( DB_REPLICA )->select( $table, '*', [], __METHOD__ );
 
                foreach ( $result as $row ) {
                        $update = call_user_func( $callback, $row, null );
@@ -123,7 +144,7 @@ class ImageBuilder extends Maintenance {
        }
 
        function buildImage() {
-               $callback = array( $this, 'imageCallback' );
+               $callback = [ $this, 'imageCallback' ];
                $this->buildTable( 'image', 'img_name', $callback );
        }
 
@@ -131,12 +152,12 @@ class ImageBuilder extends Maintenance {
                // Create a File object from the row
                // This will also upgrade it
                $file = $this->getRepo()->newFileFromRow( $row );
+
                return $file->getUpgraded();
        }
 
        function buildOldImage() {
-               $this->buildTable( 'oldimage', 'oi_archive_name',
-                       array( $this, 'oldimageCallback' ) );
+               $this->buildTable( 'oldimage', 'oi_archive_name', [ $this, 'oldimageCallback' ] );
        }
 
        function oldimageCallback( $row, $copy ) {
@@ -144,63 +165,64 @@ class ImageBuilder extends Maintenance {
                // This will also upgrade it
                if ( $row->oi_archive_name == '' ) {
                        $this->output( "Empty oi_archive_name for oi_name={$row->oi_name}\n" );
+
                        return false;
                }
                $file = $this->getRepo()->newFileFromRow( $row );
+
                return $file->getUpgraded();
        }
 
        function crawlMissing() {
-               $repo = RepoGroup::singleton()->getLocalRepo();
-               $repo->enumFilesInFS( array( $this, 'checkMissingImage' ) );
+               $this->getRepo()->enumFiles( [ $this, 'checkMissingImage' ] );
        }
 
        function checkMissingImage( $fullpath ) {
                $filename = wfBaseName( $fullpath );
-               if ( is_dir( $fullpath ) ) {
-                       return;
-               }
-               if ( is_link( $fullpath ) ) {
-                       $this->output( "skipping symlink at $fullpath\n" );
-                       return;
-               }
                $row = $this->dbw->selectRow( 'image',
-                       array( 'img_name' ),
-                       array( 'img_name' => $filename ),
+                       [ 'img_name' ],
+                       [ 'img_name' => $filename ],
                        __METHOD__ );
 
-               if ( $row ) {
-                       // already known, move on
-                       return;
-               } else {
+               if ( !$row ) { // file not registered
                        $this->addMissingImage( $filename, $fullpath );
                }
        }
 
        function addMissingImage( $filename, $fullpath ) {
-               $timestamp = $this->dbw->timestamp( filemtime( $fullpath ) );
-
                global $wgContLang;
+
+               $timestamp = $this->dbw->timestamp( $this->getRepo()->getFileTimestamp( $fullpath ) );
+
                $altname = $wgContLang->checkTitleEncoding( $filename );
                if ( $altname != $filename ) {
                        if ( $this->dryrun ) {
                                $filename = $altname;
                                $this->output( "Estimating transcoding... $altname\n" );
                        } else {
+                               # @todo FIXME: create renameFile()
                                $filename = $this->renameFile( $filename );
                        }
                }
 
                if ( $filename == '' ) {
                        $this->output( "Empty filename for $fullpath\n" );
+
                        return;
                }
                if ( !$this->dryrun ) {
                        $file = wfLocalFile( $filename );
-                       if ( !$file->recordUpload( '', '(recovered file, missing upload log entry)', '', '', '',
-                               false, $timestamp ) )
-                       {
+                       if ( !$file->recordUpload(
+                               '',
+                               '(recovered file, missing upload log entry)',
+                               '',
+                               '',
+                               '',
+                               false,
+                               $timestamp
+                       ) ) {
                                $this->output( "Error uploading file $fullpath\n" );
+
                                return;
                        }
                }
@@ -209,4 +231,4 @@ class ImageBuilder extends Maintenance {
 }
 
 $maintClass = 'ImageBuilder';
-require_once( RUN_MAINTENANCE_IF_MAIN );
+require_once RUN_MAINTENANCE_IF_MAIN;