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