includes/revisiondelete/RevisionDeleteUser.php

   1 <?php
   2 /**
   3  * Backend functions for suppressing and unsuppressing all references to a given user.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @ingroup RevisionDelete
  22  */
  23
  24 use MediaWiki\Storage\RevisionRecord;
  25 use Wikimedia\Rdbms\IDatabase;
  26
  27 /**
  28  * Backend functions for suppressing and unsuppressing all references to a given user,
  29  * used when blocking with HideUser enabled.  This was spun out of SpecialBlockip.php
  30  * in 1.18; at some point it needs to be rewritten to either use RevisionDelete abstraction,
  31  * or at least schema abstraction.
  32  *
  33  * @ingroup RevisionDelete
  34  */
  35 class RevisionDeleteUser {
  36
  37         /**
  38          * Update *_deleted bitfields in various tables to hide or unhide usernames
  39          *
  40          * @param string $name Username
  41          * @param int $userId User id
  42          * @param string $op Operator '|' or '&'
  43          * @param null|IDatabase $dbw If you happen to have one lying around
  44          * @return bool True on success, false on failure (e.g. invalid user ID)
  45          */
  46         private static function setUsernameBitfields( $name, $userId, $op, IDatabase $dbw = null ) {
  47                 global $wgActorTableSchemaMigrationStage;
  48
  49                 if ( !$userId || ( $op !== '|' && $op !== '&' ) ) {
  50                         return false; // sanity check
  51                 }
  52                 if ( !$dbw instanceof IDatabase ) {
  53                         $dbw = wfGetDB( DB_MASTER );
  54                 }
  55
  56                 # To suppress, we OR the current bitfields with RevisionRecord::DELETED_USER
  57                 # to put a 1 in the username *_deleted bit. To unsuppress we AND the
  58                 # current bitfields with the inverse of RevisionRecord::DELETED_USER. The
  59                 # username bit is made to 0 (x & 0 = 0), while others are unchanged (x & 1 = x).
  60                 # The same goes for the sysop-restricted *_deleted bit.
  61                 $delUser = RevisionRecord::DELETED_USER | RevisionRecord::DELETED_RESTRICTED;
  62                 $delAction = LogPage::DELETED_ACTION | RevisionRecord::DELETED_RESTRICTED;
  63                 if ( $op === '&' ) {
  64                         $delUser = $dbw->bitNot( $delUser );
  65                         $delAction = $dbw->bitNot( $delAction );
  66                 }
  67
  68                 # Normalize user name
  69                 $userTitle = Title::makeTitleSafe( NS_USER, $name );
  70                 $userDbKey = $userTitle->getDBkey();
  71
  72                 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_OLD ) {
  73                         # Hide name from live edits
  74                         $dbw->update(
  75                                 'revision',
  76                                 [ self::buildSetBitDeletedField( 'rev_deleted', $op, $delUser, $dbw ) ],
  77                                 [ 'rev_user' => $userId ],
  78                                 __METHOD__ );
  79
  80                         # Hide name from deleted edits
  81                         $dbw->update(
  82                                 'archive',
  83                                 [ self::buildSetBitDeletedField( 'ar_deleted', $op, $delUser, $dbw ) ],
  84                                 [ 'ar_user_text' => $name ],
  85                                 __METHOD__
  86                         );
  87
  88                         # Hide name from logs
  89                         $dbw->update(
  90                                 'logging',
  91                                 [ self::buildSetBitDeletedField( 'log_deleted', $op, $delUser, $dbw ) ],
  92                                 [ 'log_user' => $userId, 'log_type != ' . $dbw->addQuotes( 'suppress' ) ],
  93                                 __METHOD__
  94                         );
  95
  96                         # Hide name from RC
  97                         $dbw->update(
  98                                 'recentchanges',
  99                                 [ self::buildSetBitDeletedField( 'rc_deleted', $op, $delUser, $dbw ) ],
 100                                 [ 'rc_user_text' => $name ],
 101                                 __METHOD__
 102                         );
 103
 104                         # Hide name from live images
 105                         $dbw->update(
 106                                 'oldimage',
 107                                 [ self::buildSetBitDeletedField( 'oi_deleted', $op, $delUser, $dbw ) ],
 108                                 [ 'oi_user_text' => $name ],
 109                                 __METHOD__
 110                         );
 111
 112                         # Hide name from deleted images
 113                         $dbw->update(
 114                                 'filearchive',
 115                                 [ self::buildSetBitDeletedField( 'fa_deleted', $op, $delUser, $dbw ) ],
 116                                 [ 'fa_user_text' => $name ],
 117                                 __METHOD__
 118                         );
 119                 }
 120
 121                 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW ) {
 122                         $actorId = $dbw->selectField( 'actor', 'actor_id', [ 'actor_name' => $name ], __METHOD__ );
 123                         if ( $actorId ) {
 124                                 # Hide name from live edits
 125                                 $ids = $dbw->selectFieldValues(
 126                                         'revision_actor_temp', 'revactor_rev', [ 'revactor_actor' => $actorId ], __METHOD__
 127                                 );
 128                                 if ( $ids ) {
 129                                         $dbw->update(
 130                                                 'revision',
 131                                                 [ self::buildSetBitDeletedField( 'rev_deleted', $op, $delUser, $dbw ) ],
 132                                                 [ 'rev_id' => $ids ],
 133                                                 __METHOD__
 134                                         );
 135                                 }
 136
 137                                 # Hide name from deleted edits
 138                                 $dbw->update(
 139                                         'archive',
 140                                         [ self::buildSetBitDeletedField( 'ar_deleted', $op, $delUser, $dbw ) ],
 141                                         [ 'ar_actor' => $actorId ],
 142                                         __METHOD__
 143                                 );
 144
 145                                 # Hide name from logs
 146                                 $dbw->update(
 147                                         'logging',
 148                                         [ self::buildSetBitDeletedField( 'log_deleted', $op, $delUser, $dbw ) ],
 149                                         [ 'log_actor' => $actorId, 'log_type != ' . $dbw->addQuotes( 'suppress' ) ],
 150                                         __METHOD__
 151                                 );
 152
 153                                 # Hide name from RC
 154                                 $dbw->update(
 155                                         'recentchanges',
 156                                         [ self::buildSetBitDeletedField( 'rc_deleted', $op, $delUser, $dbw ) ],
 157                                         [ 'rc_actor' => $actorId ],
 158                                         __METHOD__
 159                                 );
 160
 161                                 # Hide name from live images
 162                                 $dbw->update(
 163                                         'oldimage',
 164                                         [ self::buildSetBitDeletedField( 'oi_deleted', $op, $delUser, $dbw ) ],
 165                                         [ 'oi_actor' => $actorId ],
 166                                         __METHOD__
 167                                 );
 168
 169                                 # Hide name from deleted images
 170                                 $dbw->update(
 171                                         'filearchive',
 172                                         [ self::buildSetBitDeletedField( 'fa_deleted', $op, $delUser, $dbw ) ],
 173                                         [ 'fa_actor' => $actorId ],
 174                                         __METHOD__
 175                                 );
 176                         }
 177                 }
 178
 179                 # Hide log entries pointing to the user page
 180                 $dbw->update(
 181                         'logging',
 182                         [ self::buildSetBitDeletedField( 'log_deleted', $op, $delAction, $dbw ) ],
 183                         [ 'log_namespace' => NS_USER, 'log_title' => $userDbKey,
 184                         'log_type != ' . $dbw->addQuotes( 'suppress' ) ],
 185                         __METHOD__
 186                 );
 187
 188                 # Hide RC entries pointing to the user page
 189                 $dbw->update(
 190                         'recentchanges',
 191                         [ self::buildSetBitDeletedField( 'rc_deleted', $op, $delAction, $dbw ) ],
 192                         [ 'rc_namespace' => NS_USER, 'rc_title' => $userDbKey, 'rc_logid > 0' ],
 193                         __METHOD__
 194                 );
 195
 196                 return true;
 197         }
 198
 199         private static function buildSetBitDeletedField( $field, $op, $value, IDatabase $dbw ) {
 200                 return $field . ' = ' . ( $op === '&'
 201                         ? $dbw->bitAnd( $field, $value )
 202                         : $dbw->bitOr( $field, $value ) );
 203         }
 204
 205         /**
 206          * @param string $name User name
 207          * @param int $userId Both user name and ID must be provided
 208          * @param IDatabase|null $dbw If you happen to have one lying around
 209          * @return bool True on success, false on failure (e.g. invalid user ID)
 210          */
 211         public static function suppressUserName( $name, $userId, IDatabase $dbw = null ) {
 212                 return self::setUsernameBitfields( $name, $userId, '|', $dbw );
 213         }
 214
 215         /**
 216          * @param string $name User name
 217          * @param int $userId Both user name and ID must be provided
 218          * @param IDatabase|null $dbw If you happen to have one lying around
 219          * @return bool True on success, false on failure (e.g. invalid user ID)
 220          */
 221         public static function unsuppressUserName( $name, $userId, IDatabase $dbw = null ) {
 222                 return self::setUsernameBitfields( $name, $userId, '&', $dbw );
 223         }
 224 }