includes/logging/PatrolLogFormatter.php

   1 <?php
   2 /**
   3  * Formatter for new user 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\Message\Message;
  27
  28 /**
  29  * This class formats patrol log entries.
  30  *
  31  * @since 1.19
  32  */
  33 class PatrolLogFormatter extends LogFormatter {
  34         protected function getMessageKey() {
  35                 $params = $this->getMessageParameters();
  36                 if ( isset( $params[5] ) && $params[5] ) {
  37                         $key = 'logentry-patrol-patrol-auto';
  38                 } else {
  39                         $key = 'logentry-patrol-patrol';
  40                 }
  41
  42                 return $key;
  43         }
  44
  45         protected function getMessageParameters() {
  46                 $params = parent::getMessageParameters();
  47
  48                 $target = $this->entry->getTarget();
  49                 $oldid = $params[3];
  50                 $revision = $this->context->getLanguage()->formatNumNoSeparators( $oldid );
  51
  52                 if ( $this->plaintext ) {
  53                         $revlink = $revision;
  54                 } elseif ( $target->exists() ) {
  55                         $query = [
  56                                 'oldid' => $oldid,
  57                                 'diff' => 'prev'
  58                         ];
  59                         $revlink = $this->getLinkRenderer()->makeLink( $target, $revision, [], $query );
  60                 } else {
  61                         $revlink = htmlspecialchars( $revision );
  62                 }
  63
  64                 // @phan-suppress-next-line SecurityCheck-XSS Unlikely positive, only if language format is bad
  65                 $params[3] = Message::rawParam( $revlink );
  66
  67                 return $params;
  68         }
  69
  70         protected function getParametersForApi() {
  71                 $entry = $this->entry;
  72                 $params = $entry->getParameters();
  73
  74                 static $map = [
  75                         '4:number:curid',
  76                         '5:number:previd',
  77                         '6:bool:auto',
  78                         '4::curid' => '4:number:curid',
  79                         '5::previd' => '5:number:previd',
  80                         '6::auto' => '6:bool:auto',
  81                 ];
  82                 foreach ( $map as $index => $key ) {
  83                         if ( isset( $params[$index] ) ) {
  84                                 $params[$key] = $params[$index];
  85                                 unset( $params[$index] );
  86                         }
  87                 }
  88
  89                 return $params;
  90         }
  91 }