cleanupImages.php

Go to the documentation of this file.

<?php
require_once( __DIR__ . '/cleanupTable.inc' );

class ImageCleanup extends TableCleanup {
        protected $defaultParams = array(
                'table' => 'image',
                'conds' => array(),
                'index' => 'img_name',
                'callback' => 'processRow',
        );

        public function __construct() {
                parent::__construct();
                $this->mDescription = "Script to clean up broken, unparseable upload filenames";
        }

        protected function processRow( $row ) {
                global $wgContLang;

                $source = $row->img_name;
                if ( $source == '' ) {
                        // Ye olde empty rows. Just kill them.
                        $this->killRow( $source );
                        return $this->progress( 1 );
                }

                $cleaned = $source;

                // About half of old bad image names have percent-codes
                $cleaned = rawurldecode( $cleaned );

                // We also have some HTML entities there
                $cleaned = Sanitizer::decodeCharReferences( $cleaned );

                // Some are old latin-1
                $cleaned = $wgContLang->checkTitleEncoding( $cleaned );

                // Many of remainder look like non-normalized unicode
                $cleaned = $wgContLang->normalize( $cleaned );

                $title = Title::makeTitleSafe( NS_FILE, $cleaned );

                if ( is_null( $title ) ) {
                        $this->output( "page $source ($cleaned) is illegal.\n" );
                        $safe = $this->buildSafeTitle( $cleaned );
                        if ( $safe === false ) {
                                return $this->progress( 0 );
                        }
                        $this->pokeFile( $source, $safe );
                        return $this->progress( 1 );
                }

                if ( $title->getDBkey() !== $source ) {
                        $munged = $title->getDBkey();
                        $this->output( "page $source ($munged) doesn't match self.\n" );
                        $this->pokeFile( $source, $munged );
                        return $this->progress( 1 );
                }

                return $this->progress( 0 );
        }

        private function killRow( $name ) {
                if ( $this->dryrun ) {
                        $this->output( "DRY RUN: would delete bogus row '$name'\n" );
                } else {
                        $this->output( "deleting bogus row '$name'\n" );
                        $db = wfGetDB( DB_MASTER );
                        $db->delete( 'image',
                                array( 'img_name' => $name ),
                                __METHOD__ );
                }
        }

        private function filePath( $name ) {
                if ( !isset( $this->repo ) ) {
                        $this->repo = RepoGroup::singleton()->getLocalRepo();
                }
                return $this->repo->getRootDirectory() . '/' . $this->repo->getHashPath( $name ) . $name;
        }

        private function imageExists( $name, $db ) {
                return $db->selectField( 'image', '1', array( 'img_name' => $name ), __METHOD__ );
        }

        private function pageExists( $name, $db ) {
                return $db->selectField( 'page', '1', array( 'page_namespace' => NS_FILE, 'page_title' => $name ), __METHOD__ );
        }

        private function pokeFile( $orig, $new ) {
                $path = $this->filePath( $orig );
                if ( !file_exists( $path ) ) {
                        $this->output( "missing file: $path\n" );
                        $this->killRow( $orig );
                        return;
                }

                $db = wfGetDB( DB_MASTER );

                /*
                 * To prevent key collisions in the update() statements below,
                 * if the target title exists in the image table, or if both the
                 * original and target titles exist in the page table, append
                 * increasing version numbers until the target title exists in
                 * neither.  (See also bug 16916.)
                 */
                $version = 0;
                $final = $new;
                $conflict = ( $this->imageExists( $final, $db ) ||
                                ( $this->pageExists( $orig, $db ) && $this->pageExists( $final, $db ) ) );

                while ( $conflict ) {
                        $this->output( "Rename conflicts with '$final'...\n" );
                        $version++;
                        $final = $this->appendTitle( $new, "_$version" );
                        $conflict = ( $this->imageExists( $final, $db ) || $this->pageExists( $final, $db ) );
                }

                $finalPath = $this->filePath( $final );

                if ( $this->dryrun ) {
                        $this->output( "DRY RUN: would rename $path to $finalPath\n" );
                } else {
                        $this->output( "renaming $path to $finalPath\n" );
                        // @todo FIXME: Should this use File::move()?
                        $db->begin( __METHOD__ );
                        $db->update( 'image',
                                array( 'img_name' => $final ),
                                array( 'img_name' => $orig ),
                                __METHOD__ );
                        $db->update( 'oldimage',
                                array( 'oi_name' => $final ),
                                array( 'oi_name' => $orig ),
                                __METHOD__ );
                        $db->update( 'page',
                                array( 'page_title' => $final ),
                                array( 'page_title' => $orig, 'page_namespace' => NS_FILE ),
                                __METHOD__ );
                        $dir = dirname( $finalPath );
                        if ( !file_exists( $dir ) ) {
                                if ( !wfMkdirParents( $dir, null, __METHOD__ ) ) {
                                        $this->output( "RENAME FAILED, COULD NOT CREATE $dir" );
                                        $db->rollback( __METHOD__ );
                                        return;
                                }
                        }
                        if ( rename( $path, $finalPath ) ) {
                                $db->commit( __METHOD__ );
                        } else {
                                $this->error( "RENAME FAILED" );
                                $db->rollback( __METHOD__ );
                        }
                }
        }

        private function appendTitle( $name, $suffix ) {
                return preg_replace( '/^(.*)(\..*?)$/',
                        "\\1$suffix\\2", $name );
        }

        private function buildSafeTitle( $name ) {
                $x = preg_replace_callback(
                        '/([^' . Title::legalChars() . ']|~)/',
                        array( $this, 'hexChar' ),
                        $name );

                $test = Title::makeTitleSafe( NS_FILE, $x );
                if ( is_null( $test ) || $test->getDBkey() !== $x ) {
                        $this->error( "Unable to generate safe title from '$name', got '$x'" );
                        return false;
                }

                return $x;
        }
}

$maintClass = "ImageCleanup";
require_once( RUN_MAINTENANCE_IF_MAIN );