3 * Contains classes 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 http://www.gnu.org/copyleft/gpl.html GNU General Public License 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() . '/*';
56 if ( isset( $wgLogActionsHandlers[$fulltype] ) ) {
57 $handler = $wgLogActionsHandlers[$fulltype];
58 } elseif ( isset( $wgLogActionsHandlers[$wildcard] ) ) {
59 $handler = $wgLogActionsHandlers[$wildcard];
62 if ( $handler !== '' && is_string( $handler ) && class_exists( $handler ) ) {
63 return new $handler( $entry );
66 return new LegacyLogFormatter( $entry );
70 * Handy shortcut for constructing a formatter directly from
72 * @param stdClass|array $row
73 * @see DatabaseLogEntry::getSelectQueryData
74 * @return LogFormatter
76 public static function newFromRow( $row ) {
77 return self
::newFromEntry( DatabaseLogEntry
::newFromRow( $row ) );
82 /** @var LogEntryBase */
85 /** @var int Constant for handling log_deleted */
86 protected $audience = self
::FOR_PUBLIC
;
88 /** @var IContextSource Context for logging */
91 /** @var bool Whether to output user tool links */
92 protected $linkFlood = false;
95 * Set to true if we are constructing a message text that is going to
96 * be included in page history or send to IRC feed. Links are replaced
97 * with plaintext or with [[pagename]] kind of syntax, that is parsed
98 * by page histories and IRC feeds.
101 protected $plaintext = false;
104 protected $irctext = false;
107 * @var LinkRenderer|null
109 private $linkRenderer;
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
187 public function getPlainActionText() {
188 $this->plaintext
= true;
189 $text = $this->getActionText();
190 $this->plaintext
= false;
196 * Even uglier hack to maintain backwards compatibilty with IRC bots
198 * @see getActionText()
199 * @return string Text
201 public function getIRCActionComment() {
202 $actionComment = $this->getIRCActionText();
203 $comment = $this->entry
->getComment();
205 if ( $comment != '' ) {
206 if ( $actionComment == '' ) {
207 $actionComment = $comment;
209 $actionComment .= wfMessage( 'colon-separator' )->inContentLanguage()->text() . $comment;
213 return $actionComment;
217 * Even uglier hack to maintain backwards compatibilty with IRC bots
219 * @see getActionText()
220 * @return string Text
222 public function getIRCActionText() {
225 $this->plaintext
= true;
226 $this->irctext
= true;
228 $entry = $this->entry
;
229 $parameters = $entry->getParameters();
230 // @see LogPage::actionText()
231 // Text of title the action is aimed at.
232 $target = $entry->getTarget()->getPrefixedText();
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();
332 $text = wfMessage( 'overwroteimage' )
333 ->rawParams( $target )->inContentLanguage()->escaped();
339 if ( count( $parameters['4::oldgroups'] ) ) {
340 $oldgroups = implode( ', ', $parameters['4::oldgroups'] );
342 $oldgroups = wfMessage( 'rightsnone' )->inContentLanguage()->escaped();
344 if ( count( $parameters['5::newgroups'] ) ) {
345 $newgroups = implode( ', ', $parameters['5::newgroups'] );
347 $newgroups = wfMessage( 'rightsnone' )->inContentLanguage()->escaped();
349 switch ( $entry->getSubtype() ) {
351 $text = wfMessage( 'rightslogentry' )
352 ->rawParams( $target, $oldgroups, $newgroups )->inContentLanguage()->escaped();
355 $text = wfMessage( 'rightslogentry-autopromote' )
356 ->rawParams( $target, $oldgroups, $newgroups )->inContentLanguage()->escaped();
362 $text = wfMessage( 'pagemerge-logentry' )
363 ->rawParams( $target, $parameters['4::dest'], $parameters['5::mergepoint'] )
364 ->inContentLanguage()->escaped();
368 switch ( $entry->getSubtype() ) {
370 // Keep compatibility with extensions by checking for
371 // new key (5::duration/6::flags) or old key (0/optional 1)
372 if ( $entry->isLegacy() ) {
373 $rawDuration = $parameters[0];
374 $rawFlags = isset( $parameters[1] ) ?
$parameters[1] : '';
376 $rawDuration = $parameters['5::duration'];
377 $rawFlags = $parameters['6::flags'];
379 $duration = $wgContLang->translateBlockExpiry(
382 wfTimestamp( TS_UNIX
, $entry->getTimestamp() )
384 $flags = BlockLogFormatter
::formatBlockFlags( $rawFlags, $wgContLang );
385 $text = wfMessage( 'blocklogentry' )
386 ->rawParams( $target, $duration, $flags )->inContentLanguage()->escaped();
389 $text = wfMessage( 'unblocklogentry' )
390 ->rawParams( $target )->inContentLanguage()->escaped();
393 $duration = $wgContLang->translateBlockExpiry(
394 $parameters['5::duration'],
396 wfTimestamp( TS_UNIX
, $entry->getTimestamp() )
398 $flags = BlockLogFormatter
::formatBlockFlags( $parameters['6::flags'], $wgContLang );
399 $text = wfMessage( 'reblock-logentry' )
400 ->rawParams( $target, $duration, $flags )->inContentLanguage()->escaped();
406 switch ( $entry->getSubtype() ) {
408 $text = wfMessage( 'import-logentry-upload' )
409 ->rawParams( $target )->inContentLanguage()->escaped();
412 $text = wfMessage( 'import-logentry-interwiki' )
413 ->rawParams( $target )->inContentLanguage()->escaped();
417 // case 'suppress' --private log -- aaron (so we know who to blame in a few years :-D)
420 if ( is_null( $text ) ) {
421 $text = $this->getPlainActionText();
424 $this->plaintext
= false;
425 $this->irctext
= false;
431 * Gets the log action, including username.
432 * @return string HTML
434 public function getActionText() {
435 if ( $this->canView( LogPage
::DELETED_ACTION
) ) {
436 $element = $this->getActionMessage();
437 if ( $element instanceof Message
) {
438 $element = $this->plaintext ?
$element->text() : $element->escaped();
440 if ( $this->entry
->isDeleted( LogPage
::DELETED_ACTION
) ) {
441 $element = $this->styleRestricedElement( $element );
444 $sep = $this->msg( 'word-separator' );
445 $sep = $this->plaintext ?
$sep->text() : $sep->escaped();
446 $performer = $this->getPerformerElement();
447 $element = $performer . $sep . $this->getRestrictedElement( 'rev-deleted-event' );
454 * Returns a sentence describing the log action. Usually
455 * a Message object is returned, but old style log types
456 * and entries might return pre-escaped HTML string.
457 * @return Message|string Pre-escaped HTML
459 protected function getActionMessage() {
460 $message = $this->msg( $this->getMessageKey() );
461 $message->params( $this->getMessageParameters() );
467 * Returns a key to be used for formatting the action sentence.
468 * Default is logentry-TYPE-SUBTYPE for modern logs. Legacy log
469 * types will use custom keys, and subclasses can also alter the
470 * key depending on the entry itself.
471 * @return string Message key
473 protected function getMessageKey() {
474 $type = $this->entry
->getType();
475 $subtype = $this->entry
->getSubtype();
477 return "logentry-$type-$subtype";
481 * Returns extra links that comes after the action text, like "revert", etc.
485 public function getActionLinks() {
490 * Extracts the optional extra parameters for use in action messages.
491 * The array indexes start from number 3.
494 protected function extractParameters() {
495 $entry = $this->entry
;
498 if ( $entry->isLegacy() ) {
499 foreach ( $entry->getParameters() as $index => $value ) {
500 $params[$index +
3] = $value;
504 // Filter out parameters which are not in format #:foo
505 foreach ( $entry->getParameters() as $key => $value ) {
506 if ( strpos( $key, ':' ) === false ) {
509 list( $index, $type, ) = explode( ':', $key, 3 );
510 if ( ctype_digit( $index ) ) {
511 $params[$index - 1] = $this->formatParameterValue( $type, $value );
515 /* Message class doesn't like non consecutive numbering.
516 * Fill in missing indexes with empty strings to avoid
517 * incorrect renumbering.
519 if ( count( $params ) ) {
520 $max = max( array_keys( $params ) );
521 // index 0 to 2 are added in getMessageParameters
522 for ( $i = 3; $i < $max; $i++
) {
523 if ( !isset( $params[$i] ) ) {
533 * Formats parameters intented for action message from
534 * array of all parameters. There are three hardcoded
535 * parameters (array is zero-indexed, this list not):
536 * - 1: user name with premade link
537 * - 2: usable for gender magic function
538 * - 3: target page with premade link
541 protected function getMessageParameters() {
542 if ( isset( $this->parsedParameters
) ) {
543 return $this->parsedParameters
;
546 $entry = $this->entry
;
547 $params = $this->extractParameters();
548 $params[0] = Message
::rawParam( $this->getPerformerElement() );
549 $params[1] = $this->canView( LogPage
::DELETED_USER
) ?
$entry->getPerformer()->getName() : '';
550 $params[2] = Message
::rawParam( $this->makePageLink( $entry->getTarget() ) );
552 // Bad things happens if the numbers are not in correct order
555 $this->parsedParameters
= $params;
556 return $this->parsedParameters
;
560 * Formats parameters values dependent to their type
561 * @param string $type The type of the value.
562 * Valid are currently:
563 * * - (empty) or plain: The value is returned as-is
564 * * raw: The value will be added to the log message
565 * as raw parameter (e.g. no escaping)
566 * Use this only if there is no other working
567 * type like user-link or title-link
568 * * msg: The value is a message-key, the output is
569 * the message in user language
570 * * msg-content: The value is a message-key, the output
571 * is the message in content language
572 * * user: The value is a user name, e.g. for GENDER
573 * * user-link: The value is a user name, returns a
575 * * title: The value is a page title,
576 * returns name of page
577 * * title-link: The value is a page title,
578 * returns link to this page
579 * * number: Format value as number
580 * * list: Format value as a comma-separated list
581 * @param mixed $value The parameter value that should be formatted
582 * @return string|array Formated value
585 protected function formatParameterValue( $type, $value ) {
586 $saveLinkFlood = $this->linkFlood
;
588 switch ( strtolower( trim( $type ) ) ) {
590 $value = Message
::rawParam( $value );
593 $value = $this->context
->getLanguage()->commaList( $value );
596 $value = $this->msg( $value )->text();
599 $value = $this->msg( $value )->inContentLanguage()->text();
602 $value = Message
::numParam( $value );
605 $user = User
::newFromName( $value );
606 $value = $user->getName();
609 $this->setShowUserToolLinks( false );
611 $user = User
::newFromName( $value );
612 $value = Message
::rawParam( $this->makeUserLink( $user ) );
614 $this->setShowUserToolLinks( $saveLinkFlood );
617 $title = Title
::newFromText( $value );
618 $value = $title->getPrefixedText();
621 $title = Title
::newFromText( $value );
622 $value = Message
::rawParam( $this->makePageLink( $title ) );
625 // Plain text, nothing to do
627 // Catch other types and use the old behavior (return as-is)
634 * Helper to make a link to the page, taking the plaintext
635 * value in consideration.
636 * @param Title $title The page
637 * @param array $parameters Query parameters
638 * @param string|null $html Linktext of the link as raw html
639 * @throws MWException
642 protected function makePageLink( Title
$title = null, $parameters = [], $html = null ) {
643 if ( !$title instanceof Title
) {
644 throw new MWException( 'Expected title, got null' );
646 if ( !$this->plaintext
) {
647 $html = $html !== null ?
new HtmlArmor( $html ) : $html;
648 $link = $this->getLinkRenderer()->makeLink( $title, $html, [], $parameters );
650 $link = '[[' . $title->getPrefixedText() . ']]';
657 * Provides the name of the user who performed the log action.
658 * Used as part of log action message or standalone, depending
659 * which parts of the log entry has been hidden.
662 public function getPerformerElement() {
663 if ( $this->canView( LogPage
::DELETED_USER
) ) {
664 $performer = $this->entry
->getPerformer();
665 $element = $this->makeUserLink( $performer );
666 if ( $this->entry
->isDeleted( LogPage
::DELETED_USER
) ) {
667 $element = $this->styleRestricedElement( $element );
670 $element = $this->getRestrictedElement( 'rev-deleted-user' );
677 * Gets the user provided comment
678 * @return string HTML
680 public function getComment() {
681 if ( $this->canView( LogPage
::DELETED_COMMENT
) ) {
682 $comment = Linker
::commentBlock( $this->entry
->getComment() );
683 // No hard coded spaces thanx
684 $element = ltrim( $comment );
685 if ( $this->entry
->isDeleted( LogPage
::DELETED_COMMENT
) ) {
686 $element = $this->styleRestricedElement( $element );
689 $element = $this->getRestrictedElement( 'rev-deleted-comment' );
696 * Helper method for displaying restricted element.
697 * @param string $message
698 * @return string HTML or wiki text
700 protected function getRestrictedElement( $message ) {
701 if ( $this->plaintext
) {
702 return $this->msg( $message )->text();
705 $content = $this->msg( $message )->escaped();
706 $attribs = [ 'class' => 'history-deleted' ];
708 return Html
::rawElement( 'span', $attribs, $content );
712 * Helper method for styling restricted element.
713 * @param string $content
714 * @return string HTML or wiki text
716 protected function styleRestricedElement( $content ) {
717 if ( $this->plaintext
) {
720 $attribs = [ 'class' => 'history-deleted' ];
722 return Html
::rawElement( 'span', $attribs, $content );
726 * Shortcut for wfMessage which honors local context.
730 protected function msg( $key ) {
731 return $this->context
->msg( $key );
734 protected function makeUserLink( User
$user, $toolFlags = 0 ) {
735 if ( $this->plaintext
) {
736 $element = $user->getName();
738 $element = Linker
::userLink(
743 if ( $this->linkFlood
) {
744 $element .= Linker
::userToolLinks(
747 true, // redContribsWhenNoEdits
749 $user->getEditCount()
758 * @return array Array of titles that should be preloaded with LinkBatch
760 public function getPreloadTitles() {
765 * @return array Output of getMessageParameters() for testing
767 public function getMessageParametersForTesting() {
768 // This function was added because getMessageParameters() is
769 // protected and a change from protected to public caused
770 // problems with extensions
771 return $this->getMessageParameters();
775 * Get the array of parameters, converted from legacy format if necessary.
779 protected function getParametersForApi() {
780 return $this->entry
->getParameters();
784 * Format parameters for API output
786 * The result array should generally map named keys to values. Index and
787 * type should be omitted, e.g. "4::foo" should be returned as "foo" in the
788 * output. Values should generally be unformatted.
790 * Renames or removals of keys besides from the legacy numeric format to
791 * modern named style should be avoided. Any renames should be announced to
792 * the mediawiki-api-announce mailing list.
797 public function formatParametersForApi() {
799 foreach ( $this->getParametersForApi() as $key => $value ) {
800 $vals = explode( ':', $key, 3 );
801 if ( count( $vals ) !== 3 ) {
802 $logParams[$key] = $value;
805 $logParams +
= $this->formatParameterValueForApi( $vals[2], $vals[1], $value );
807 ApiResult
::setIndexedTagName( $logParams, 'param' );
808 ApiResult
::setArrayType( $logParams, 'assoc' );
814 * Format a single parameter value for API output
817 * @param string $name
818 * @param string $type
819 * @param string $value
822 protected function formatParameterValueForApi( $name, $type, $value ) {
823 $type = strtolower( trim( $type ) );
826 $value = (bool)$value;
830 if ( ctype_digit( $value ) ||
is_int( $value ) ) {
831 $value = (int)$value;
833 $value = (float)$value;
840 if ( is_array( $value ) ) {
841 ApiResult
::setArrayType( $value, $type );
846 $value = wfTimestamp( TS_ISO_8601
, $value );
851 $msg = $this->msg( $value );
852 if ( $type === 'msg-content' ) {
853 $msg->inContentLanguage();
856 $value["{$name}_key"] = $msg->getKey();
857 if ( $msg->getParams() ) {
858 $value["{$name}_params"] = $msg->getParams();
860 $value["{$name}_text"] = $msg->text();
865 $title = Title
::newFromText( $value );
867 // Huh? Do something halfway sane.
868 $title = SpecialPage
::getTitleFor( 'Badtitle', $value );
871 ApiQueryBase
::addTitleInfo( $value, $title, "{$name}_" );
876 $user = User
::newFromName( $value );
878 $value = $user->getName();
887 return [ $name => $value ];
892 * This class formats all log entries for log types
893 * which have not been converted to the new system.
894 * This is not about old log entries which store
895 * parameters in a different format - the new
896 * LogFormatter classes have code to support formatting
900 class LegacyLogFormatter
extends LogFormatter
{
902 * Backward compatibility for extension changing the comment from
903 * the LogLine hook. This will be set by the first call on getComment(),
904 * then it might be modified by the hook when calling getActionLinks(),
905 * so that the modified value will be returned when calling getComment()
910 private $comment = null;
913 * Cache for the result of getActionLinks() so that it does not need to
914 * run multiple times depending on the order that getComment() and
915 * getActionLinks() are called.
919 private $revert = null;
921 public function getComment() {
922 if ( $this->comment
=== null ) {
923 $this->comment
= parent
::getComment();
926 // Make sure we execute the LogLine hook so that we immediately return
927 // the correct value.
928 if ( $this->revert
=== null ) {
929 $this->getActionLinks();
932 return $this->comment
;
935 protected function getActionMessage() {
936 $entry = $this->entry
;
937 $action = LogPage
::actionText(
939 $entry->getSubtype(),
941 $this->plaintext ?
null : $this->context
->getSkin(),
942 (array)$entry->getParameters(),
943 !$this->plaintext
// whether to filter [[]] links
946 $performer = $this->getPerformerElement();
947 if ( !$this->irctext
) {
948 $sep = $this->msg( 'word-separator' );
949 $sep = $this->plaintext ?
$sep->text() : $sep->escaped();
950 $action = $performer . $sep . $action;
956 public function getActionLinks() {
957 if ( $this->revert
!== null ) {
958 return $this->revert
;
961 if ( $this->entry
->isDeleted( LogPage
::DELETED_ACTION
) ) {
963 return $this->revert
;
966 $title = $this->entry
->getTarget();
967 $type = $this->entry
->getType();
968 $subtype = $this->entry
->getSubtype();
970 // Do nothing. The implementation is handled by the hook modifiying the
971 // passed-by-ref parameters. This also changes the default value so that
972 // getComment() and getActionLinks() do not call them indefinitely.
975 // This is to populate the $comment member of this instance so that it
976 // can be modified when calling the hook just below.
977 if ( $this->comment
=== null ) {
981 $params = $this->entry
->getParameters();
983 Hooks
::run( 'LogLine', [ $type, $subtype, $title, $params,
984 &$this->comment
, &$this->revert
, $this->entry
->getTimestamp() ] );
986 return $this->revert
;