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