wikimedia/mediawiki-core

View on GitHub
maintenance/storage/orphanStats.php

Summary

Maintainability
A
1 hr
Test Coverage
<?php
/**
 * Show some statistics on the blob_orphans table, created with trackBlobs.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
 * @ingroup Maintenance ExternalStorage
 */

require_once __DIR__ . '/../Maintenance.php';

/**
 * Maintenance script that shows some statistics on the blob_orphans table,
 * created with trackBlobs.php.
 *
 * @ingroup Maintenance ExternalStorage
 */
class OrphanStats extends Maintenance {
    public function __construct() {
        parent::__construct();
        $this->addDescription(
            "Show some statistics on the blob_orphans table, created with trackBlobs.php" );
    }

    protected function getExternalDB( $db, $cluster ) {
        $lbFactory = $this->getServiceContainer()->getDBLoadBalancerFactory();
        $lb = $lbFactory->getExternalLB( $cluster );

        return $lb->getMaintenanceConnectionRef( $db );
    }

    public function execute() {
        if ( !$this->getDB( DB_PRIMARY )->tableExists( 'blob_orphans', __METHOD__ ) ) {
            $this->fatalError( "blob_orphans doesn't seem to exist, need to run trackBlobs.php first" );
        }
        $dbr = $this->getReplicaDB();
        $res = $dbr->newSelectQueryBuilder()
            ->select( '*' )
            ->from( 'blob_orphans' )
            ->caller( __METHOD__ )->fetchResultSet();

        $num = 0;
        $totalSize = 0;
        $hashes = [];
        $maxSize = 0;

        foreach ( $res as $row ) {
            $extDB = $this->getExternalDB( DB_REPLICA, $row->bo_cluster );
            $blobRow = $extDB->newSelectQueryBuilder()
                ->select( '*' )
                ->from( 'blobs' )
                ->where( [ 'blob_id' => $row->bo_blob_id ] )
                ->caller( __METHOD__ )->fetchRow();

            $num++;
            $size = strlen( $blobRow->blob_text );
            $totalSize += $size;
            $hashes[sha1( $blobRow->blob_text )] = true;
            $maxSize = max( $size, $maxSize );
        }
        unset( $res );

        $this->output( "Number of orphans: $num\n" );
        if ( $num > 0 ) {
            $this->output( "Average size: " . round( $totalSize / $num, 0 ) . " bytes\n" .
                "Max size: $maxSize\n" .
                "Number of unique texts: " . count( $hashes ) . "\n" );
        }
    }
}

$maintClass = OrphanStats::class;
require_once RUN_MAINTENANCE_IF_MAIN;