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