includes/logging/TagLogFormatter.php

   1 <?php
   2 /**
   3  * This program is free software; you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation; either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  16  * http://www.gnu.org/copyleft/gpl.html
  17  */
  18
  19 /**
  20  * This class formats tag log entries.
  21  *
  22  * Parameters (one-based indexes):
  23  * 4::revid
  24  * 5::logid
  25  * 6:list:tagsAdded
  26  * 7:number:tagsAddedCount
  27  * 8:list:tagsRemoved
  28  * 9:number:tagsRemovedCount
  29  *
  30  * @since 1.25
  31  */
  32 class TagLogFormatter extends LogFormatter {
  33
  34         protected function getMessageParameters() {
  35                 $params = parent::getMessageParameters();
  36
  37                 $isRevLink = !empty( $params[3] );
  38                 if ( $isRevLink ) {
  39                         $id = $params[3];
  40                         $target = $this->entry->getTarget();
  41                         $query = [
  42                                 'oldid' => $id,
  43                                 'diff' => 'prev'
  44                         ];
  45                 } else {
  46                         $id = $params[4];
  47                         $target = SpecialPage::getTitleValueFor( 'Log' );
  48                         $query = [
  49                                 'logid' => $id,
  50                         ];
  51                 }
  52
  53                 $formattedNumber = $this->context->getLanguage()->formatNum( $id, true );
  54                 if ( $this->plaintext ) {
  55                         $link = $formattedNumber;
  56                 } elseif ( !$isRevLink || $target->exists() ) {
  57                         $link = $this->getLinkRenderer()->makeKnownLink(
  58                                 $target, $formattedNumber, [], $query );
  59                 } else {
  60                         $link = htmlspecialchars( $formattedNumber );
  61                 }
  62
  63                 if ( $isRevLink ) {
  64                         $params[3] = Message::rawParam( $link );
  65                 } else {
  66                         $params[4] = Message::rawParam( $link );
  67                 }
  68
  69                 return $params;
  70         }
  71
  72         protected function getMessageKey() {
  73                 $key = parent::getMessageKey();
  74                 $params = $this->getMessageParameters();
  75
  76                 $add = ( isset( $params[6] ) && isset( $params[6]['num'] ) && $params[6]['num'] );
  77                 $remove = ( isset( $params[8] ) && isset( $params[8]['num'] ) && $params[8]['num'] );
  78                 $key .= ( $remove ? ( $add ? '' : '-remove' ) : '-add' );
  79
  80                 if ( isset( $params[3] ) && $params[3] ) {
  81                         // Messages: logentry-tag-update-add-revision, logentry-tag-update-remove-revision,
  82                         // logentry-tag-update-revision
  83                         $key .= '-revision';
  84                 } else {
  85                         // Messages: logentry-tag-update-add-logentry, logentry-tag-update-remove-logentry,
  86                         // logentry-tag-update-logentry
  87                         $key .= '-logentry';
  88                 }
  89
  90                 return $key;
  91         }
  92
  93 }