123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158 |
- <?php
- /**
- * Clean up user preferences from the database.
- *
- * 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
- * @author TyA <tya.wiki@gmail.com>
- * @author Chad <chad@wikimedia.org>
- * @see https://phabricator.wikimedia.org/T32976
- * @ingroup Maintenance
- */
- require_once __DIR__ . '/Maintenance.php';
- /**
- * Maintenance script that removes bogus preferences from the database.
- *
- * @ingroup Maintenance
- */
- class CleanupPreferences extends Maintenance {
- public function __construct() {
- parent::__construct();
- $this->mDescription = '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' );
- }
- /**
- * We will do this in three passes
- * 1) The easiest is to drop the hidden preferences from the database. We
- * don't actually want them
- * 2) Drop preference keys that we don't know about. They could've been
- * removed from core, provided by a now-disabled extension, or the result
- * of a bug. We don't want them.
- * 3) TODO: Normalize accepted preference values. This is the biggest part of the work.
- * For each preference we know about, iterate over it and if it's got a
- * limited set of accepted values (so it's not text, basically), make sure
- * all values are in that range. Drop ones that aren't.
- */
- public function execute() {
- global $wgHiddenPrefs, $wgDefaultUserOptions;
- $dbw = $this->getDB( DB_MASTER );
- $didWork = false;
- $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 ) {
- if ( !$wgHiddenPrefs ) {
- $this->output( "No hidden preferences, skipping\n" );
- }
- foreach ( $wgHiddenPrefs 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 ) {
- $where = [
- 'up_property NOT' . $dbw->buildLike( 'userjs-', $dbw->anyString() ),
- 'up_property NOT IN (' . $dbw->makeList( array_keys( $wgDefaultUserOptions ) ) . ')',
- ];
- // 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 ) {
- // All done!
- $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;
|