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 MediaWiki\Storage\RevisionRecord
;
25 use Wikimedia\Rdbms\IDatabase
;
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.
33 * @ingroup RevisionDelete
35 class RevisionDeleteUser
{
38 * Update *_deleted bitfields in various tables to hide or unhide usernames
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)
46 private static function setUsernameBitfields( $name, $userId, $op, IDatabase
$dbw = null ) {
47 global $wgActorTableSchemaMigrationStage;
49 if ( !$userId ||
( $op !== '|' && $op !== '&' ) ) {
50 return false; // sanity check
52 if ( !$dbw instanceof IDatabase
) {
53 $dbw = wfGetDB( DB_MASTER
);
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
;
64 $delUser = $dbw->bitNot( $delUser );
65 $delAction = $dbw->bitNot( $delAction );
69 $userTitle = Title
::makeTitleSafe( NS_USER
, $name );
70 $userDbKey = $userTitle->getDBkey();
72 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_OLD
) {
73 # Hide name from live edits
76 [ self
::buildSetBitDeletedField( 'rev_deleted', $op, $delUser, $dbw ) ],
77 [ 'rev_user' => $userId ],
80 # Hide name from deleted edits
83 [ self
::buildSetBitDeletedField( 'ar_deleted', $op, $delUser, $dbw ) ],
84 [ 'ar_user_text' => $name ],
91 [ self
::buildSetBitDeletedField( 'log_deleted', $op, $delUser, $dbw ) ],
92 [ 'log_user' => $userId, 'log_type != ' . $dbw->addQuotes( 'suppress' ) ],
99 [ self
::buildSetBitDeletedField( 'rc_deleted', $op, $delUser, $dbw ) ],
100 [ 'rc_user_text' => $name ],
104 # Hide name from live images
107 [ self
::buildSetBitDeletedField( 'oi_deleted', $op, $delUser, $dbw ) ],
108 [ 'oi_user_text' => $name ],
112 # Hide name from deleted images
115 [ self
::buildSetBitDeletedField( 'fa_deleted', $op, $delUser, $dbw ) ],
116 [ 'fa_user_text' => $name ],
121 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW
) {
122 $actorId = $dbw->selectField( 'actor', 'actor_id', [ 'actor_name' => $name ], __METHOD__
);
124 # Hide name from live edits
125 $ids = $dbw->selectFieldValues(
126 'revision_actor_temp', 'revactor_rev', [ 'revactor_actor' => $actorId ], __METHOD__
131 [ self
::buildSetBitDeletedField( 'rev_deleted', $op, $delUser, $dbw ) ],
132 [ 'rev_id' => $ids ],
137 # Hide name from deleted edits
140 [ self
::buildSetBitDeletedField( 'ar_deleted', $op, $delUser, $dbw ) ],
141 [ 'ar_actor' => $actorId ],
145 # Hide name from logs
148 [ self
::buildSetBitDeletedField( 'log_deleted', $op, $delUser, $dbw ) ],
149 [ 'log_actor' => $actorId, 'log_type != ' . $dbw->addQuotes( 'suppress' ) ],
156 [ self
::buildSetBitDeletedField( 'rc_deleted', $op, $delUser, $dbw ) ],
157 [ 'rc_actor' => $actorId ],
161 # Hide name from live images
164 [ self
::buildSetBitDeletedField( 'oi_deleted', $op, $delUser, $dbw ) ],
165 [ 'oi_actor' => $actorId ],
169 # Hide name from deleted images
172 [ self
::buildSetBitDeletedField( 'fa_deleted', $op, $delUser, $dbw ) ],
173 [ 'fa_actor' => $actorId ],
179 # Hide log entries pointing to the user page
182 [ self
::buildSetBitDeletedField( 'log_deleted', $op, $delAction, $dbw ) ],
183 [ 'log_namespace' => NS_USER
, 'log_title' => $userDbKey,
184 'log_type != ' . $dbw->addQuotes( 'suppress' ) ],
188 # Hide RC entries pointing to the user page
191 [ self
::buildSetBitDeletedField( 'rc_deleted', $op, $delAction, $dbw ) ],
192 [ 'rc_namespace' => NS_USER
, 'rc_title' => $userDbKey, 'rc_logid > 0' ],
199 private static function buildSetBitDeletedField( $field, $op, $value, IDatabase
$dbw ) {
200 return $field . ' = ' . ( $op === '&'
201 ?
$dbw->bitAnd( $field, $value )
202 : $dbw->bitOr( $field, $value ) );
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)
211 public static function suppressUserName( $name, $userId, IDatabase
$dbw = null ) {
212 return self
::setUsernameBitfields( $name, $userId, '|', $dbw );
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)
221 public static function unsuppressUserName( $name, $userId, IDatabase
$dbw = null ) {
222 return self
::setUsernameBitfields( $name, $userId, '&', $dbw );