wikimedia/mediawiki-core

View on GitHub
maintenance/findMissingFiles.php

Summary

Maintainability
C
7 hrs
Test Coverage
<?php
/**
 * 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
 */

// @codeCoverageIgnoreStart
require_once __DIR__ . '/Maintenance.php';
// @codeCoverageIgnoreEnd

class FindMissingFiles extends Maintenance {
    public function __construct() {
        parent::__construct();

        $this->addDescription( 'Find registered files with no corresponding file.' );
        $this->addOption( 'start', 'Start after this file name', false, true );
        $this->addOption( 'mtimeafter', 'Only include files changed since this time', false, true );
        $this->addOption( 'mtimebefore', 'Only includes files changed before this time', false, true );
        $this->setBatchSize( 300 );
    }

    public function execute() {
        $lastName = $this->getOption( 'start', '' );

        $repo = $this->getServiceContainer()->getRepoGroup()->getLocalRepo();
        $dbr = $repo->getReplicaDB();
        $be = $repo->getBackend();
        $batchSize = $this->getBatchSize();

        $mtime1 = $dbr->timestampOrNull( $this->getOption( 'mtimeafter', null ) );
        $mtime2 = $dbr->timestampOrNull( $this->getOption( 'mtimebefore', null ) );

        $queryBuilder = $dbr->newSelectQueryBuilder()
            ->select( [ 'name' => 'img_name' ] )
            ->from( 'image' )
            ->where( $dbr->expr( 'img_name', '>', $lastName ) )
            ->groupBy( 'name' )
            ->orderBy( 'name' )
            ->limit( $batchSize );

        if ( $mtime1 || $mtime2 ) {
            $queryBuilder->join( 'page', null, 'page_title = img_name' );
            $queryBuilder->andWhere( [ 'page_namespace' => NS_FILE ] );

            $queryBuilder->join( 'logging', null, 'log_page = page_id' );
            $queryBuilder->andWhere( [ 'log_type' => [ 'upload', 'move', 'delete' ] ] );
            if ( $mtime1 ) {
                $queryBuilder->andWhere( $dbr->expr( 'log_timestamp', '>', $mtime1 ) );
            }
            if ( $mtime2 ) {
                $queryBuilder->andWhere( $dbr->expr( 'log_timestamp', '<', $mtime2 ) );
            }
        }

        do {
            $res = $queryBuilder->caller( __METHOD__ )->fetchResultSet();

            // Check if any of these files are missing...
            $pathsByName = [];
            foreach ( $res as $row ) {
                $file = $repo->newFile( $row->name );
                $pathsByName[$row->name] = $file->getPath();
                $lastName = $row->name;
            }
            $be->preloadFileStat( [ 'srcs' => $pathsByName ] );
            foreach ( $pathsByName as $path ) {
                if ( $be->fileExists( [ 'src' => $path ] ) === false ) {
                    $this->output( "$path\n" );
                }
            }

            // Find all missing old versions of any of the files in this batch...
            if ( count( $pathsByName ) ) {
                $ores = $dbr->newSelectQueryBuilder()
                    ->select( [ 'oi_name', 'oi_archive_name' ] )
                    ->from( 'oldimage' )
                    ->where( [ 'oi_name' => array_map( 'strval', array_keys( $pathsByName ) ) ] )
                    ->caller( __METHOD__ )->fetchResultSet();

                $checkPaths = [];
                foreach ( $ores as $row ) {
                    if ( !strlen( $row->oi_archive_name ) ) {
                        // broken row
                        continue;
                    }
                    $file = $repo->newFromArchiveName( $row->oi_name, $row->oi_archive_name );
                    $checkPaths[] = $file->getPath();
                }

                foreach ( array_chunk( $checkPaths, $batchSize ) as $paths ) {
                    $be->preloadFileStat( [ 'srcs' => $paths ] );
                    foreach ( $paths as $path ) {
                        if ( $be->fileExists( [ 'src' => $path ] ) === false ) {
                            $this->output( "$path\n" );
                        }
                    }
                }
            }
        } while ( $res->numRows() >= $batchSize );
    }
}

// @codeCoverageIgnoreStart
$maintClass = FindMissingFiles::class;
require_once RUN_MAINTENANCE_IF_MAIN;
// @codeCoverageIgnoreEnd