composer.json: Add a phan script command

[mediawiki.git] / maintenance / rebuildrecentchanges.php

<?php
/**
 * Rebuild recent changes from scratch.  This takes several hours,
 * depending on the database size and server configuration.
 *
 * 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
 * @todo Document
 */

require_once __DIR__ . '/Maintenance.php';

use MediaWiki\MediaWikiServices;
use Wikimedia\Rdbms\IDatabase;
use Wikimedia\Rdbms\ILBFactory;

/**
 * Maintenance script that rebuilds recent changes from scratch.
 *
 * @ingroup Maintenance
 */
class RebuildRecentchanges extends Maintenance {
        /** @var int UNIX timestamp */
        private $cutoffFrom;
        /** @var int UNIX timestamp */
        private $cutoffTo;

        public function __construct() {
                parent::__construct();
                $this->addDescription( 'Rebuild recent changes' );

                $this->addOption(
                        'from',
                        "Only rebuild rows in requested time range (in YYYYMMDDHHMMSS format)",
                        false,
                        true
                );
                $this->addOption(
                        'to',
                        "Only rebuild rows in requested time range (in YYYYMMDDHHMMSS format)",
                        false,
                        true
                );
                $this->setBatchSize( 200 );
        }

        public function execute() {
                if (
                        ( $this->hasOption( 'from' ) && !$this->hasOption( 'to' ) ) ||
                        ( !$this->hasOption( 'from' ) && $this->hasOption( 'to' ) )
                ) {
                        $this->fatalError( "Both 'from' and 'to' must be given, or neither" );
                }

                $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
                $this->rebuildRecentChangesTablePass1( $lbFactory );
                $this->rebuildRecentChangesTablePass2( $lbFactory );
                $this->rebuildRecentChangesTablePass3( $lbFactory );
                $this->rebuildRecentChangesTablePass4( $lbFactory );
                $this->rebuildRecentChangesTablePass5( $lbFactory );
                if ( !( $this->hasOption( 'from' ) && $this->hasOption( 'to' ) ) ) {
                        $this->purgeFeeds();
                }
                $this->output( "Done.\n" );
        }

        /**
         * Rebuild pass 1: Insert `recentchanges` entries for page revisions.
         *
         * @param ILBFactory $lbFactory
         */
        private function rebuildRecentChangesTablePass1( ILBFactory $lbFactory ) {
                $dbw = $this->getDB( DB_MASTER );
                $commentStore = CommentStore::getStore();

                if ( $this->hasOption( 'from' ) && $this->hasOption( 'to' ) ) {
                        $this->cutoffFrom = wfTimestamp( TS_UNIX, $this->getOption( 'from' ) );
                        $this->cutoffTo = wfTimestamp( TS_UNIX, $this->getOption( 'to' ) );

                        $sec = $this->cutoffTo - $this->cutoffFrom;
                        $days = $sec / 24 / 3600;
                        $this->output( "Rebuilding range of $sec seconds ($days days)\n" );
                } else {
                        global $wgRCMaxAge;

                        $days = $wgRCMaxAge / 24 / 3600;
                        $this->output( "Rebuilding \$wgRCMaxAge=$wgRCMaxAge seconds ($days days)\n" );

                        $this->cutoffFrom = time() - $wgRCMaxAge;
                        $this->cutoffTo = time();
                }

                $this->output( "Clearing recentchanges table for time range...\n" );
                $rcids = $dbw->selectFieldValues(
                        'recentchanges',
                        'rc_id',
                        [
                                'rc_timestamp > ' . $dbw->addQuotes( $dbw->timestamp( $this->cutoffFrom ) ),
                                'rc_timestamp < ' . $dbw->addQuotes( $dbw->timestamp( $this->cutoffTo ) )
                        ],
                        __METHOD__
                );
                foreach ( array_chunk( $rcids, $this->getBatchSize() ) as $rcidBatch ) {
                        $dbw->delete( 'recentchanges', [ 'rc_id' => $rcidBatch ], __METHOD__ );
                        $lbFactory->waitForReplication();
                }

                $this->output( "Loading from page and revision tables...\n" );

                $commentQuery = $commentStore->getJoin( 'rev_comment' );
                $actorQuery = ActorMigration::newMigration()->getJoin( 'rev_user' );
                $res = $dbw->select(
                        [ 'revision', 'page' ] + $commentQuery['tables'] + $actorQuery['tables'],
                        [
                                'rev_timestamp',
                                'rev_minor_edit',
                                'rev_id',
                                'rev_deleted',
                                'page_namespace',
                                'page_title',
                                'page_is_new',
                                'page_id'
                        ] + $commentQuery['fields'] + $actorQuery['fields'],
                        [
                                'rev_timestamp > ' . $dbw->addQuotes( $dbw->timestamp( $this->cutoffFrom ) ),
                                'rev_timestamp < ' . $dbw->addQuotes( $dbw->timestamp( $this->cutoffTo ) )
                        ],
                        __METHOD__,
                        [ 'ORDER BY' => 'rev_timestamp DESC' ],
                        [
                                'page' => [ 'JOIN', 'rev_page=page_id' ],
                        ] + $commentQuery['joins'] + $actorQuery['joins']
                );

                $this->output( "Inserting from page and revision tables...\n" );
                $inserted = 0;
                $actorMigration = ActorMigration::newMigration();
                foreach ( $res as $row ) {
                        $comment = $commentStore->getComment( 'rev_comment', $row );
                        $user = User::newFromAnyId( $row->rev_user, $row->rev_user_text, $row->rev_actor );
                        $dbw->insert(
                                'recentchanges',
                                [
                                        'rc_timestamp' => $row->rev_timestamp,
                                        'rc_namespace' => $row->page_namespace,
                                        'rc_title' => $row->page_title,
                                        'rc_minor' => $row->rev_minor_edit,
                                        'rc_bot' => 0,
                                        'rc_new' => $row->page_is_new,
                                        'rc_cur_id' => $row->page_id,
                                        'rc_this_oldid' => $row->rev_id,
                                        'rc_last_oldid' => 0, // is this ok?
                                        'rc_type' => $row->page_is_new ? RC_NEW : RC_EDIT,
                                        'rc_source' => $row->page_is_new ? RecentChange::SRC_NEW : RecentChange::SRC_EDIT,
                                        'rc_deleted' => $row->rev_deleted
                                ] + $commentStore->insert( $dbw, 'rc_comment', $comment )
                                        + $actorMigration->getInsertValues( $dbw, 'rc_user', $user ),
                                __METHOD__
                        );

                        $rcid = $dbw->insertId();
                        $dbw->update(
                                'change_tag',
                                [ 'ct_rc_id' => $rcid ],
                                [ 'ct_rev_id' => $row->rev_id ],
                                __METHOD__
                        );

                        if ( ( ++$inserted % $this->getBatchSize() ) == 0 ) {
                                $lbFactory->waitForReplication();
                        }
                }
        }

        /**
         * Rebuild pass 2: Enhance entries for page revisions with references to the previous revision
         * (rc_last_oldid, rc_new etc.) and size differences (rc_old_len, rc_new_len).
         *
         * @param ILBFactory $lbFactory
         */
        private function rebuildRecentChangesTablePass2( ILBFactory $lbFactory ) {
                $dbw = $this->getDB( DB_MASTER );

                $this->output( "Updating links and size differences...\n" );

                # Fill in the rc_last_oldid field, which points to the previous edit
                $res = $dbw->select(
                        'recentchanges',
                        [ 'rc_cur_id', 'rc_this_oldid', 'rc_timestamp' ],
                        [
                                "rc_timestamp > " . $dbw->addQuotes( $dbw->timestamp( $this->cutoffFrom ) ),
                                "rc_timestamp < " . $dbw->addQuotes( $dbw->timestamp( $this->cutoffTo ) )
                        ],
                        __METHOD__,
                        [ 'ORDER BY' => [ 'rc_cur_id', 'rc_timestamp' ] ]
                );

                $lastCurId = 0;
                $lastOldId = 0;
                $lastSize = null;
                $updated = 0;
                foreach ( $res as $row ) {
                        $new = 0;

                        if ( $row->rc_cur_id != $lastCurId ) {
                                # Switch! Look up the previous last edit, if any
                                $lastCurId = intval( $row->rc_cur_id );
                                $emit = $row->rc_timestamp;

                                $revRow = $dbw->selectRow(
                                        'revision',
                                        [ 'rev_id', 'rev_len' ],
                                        [ 'rev_page' => $lastCurId, "rev_timestamp < " . $dbw->addQuotes( $emit ) ],
                                        __METHOD__,
                                        [ 'ORDER BY' => 'rev_timestamp DESC' ]
                                );
                                if ( $revRow ) {
                                        $lastOldId = intval( $revRow->rev_id );
                                        # Grab the last text size if available
                                        $lastSize = $revRow->rev_len !== null ? intval( $revRow->rev_len ) : null;
                                } else {
                                        # No previous edit
                                        $lastOldId = 0;
                                        $lastSize = 0;
                                        $new = 1; // probably true
                                }
                        }

                        if ( $lastCurId == 0 ) {
                                $this->output( "Uhhh, something wrong? No curid\n" );
                        } else {
                                # Grab the entry's text size
                                $size = (int)$dbw->selectField(
                                        'revision',
                                        'rev_len',
                                        [ 'rev_id' => $row->rc_this_oldid ],
                                        __METHOD__
                                );

                                $dbw->update(
                                        'recentchanges',
                                        [
                                                'rc_last_oldid' => $lastOldId,
                                                'rc_new' => $new,
                                                'rc_type' => $new ? RC_NEW : RC_EDIT,
                                                'rc_source' => $new === 1 ? RecentChange::SRC_NEW : RecentChange::SRC_EDIT,
                                                'rc_old_len' => $lastSize,
                                                'rc_new_len' => $size,
                                        ],
                                        [
                                                'rc_cur_id' => $lastCurId,
                                                'rc_this_oldid' => $row->rc_this_oldid,
                                                'rc_timestamp' => $row->rc_timestamp // index usage
                                        ],
                                        __METHOD__
                                );

                                $lastOldId = intval( $row->rc_this_oldid );
                                $lastSize = $size;

                                if ( ( ++$updated % $this->getBatchSize() ) == 0 ) {
                                        $lbFactory->waitForReplication();
                                }
                        }
                }
        }

        /**
         * Rebuild pass 3: Insert `recentchanges` entries for action logs.
         *
         * @param ILBFactory $lbFactory
         */
        private function rebuildRecentChangesTablePass3( ILBFactory $lbFactory ) {
                global $wgLogRestrictions, $wgFilterLogTypes;

                $dbw = $this->getDB( DB_MASTER );
                $commentStore = CommentStore::getStore();
                $nonRCLogs = array_merge( array_keys( $wgLogRestrictions ),
                        array_keys( $wgFilterLogTypes ),
                        [ 'create' ] );

                $this->output( "Loading from user and logging tables...\n" );

                $commentQuery = $commentStore->getJoin( 'log_comment' );
                $actorQuery = ActorMigration::newMigration()->getJoin( 'log_user' );
                $res = $dbw->select(
                        [ 'logging' ] + $commentQuery['tables'] + $actorQuery['tables'],
                        [
                                'log_timestamp',
                                'log_namespace',
                                'log_title',
                                'log_page',
                                'log_type',
                                'log_action',
                                'log_id',
                                'log_params',
                                'log_deleted'
                        ] + $commentQuery['fields'] + $actorQuery['fields'],
                        [
                                'log_timestamp > ' . $dbw->addQuotes( $dbw->timestamp( $this->cutoffFrom ) ),
                                'log_timestamp < ' . $dbw->addQuotes( $dbw->timestamp( $this->cutoffTo ) ),
                                // Some logs don't go in RC since they are private, or are included in the filterable log types.
                                'log_type' => array_diff( LogPage::validTypes(), $nonRCLogs ),
                        ],
                        __METHOD__,
                        [ 'ORDER BY' => 'log_timestamp DESC' ],
                        $commentQuery['joins'] + $actorQuery['joins']
                );

                $field = $dbw->fieldInfo( 'recentchanges', 'rc_cur_id' );

                $inserted = 0;
                $actorMigration = ActorMigration::newMigration();
                foreach ( $res as $row ) {
                        $comment = $commentStore->getComment( 'log_comment', $row );
                        $user = User::newFromAnyId( $row->log_user, $row->log_user_text, $row->log_actor );
                        $dbw->insert(
                                'recentchanges',
                                [
                                        'rc_timestamp' => $row->log_timestamp,
                                        'rc_namespace' => $row->log_namespace,
                                        'rc_title' => $row->log_title,
                                        'rc_minor' => 0,
                                        'rc_bot' => 0,
                                        'rc_patrolled' => $row->log_type == 'upload' ? 0 : 2,
                                        'rc_new' => 0,
                                        'rc_this_oldid' => 0,
                                        'rc_last_oldid' => 0,
                                        'rc_type' => RC_LOG,
                                        'rc_source' => RecentChange::SRC_LOG,
                                        'rc_cur_id' => $field->isNullable()
                                                ? $row->log_page
                                                : (int)$row->log_page, // NULL => 0,
                                        'rc_log_type' => $row->log_type,
                                        'rc_log_action' => $row->log_action,
                                        'rc_logid' => $row->log_id,
                                        'rc_params' => $row->log_params,
                                        'rc_deleted' => $row->log_deleted
                                ] + $commentStore->insert( $dbw, 'rc_comment', $comment )
                                        + $actorMigration->getInsertValues( $dbw, 'rc_user', $user ),
                                __METHOD__
                        );

                        $rcid = $dbw->insertId();
                        $dbw->update(
                                'change_tag',
                                [ 'ct_rc_id' => $rcid ],
                                [ 'ct_log_id' => $row->log_id ],
                                __METHOD__
                        );

                        if ( ( ++$inserted % $this->getBatchSize() ) == 0 ) {
                                $lbFactory->waitForReplication();
                        }
                }
        }

        /**
         * Rebuild pass 4: Mark bot and autopatrolled entries.
         *
         * @param ILBFactory $lbFactory
         */
        private function rebuildRecentChangesTablePass4( ILBFactory $lbFactory ) {
                global $wgUseRCPatrol, $wgUseNPPatrol, $wgUseFilePatrol, $wgMiserMode;

                $dbw = $this->getDB( DB_MASTER );

                $userQuery = User::getQueryInfo();

                # @FIXME: recognize other bot account groups (not the same as users with 'bot' rights)
                # @NOTE: users with 'bot' rights choose when edits are bot edits or not. That information
                # may be lost at this point (aside from joining on the patrol log table entries).
                $botgroups = [ 'bot' ];
                $autopatrolgroups = ( $wgUseRCPatrol || $wgUseNPPatrol || $wgUseFilePatrol ) ?
                        MediaWikiServices::getInstance()->getPermissionManager()
                        ->getGroupsWithPermission( 'autopatrol' ) : [];

                # Flag our recent bot edits
                // @phan-suppress-next-line PhanRedundantCondition
                if ( $botgroups ) {
                        $this->output( "Flagging bot account edits...\n" );

                        # Find all users that are bots
                        $res = $dbw->select(
                                array_merge( [ 'user_groups' ], $userQuery['tables'] ),
                                $userQuery['fields'],
                                [ 'ug_group' => $botgroups ],
                                __METHOD__,
                                [ 'DISTINCT' ],
                                [ 'user_groups' => [ 'JOIN', 'user_id = ug_user' ] ] + $userQuery['joins']
                        );

                        $botusers = [];
                        foreach ( $res as $row ) {
                                $botusers[] = User::newFromRow( $row );
                        }

                        # Fill in the rc_bot field
                        if ( $botusers ) {
                                $actorQuery = ActorMigration::newMigration()->getWhere( $dbw, 'rc_user', $botusers, false );
                                $rcids = [];
                                foreach ( $actorQuery['orconds'] as $cond ) {
                                        $rcids = array_merge( $rcids, $dbw->selectFieldValues(
                                                [ 'recentchanges' ] + $actorQuery['tables'],
                                                'rc_id',
                                                [
                                                        "rc_timestamp > " . $dbw->addQuotes( $dbw->timestamp( $this->cutoffFrom ) ),
                                                        "rc_timestamp < " . $dbw->addQuotes( $dbw->timestamp( $this->cutoffTo ) ),
                                                        $cond,
                                                ],
                                                __METHOD__,
                                                [],
                                                $actorQuery['joins']
                                        ) );
                                }
                                $rcids = array_values( array_unique( $rcids ) );

                                foreach ( array_chunk( $rcids, $this->getBatchSize() ) as $rcidBatch ) {
                                        $dbw->update(
                                                'recentchanges',
                                                [ 'rc_bot' => 1 ],
                                                [ 'rc_id' => $rcidBatch ],
                                                __METHOD__
                                        );
                                        $lbFactory->waitForReplication();
                                }
                        }
                }

                # Flag our recent autopatrolled edits
                if ( !$wgMiserMode && $autopatrolgroups ) {
                        $patrolusers = [];

                        $this->output( "Flagging auto-patrolled edits...\n" );

                        # Find all users in RC with autopatrol rights
                        $res = $dbw->select(
                                array_merge( [ 'user_groups' ], $userQuery['tables'] ),
                                $userQuery['fields'],
                                [ 'ug_group' => $autopatrolgroups ],
                                __METHOD__,
                                [ 'DISTINCT' ],
                                [ 'user_groups' => [ 'JOIN', 'user_id = ug_user' ] ] + $userQuery['joins']
                        );

                        foreach ( $res as $row ) {
                                $patrolusers[] = User::newFromRow( $row );
                        }

                        # Fill in the rc_patrolled field
                        if ( $patrolusers ) {
                                $actorQuery = ActorMigration::newMigration()->getWhere( $dbw, 'rc_user', $patrolusers, false );
                                foreach ( $actorQuery['orconds'] as $cond ) {
                                        $conds = [
                                                $cond,
                                                'rc_timestamp > ' . $dbw->addQuotes( $dbw->timestamp( $this->cutoffFrom ) ),
                                                'rc_timestamp < ' . $dbw->addQuotes( $dbw->timestamp( $this->cutoffTo ) ),
                                                'rc_patrolled' => 0
                                        ];

                                        if ( !$wgUseRCPatrol ) {
                                                $subConds = [];
                                                if ( $wgUseNPPatrol ) {
                                                        $subConds[] = 'rc_source = ' . $dbw->addQuotes( RecentChange::SRC_NEW );
                                                }
                                                if ( $wgUseFilePatrol ) {
                                                        $subConds[] = 'rc_log_type = ' . $dbw->addQuotes( 'upload' );
                                                }
                                                $conds[] = $dbw->makeList( $subConds, IDatabase::LIST_OR );
                                        }

                                        $dbw->update(
                                                'recentchanges',
                                                [ 'rc_patrolled' => 2 ],
                                                $conds,
                                                __METHOD__
                                        );
                                        $lbFactory->waitForReplication();
                                }
                        }
                }
        }

        /**
         * Rebuild pass 5: Delete duplicate entries where we generate both a page revision and a log
         * entry for a single action (upload, move, protect, import, etc.).
         *
         * @param ILBFactory $lbFactory
         */
        private function rebuildRecentChangesTablePass5( ILBFactory $lbFactory ) {
                $dbw = wfGetDB( DB_MASTER );

                $this->output( "Removing duplicate revision and logging entries...\n" );

                $res = $dbw->select(
                        [ 'logging', 'log_search' ],
                        [ 'ls_value', 'ls_log_id' ],
                        [
                                'ls_log_id = log_id',
                                'ls_field' => 'associated_rev_id',
                                'log_type != ' . $dbw->addQuotes( 'create' ),
                                'log_timestamp > ' . $dbw->addQuotes( $dbw->timestamp( $this->cutoffFrom ) ),
                                'log_timestamp < ' . $dbw->addQuotes( $dbw->timestamp( $this->cutoffTo ) ),
                        ],
                        __METHOD__
                );

                $updates = 0;
                foreach ( $res as $row ) {
                        $rev_id = $row->ls_value;
                        $log_id = $row->ls_log_id;

                        // Mark the logging row as having an associated rev id
                        $dbw->update(
                                'recentchanges',
                                /*SET*/ [ 'rc_this_oldid' => $rev_id ],
                                /*WHERE*/ [ 'rc_logid' => $log_id ],
                                __METHOD__
                        );

                        // Delete the revision row
                        $dbw->delete(
                                'recentchanges',
                                /*WHERE*/ [ 'rc_this_oldid' => $rev_id, 'rc_logid' => 0 ],
                                __METHOD__
                        );

                        if ( ( ++$updates % $this->getBatchSize() ) == 0 ) {
                                $lbFactory->waitForReplication();
                        }
                }
        }

        /**
         * Purge cached feeds in $wanCache
         */
        private function purgeFeeds() {
                global $wgFeedClasses;

                $this->output( "Deleting feed timestamps.\n" );

                $wanCache = MediaWikiServices::getInstance()->getMainWANObjectCache();
                foreach ( $wgFeedClasses as $feed => $className ) {
                        $wanCache->delete( $wanCache->makeKey( 'rcfeed', $feed, 'timestamp' ) ); # Good enough for now.
                }
        }
}

$maintClass = RebuildRecentchanges::class;
require_once RUN_MAINTENANCE_IF_MAIN;