3 * Backend functions for suppressing and unsuppressing all references to a given user.
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.
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.
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
21 * @ingroup RevisionDelete
24 use Wikimedia\Rdbms\IDatabase
;
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.
32 * @ingroup RevisionDelete
34 class RevisionDeleteUser
{
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
44 private static function setUsernameBitfields( $name, $userId, $op, $dbw ) {
45 global $wgActorTableSchemaMigrationStage;
47 if ( !$userId ||
( $op !== '|' && $op !== '&' ) ) {
48 return false; // sanity check
50 if ( !$dbw instanceof IDatabase
) {
51 $dbw = wfGetDB( DB_MASTER
);
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
;
62 $delUser = $dbw->bitNot( $delUser );
63 $delAction = $dbw->bitNot( $delAction );
67 $userTitle = Title
::makeTitleSafe( NS_USER
, $name );
68 $userDbKey = $userTitle->getDBkey();
70 if ( $wgActorTableSchemaMigrationStage < MIGRATION_NEW
) {
71 # Hide name from live edits
74 [ self
::buildSetBitDeletedField( 'rev_deleted', $op, $delUser, $dbw ) ],
75 [ 'rev_user' => $userId ],
78 # Hide name from deleted edits
81 [ self
::buildSetBitDeletedField( 'ar_deleted', $op, $delUser, $dbw ) ],
82 [ 'ar_user_text' => $name ],
89 [ self
::buildSetBitDeletedField( 'log_deleted', $op, $delUser, $dbw ) ],
90 [ 'log_user' => $userId, 'log_type != ' . $dbw->addQuotes( 'suppress' ) ],
97 [ self
::buildSetBitDeletedField( 'rc_deleted', $op, $delUser, $dbw ) ],
98 [ 'rc_user_text' => $name ],
102 # Hide name from live images
105 [ self
::buildSetBitDeletedField( 'oi_deleted', $op, $delUser, $dbw ) ],
106 [ 'oi_user_text' => $name ],
110 # Hide name from deleted images
113 [ self
::buildSetBitDeletedField( 'fa_deleted', $op, $delUser, $dbw ) ],
114 [ 'fa_user_text' => $name ],
119 if ( $wgActorTableSchemaMigrationStage > MIGRATION_OLD
) {
120 $actorId = $dbw->selectField( 'actor', 'actor_id', [ 'actor_name' => $name ], __METHOD__
);
122 # Hide name from live edits
123 $subquery = $dbw->selectSQLText(
124 'revision_actor_temp', 'revactor_rev', [ 'revactor_actor' => $actorId ], __METHOD__
128 [ self
::buildSetBitDeletedField( 'rev_deleted', $op, $delUser, $dbw ) ],
129 [ "rev_id IN ($subquery)" ],
132 # Hide name from deleted edits
135 [ self
::buildSetBitDeletedField( 'ar_deleted', $op, $delUser, $dbw ) ],
136 [ 'ar_actor' => $actorId ],
140 # Hide name from logs
143 [ self
::buildSetBitDeletedField( 'log_deleted', $op, $delUser, $dbw ) ],
144 [ 'log_actor' => $actorId, 'log_type != ' . $dbw->addQuotes( 'suppress' ) ],
151 [ self
::buildSetBitDeletedField( 'rc_deleted', $op, $delUser, $dbw ) ],
152 [ 'rc_actor' => $actorId ],
156 # Hide name from live images
159 [ self
::buildSetBitDeletedField( 'oi_deleted', $op, $delUser, $dbw ) ],
160 [ 'oi_actor' => $actorId ],
164 # Hide name from deleted images
167 [ self
::buildSetBitDeletedField( 'fa_deleted', $op, $delUser, $dbw ) ],
168 [ 'fa_actor' => $actorId ],
174 # Hide log entries pointing to the user page
177 [ self
::buildSetBitDeletedField( 'log_deleted', $op, $delAction, $dbw ) ],
178 [ 'log_namespace' => NS_USER
, 'log_title' => $userDbKey,
179 'log_type != ' . $dbw->addQuotes( 'suppress' ) ],
183 # Hide RC entries pointing to the user page
186 [ self
::buildSetBitDeletedField( 'rc_deleted', $op, $delAction, $dbw ) ],
187 [ 'rc_namespace' => NS_USER
, 'rc_title' => $userDbKey, 'rc_logid > 0' ],
195 private static function buildSetBitDeletedField( $field, $op, $value, $dbw ) {
196 return $field . ' = ' . ( $op === '&'
197 ?
$dbw->bitAnd( $field, $value )
198 : $dbw->bitOr( $field, $value ) );
201 public static function suppressUserName( $name, $userId, $dbw = null ) {
202 return self
::setUsernameBitfields( $name, $userId, '|', $dbw );
205 public static function unsuppressUserName( $name, $userId, $dbw = null ) {
206 return self
::setUsernameBitfields( $name, $userId, '&', $dbw );