3 * Contains a class for formatting log entries
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.
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.
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
21 * @author Niklas Laxström
22 * @license GPL-2.0-or-later
25 use MediaWiki\Linker\LinkRenderer
;
26 use MediaWiki\MediaWikiServices
;
29 * Implements the default log formatting.
31 * Can be overridden by subclassing and setting:
33 * $wgLogActionsHandlers['type/subtype'] = 'class'; or
34 * $wgLogActionsHandlers['type/*'] = 'class';
39 // Audience options for viewing usernames, comments, and actions
41 const FOR_THIS_USER
= 2;
46 * Constructs a new formatter suitable for given entry.
47 * @param LogEntry $entry
48 * @return LogFormatter
50 public static function newFromEntry( LogEntry
$entry ) {
51 global $wgLogActionsHandlers;
52 $fulltype = $entry->getFullType();
53 $wildcard = $entry->getType() . '/*';
54 $handler = $wgLogActionsHandlers[$fulltype] ??
$wgLogActionsHandlers[$wildcard] ??
'';
56 if ( $handler !== '' && is_string( $handler ) && class_exists( $handler ) ) {
57 return new $handler( $entry );
60 return new LegacyLogFormatter( $entry );
64 * Handy shortcut for constructing a formatter directly from
66 * @param stdClass|array $row
67 * @see DatabaseLogEntry::getSelectQueryData
68 * @return LogFormatter
70 public static function newFromRow( $row ) {
71 return self
::newFromEntry( DatabaseLogEntry
::newFromRow( $row ) );
76 /** @var LogEntryBase */
79 /** @var int Constant for handling log_deleted */
80 protected $audience = self
::FOR_PUBLIC
;
82 /** @var IContextSource Context for logging */
85 /** @var bool Whether to output user tool links */
86 protected $linkFlood = false;
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.
95 protected $plaintext = false;
98 protected $irctext = false;
101 * @var LinkRenderer|null
103 private $linkRenderer;
106 * @see LogFormatter::getMessageParameters
109 protected $parsedParameters;
111 protected function __construct( LogEntry
$entry ) {
112 $this->entry
= $entry;
113 $this->context
= RequestContext
::getMain();
117 * Replace the default context
118 * @param IContextSource $context
120 public function setContext( IContextSource
$context ) {
121 $this->context
= $context;
126 * @param LinkRenderer $linkRenderer
128 public function setLinkRenderer( LinkRenderer
$linkRenderer ) {
129 $this->linkRenderer
= $linkRenderer;
134 * @return LinkRenderer
136 public function getLinkRenderer() {
137 if ( $this->linkRenderer
!== null ) {
138 return $this->linkRenderer
;
140 return MediaWikiServices
::getInstance()->getLinkRenderer();
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
150 public function setAudience( $audience ) {
151 $this->audience
= ( $audience == self
::FOR_THIS_USER
)
152 ? self
::FOR_THIS_USER
157 * Check if a log item can be displayed
158 * @param int $field LogPage::DELETED_* constant
161 protected function canView( $field ) {
162 if ( $this->audience
== self
::FOR_THIS_USER
) {
163 return LogEventsList
::userCanBitfield(
164 $this->entry
->getDeleted(), $field, $this->context
->getUser() );
166 return !$this->entry
->isDeleted( $field );
171 * If set to true, will produce user tool links after
172 * the user name. This should be replaced with generic
176 public function setShowUserToolLinks( $value ) {
177 $this->linkFlood
= $value;
181 * Ugly hack to produce plaintext version of the message.
182 * Usually you also want to set extraneous request context
183 * to avoid formatting for any particular user.
184 * @see getActionText()
185 * @return string Plain text
186 * @return-taint tainted
188 public function getPlainActionText() {
189 $this->plaintext
= true;
190 $text = $this->getActionText();
191 $this->plaintext
= false;
197 * Even uglier hack to maintain backwards compatibility with IRC bots
199 * @see getActionText()
200 * @return string Text
202 public function getIRCActionComment() {
203 $actionComment = $this->getIRCActionText();
204 $comment = $this->entry
->getComment();
206 if ( $comment != '' ) {
207 if ( $actionComment == '' ) {
208 $actionComment = $comment;
210 $actionComment .= wfMessage( 'colon-separator' )->inContentLanguage()->text() . $comment;
214 return $actionComment;
218 * Even uglier hack to maintain backwards compatibility with IRC bots
220 * @see getActionText()
221 * @return string Text
223 public function getIRCActionText() {
224 $this->plaintext
= true;
225 $this->irctext
= true;
227 $entry = $this->entry
;
228 $parameters = $entry->getParameters();
229 // @see LogPage::actionText()
230 // Text of title the action is aimed at.
231 $target = $entry->getTarget()->getPrefixedText();
233 $contLang = MediaWikiServices
::getInstance()->getContentLanguage();
234 switch ( $entry->getType() ) {
236 switch ( $entry->getSubtype() ) {
238 $movesource = $parameters['4::target'];
239 $text = wfMessage( '1movedto2' )
240 ->rawParams( $target, $movesource )->inContentLanguage()->escaped();
243 $movesource = $parameters['4::target'];
244 $text = wfMessage( '1movedto2_redir' )
245 ->rawParams( $target, $movesource )->inContentLanguage()->escaped();
247 case 'move-noredirect':
249 case 'move_redir-noredirect':
255 switch ( $entry->getSubtype() ) {
257 $text = wfMessage( 'deletedarticle' )
258 ->rawParams( $target )->inContentLanguage()->escaped();
261 $text = wfMessage( 'undeletedarticle' )
262 ->rawParams( $target )->inContentLanguage()->escaped();
264 //case 'revision': // Revision deletion
265 //case 'event': // Log deletion
266 // see https://github.com/wikimedia/mediawiki/commit/a9c243b7b5289dad204278dbe7ed571fd914e395
272 // https://github.com/wikimedia/mediawiki/commit/1a05f8faf78675dc85984f27f355b8825b43efff
273 // Create a diff link to the patrolled revision
274 if ( $entry->getSubtype() === 'patrol' ) {
275 $diffLink = htmlspecialchars(
276 wfMessage( 'patrol-log-diff', $parameters['4::curid'] )
277 ->inContentLanguage()->text() );
278 $text = wfMessage( 'patrol-log-line', $diffLink, "[[$target]]", "" )
279 ->inContentLanguage()->text();
286 switch ( $entry->getSubtype() ) {
288 $text = wfMessage( 'protectedarticle' )
289 ->rawParams( $target . ' ' . $parameters['4::description'] )->inContentLanguage()->escaped();
292 $text = wfMessage( 'unprotectedarticle' )
293 ->rawParams( $target )->inContentLanguage()->escaped();
296 $text = wfMessage( 'modifiedarticleprotection' )
297 ->rawParams( $target . ' ' . $parameters['4::description'] )->inContentLanguage()->escaped();
300 $text = wfMessage( 'movedarticleprotection' )
301 ->rawParams( $target, $parameters['4::oldtitle'] )->inContentLanguage()->escaped();
307 switch ( $entry->getSubtype() ) {
310 $text = wfMessage( 'newuserlog-create-entry' )
311 ->inContentLanguage()->escaped();
315 $text = wfMessage( 'newuserlog-create2-entry' )
316 ->rawParams( $target )->inContentLanguage()->escaped();
319 $text = wfMessage( 'newuserlog-autocreate-entry' )
320 ->inContentLanguage()->escaped();
326 switch ( $entry->getSubtype() ) {
328 $text = wfMessage( 'uploadedimage' )
329 ->rawParams( $target )->inContentLanguage()->escaped();
333 $text = wfMessage( 'overwroteimage' )
334 ->rawParams( $target )->inContentLanguage()->escaped();
340 if ( count( $parameters['4::oldgroups'] ) ) {
341 $oldgroups = implode( ', ', $parameters['4::oldgroups'] );
343 $oldgroups = wfMessage( 'rightsnone' )->inContentLanguage()->escaped();
345 if ( count( $parameters['5::newgroups'] ) ) {
346 $newgroups = implode( ', ', $parameters['5::newgroups'] );
348 $newgroups = wfMessage( 'rightsnone' )->inContentLanguage()->escaped();
350 switch ( $entry->getSubtype() ) {
352 $text = wfMessage( 'rightslogentry' )
353 ->rawParams( $target, $oldgroups, $newgroups )->inContentLanguage()->escaped();
356 $text = wfMessage( 'rightslogentry-autopromote' )
357 ->rawParams( $target, $oldgroups, $newgroups )->inContentLanguage()->escaped();
363 $text = wfMessage( 'pagemerge-logentry' )
364 ->rawParams( $target, $parameters['4::dest'], $parameters['5::mergepoint'] )
365 ->inContentLanguage()->escaped();
369 switch ( $entry->getSubtype() ) {
371 // Keep compatibility with extensions by checking for
372 // new key (5::duration/6::flags) or old key (0/optional 1)
373 if ( $entry->isLegacy() ) {
374 $rawDuration = $parameters[0];
375 $rawFlags = $parameters[1] ??
'';
377 $rawDuration = $parameters['5::duration'];
378 $rawFlags = $parameters['6::flags'];
380 $duration = $contLang->translateBlockExpiry(
383 wfTimestamp( TS_UNIX
, $entry->getTimestamp() )
385 $flags = BlockLogFormatter
::formatBlockFlags( $rawFlags, $contLang );
386 $text = wfMessage( 'blocklogentry' )
387 ->rawParams( $target, $duration, $flags )->inContentLanguage()->escaped();
390 $text = wfMessage( 'unblocklogentry' )
391 ->rawParams( $target )->inContentLanguage()->escaped();
394 $duration = $contLang->translateBlockExpiry(
395 $parameters['5::duration'],
397 wfTimestamp( TS_UNIX
, $entry->getTimestamp() )
399 $flags = BlockLogFormatter
::formatBlockFlags( $parameters['6::flags'],
401 $text = wfMessage( 'reblock-logentry' )
402 ->rawParams( $target, $duration, $flags )->inContentLanguage()->escaped();
408 switch ( $entry->getSubtype() ) {
410 $text = wfMessage( 'import-logentry-upload' )
411 ->rawParams( $target )->inContentLanguage()->escaped();
414 $text = wfMessage( 'import-logentry-interwiki' )
415 ->rawParams( $target )->inContentLanguage()->escaped();
419 // case 'suppress' --private log -- aaron (so we know who to blame in a few years :-D)
422 if ( is_null( $text ) ) {
423 $text = $this->getPlainActionText();
426 $this->plaintext
= false;
427 $this->irctext
= false;
433 * Gets the log action, including username.
434 * @return string HTML
435 * phan-taint-check gets very confused by $this->plaintext, so disable.
436 * @return-taint onlysafefor_html
438 public function getActionText() {
439 if ( $this->canView( LogPage
::DELETED_ACTION
) ) {
440 $element = $this->getActionMessage();
441 if ( $element instanceof Message
) {
442 $element = $this->plaintext ?
$element->text() : $element->escaped();
444 if ( $this->entry
->isDeleted( LogPage
::DELETED_ACTION
) ) {
445 $element = $this->styleRestricedElement( $element );
448 $sep = $this->msg( 'word-separator' );
449 $sep = $this->plaintext ?
$sep->text() : $sep->escaped();
450 $performer = $this->getPerformerElement();
451 $element = $performer . $sep . $this->getRestrictedElement( 'rev-deleted-event' );
458 * Returns a sentence describing the log action. Usually
459 * a Message object is returned, but old style log types
460 * and entries might return pre-escaped HTML string.
461 * @return Message|string Pre-escaped HTML
463 protected function getActionMessage() {
464 $message = $this->msg( $this->getMessageKey() );
465 $message->params( $this->getMessageParameters() );
471 * Returns a key to be used for formatting the action sentence.
472 * Default is logentry-TYPE-SUBTYPE for modern logs. Legacy log
473 * types will use custom keys, and subclasses can also alter the
474 * key depending on the entry itself.
475 * @return string Message key
477 protected function getMessageKey() {
478 $type = $this->entry
->getType();
479 $subtype = $this->entry
->getSubtype();
481 return "logentry-$type-$subtype";
485 * Returns extra links that comes after the action text, like "revert", etc.
489 public function getActionLinks() {
494 * Extracts the optional extra parameters for use in action messages.
495 * The array indexes start from number 3.
498 protected function extractParameters() {
499 $entry = $this->entry
;
502 if ( $entry->isLegacy() ) {
503 foreach ( $entry->getParameters() as $index => $value ) {
504 $params[$index +
3] = $value;
508 // Filter out parameters which are not in format #:foo
509 foreach ( $entry->getParameters() as $key => $value ) {
510 if ( strpos( $key, ':' ) === false ) {
513 list( $index, $type, ) = explode( ':', $key, 3 );
514 if ( ctype_digit( $index ) ) {
515 $params[$index - 1] = $this->formatParameterValue( $type, $value );
519 /* Message class doesn't like non consecutive numbering.
520 * Fill in missing indexes with empty strings to avoid
521 * incorrect renumbering.
523 if ( count( $params ) ) {
524 $max = max( array_keys( $params ) );
525 // index 0 to 2 are added in getMessageParameters
526 for ( $i = 3; $i < $max; $i++
) {
527 if ( !isset( $params[$i] ) ) {
537 * Formats parameters intented for action message from
538 * array of all parameters. There are three hardcoded
539 * parameters (array is zero-indexed, this list not):
540 * - 1: user name with premade link
541 * - 2: usable for gender magic function
542 * - 3: target page with premade link
545 protected function getMessageParameters() {
546 if ( isset( $this->parsedParameters
) ) {
547 return $this->parsedParameters
;
550 $entry = $this->entry
;
551 $params = $this->extractParameters();
552 $params[0] = Message
::rawParam( $this->getPerformerElement() );
553 $params[1] = $this->canView( LogPage
::DELETED_USER
) ?
$entry->getPerformer()->getName() : '';
554 $params[2] = Message
::rawParam( $this->makePageLink( $entry->getTarget() ) );
556 // Bad things happens if the numbers are not in correct order
559 $this->parsedParameters
= $params;
560 return $this->parsedParameters
;
564 * Formats parameters values dependent to their type
565 * @param string $type The type of the value.
566 * Valid are currently:
567 * * - (empty) or plain: The value is returned as-is
568 * * raw: The value will be added to the log message
569 * as raw parameter (e.g. no escaping)
570 * Use this only if there is no other working
571 * type like user-link or title-link
572 * * msg: The value is a message-key, the output is
573 * the message in user language
574 * * msg-content: The value is a message-key, the output
575 * is the message in content language
576 * * user: The value is a user name, e.g. for GENDER
577 * * user-link: The value is a user name, returns a
579 * * title: The value is a page title,
580 * returns name of page
581 * * title-link: The value is a page title,
582 * returns link to this page
583 * * number: Format value as number
584 * * list: Format value as a comma-separated list
585 * @param mixed $value The parameter value that should be formatted
586 * @return string|array Formated value
589 protected function formatParameterValue( $type, $value ) {
590 $saveLinkFlood = $this->linkFlood
;
592 switch ( strtolower( trim( $type ) ) ) {
594 $value = Message
::rawParam( $value );
597 $value = $this->context
->getLanguage()->commaList( $value );
600 $value = $this->msg( $value )->text();
603 $value = $this->msg( $value )->inContentLanguage()->text();
606 $value = Message
::numParam( $value );
609 $user = User
::newFromName( $value );
610 $value = $user->getName();
613 $this->setShowUserToolLinks( false );
615 $user = User
::newFromName( $value );
618 $value = $this->msg( 'empty-username' )->text();
620 $value = Message
::rawParam( $this->makeUserLink( $user ) );
621 $this->setShowUserToolLinks( $saveLinkFlood );
625 $title = Title
::newFromText( $value );
626 $value = $title->getPrefixedText();
629 $title = Title
::newFromText( $value );
630 $value = Message
::rawParam( $this->makePageLink( $title ) );
633 // Plain text, nothing to do
635 // Catch other types and use the old behavior (return as-is)
642 * Helper to make a link to the page, taking the plaintext
643 * value in consideration.
644 * @param Title|null $title The page
645 * @param array $parameters Query parameters
646 * @param string|null $html Linktext of the link as raw html
649 protected function makePageLink( Title
$title = null, $parameters = [], $html = null ) {
650 if ( !$title instanceof Title
) {
651 $msg = $this->msg( 'invalidtitle' )->text();
652 if ( $this->plaintext
) {
655 return Html
::element( 'span', [ 'class' => 'mw-invalidtitle' ], $msg );
659 if ( $this->plaintext
) {
660 $link = '[[' . $title->getPrefixedText() . ']]';
662 $html = $html !== null ?
new HtmlArmor( $html ) : $html;
663 $link = $this->getLinkRenderer()->makeLink( $title, $html, [], $parameters );
670 * Provides the name of the user who performed the log action.
671 * Used as part of log action message or standalone, depending
672 * which parts of the log entry has been hidden.
675 public function getPerformerElement() {
676 if ( $this->canView( LogPage
::DELETED_USER
) ) {
677 $performer = $this->entry
->getPerformer();
678 $element = $this->makeUserLink( $performer );
679 if ( $this->entry
->isDeleted( LogPage
::DELETED_USER
) ) {
680 $element = $this->styleRestricedElement( $element );
683 $element = $this->getRestrictedElement( 'rev-deleted-user' );
690 * Gets the user provided comment
691 * @return string HTML
693 public function getComment() {
694 if ( $this->canView( LogPage
::DELETED_COMMENT
) ) {
695 $comment = Linker
::commentBlock( $this->entry
->getComment() );
696 // No hard coded spaces thanx
697 $element = ltrim( $comment );
698 if ( $this->entry
->isDeleted( LogPage
::DELETED_COMMENT
) ) {
699 $element = $this->styleRestricedElement( $element );
702 $element = $this->getRestrictedElement( 'rev-deleted-comment' );
709 * Helper method for displaying restricted element.
710 * @param string $message
711 * @return string HTML or wiki text
712 * @return-taint onlysafefor_html
714 protected function getRestrictedElement( $message ) {
715 if ( $this->plaintext
) {
716 return $this->msg( $message )->text();
719 $content = $this->msg( $message )->escaped();
720 $attribs = [ 'class' => 'history-deleted' ];
722 return Html
::rawElement( 'span', $attribs, $content );
726 * Helper method for styling restricted element.
727 * @param string $content
728 * @return string HTML or wiki text
730 protected function styleRestricedElement( $content ) {
731 if ( $this->plaintext
) {
734 $attribs = [ 'class' => 'history-deleted' ];
736 return Html
::rawElement( 'span', $attribs, $content );
740 * Shortcut for wfMessage which honors local context.
744 protected function msg( $key ) {
745 return $this->context
->msg( $key );
750 * @param int $toolFlags Combination of Linker::TOOL_LINKS_* flags
751 * @return string wikitext or html
752 * @return-taint onlysafefor_html
754 protected function makeUserLink( User
$user, $toolFlags = 0 ) {
755 if ( $this->plaintext
) {
756 $element = $user->getName();
758 $element = Linker
::userLink(
763 if ( $this->linkFlood
) {
764 $element .= Linker
::userToolLinks(
767 true, // redContribsWhenNoEdits
769 $user->getEditCount(),
770 // do not render parenthesises in the HTML markup (CSS will provide)
780 * @return array Array of titles that should be preloaded with LinkBatch
782 public function getPreloadTitles() {
787 * @return array Output of getMessageParameters() for testing
789 public function getMessageParametersForTesting() {
790 // This function was added because getMessageParameters() is
791 // protected and a change from protected to public caused
792 // problems with extensions
793 return $this->getMessageParameters();
797 * Get the array of parameters, converted from legacy format if necessary.
801 protected function getParametersForApi() {
802 return $this->entry
->getParameters();
806 * Format parameters for API output
808 * The result array should generally map named keys to values. Index and
809 * type should be omitted, e.g. "4::foo" should be returned as "foo" in the
810 * output. Values should generally be unformatted.
812 * Renames or removals of keys besides from the legacy numeric format to
813 * modern named style should be avoided. Any renames should be announced to
814 * the mediawiki-api-announce mailing list.
819 public function formatParametersForApi() {
821 foreach ( $this->getParametersForApi() as $key => $value ) {
822 $vals = explode( ':', $key, 3 );
823 if ( count( $vals ) !== 3 ) {
824 if ( $value instanceof __PHP_Incomplete_Class
) {
825 wfLogWarning( 'Log entry of type ' . $this->entry
->getFullType() .
826 ' contains unrecoverable extra parameters.' );
829 $logParams[$key] = $value;
832 $logParams +
= $this->formatParameterValueForApi( $vals[2], $vals[1], $value );
834 ApiResult
::setIndexedTagName( $logParams, 'param' );
835 ApiResult
::setArrayType( $logParams, 'assoc' );
841 * Format a single parameter value for API output
844 * @param string $name
845 * @param string $type
846 * @param string $value
849 protected function formatParameterValueForApi( $name, $type, $value ) {
850 $type = strtolower( trim( $type ) );
853 $value = (bool)$value;
857 if ( ctype_digit( $value ) ||
is_int( $value ) ) {
858 $value = (int)$value;
860 $value = (float)$value;
867 if ( is_array( $value ) ) {
868 ApiResult
::setArrayType( $value, $type );
873 $value = wfTimestamp( TS_ISO_8601
, $value );
878 $msg = $this->msg( $value );
879 if ( $type === 'msg-content' ) {
880 $msg->inContentLanguage();
883 $value["{$name}_key"] = $msg->getKey();
884 if ( $msg->getParams() ) {
885 $value["{$name}_params"] = $msg->getParams();
887 $value["{$name}_text"] = $msg->text();
892 $title = Title
::newFromText( $value );
894 // Huh? Do something halfway sane.
895 $title = SpecialPage
::getTitleFor( 'Badtitle', $value );
898 ApiQueryBase
::addTitleInfo( $value, $title, "{$name}_" );
903 $user = User
::newFromName( $value );
905 $value = $user->getName();
914 return [ $name => $value ];