Add newline to echo call
[lhc/web/wiklou.git] / maintenance / rebuildImages.php
index 73e0b08..46b5d0e 100644 (file)
@@ -1,60 +1,63 @@
 <?php
+/*
+ * Script to update image metadata records
+ *
+ * Usage: php rebuildImages.php [--missing] [--dry-run]
+ * Options:
+ *   --missing  Crawl the uploads dir for images without records, and
+ *              add them only.
+ *
+ * Copyright (C) 2005 Brion Vibber <brion@pobox.com>
+ * http://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
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ * @author Brion Vibber <brion at pobox.com>
+ * @ingrouo maintenance
+ */
+
+$options = array( 'missing', 'dry-run' );
 
 require_once( 'commandLine.inc' );
+require_once( 'FiveUpgrade.inc' );
+
+class ImageBuilder extends FiveUpgrade {
+       function ImageBuilder( $dryrun = false ) {
+               parent::FiveUpgrade();
+
+               $this->maxLag = 10; # if slaves are lagged more than 10 secs, wait
+               $this->dryrun = $dryrun;
+               if ( $dryrun ) {
+                       $GLOBALS['wgReadOnly'] = 'Dry run mode, image upgrades are suppressed';
+               }
+       }
 
-class ImageBuilder {
-       function ImageBuilder() {
-               global $wgDatabase;
-               
-               $this->dbw =& $this->newConnection();
-               $this->dbr =& $this->streamConnection();
-               
-               $this->maxLag    = 10; # if slaves are lagged more than 10 secs, wait
+       function getRepo() {
+               if ( !isset( $this->repo ) ) {
+                       $this->repo = RepoGroup::singleton()->getLocalRepo();
+               }
+               return $this->repo;
        }
-       
+
        function build() {
                $this->buildImage();
                $this->buildOldImage();
        }
-       
-       /**
-        * Open a connection to the master server with the admin rights.
-        * @return Database
-        * @access private
-        */
-       function &newConnection() {
-               global $wgDBadminuser, $wgDBadminpassword;
-               global $wgDBserver, $wgDBname;
-               $db =& new Database( $wgDBserver, $wgDBadminuser, $wgDBadminpassword, $wgDBname );
-               return $db;
-       }
-       
-       /**
-        * Open a second connection to the master server, with buffering off.
-        * This will let us stream large datasets in and write in chunks on the
-        * other end.
-        * @return Database
-        * @access private
-        */
-       function &streamConnection() {
-               $timeout = 3600 * 24;
-               $db =& $this->newConnection();
-               $db->bufferResults( false );
-               $db->query( "SET net_read_timeout=$timeout" );
-               $db->query( "SET net_write_timeout=$timeout" );
-               return $db;
-       }
-       
-       /**
-        * Dump timestamp and message to output
-        * @param string $message
-        * @access private
-        */
-       function log( $message ) {
-               echo wfTimestamp( TS_DB ) . ': ' . $message . "\n";
-               flush();
-       }
-       
+
        function init( $count, $table ) {
                $this->processed = 0;
                $this->updated = 0;
@@ -62,7 +65,7 @@ class ImageBuilder {
                $this->startTime = wfTime();
                $this->table = $table;
        }
-       
+
        function progress( $updated ) {
                $this->updated += $updated;
                $this->processed++;
@@ -71,42 +74,38 @@ class ImageBuilder {
                }
                $portion = $this->processed / $this->count;
                $updateRate = $this->updated / $this->processed;
-               
+
                $now = wfTime();
                $delta = $now - $this->startTime;
                $estimatedTotalTime = $delta / $portion;
                $eta = $this->startTime + $estimatedTotalTime;
-               
+
                printf( "%s: %6.2f%% done on %s; ETA %s [%d/%d] %.2f/sec <%.2f%% updated>\n",
                        wfTimestamp( TS_DB, intval( $now ) ),
                        $portion * 100.0,
                        $this->table,
                        wfTimestamp( TS_DB, intval( $eta ) ),
-                       $completed,
+                       $completed,   // $completed does not appear to be defined.
                        $this->count,
-                       $rate,
+                       $rate,        // $rate does not appear to be defined.
                        $updateRate * 100.0 );
                flush();
        }
-       
+
        function buildTable( $table, $key, $callback ) {
                $fname = 'ImageBuilder::buildTable';
-               
+
                $count = $this->dbw->selectField( $table, 'count(*)', '', $fname );
                $this->init( $count, $table );
                $this->log( "Processing $table..." );
-               
+
                $tableName = $this->dbr->tableName( $table );
                $sql = "SELECT * FROM $tableName";
                $result = $this->dbr->query( $sql, $fname );
-               
+
                while( $row = $this->dbr->fetchObject( $result ) ) {
                        $update = call_user_func( $callback, $row );
-                       if( is_array( $update ) ) {
-                               $this->dbw->update( $table,
-                                       $update,
-                                       array( $key => $row->$key ),
-                                       $fname );
+                       if( $update ) {
                                $this->progress( 1 );
                        } else {
                                $this->progress( 0 );
@@ -115,89 +114,101 @@ class ImageBuilder {
                $this->log( "Finished $table... $this->updated of $this->processed rows updated" );
                $this->dbr->freeResult( $result );
        }
-       
+
        function buildImage() {
                $callback = array( &$this, 'imageCallback' );
                $this->buildTable( 'image', 'img_name', $callback );
        }
-       
+
        function imageCallback( $row ) {
-               if( $row->img_width ) {
-                       // Already processed
-                       return null;
-               }
-               
-               // Fill in the new image info fields
-               $info = $this->imageInfo( $row->img_name );
-               return array(
-                       'img_width'      => $info['width'],
-                       'img_height'     => $info['height'],
-                       'img_bits'       => $info['bits'],
-                       'img_media_type' => $info['media'],
-                       'img_major_mime' => $info['major'],
-                       'img_minor_mime' => $info['minor'] );
+               // 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' ) );
        }
-       
+
        function oldimageCallback( $row ) {
-               if( $row->oi_width ) {
-                       return null;
+               // Create a File object from the row
+               // This will also upgrade it
+               if ( $row->oi_archive_name == '' ) {
+                       $this->log( "Empty oi_archive_name for oi_name={$row->oi_name}" );
+                       return false;
                }
-               
-               // Fill in the new image info fields
-               $info = $this->imageInfo( $row->oi_archive_name, 'wfImageArchiveDir', $row->oi_name );
-               return array(
-                       'oi_width'  => $info['width' ],
-                       'oi_height' => $info['height'],
-                       'oi_bits'   => $info['bits'  ] );
+               $file = $this->getRepo()->newFileFromRow( $row );
+               return $file->getUpgraded();
+       }
+
+       function crawlMissing() {
+               $repo = RepoGroup::singleton()->getLocalRepo();
+               $repo->enumFilesInFS( array( $this, 'checkMissingImage' ) );
        }
-       
-       function imageInfo( $name, $subdirCallback='wfImageDir', $basename = null ) {
-               if( is_null( $basename ) ) $basename = $name;
-               $dir = call_user_func( $subdirCallback, $basename );
-               $filename = $dir . '/' . $name;
-               $info = array(
-                       'width'  => 0,
-                       'height' => 0,
-                       'bits'   => 0,
-                       'media'  => '',
-                       'major'  => '',
-                       'minor'  => '' );
-               
-               $magic =& wfGetMimeMagic();
-               $mime = $magic->guessMimeType( $filename, true );
-               list( $info['major'], $info['minor'] ) = explode( '/', $mime );
-               
-               $info['media'] = $magic->getMediaType( $filename, $mime );
-               
-               # Height and width
-               $gis = false;
-               if( $mime == 'image/svg' ) {
-                       $gis = wfGetSVGsize( $this->imagePath );
-               } elseif( $magic->isPHPImageType( $mime ) ) {
-                       $gis = getimagesize( $filename );
+
+       function checkMissingImage( $fullpath ) {
+               $fname = 'ImageBuilder::checkMissingImage';
+               $filename = wfBaseName( $fullpath );
+               if( is_dir( $fullpath ) ) {
+                       return;
+               }
+               if( is_link( $fullpath ) ) {
+                       $this->log( "skipping symlink at $fullpath" );
+                       return;
+               }
+               $row = $this->dbw->selectRow( 'image',
+                       array( 'img_name' ),
+                       array( 'img_name' => $filename ),
+                       $fname );
+
+               if( $row ) {
+                       // already known, move on
+                       return;
                } else {
-                       $this->log( "Surprising mime type: $mime" );
+                       $this->addMissingImage( $filename, $fullpath );
+               }
+       }
+
+       function addMissingImage( $filename, $fullpath ) {
+               $fname = 'ImageBuilder::addMissingImage';
+
+               $timestamp = $this->dbw->timestamp( filemtime( $fullpath ) );
+
+               global $wgContLang;
+               $altname = $wgContLang->checkTitleEncoding( $filename );
+               if( $altname != $filename ) {
+                       if( $this->dryrun ) {
+                               $filename = $altname;
+                               $this->log( "Estimating transcoding... $altname" );
+                       } else {
+                               $filename = $this->renameFile( $filename );
+                       }
                }
-               if( $gis ) {
-                       $info['width' ] = $gis[0];
-                       $info['height'] = $gis[1];
+
+               if( $filename == '' ) {
+                       $this->log( "Empty filename for $fullpath" );
+                       return;
                }
-               if( isset( $gis['bits'] ) ) {
-                       $info['bits'] = $gis['bits'];
+               if ( !$this->dryrun ) {
+                       $file = wfLocalFile( $filename );
+                       if ( !$file->recordUpload( '', '(recovered file, missing upload log entry)', '', '', '', 
+                               false, $timestamp ) )
+                       {
+                               $this->log( "Error uploading file $fullpath" );
+                               return;
+                       }
                }
-               
-               return $info;
+               $this->log( $fullpath );
        }
-       
 }
 
-$builder = new ImageBuilder();
-$builder->build();
+$builder = new ImageBuilder( isset( $options['dry-run'] ) );
+if( isset( $options['missing'] ) ) {
+       $builder->crawlMissing();
+} else {
+       $builder->build();
+}
+
 
-?>