includes/logging/LogFormatter.php

   1 <?php
   2 /**
   3  * Contains a class for formatting 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.19
  24  */
  25 use MediaWiki\Linker\LinkRenderer;
  26 use MediaWiki\MediaWikiServices;
  27
  28 /**
  29  * Implements the default log formatting.
  30  *
  31  * Can be overridden by subclassing and setting:
  32  *
  33  *     $wgLogActionsHandlers['type/subtype'] = 'class'; or
  34  *     $wgLogActionsHandlers['type/*'] = 'class';
  35  *
  36  * @since 1.19
  37  */
  38 class LogFormatter {
  39         // Audience options for viewing usernames, comments, and actions
  40         const FOR_PUBLIC = 1;
  41         const FOR_THIS_USER = 2;
  42
  43         // Static->
  44
  45         /**
  46          * Constructs a new formatter suitable for given entry.
  47          * @param LogEntry $entry
  48          * @return LogFormatter
  49          */
  50         public static function newFromEntry( LogEntry $entry ) {
  51                 global $wgLogActionsHandlers;
  52                 $fulltype = $entry->getFullType();
  53                 $wildcard = $entry->getType() . '/*';
  54                 $handler = $wgLogActionsHandlers[$fulltype] ?? $wgLogActionsHandlers[$wildcard] ?? '';
  55
  56                 if ( $handler !== '' && is_string( $handler ) && class_exists( $handler ) ) {
  57                         return new $handler( $entry );
  58                 }
  59
  60                 return new LegacyLogFormatter( $entry );
  61         }
  62
  63         /**
  64          * Handy shortcut for constructing a formatter directly from
  65          * database row.
  66          * @param stdClass|array $row
  67          * @see DatabaseLogEntry::getSelectQueryData
  68          * @return LogFormatter
  69          */
  70         public static function newFromRow( $row ) {
  71                 return self::newFromEntry( DatabaseLogEntry::newFromRow( $row ) );
  72         }
  73
  74         // Nonstatic->
  75
  76         /** @var LogEntryBase */
  77         protected $entry;
  78
  79         /** @var int Constant for handling log_deleted */
  80         protected $audience = self::FOR_PUBLIC;
  81
  82         /** @var IContextSource Context for logging */
  83         public $context;
  84
  85         /** @var bool Whether to output user tool links */
  86         protected $linkFlood = false;
  87
  88         /**
  89          * Set to true if we are constructing a message text that is going to
  90          * be included in page history or send to IRC feed. Links are replaced
  91          * with plaintext or with [[pagename]] kind of syntax, that is parsed
  92          * by page histories and IRC feeds.
  93          * @var string
  94          */
  95         protected $plaintext = false;
  96
  97         /** @var string */
  98         protected $irctext = false;
  99
 100         /**
 101          * @var LinkRenderer|null
 102          */
 103         private $linkRenderer;
 104
 105         /**
 106          * @see LogFormatter::getMessageParameters
 107          * @var array
 108          */
 109         protected $parsedParameters;
 110
 111         protected function __construct( LogEntry $entry ) {
 112                 $this->entry = $entry;
 113                 $this->context = RequestContext::getMain();
 114         }
 115
 116         /**
 117          * Replace the default context
 118          * @param IContextSource $context
 119          */
 120         public function setContext( IContextSource $context ) {
 121                 $this->context = $context;
 122         }
 123
 124         /**
 125          * @since 1.30
 126          * @param LinkRenderer $linkRenderer
 127          */
 128         public function setLinkRenderer( LinkRenderer $linkRenderer ) {
 129                 $this->linkRenderer = $linkRenderer;
 130         }
 131
 132         /**
 133          * @since 1.30
 134          * @return LinkRenderer
 135          */
 136         public function getLinkRenderer() {
 137                 if ( $this->linkRenderer !== null ) {
 138                         return $this->linkRenderer;
 139                 } else {
 140                         return MediaWikiServices::getInstance()->getLinkRenderer();
 141                 }
 142         }
 143
 144         /**
 145          * Set the visibility restrictions for displaying content.
 146          * If set to public, and an item is deleted, then it will be replaced
 147          * with a placeholder even if the context user is allowed to view it.
 148          * @param int $audience Const self::FOR_THIS_USER or self::FOR_PUBLIC
 149          */
 150         public function setAudience( $audience ) {
 151                 $this->audience = ( $audience == self::FOR_THIS_USER )
 152                         ? self::FOR_THIS_USER
 153                         : self::FOR_PUBLIC;
 154         }
 155
 156         /**
 157          * Check if a log item type can be displayed
 158          * @return bool
 159          */
 160         public function canViewLogType() {
 161                 // If the user doesn't have the right permission to view the specific
 162                 // log type, return false
 163                 $logRestrictions = $this->context->getConfig()->get( 'LogRestrictions' );
 164                 $type = $this->entry->getType();
 165                 return !isset( $logRestrictions[$type] )
 166                         || $this->context->getUser()->isAllowed( $logRestrictions[$type] );
 167         }
 168
 169         /**
 170          * Check if a log item can be displayed
 171          * @param int $field LogPage::DELETED_* constant
 172          * @return bool
 173          */
 174         protected function canView( $field ) {
 175                 if ( $this->audience == self::FOR_THIS_USER ) {
 176                         return LogEventsList::userCanBitfield(
 177                                 $this->entry->getDeleted(), $field, $this->context->getUser() ) &&
 178                                 self::canViewLogType();
 179                 } else {
 180                         return !$this->entry->isDeleted( $field ) && self::canViewLogType();
 181                 }
 182         }
 183
 184         /**
 185          * If set to true, will produce user tool links after
 186          * the user name. This should be replaced with generic
 187          * CSS/JS solution.
 188          * @param bool $value
 189          */
 190         public function setShowUserToolLinks( $value ) {
 191                 $this->linkFlood = $value;
 192         }
 193
 194         /**
 195          * Ugly hack to produce plaintext version of the message.
 196          * Usually you also want to set extraneous request context
 197          * to avoid formatting for any particular user.
 198          * @see getActionText()
 199          * @return string Plain text
 200          * @return-taint tainted
 201          */
 202         public function getPlainActionText() {
 203                 $this->plaintext = true;
 204                 $text = $this->getActionText();
 205                 $this->plaintext = false;
 206
 207                 return $text;
 208         }
 209
 210         /**
 211          * Even uglier hack to maintain backwards compatibility with IRC bots
 212          * (T36508).
 213          * @see getActionText()
 214          * @return string Text
 215          */
 216         public function getIRCActionComment() {
 217                 $actionComment = $this->getIRCActionText();
 218                 $comment = $this->entry->getComment();
 219
 220                 if ( $comment != '' ) {
 221                         if ( $actionComment == '' ) {
 222                                 $actionComment = $comment;
 223                         } else {
 224                                 $actionComment .= wfMessage( 'colon-separator' )->inContentLanguage()->text() . $comment;
 225                         }
 226                 }
 227
 228                 return $actionComment;
 229         }
 230
 231         /**
 232          * Even uglier hack to maintain backwards compatibility with IRC bots
 233          * (T36508).
 234          * @see getActionText()
 235          * @return string Text
 236          */
 237         public function getIRCActionText() {
 238                 $this->plaintext = true;
 239                 $this->irctext = true;
 240
 241                 $entry = $this->entry;
 242                 $parameters = $entry->getParameters();
 243                 // @see LogPage::actionText()
 244                 // Text of title the action is aimed at.
 245                 $target = $entry->getTarget()->getPrefixedText();
 246                 $text = null;
 247                 $contLang = MediaWikiServices::getInstance()->getContentLanguage();
 248                 switch ( $entry->getType() ) {
 249                         case 'move':
 250                                 switch ( $entry->getSubtype() ) {
 251                                         case 'move':
 252                                                 $movesource = $parameters['4::target'];
 253                                                 $text = wfMessage( '1movedto2' )
 254                                                         ->rawParams( $target, $movesource )->inContentLanguage()->escaped();
 255                                                 break;
 256                                         case 'move_redir':
 257                                                 $movesource = $parameters['4::target'];
 258                                                 $text = wfMessage( '1movedto2_redir' )
 259                                                         ->rawParams( $target, $movesource )->inContentLanguage()->escaped();
 260                                                 break;
 261                                         case 'move-noredirect':
 262                                                 break;
 263                                         case 'move_redir-noredirect':
 264                                                 break;
 265                                 }
 266                                 break;
 267
 268                         case 'delete':
 269                                 switch ( $entry->getSubtype() ) {
 270                                         case 'delete':
 271                                                 $text = wfMessage( 'deletedarticle' )
 272                                                         ->rawParams( $target )->inContentLanguage()->escaped();
 273                                                 break;
 274                                         case 'restore':
 275                                                 $text = wfMessage( 'undeletedarticle' )
 276                                                         ->rawParams( $target )->inContentLanguage()->escaped();
 277                                                 break;
 278                                         //case 'revision': // Revision deletion
 279                                         //case 'event': // Log deletion
 280                                         // see https://github.com/wikimedia/mediawiki/commit/a9c243b7b5289dad204278dbe7ed571fd914e395
 281                                         //default:
 282                                 }
 283                                 break;
 284
 285                         case 'patrol':
 286                                 // https://github.com/wikimedia/mediawiki/commit/1a05f8faf78675dc85984f27f355b8825b43efff
 287                                 // Create a diff link to the patrolled revision
 288                                 if ( $entry->getSubtype() === 'patrol' ) {
 289                                         $diffLink = htmlspecialchars(
 290                                                 wfMessage( 'patrol-log-diff', $parameters['4::curid'] )
 291                                                         ->inContentLanguage()->text() );
 292                                         $text = wfMessage( 'patrol-log-line', $diffLink, "[[$target]]", "" )
 293                                                 ->inContentLanguage()->text();
 294                                 } else {
 295                                         // broken??
 296                                 }
 297                                 break;
 298
 299                         case 'protect':
 300                                 switch ( $entry->getSubtype() ) {
 301                                         case 'protect':
 302                                                 $text = wfMessage( 'protectedarticle' )
 303                                                         ->rawParams( $target . ' ' . $parameters['4::description'] )->inContentLanguage()->escaped();
 304                                                 break;
 305                                         case 'unprotect':
 306                                                 $text = wfMessage( 'unprotectedarticle' )
 307                                                         ->rawParams( $target )->inContentLanguage()->escaped();
 308                                                 break;
 309                                         case 'modify':
 310                                                 $text = wfMessage( 'modifiedarticleprotection' )
 311                                                         ->rawParams( $target . ' ' . $parameters['4::description'] )->inContentLanguage()->escaped();
 312                                                 break;
 313                                         case 'move_prot':
 314                                                 $text = wfMessage( 'movedarticleprotection' )
 315                                                         ->rawParams( $target, $parameters['4::oldtitle'] )->inContentLanguage()->escaped();
 316                                                 break;
 317                                 }
 318                                 break;
 319
 320                         case 'newusers':
 321                                 switch ( $entry->getSubtype() ) {
 322                                         case 'newusers':
 323                                         case 'create':
 324                                                 $text = wfMessage( 'newuserlog-create-entry' )
 325                                                         ->inContentLanguage()->escaped();
 326                                                 break;
 327                                         case 'create2':
 328                                         case 'byemail':
 329                                                 $text = wfMessage( 'newuserlog-create2-entry' )
 330                                                         ->rawParams( $target )->inContentLanguage()->escaped();
 331                                                 break;
 332                                         case 'autocreate':
 333                                                 $text = wfMessage( 'newuserlog-autocreate-entry' )
 334                                                         ->inContentLanguage()->escaped();
 335                                                 break;
 336                                 }
 337                                 break;
 338
 339                         case 'upload':
 340                                 switch ( $entry->getSubtype() ) {
 341                                         case 'upload':
 342                                                 $text = wfMessage( 'uploadedimage' )
 343                                                         ->rawParams( $target )->inContentLanguage()->escaped();
 344                                                 break;
 345                                         case 'overwrite':
 346                                         case 'revert':
 347                                                 $text = wfMessage( 'overwroteimage' )
 348                                                         ->rawParams( $target )->inContentLanguage()->escaped();
 349                                                 break;
 350                                 }
 351                                 break;
 352
 353                         case 'rights':
 354                                 if ( count( $parameters['4::oldgroups'] ) ) {
 355                                         $oldgroups = implode( ', ', $parameters['4::oldgroups'] );
 356                                 } else {
 357                                         $oldgroups = wfMessage( 'rightsnone' )->inContentLanguage()->escaped();
 358                                 }
 359                                 if ( count( $parameters['5::newgroups'] ) ) {
 360                                         $newgroups = implode( ', ', $parameters['5::newgroups'] );
 361                                 } else {
 362                                         $newgroups = wfMessage( 'rightsnone' )->inContentLanguage()->escaped();
 363                                 }
 364                                 switch ( $entry->getSubtype() ) {
 365                                         case 'rights':
 366                                                 $text = wfMessage( 'rightslogentry' )
 367                                                         ->rawParams( $target, $oldgroups, $newgroups )->inContentLanguage()->escaped();
 368                                                 break;
 369                                         case 'autopromote':
 370                                                 $text = wfMessage( 'rightslogentry-autopromote' )
 371                                                         ->rawParams( $target, $oldgroups, $newgroups )->inContentLanguage()->escaped();
 372                                                 break;
 373                                 }
 374                                 break;
 375
 376                         case 'merge':
 377                                 $text = wfMessage( 'pagemerge-logentry' )
 378                                         ->rawParams( $target, $parameters['4::dest'], $parameters['5::mergepoint'] )
 379                                         ->inContentLanguage()->escaped();
 380                                 break;
 381
 382                         case 'block':
 383                                 switch ( $entry->getSubtype() ) {
 384                                         case 'block':
 385                                                 // Keep compatibility with extensions by checking for
 386                                                 // new key (5::duration/6::flags) or old key (0/optional 1)
 387                                                 if ( $entry->isLegacy() ) {
 388                                                         $rawDuration = $parameters[0];
 389                                                         $rawFlags = $parameters[1] ?? '';
 390                                                 } else {
 391                                                         $rawDuration = $parameters['5::duration'];
 392                                                         $rawFlags = $parameters['6::flags'];
 393                                                 }
 394                                                 $duration = $contLang->translateBlockExpiry(
 395                                                         $rawDuration,
 396                                                         null,
 397                                                         wfTimestamp( TS_UNIX, $entry->getTimestamp() )
 398                                                 );
 399                                                 $flags = BlockLogFormatter::formatBlockFlags( $rawFlags, $contLang );
 400                                                 $text = wfMessage( 'blocklogentry' )
 401                                                         ->rawParams( $target, $duration, $flags )->inContentLanguage()->escaped();
 402                                                 break;
 403                                         case 'unblock':
 404                                                 $text = wfMessage( 'unblocklogentry' )
 405                                                         ->rawParams( $target )->inContentLanguage()->escaped();
 406                                                 break;
 407                                         case 'reblock':
 408                                                 $duration = $contLang->translateBlockExpiry(
 409                                                         $parameters['5::duration'],
 410                                                         null,
 411                                                         wfTimestamp( TS_UNIX, $entry->getTimestamp() )
 412                                                 );
 413                                                 $flags = BlockLogFormatter::formatBlockFlags( $parameters['6::flags'],
 414                                                         $contLang );
 415                                                 $text = wfMessage( 'reblock-logentry' )
 416                                                         ->rawParams( $target, $duration, $flags )->inContentLanguage()->escaped();
 417                                                 break;
 418                                 }
 419                                 break;
 420
 421                         case 'import':
 422                                 switch ( $entry->getSubtype() ) {
 423                                         case 'upload':
 424                                                 $text = wfMessage( 'import-logentry-upload' )
 425                                                         ->rawParams( $target )->inContentLanguage()->escaped();
 426                                                 break;
 427                                         case 'interwiki':
 428                                                 $text = wfMessage( 'import-logentry-interwiki' )
 429                                                         ->rawParams( $target )->inContentLanguage()->escaped();
 430                                                 break;
 431                                 }
 432                                 break;
 433                         // case 'suppress' --private log -- aaron  (so we know who to blame in a few years :-D)
 434                         // default:
 435                 }
 436                 if ( is_null( $text ) ) {
 437                         $text = $this->getPlainActionText();
 438                 }
 439
 440                 $this->plaintext = false;
 441                 $this->irctext = false;
 442
 443                 return $text;
 444         }
 445
 446         /**
 447          * Gets the log action, including username.
 448          * @return string HTML
 449          * phan-taint-check gets very confused by $this->plaintext, so disable.
 450          * @return-taint onlysafefor_html
 451          */
 452         public function getActionText() {
 453                 if ( $this->canView( LogPage::DELETED_ACTION ) ) {
 454                         $element = $this->getActionMessage();
 455                         if ( $element instanceof Message ) {
 456                                 $element = $this->plaintext ? $element->text() : $element->escaped();
 457                         }
 458                         if ( $this->entry->isDeleted( LogPage::DELETED_ACTION ) ) {
 459                                 $element = $this->styleRestricedElement( $element );
 460                         }
 461                 } else {
 462                         $sep = $this->msg( 'word-separator' );
 463                         $sep = $this->plaintext ? $sep->text() : $sep->escaped();
 464                         $performer = $this->getPerformerElement();
 465                         $element = $performer . $sep . $this->getRestrictedElement( 'rev-deleted-event' );
 466                 }
 467
 468                 return $element;
 469         }
 470
 471         /**
 472          * Returns a sentence describing the log action. Usually
 473          * a Message object is returned, but old style log types
 474          * and entries might return pre-escaped HTML string.
 475          * @return Message|string Pre-escaped HTML
 476          */
 477         protected function getActionMessage() {
 478                 $message = $this->msg( $this->getMessageKey() );
 479                 $message->params( $this->getMessageParameters() );
 480
 481                 return $message;
 482         }
 483
 484         /**
 485          * Returns a key to be used for formatting the action sentence.
 486          * Default is logentry-TYPE-SUBTYPE for modern logs. Legacy log
 487          * types will use custom keys, and subclasses can also alter the
 488          * key depending on the entry itself.
 489          * @return string Message key
 490          */
 491         protected function getMessageKey() {
 492                 $type = $this->entry->getType();
 493                 $subtype = $this->entry->getSubtype();
 494
 495                 return "logentry-$type-$subtype";
 496         }
 497
 498         /**
 499          * Returns extra links that comes after the action text, like "revert", etc.
 500          *
 501          * @return string
 502          */
 503         public function getActionLinks() {
 504                 return '';
 505         }
 506
 507         /**
 508          * Extracts the optional extra parameters for use in action messages.
 509          * The array indexes start from number 3.
 510          * @return array
 511          */
 512         protected function extractParameters() {
 513                 $entry = $this->entry;
 514                 $params = [];
 515
 516                 if ( $entry->isLegacy() ) {
 517                         foreach ( $entry->getParameters() as $index => $value ) {
 518                                 $params[$index + 3] = $value;
 519                         }
 520                 }
 521
 522                 // Filter out parameters which are not in format #:foo
 523                 foreach ( $entry->getParameters() as $key => $value ) {
 524                         if ( strpos( $key, ':' ) === false ) {
 525                                 continue;
 526                         }
 527                         list( $index, $type, ) = explode( ':', $key, 3 );
 528                         if ( ctype_digit( $index ) ) {
 529                                 $params[$index - 1] = $this->formatParameterValue( $type, $value );
 530                         }
 531                 }
 532
 533                 /* Message class doesn't like non consecutive numbering.
 534                  * Fill in missing indexes with empty strings to avoid
 535                  * incorrect renumbering.
 536                  */
 537                 if ( count( $params ) ) {
 538                         $max = max( array_keys( $params ) );
 539                         // index 0 to 2 are added in getMessageParameters
 540                         for ( $i = 3; $i < $max; $i++ ) {
 541                                 if ( !isset( $params[$i] ) ) {
 542                                         $params[$i] = '';
 543                                 }
 544                         }
 545                 }
 546
 547                 return $params;
 548         }
 549
 550         /**
 551          * Formats parameters intented for action message from
 552          * array of all parameters. There are three hardcoded
 553          * parameters (array is zero-indexed, this list not):
 554          *  - 1: user name with premade link
 555          *  - 2: usable for gender magic function
 556          *  - 3: target page with premade link
 557          * @return array
 558          */
 559         protected function getMessageParameters() {
 560                 if ( isset( $this->parsedParameters ) ) {
 561                         return $this->parsedParameters;
 562                 }
 563
 564                 $entry = $this->entry;
 565                 $params = $this->extractParameters();
 566                 $params[0] = Message::rawParam( $this->getPerformerElement() );
 567                 $params[1] = $this->canView( LogPage::DELETED_USER ) ? $entry->getPerformer()->getName() : '';
 568                 $params[2] = Message::rawParam( $this->makePageLink( $entry->getTarget() ) );
 569
 570                 // Bad things happens if the numbers are not in correct order
 571                 ksort( $params );
 572
 573                 $this->parsedParameters = $params;
 574                 return $this->parsedParameters;
 575         }
 576
 577         /**
 578          * Formats parameters values dependent to their type
 579          * @param string $type The type of the value.
 580          *   Valid are currently:
 581          *     * - (empty) or plain: The value is returned as-is
 582          *     * raw: The value will be added to the log message
 583          *            as raw parameter (e.g. no escaping)
 584          *            Use this only if there is no other working
 585          *            type like user-link or title-link
 586          *     * msg: The value is a message-key, the output is
 587          *            the message in user language
 588          *     * msg-content: The value is a message-key, the output
 589          *                    is the message in content language
 590          *     * user: The value is a user name, e.g. for GENDER
 591          *     * user-link: The value is a user name, returns a
 592          *                  link for the user
 593          *     * title: The value is a page title,
 594          *              returns name of page
 595          *     * title-link: The value is a page title,
 596          *                   returns link to this page
 597          *     * number: Format value as number
 598          *     * list: Format value as a comma-separated list
 599          * @param mixed $value The parameter value that should be formatted
 600          * @return string|array Formated value
 601          * @since 1.21
 602          */
 603         protected function formatParameterValue( $type, $value ) {
 604                 $saveLinkFlood = $this->linkFlood;
 605
 606                 switch ( strtolower( trim( $type ) ) ) {
 607                         case 'raw':
 608                                 $value = Message::rawParam( $value );
 609                                 break;
 610                         case 'list':
 611                                 $value = $this->context->getLanguage()->commaList( $value );
 612                                 break;
 613                         case 'msg':
 614                                 $value = $this->msg( $value )->text();
 615                                 break;
 616                         case 'msg-content':
 617                                 $value = $this->msg( $value )->inContentLanguage()->text();
 618                                 break;
 619                         case 'number':
 620                                 $value = Message::numParam( $value );
 621                                 break;
 622                         case 'user':
 623                                 $user = User::newFromName( $value );
 624                                 $value = $user->getName();
 625                                 break;
 626                         case 'user-link':
 627                                 $this->setShowUserToolLinks( false );
 628
 629                                 $user = User::newFromName( $value );
 630
 631                                 if ( !$user ) {
 632                                         $value = $this->msg( 'empty-username' )->text();
 633                                 } else {
 634                                         $value = Message::rawParam( $this->makeUserLink( $user ) );
 635                                         $this->setShowUserToolLinks( $saveLinkFlood );
 636                                 }
 637                                 break;
 638                         case 'title':
 639                                 $title = Title::newFromText( $value );
 640                                 $value = $title->getPrefixedText();
 641                                 break;
 642                         case 'title-link':
 643                                 $title = Title::newFromText( $value );
 644                                 $value = Message::rawParam( $this->makePageLink( $title ) );
 645                                 break;
 646                         case 'plain':
 647                                 // Plain text, nothing to do
 648                         default:
 649                                 // Catch other types and use the old behavior (return as-is)
 650                 }
 651
 652                 return $value;
 653         }
 654
 655         /**
 656          * Helper to make a link to the page, taking the plaintext
 657          * value in consideration.
 658          * @param Title|null $title The page
 659          * @param array $parameters Query parameters
 660          * @param string|null $html Linktext of the link as raw html
 661          * @return string
 662          */
 663         protected function makePageLink( Title $title = null, $parameters = [], $html = null ) {
 664                 if ( !$title instanceof Title ) {
 665                         $msg = $this->msg( 'invalidtitle' )->text();
 666                         if ( $this->plaintext ) {
 667                                 return $msg;
 668                         } else {
 669                                 return Html::element( 'span', [ 'class' => 'mw-invalidtitle' ], $msg );
 670                         }
 671                 }
 672
 673                 if ( $this->plaintext ) {
 674                         $link = '[[' . $title->getPrefixedText() . ']]';
 675                 } else {
 676                         $html = $html !== null ? new HtmlArmor( $html ) : $html;
 677                         $link = $this->getLinkRenderer()->makeLink( $title, $html, [], $parameters );
 678                 }
 679
 680                 return $link;
 681         }
 682
 683         /**
 684          * Provides the name of the user who performed the log action.
 685          * Used as part of log action message or standalone, depending
 686          * which parts of the log entry has been hidden.
 687          * @return string
 688          */
 689         public function getPerformerElement() {
 690                 if ( $this->canView( LogPage::DELETED_USER ) ) {
 691                         $performer = $this->entry->getPerformer();
 692                         $element = $this->makeUserLink( $performer );
 693                         if ( $this->entry->isDeleted( LogPage::DELETED_USER ) ) {
 694                                 $element = $this->styleRestricedElement( $element );
 695                         }
 696                 } else {
 697                         $element = $this->getRestrictedElement( 'rev-deleted-user' );
 698                 }
 699
 700                 return $element;
 701         }
 702
 703         /**
 704          * Gets the user provided comment
 705          * @return string HTML
 706          */
 707         public function getComment() {
 708                 if ( $this->canView( LogPage::DELETED_COMMENT ) ) {
 709                         $comment = Linker::commentBlock( $this->entry->getComment() );
 710                         // No hard coded spaces thanx
 711                         $element = ltrim( $comment );
 712                         if ( $this->entry->isDeleted( LogPage::DELETED_COMMENT ) ) {
 713                                 $element = $this->styleRestricedElement( $element );
 714                         }
 715                 } else {
 716                         $element = $this->getRestrictedElement( 'rev-deleted-comment' );
 717                 }
 718
 719                 return $element;
 720         }
 721
 722         /**
 723          * Helper method for displaying restricted element.
 724          * @param string $message
 725          * @return string HTML or wiki text
 726          * @return-taint onlysafefor_html
 727          */
 728         protected function getRestrictedElement( $message ) {
 729                 if ( $this->plaintext ) {
 730                         return $this->msg( $message )->text();
 731                 }
 732
 733                 $content = $this->msg( $message )->escaped();
 734                 $attribs = [ 'class' => 'history-deleted' ];
 735
 736                 return Html::rawElement( 'span', $attribs, $content );
 737         }
 738
 739         /**
 740          * Helper method for styling restricted element.
 741          * @param string $content
 742          * @return string HTML or wiki text
 743          */
 744         protected function styleRestricedElement( $content ) {
 745                 if ( $this->plaintext ) {
 746                         return $content;
 747                 }
 748                 $attribs = [ 'class' => 'history-deleted' ];
 749
 750                 return Html::rawElement( 'span', $attribs, $content );
 751         }
 752
 753         /**
 754          * Shortcut for wfMessage which honors local context.
 755          * @param string $key
 756          * @return Message
 757          */
 758         protected function msg( $key ) {
 759                 return $this->context->msg( $key );
 760         }
 761
 762         /**
 763          * @param User $user
 764          * @param int $toolFlags Combination of Linker::TOOL_LINKS_* flags
 765          * @return string wikitext or html
 766          * @return-taint onlysafefor_html
 767          */
 768         protected function makeUserLink( User $user, $toolFlags = 0 ) {
 769                 if ( $this->plaintext ) {
 770                         $element = $user->getName();
 771                 } else {
 772                         $element = Linker::userLink(
 773                                 $user->getId(),
 774                                 $user->getName()
 775                         );
 776
 777                         if ( $this->linkFlood ) {
 778                                 $element .= Linker::userToolLinks(
 779                                         $user->getId(),
 780                                         $user->getName(),
 781                                         true, // redContribsWhenNoEdits
 782                                         $toolFlags,
 783                                         $user->getEditCount(),
 784                                         // do not render parenthesises in the HTML markup (CSS will provide)
 785                                         false
 786                                 );
 787                         }
 788                 }
 789
 790                 return $element;
 791         }
 792
 793         /**
 794          * @return array Array of titles that should be preloaded with LinkBatch
 795          */
 796         public function getPreloadTitles() {
 797                 return [];
 798         }
 799
 800         /**
 801          * @return array Output of getMessageParameters() for testing
 802          */
 803         public function getMessageParametersForTesting() {
 804                 // This function was added because getMessageParameters() is
 805                 // protected and a change from protected to public caused
 806                 // problems with extensions
 807                 return $this->getMessageParameters();
 808         }
 809
 810         /**
 811          * Get the array of parameters, converted from legacy format if necessary.
 812          * @since 1.25
 813          * @return array
 814          */
 815         protected function getParametersForApi() {
 816                 return $this->entry->getParameters();
 817         }
 818
 819         /**
 820          * Format parameters for API output
 821          *
 822          * The result array should generally map named keys to values. Index and
 823          * type should be omitted, e.g. "4::foo" should be returned as "foo" in the
 824          * output. Values should generally be unformatted.
 825          *
 826          * Renames or removals of keys besides from the legacy numeric format to
 827          * modern named style should be avoided. Any renames should be announced to
 828          * the mediawiki-api-announce mailing list.
 829          *
 830          * @since 1.25
 831          * @return array
 832          */
 833         public function formatParametersForApi() {
 834                 $logParams = [];
 835                 foreach ( $this->getParametersForApi() as $key => $value ) {
 836                         $vals = explode( ':', $key, 3 );
 837                         if ( count( $vals ) !== 3 ) {
 838                                 if ( $value instanceof __PHP_Incomplete_Class ) {
 839                                         wfLogWarning( 'Log entry of type ' . $this->entry->getFullType() .
 840                                                 ' contains unrecoverable extra parameters.' );
 841                                         continue;
 842                                 }
 843                                 $logParams[$key] = $value;
 844                                 continue;
 845                         }
 846                         $logParams += $this->formatParameterValueForApi( $vals[2], $vals[1], $value );
 847                 }
 848                 ApiResult::setIndexedTagName( $logParams, 'param' );
 849                 ApiResult::setArrayType( $logParams, 'assoc' );
 850
 851                 return $logParams;
 852         }
 853
 854         /**
 855          * Format a single parameter value for API output
 856          *
 857          * @since 1.25
 858          * @param string $name
 859          * @param string $type
 860          * @param string $value
 861          * @return array
 862          */
 863         protected function formatParameterValueForApi( $name, $type, $value ) {
 864                 $type = strtolower( trim( $type ) );
 865                 switch ( $type ) {
 866                         case 'bool':
 867                                 $value = (bool)$value;
 868                                 break;
 869
 870                         case 'number':
 871                                 if ( ctype_digit( $value ) || is_int( $value ) ) {
 872                                         $value = (int)$value;
 873                                 } else {
 874                                         $value = (float)$value;
 875                                 }
 876                                 break;
 877
 878                         case 'array':
 879                         case 'assoc':
 880                         case 'kvp':
 881                                 if ( is_array( $value ) ) {
 882                                         ApiResult::setArrayType( $value, $type );
 883                                 }
 884                                 break;
 885
 886                         case 'timestamp':
 887                                 $value = wfTimestamp( TS_ISO_8601, $value );
 888                                 break;
 889
 890                         case 'msg':
 891                         case 'msg-content':
 892                                 $msg = $this->msg( $value );
 893                                 if ( $type === 'msg-content' ) {
 894                                         $msg->inContentLanguage();
 895                                 }
 896                                 $value = [];
 897                                 $value["{$name}_key"] = $msg->getKey();
 898                                 if ( $msg->getParams() ) {
 899                                         $value["{$name}_params"] = $msg->getParams();
 900                                 }
 901                                 $value["{$name}_text"] = $msg->text();
 902                                 return $value;
 903
 904                         case 'title':
 905                         case 'title-link':
 906                                 $title = Title::newFromText( $value );
 907                                 if ( !$title ) {
 908                                         // Huh? Do something halfway sane.
 909                                         $title = SpecialPage::getTitleFor( 'Badtitle', $value );
 910                                 }
 911                                 $value = [];
 912                                 ApiQueryBase::addTitleInfo( $value, $title, "{$name}_" );
 913                                 return $value;
 914
 915                         case 'user':
 916                         case 'user-link':
 917                                 $user = User::newFromName( $value );
 918                                 if ( $user ) {
 919                                         $value = $user->getName();
 920                                 }
 921                                 break;
 922
 923                         default:
 924                                 // do nothing
 925                                 break;
 926                 }
 927
 928                 return [ $name => $value ];
 929         }
 930 }