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
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)
45 private static function setUsernameBitfields( $name, $userId, $op, IDatabase
$dbw = null ) {
46 global $wgActorTableSchemaMigrationStage;
48 if ( !$userId ||
( $op !== '|' && $op !== '&' ) ) {
49 return false; // sanity check
51 if ( !$dbw instanceof IDatabase
) {
52 $dbw = wfGetDB( DB_MASTER
);
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
;
63 $delUser = $dbw->bitNot( $delUser );
64 $delAction = $dbw->bitNot( $delAction );
68 $userTitle = Title
::makeTitleSafe( NS_USER
, $name );
69 $userDbKey = $userTitle->getDBkey();
71 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_OLD
) {
72 # Hide name from live edits
75 [ self
::buildSetBitDeletedField( 'rev_deleted', $op, $delUser, $dbw ) ],
76 [ 'rev_user' => $userId ],
79 # Hide name from deleted edits
82 [ self
::buildSetBitDeletedField( 'ar_deleted', $op, $delUser, $dbw ) ],
83 [ 'ar_user_text' => $name ],
90 [ self
::buildSetBitDeletedField( 'log_deleted', $op, $delUser, $dbw ) ],
91 [ 'log_user' => $userId, 'log_type != ' . $dbw->addQuotes( 'suppress' ) ],
98 [ self
::buildSetBitDeletedField( 'rc_deleted', $op, $delUser, $dbw ) ],
99 [ 'rc_user_text' => $name ],
103 # Hide name from live images
106 [ self
::buildSetBitDeletedField( 'oi_deleted', $op, $delUser, $dbw ) ],
107 [ 'oi_user_text' => $name ],
111 # Hide name from deleted images
114 [ self
::buildSetBitDeletedField( 'fa_deleted', $op, $delUser, $dbw ) ],
115 [ 'fa_user_text' => $name ],
120 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW
) {
121 $actorId = $dbw->selectField( 'actor', 'actor_id', [ 'actor_name' => $name ], __METHOD__
);
123 # Hide name from live edits
124 $ids = $dbw->selectFieldValues(
125 'revision_actor_temp', 'revactor_rev', [ 'revactor_actor' => $actorId ], __METHOD__
130 [ self
::buildSetBitDeletedField( 'rev_deleted', $op, $delUser, $dbw ) ],
131 [ 'rev_id' => $ids ],
136 # Hide name from deleted edits
139 [ self
::buildSetBitDeletedField( 'ar_deleted', $op, $delUser, $dbw ) ],
140 [ 'ar_actor' => $actorId ],
144 # Hide name from logs
147 [ self
::buildSetBitDeletedField( 'log_deleted', $op, $delUser, $dbw ) ],
148 [ 'log_actor' => $actorId, 'log_type != ' . $dbw->addQuotes( 'suppress' ) ],
155 [ self
::buildSetBitDeletedField( 'rc_deleted', $op, $delUser, $dbw ) ],
156 [ 'rc_actor' => $actorId ],
160 # Hide name from live images
163 [ self
::buildSetBitDeletedField( 'oi_deleted', $op, $delUser, $dbw ) ],
164 [ 'oi_actor' => $actorId ],
168 # Hide name from deleted images
171 [ self
::buildSetBitDeletedField( 'fa_deleted', $op, $delUser, $dbw ) ],
172 [ 'fa_actor' => $actorId ],
178 # Hide log entries pointing to the user page
181 [ self
::buildSetBitDeletedField( 'log_deleted', $op, $delAction, $dbw ) ],
182 [ 'log_namespace' => NS_USER
, 'log_title' => $userDbKey,
183 'log_type != ' . $dbw->addQuotes( 'suppress' ) ],
187 # Hide RC entries pointing to the user page
190 [ self
::buildSetBitDeletedField( 'rc_deleted', $op, $delAction, $dbw ) ],
191 [ 'rc_namespace' => NS_USER
, 'rc_title' => $userDbKey, 'rc_logid > 0' ],
198 private static function buildSetBitDeletedField( $field, $op, $value, IDatabase
$dbw ) {
199 return $field . ' = ' . ( $op === '&'
200 ?
$dbw->bitAnd( $field, $value )
201 : $dbw->bitOr( $field, $value ) );
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)
210 public static function suppressUserName( $name, $userId, IDatabase
$dbw = null ) {
211 return self
::setUsernameBitfields( $name, $userId, '|', $dbw );
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)
220 public static function unsuppressUserName( $name, $userId, IDatabase
$dbw = null ) {
221 return self
::setUsernameBitfields( $name, $userId, '&', $dbw );