cleanupPreferences.php

Go to the documentation of this file.

<?php
require_once __DIR__ . '/Maintenance.php';
 
class CleanupPreferences extends Maintenance {
    public function __construct() {
        parent::__construct();
        $this->addDescription(
            'Clean up hidden preferences, removed preferences, and normalizes values'
        );
        $this->setBatchSize( 50 );
        $this->addOption( 'dry-run', 'Print debug info instead of actually deleting' );
        $this->addOption( 'hidden', 'Drop hidden preferences ($wgHiddenPrefs)' );
        $this->addOption( 'unknown',
            'Drop unknown preferences (not in $wgDefaultUserOptions or prefixed with "userjs-")' );
        // TODO: actually implement this
        // $this->addOption( 'bogus', 'Drop preferences that have invalid/unaccepted values' );
    }
 
    public function execute() {
        $dbw = $this->getDB( DB_MASTER );
        $hidden = $this->hasOption( 'hidden' );
        $unknown = $this->hasOption( 'unknown' );
        $bogus = $this->hasOption( 'bogus' );
 
        if ( !$hidden && !$unknown && !$bogus ) {
            $this->output( "Did not select one of --hidden, --unknown or --bogus, exiting\n" );
            return;
        }
 
        // Remove hidden prefs. Iterate over them to avoid the IN on a large table
        if ( $hidden ) {
            $hiddenPrefs = $this->getConfig()->get( 'HiddenPrefs' );
            if ( !$hiddenPrefs ) {
                $this->output( "No hidden preferences, skipping\n" );
            }
            foreach ( $hiddenPrefs as $hiddenPref ) {
                $this->deleteByWhere(
                    $dbw,
                    'Dropping hidden preferences',
                    [ 'up_property' => $hiddenPref ]
                );
            }
        }
 
        // Remove unknown preferences. Special-case 'userjs-' as we can't control those names.
        if ( $unknown ) {
            $defaultUserOptions = $this->getConfig()->get( 'DefaultUserOptions' );
            $where = [
                'up_property NOT' . $dbw->buildLike( 'userjs-', $dbw->anyString() ),
                'up_property NOT IN (' . $dbw->makeList( array_keys( $defaultUserOptions ) ) . ')',
            ];
            // Allow extensions to add to the where clause to prevent deletion of their own prefs.
            Hooks::run( 'DeleteUnknownPreferences', [ &$where, $dbw ] );
            $this->deleteByWhere( $dbw, 'Dropping unknown preferences', $where );
        }
 
        // Something something phase 3
        if ( $bogus ) {
        }
    }
 
    private function deleteByWhere( $dbw, $startMessage, $where ) {
        $this->output( $startMessage . "...\n" );
        $total = 0;
        while ( true ) {
            $res = $dbw->select(
                'user_properties',
                '*', // The table lacks a primary key, so select the whole row
                $where,
                __METHOD__,
                [ 'LIMIT' => $this->mBatchSize ]
            );
 
            $numRows = $res->numRows();
            $total += $numRows;
            if ( $res->numRows() <= 0 ) {
                $this->output( "DONE! (handled $total entries)\n" );
                break;
            }
 
            // Progress or something
            $this->output( "..doing $numRows entries\n" );
 
            // Delete our batch, then wait
            foreach ( $res as $row ) {
                if ( $this->hasOption( 'dry-run' ) ) {
                    $this->output(
                        "    DRY RUN, would drop: " .
                        "[up_user] => '{$row->up_user}' " .
                        "[up_property] => '{$row->up_property}' " .
                        "[up_value] => '{$row->up_value}'\n"
                    );
                    continue;
                }
                $this->beginTransaction( $dbw, __METHOD__ );
                $dbw->delete(
                    'user_properties',
                    [
                        'up_user'     => $row->up_user,
                        'up_property' => $row->up_property,
                        'up_value'    => $row->up_value,
                    ],
                    __METHOD__
                );
                $this->commitTransaction( $dbw, __METHOD__ );
            }
        }
    }
}
 
$maintClass = CleanupPreferences::class; // Tells it to run the class
require_once RUN_MAINTENANCE_IF_MAIN;