includes/logging/DeleteLogFormatter.php

   1 <?php
   2 /**
   3  * Formatter for delete log entries.
   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  * @author Niklas Laxström
  22  * @license GPL-2.0-or-later
  23  * @since 1.22
  24  */
  25
  26 use MediaWiki\MediaWikiServices;
  27 use MediaWiki\Storage\RevisionRecord;
  28
  29 /**
  30  * This class formats delete log entries.
  31  *
  32  * @since 1.19
  33  */
  34 class DeleteLogFormatter extends LogFormatter {
  35         protected function getMessageKey() {
  36                 $key = parent::getMessageKey();
  37                 if ( in_array( $this->entry->getSubtype(), [ 'event', 'revision' ] ) ) {
  38                         if ( count( $this->getMessageParameters() ) < 5 ) {
  39                                 // Messages: logentry-delete-event-legacy, logentry-delete-revision-legacy,
  40                                 // logentry-suppress-event-legacy, logentry-suppress-revision-legacy
  41                                 return "$key-legacy";
  42                         }
  43                 } elseif ( $this->entry->getSubtype() === 'restore' ) {
  44                         $rawParams = $this->entry->getParameters();
  45                         if ( !isset( $rawParams[':assoc:count'] ) ) {
  46                                 // Message: logentry-delete-restore-nocount
  47                                 return $key . '-nocount';
  48                         }
  49                 }
  50
  51                 return $key;
  52         }
  53
  54         protected function getMessageParameters() {
  55                 if ( isset( $this->parsedParametersDeleteLog ) ) {
  56                         return $this->parsedParametersDeleteLog;
  57                 }
  58
  59                 $params = parent::getMessageParameters();
  60                 $subtype = $this->entry->getSubtype();
  61                 if ( in_array( $subtype, [ 'event', 'revision' ] ) ) {
  62                         // $params[3] here is 'revision' or 'archive' for page revisions, 'oldimage' or
  63                         // 'filearchive' for file versions, or a comma-separated list of log_ids for log
  64                         // entries. $subtype here is 'revision' for page revisions and file
  65                         // versions, or 'event' for log entries.
  66                         if (
  67                                 ( $subtype === 'event' && count( $params ) === 6 )
  68                                 || (
  69                                         $subtype === 'revision' && isset( $params[3] )
  70                                         && in_array( $params[3], [ 'revision', 'archive', 'oldimage', 'filearchive' ] )
  71                                 )
  72                         ) {
  73                                 // See RevDelList::getLogParams()/RevDelLogList::getLogParams()
  74                                 $paramStart = $subtype === 'revision' ? 4 : 3;
  75
  76                                 $old = $this->parseBitField( $params[$paramStart + 1] );
  77                                 $new = $this->parseBitField( $params[$paramStart + 2] );
  78                                 list( $hid, $unhid, $extra ) = RevisionDeleter::getChanges( $new, $old );
  79                                 $changes = [];
  80                                 // messages used: revdelete-content-hid, revdelete-summary-hid, revdelete-uname-hid
  81                                 foreach ( $hid as $v ) {
  82                                         $changes[] = $this->msg( "$v-hid" )->plain();
  83                                 }
  84                                 // messages used: revdelete-content-unhid, revdelete-summary-unhid,
  85                                 // revdelete-uname-unhid
  86                                 foreach ( $unhid as $v ) {
  87                                         $changes[] = $this->msg( "$v-unhid" )->plain();
  88                                 }
  89                                 foreach ( $extra as $v ) {
  90                                         $changes[] = $this->msg( $v )->plain();
  91                                 }
  92                                 $changeText = $this->context->getLanguage()->listToText( $changes );
  93
  94                                 $newParams = array_slice( $params, 0, 3 );
  95                                 $newParams[3] = $changeText;
  96                                 $ids = is_array( $params[$paramStart] )
  97                                         ? $params[$paramStart]
  98                                         : explode( ',', $params[$paramStart] );
  99                                 $newParams[4] = $this->context->getLanguage()->formatNum( count( $ids ) );
 100
 101                                 $this->parsedParametersDeleteLog = $newParams;
 102                                 return $this->parsedParametersDeleteLog;
 103                         } else {
 104                                 $this->parsedParametersDeleteLog = array_slice( $params, 0, 3 );
 105                                 return $this->parsedParametersDeleteLog;
 106                         }
 107                 } elseif ( $subtype === 'restore' ) {
 108                         $rawParams = $this->entry->getParameters();
 109                         if ( isset( $rawParams[':assoc:count'] ) ) {
 110                                 $countList = [];
 111                                 foreach ( $rawParams[':assoc:count'] as $type => $count ) {
 112                                         if ( $count ) {
 113                                                 // Messages: restore-count-revisions, restore-count-files
 114                                                 $countList[] = $this->context->msg( 'restore-count-' . $type )
 115                                                         ->numParams( $count )->plain();
 116                                         }
 117                                 }
 118                                 $params[3] = $this->context->getLanguage()->listToText( $countList );
 119                         }
 120                 }
 121
 122                 $this->parsedParametersDeleteLog = $params;
 123                 return $this->parsedParametersDeleteLog;
 124         }
 125
 126         protected function parseBitField( $string ) {
 127                 // Input is like ofield=2134 or just the number
 128                 if ( strpos( $string, 'field=' ) === 1 ) {
 129                         list( , $field ) = explode( '=', $string );
 130
 131                         return (int)$field;
 132                 } else {
 133                         return (int)$string;
 134                 }
 135         }
 136
 137         public function getActionLinks() {
 138                 $user = $this->context->getUser();
 139                 $linkRenderer = $this->getLinkRenderer();
 140                 $permissionManager = MediaWikiServices::getInstance()->getPermissionManager();
 141                 if ( !$permissionManager->userHasRight( $user, 'deletedhistory' )
 142                         || $this->entry->isDeleted( LogPage::DELETED_ACTION )
 143                 ) {
 144                         return '';
 145                 }
 146
 147                 switch ( $this->entry->getSubtype() ) {
 148                         case 'delete': // Show undelete link
 149                         case 'delete_redir':
 150                                 if ( $permissionManager->userHasRight( $user, 'undelete' ) ) {
 151                                         $message = 'undeletelink';
 152                                 } else {
 153                                         $message = 'undeleteviewlink';
 154                                 }
 155                                 $revert = $linkRenderer->makeKnownLink(
 156                                         SpecialPage::getTitleFor( 'Undelete' ),
 157                                         $this->msg( $message )->text(),
 158                                         [],
 159                                         [ 'target' => $this->entry->getTarget()->getPrefixedDBkey() ]
 160                                 );
 161
 162                                 return $this->msg( 'parentheses' )->rawParams( $revert )->escaped();
 163
 164                         case 'revision': // If an edit was hidden from a page give a review link to the history
 165                                 $params = $this->extractParameters();
 166                                 if ( !isset( $params[3] ) || !isset( $params[4] ) ) {
 167                                         return '';
 168                                 }
 169
 170                                 // Different revision types use different URL params...
 171                                 $key = $params[3];
 172                                 // This is a array or CSV of the IDs
 173                                 $ids = is_array( $params[4] )
 174                                         ? $params[4]
 175                                         : explode( ',', $params[4] );
 176
 177                                 $links = [];
 178
 179                                 // If there's only one item, we can show a diff link
 180                                 if ( count( $ids ) == 1 ) {
 181                                         // Live revision diffs...
 182                                         if ( $key == 'oldid' || $key == 'revision' ) {
 183                                                 $links[] = $linkRenderer->makeKnownLink(
 184                                                         $this->entry->getTarget(),
 185                                                         $this->msg( 'diff' )->text(),
 186                                                         [],
 187                                                         [
 188                                                                 'diff' => intval( $ids[0] ),
 189                                                                 'unhide' => 1
 190                                                         ]
 191                                                 );
 192                                                 // Deleted revision diffs...
 193                                         } elseif ( $key == 'artimestamp' || $key == 'archive' ) {
 194                                                 $links[] = $linkRenderer->makeKnownLink(
 195                                                         SpecialPage::getTitleFor( 'Undelete' ),
 196                                                         $this->msg( 'diff' )->text(),
 197                                                         [],
 198                                                         [
 199                                                                 'target' => $this->entry->getTarget()->getPrefixedDBkey(),
 200                                                                 'diff' => 'prev',
 201                                                                 'timestamp' => $ids[0]
 202                                                         ]
 203                                                 );
 204                                         }
 205                                 }
 206
 207                                 // View/modify link...
 208                                 $links[] = $linkRenderer->makeKnownLink(
 209                                         SpecialPage::getTitleFor( 'Revisiondelete' ),
 210                                         $this->msg( 'revdel-restore' )->text(),
 211                                         [],
 212                                         [
 213                                                 'target' => $this->entry->getTarget()->getPrefixedText(),
 214                                                 'type' => $key,
 215                                                 'ids' => implode( ',', $ids ),
 216                                         ]
 217                                 );
 218
 219                                 return $this->msg( 'parentheses' )->rawParams(
 220                                         $this->context->getLanguage()->pipeList( $links ) )->escaped();
 221
 222                         case 'event': // Hidden log items, give review link
 223                                 $params = $this->extractParameters();
 224                                 if ( !isset( $params[3] ) ) {
 225                                         return '';
 226                                 }
 227                                 // This is a CSV of the IDs
 228                                 $query = $params[3];
 229                                 if ( is_array( $query ) ) {
 230                                         $query = implode( ',', $query );
 231                                 }
 232                                 // Link to each hidden object ID, $params[1] is the url param
 233                                 $revert = $linkRenderer->makeKnownLink(
 234                                         SpecialPage::getTitleFor( 'Revisiondelete' ),
 235                                         $this->msg( 'revdel-restore' )->text(),
 236                                         [],
 237                                         [
 238                                                 'target' => $this->entry->getTarget()->getPrefixedText(),
 239                                                 'type' => 'logging',
 240                                                 'ids' => $query
 241                                         ]
 242                                 );
 243
 244                                 return $this->msg( 'parentheses' )->rawParams( $revert )->escaped();
 245                         default:
 246                                 return '';
 247                 }
 248         }
 249
 250         protected function getParametersForApi() {
 251                 $entry = $this->entry;
 252                 $params = [];
 253
 254                 $subtype = $this->entry->getSubtype();
 255                 if ( in_array( $subtype, [ 'event', 'revision' ] ) ) {
 256                         $rawParams = $entry->getParameters();
 257                         if ( $subtype === 'event' ) {
 258                                 array_unshift( $rawParams, 'logging' );
 259                         }
 260
 261                         static $map = [
 262                                 '4::type',
 263                                 '5::ids',
 264                                 '6::ofield',
 265                                 '7::nfield',
 266                                 '4::ids' => '5::ids',
 267                                 '5::ofield' => '6::ofield',
 268                                 '6::nfield' => '7::nfield',
 269                         ];
 270                         foreach ( $map as $index => $key ) {
 271                                 if ( isset( $rawParams[$index] ) ) {
 272                                         $rawParams[$key] = $rawParams[$index];
 273                                         unset( $rawParams[$index] );
 274                                 }
 275                         }
 276
 277                         if ( !is_array( $rawParams['5::ids'] ) ) {
 278                                 $rawParams['5::ids'] = explode( ',', $rawParams['5::ids'] );
 279                         }
 280
 281                         $params = [
 282                                 '::type' => $rawParams['4::type'],
 283                                 ':array:ids' => $rawParams['5::ids'],
 284                         ];
 285
 286                         static $fields = [
 287                                 RevisionRecord::DELETED_TEXT => 'content',
 288                                 RevisionRecord::DELETED_COMMENT => 'comment',
 289                                 RevisionRecord::DELETED_USER => 'user',
 290                                 RevisionRecord::DELETED_RESTRICTED => 'restricted',
 291                         ];
 292
 293                         if ( isset( $rawParams['6::ofield'] ) ) {
 294                                 $old = $this->parseBitField( $rawParams['6::ofield'] );
 295                                 $params[':assoc:old'] = [ 'bitmask' => $old ];
 296                                 foreach ( $fields as $bit => $key ) {
 297                                         $params[':assoc:old'][$key] = (bool)( $old & $bit );
 298                                 }
 299                         }
 300                         if ( isset( $rawParams['7::nfield'] ) ) {
 301                                 $new = $this->parseBitField( $rawParams['7::nfield'] );
 302                                 $params[':assoc:new'] = [ 'bitmask' => $new ];
 303                                 foreach ( $fields as $bit => $key ) {
 304                                         $params[':assoc:new'][$key] = (bool)( $new & $bit );
 305                                 }
 306                         }
 307                 } elseif ( $subtype === 'restore' ) {
 308                         $rawParams = $entry->getParameters();
 309                         if ( isset( $rawParams[':assoc:count'] ) ) {
 310                                 $params[':assoc:count'] = $rawParams[':assoc:count'];
 311                         }
 312                 }
 313
 314                 return $params;
 315         }
 316
 317         public function formatParametersForApi() {
 318                 $ret = parent::formatParametersForApi();
 319                 if ( isset( $ret['ids'] ) ) {
 320                         ApiResult::setIndexedTagName( $ret['ids'], 'id' );
 321                 }
 322                 return $ret;
 323         }
 324 }