3 * Contain classes to list log entries
5 * Copyright © 2004 Brion Vibber <brion@pobox.com>
6 * https://www.mediawiki.org/
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License along
19 * with this program; if not, write to the Free Software Foundation, Inc.,
20 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21 * http://www.gnu.org/copyleft/gpl.html
26 use MediaWiki\Linker\LinkRenderer
;
27 use MediaWiki\MediaWikiServices
;
28 use Wikimedia\Rdbms\IDatabase
;
30 class LogEventsList
extends ContextSource
{
31 const NO_ACTION_LINK
= 1;
32 const NO_EXTRA_USER_LINKS
= 2;
33 const USE_CHECKBOXES
= 4;
40 protected $mDefaultQuery;
45 protected $showTagEditUI;
50 protected $allowedActions = null;
53 * @var LinkRenderer|null
55 private $linkRenderer;
58 * The first two parameters used to be $skin and $out, but now only a context
59 * is needed, that's why there's a second unused parameter.
61 * @param IContextSource|Skin $context Context to use; formerly it was
62 * a Skin object. Use of Skin is deprecated.
63 * @param LinkRenderer|null $linkRenderer previously unused
64 * @param int $flags Can be a combination of self::NO_ACTION_LINK,
65 * self::NO_EXTRA_USER_LINKS or self::USE_CHECKBOXES.
67 public function __construct( $context, $linkRenderer = null, $flags = 0 ) {
68 if ( $context instanceof IContextSource
) {
69 $this->setContext( $context );
71 // Old parameters, $context should be a Skin object
72 $this->setContext( $context->getContext() );
75 $this->flags
= $flags;
76 $this->showTagEditUI
= ChangeTags
::showTagEditingUI( $this->getUser() );
77 if ( $linkRenderer instanceof LinkRenderer
) {
78 $this->linkRenderer
= $linkRenderer;
84 * @return LinkRenderer
86 protected function getLinkRenderer() {
87 if ( $this->linkRenderer
!== null ) {
88 return $this->linkRenderer
;
90 return MediaWikiServices
::getInstance()->getLinkRenderer();
95 * Show options for the log list
97 * @param array|string $types
100 * @param bool $pattern
101 * @param int|string $year Use 0 to start with no year preselected.
102 * @param int|string $month A month in the 1..12 range. Use 0 to start with no month
104 * @param int|string $day A day in the 1..31 range. Use 0 to start with no month
106 * @param array|null $filter
107 * @param string $tagFilter Tag to select by default
108 * @param string|null $action
110 public function showOptions( $types = [], $user = '', $page = '', $pattern = false, $year = 0,
111 $month = 0, $day = 0, $filter = null, $tagFilter = '', $action = null
113 // For B/C, we take strings, but make sure they are converted...
114 $types = ( $types === '' ) ?
[] : (array)$types;
116 $formDescriptor = [];
119 $formDescriptor['type'] = $this->getTypeMenuDesc( $types );
120 $formDescriptor['user'] = $this->getUserInputDesc( $user );
121 $formDescriptor['page'] = $this->getTitleInputDesc( $page );
123 // Add extra inputs if any
124 // This could either be a form descriptor array or a string with raw HTML.
125 // We need it to work in both cases and show a deprecation warning if it
126 // is a string. See T199495.
127 $extraInputsDescriptor = $this->getExtraInputsDesc( $types );
129 is_array( $extraInputsDescriptor ) &&
130 !empty( $extraInputsDescriptor )
132 $formDescriptor[ 'extra' ] = $extraInputsDescriptor;
133 } elseif ( is_string( $extraInputsDescriptor ) ) {
134 // We'll add this to the footer of the form later
135 $extraInputsString = $extraInputsDescriptor;
136 wfDeprecated( 'Using $input in LogEventsListGetExtraInputs hook', '1.32' );
139 // Title pattern, if allowed
140 if ( !$this->getConfig()->get( 'MiserMode' ) ) {
141 $formDescriptor['pattern'] = $this->getTitlePatternDesc( $pattern );
145 $formDescriptor['date'] = [
147 'label-message' => 'date'
151 $formDescriptor['tagfilter'] = [
152 'type' => 'tagfilter',
153 'name' => 'tagfilter',
154 'label-raw' => $this->msg( 'tag-filter' )->parse(),
159 $formDescriptor['filters'] = $this->getFiltersDesc( $filter );
165 $this->allowedActions
!== null &&
166 count( $this->allowedActions
) > 0
168 $formDescriptor['subtype'] = $this->getActionSelectorDesc( $types, $action );
171 $context = new DerivativeContext( $this->getContext() );
172 $context->setTitle( SpecialPage
::getTitleFor( 'Log' ) ); // Remove subpage
173 $htmlForm = new HTMLForm( $formDescriptor, $context );
175 ->setSubmitText( $this->msg( 'logeventslist-submit' )->text() )
177 ->setWrapperLegendMsg( 'log' );
179 // TODO This will should be removed at some point. See T199495.
180 if ( isset( $extraInputsString ) ) {
181 $htmlForm->addFooterText( Html
::rawElement(
188 $htmlForm->prepareForm()->displayForm( false );
192 * @param array $filter
193 * @return array Form descriptor
195 private function getFiltersDesc( $filter ) {
198 foreach ( $filter as $type => $val ) {
199 $message = $this->msg( "logeventslist-{$type}-log" );
200 // FIXME: Remove this check once T199657 is fully resolved.
201 if ( !$message->exists() ) {
202 $message = $this->msg( "log-show-hide-{$type}" )->params( $this->msg( 'show' )->text() );
204 $options[ $message->text() ] = $type;
206 if ( $val === false ) {
211 'class' => 'HTMLMultiSelectField',
212 'label-message' => 'logeventslist-more-filters',
214 'options' => $options,
215 'default' => $default,
219 private function getDefaultQuery() {
220 if ( !isset( $this->mDefaultQuery
) ) {
221 $this->mDefaultQuery
= $this->getRequest()->getQueryValues();
222 unset( $this->mDefaultQuery
['title'] );
223 unset( $this->mDefaultQuery
['dir'] );
224 unset( $this->mDefaultQuery
['offset'] );
225 unset( $this->mDefaultQuery
['limit'] );
226 unset( $this->mDefaultQuery
['order'] );
227 unset( $this->mDefaultQuery
['month'] );
228 unset( $this->mDefaultQuery
['year'] );
231 return $this->mDefaultQuery
;
235 * @param array $queryTypes
236 * @return array Form descriptor
238 private function getTypeMenuDesc( $queryTypes ) {
239 $queryType = count( $queryTypes ) == 1 ?
$queryTypes[0] : '';
241 $typesByName = []; // Temporary array
242 // First pass to load the log names
243 foreach ( LogPage
::validTypes() as $type ) {
244 $page = new LogPage( $type );
245 $restriction = $page->getRestriction();
246 if ( $this->getUser()->isAllowed( $restriction ) ) {
247 $typesByName[$type] = $page->getName()->text();
251 // Second pass to sort by name
252 asort( $typesByName );
254 // Always put "All public logs" on top
255 $public = $typesByName[''];
256 unset( $typesByName[''] );
257 $typesByName = [ '' => $public ] +
$typesByName;
260 'class' => 'HTMLSelectField',
262 'options' => array_flip( $typesByName ),
263 'default' => $queryType,
268 * @param string $user
269 * @return array Form descriptor
271 private function getUserInputDesc( $user ) {
273 'class' => 'HTMLUserTextField',
274 'label-message' => 'specialloguserlabel',
281 * @param string $title
282 * @return array Form descriptor
284 private function getTitleInputDesc( $title ) {
286 'class' => 'HTMLTitleTextField',
287 'label-message' => 'speciallogtitlelabel',
294 * @param bool $pattern
295 * @return array Form descriptor
297 private function getTitlePatternDesc( $pattern ) {
300 'label-message' => 'log-title-wildcard',
306 * @param array $types
307 * @return array|string Form descriptor or string with HTML
309 private function getExtraInputsDesc( $types ) {
310 if ( count( $types ) == 1 ) {
311 if ( $types[0] == 'suppress' ) {
314 'label-message' => 'revdelete-offender',
315 'name' => 'offender',
318 // Allow extensions to add their own extra inputs
319 // This could be an array or string. See T199495.
320 $input = ''; // Deprecated
321 $formDescriptor = [];
322 Hooks
::run( 'LogEventsListGetExtraInputs', [ $types[0], $this, &$input, &$formDescriptor ] );
324 return empty( $formDescriptor ) ?
$input : $formDescriptor;
332 * Drop down menu for selection of actions that can be used to filter the log
333 * @param array $types
334 * @param string $action
335 * @return array Form descriptor
337 private function getActionSelectorDesc( $types, $action ) {
339 $actionOptions[ 'log-action-filter-all' ] = '';
341 foreach ( $this->allowedActions
as $value ) {
342 $msgKey = 'log-action-filter-' . $types[0] . '-' . $value;
343 $actionOptions[ $msgKey ] = $value;
347 'class' => 'HTMLSelectField',
349 'options-messages' => $actionOptions,
350 'default' => $action,
351 'label' => $this->msg( 'log-action-filter-' . $types[0] )->text(),
356 * Sets the action types allowed for log filtering
357 * To one action type may correspond several log_actions
358 * @param array $actions
361 public function setAllowedActions( $actions ) {
362 $this->allowedActions
= $actions;
368 public function beginLogEventsList() {
375 public function endLogEventsList() {
380 * @param stdClass $row A single row from the result set
381 * @return string Formatted HTML list item
383 public function logLine( $row ) {
384 $entry = DatabaseLogEntry
::newFromRow( $row );
385 $formatter = LogFormatter
::newFromEntry( $entry );
386 $formatter->setContext( $this->getContext() );
387 $formatter->setLinkRenderer( $this->getLinkRenderer() );
388 $formatter->setShowUserToolLinks( !( $this->flags
& self
::NO_EXTRA_USER_LINKS
) );
390 $time = htmlspecialchars( $this->getLanguage()->userTimeAndDate(
391 $entry->getTimestamp(), $this->getUser() ) );
393 $action = $formatter->getActionText();
395 if ( $this->flags
& self
::NO_ACTION_LINK
) {
398 $revert = $formatter->getActionLinks();
399 if ( $revert != '' ) {
400 $revert = '<span class="mw-logevent-actionlink">' . $revert . '</span>';
404 $comment = $formatter->getComment();
406 // Some user can hide log items and have review links
407 $del = $this->getShowHideLinks( $row );
410 list( $tagDisplay, $newClasses ) = ChangeTags
::formatSummaryRow(
415 $classes = array_merge(
416 [ 'mw-logline-' . $entry->getType() ],
420 'data-mw-logid' => $entry->getId(),
421 'data-mw-logaction' => $entry->getFullType(),
423 $ret = "$del $time $action $comment $revert $tagDisplay";
425 // Let extensions add data
426 Hooks
::run( 'LogEventsListLineEnding', [ $this, &$ret, $entry, &$classes, &$attribs ] );
427 $attribs = array_filter( $attribs,
428 [ Sanitizer
::class, 'isReservedDataAttribute' ],
431 $attribs['class'] = implode( ' ', $classes );
433 return Html
::rawElement( 'li', $attribs, $ret ) . "\n";
437 * @param stdClass $row
440 private function getShowHideLinks( $row ) {
441 // We don't want to see the links and
442 if ( $this->flags
== self
::NO_ACTION_LINK
) {
446 $user = $this->getUser();
448 // If change tag editing is available to this user, return the checkbox
449 if ( $this->flags
& self
::USE_CHECKBOXES
&& $this->showTagEditUI
) {
453 [ 'name' => 'ids[' . $row->log_id
. ']' ]
457 // no one can hide items from the suppress log.
458 if ( $row->log_type
== 'suppress' ) {
463 // Don't show useless checkbox to people who cannot hide log entries
464 if ( $user->isAllowed( 'deletedhistory' ) ) {
465 $canHide = $user->isAllowed( 'deletelogentry' );
466 $canViewSuppressedOnly = $user->isAllowed( 'viewsuppressed' ) &&
467 !$user->isAllowed( 'suppressrevision' );
468 $entryIsSuppressed = self
::isDeleted( $row, LogPage
::DELETED_RESTRICTED
);
469 $canViewThisSuppressedEntry = $canViewSuppressedOnly && $entryIsSuppressed;
470 if ( $row->log_deleted ||
$canHide ) {
471 // Show checkboxes instead of links.
472 if ( $canHide && $this->flags
& self
::USE_CHECKBOXES
&& !$canViewThisSuppressedEntry ) {
473 // If event was hidden from sysops
474 if ( !self
::userCan( $row, LogPage
::DELETED_RESTRICTED
, $user ) ) {
475 $del = Xml
::check( 'deleterevisions', false, [ 'disabled' => 'disabled' ] );
480 [ 'name' => 'ids[' . $row->log_id
. ']' ]
484 // If event was hidden from sysops
485 if ( !self
::userCan( $row, LogPage
::DELETED_RESTRICTED
, $user ) ) {
486 $del = Linker
::revDeleteLinkDisabled( $canHide );
489 'target' => SpecialPage
::getTitleFor( 'Log', $row->log_type
)->getPrefixedDBkey(),
491 'ids' => $row->log_id
,
493 $del = Linker
::revDeleteLink(
496 $canHide && !$canViewThisSuppressedEntry
507 * @param stdClass $row
508 * @param string|array $type
509 * @param string|array $action
510 * @param string $right
513 public static function typeAction( $row, $type, $action, $right = '' ) {
514 $match = is_array( $type ) ?
515 in_array( $row->log_type
, $type ) : $row->log_type
== $type;
517 $match = is_array( $action ) ?
518 in_array( $row->log_action
, $action ) : $row->log_action
== $action;
519 if ( $match && $right ) {
521 $match = $wgUser->isAllowed( $right );
529 * Determine if the current user is allowed to view a particular
530 * field of this log row, if it's marked as deleted.
532 * @param stdClass $row
534 * @param User|null $user User to check, or null to use $wgUser
537 public static function userCan( $row, $field, User
$user = null ) {
538 return self
::userCanBitfield( $row->log_deleted
, $field, $user );
542 * Determine if the current user is allowed to view a particular
543 * field of this log row, if it's marked as deleted.
545 * @param int $bitfield Current field
547 * @param User|null $user User to check, or null to use $wgUser
550 public static function userCanBitfield( $bitfield, $field, User
$user = null ) {
551 if ( $bitfield & $field ) {
552 if ( $user === null ) {
556 if ( $bitfield & LogPage
::DELETED_RESTRICTED
) {
557 $permissions = [ 'suppressrevision', 'viewsuppressed' ];
559 $permissions = [ 'deletedhistory' ];
561 $permissionlist = implode( ', ', $permissions );
562 wfDebug( "Checking for $permissionlist due to $field match on $bitfield\n" );
563 return $user->isAllowedAny( ...$permissions );
569 * @param stdClass $row
570 * @param int $field One of DELETED_* bitfield constants
573 public static function isDeleted( $row, $field ) {
574 return ( $row->log_deleted
& $field ) == $field;
578 * Show log extract. Either with text and a box (set $msgKey) or without (don't set $msgKey)
580 * @param OutputPage|string &$out
581 * @param string|array $types Log types to show
582 * @param string|Title $page The page title to show log entries for
583 * @param string $user The user who made the log entries
584 * @param array $param Associative Array with the following additional options:
585 * - lim Integer Limit of items to show, default is 50
586 * - conds Array Extra conditions for the query
587 * (e.g. 'log_action != ' . $dbr->addQuotes( 'revision' ))
588 * - showIfEmpty boolean Set to false if you don't want any output in case the loglist is empty
589 * if set to true (default), "No matching items in log" is displayed if loglist is empty
590 * - msgKey Array If you want a nice box with a message, set this to the key of the message.
591 * First element is the message key, additional optional elements are parameters for the key
592 * that are processed with wfMessage
593 * - offset Set to overwrite offset parameter in WebRequest
594 * set to '' to unset offset
595 * - wrap String Wrap the message in html (usually something like "<div ...>$1</div>").
596 * - flags Integer display flags (NO_ACTION_LINK,NO_EXTRA_USER_LINKS)
597 * - useRequestParams boolean Set true to use Pager-related parameters in the WebRequest
598 * - useMaster boolean Use master DB
599 * - extraUrlParams array|bool Additional url parameters for "full log" link (if it is shown)
600 * @return int Number of total log items (not limited by $lim)
602 public static function showLogExtract(
603 &$out, $types = [], $page = '', $user = '', $param = []
605 $defaultParameters = [
608 'showIfEmpty' => true,
612 'useRequestParams' => false,
613 'useMaster' => false,
614 'extraUrlParams' => false,
616 # The + operator appends elements of remaining keys from the right
617 # handed array to the left handed, whereas duplicated keys are NOT overwritten.
618 $param +
= $defaultParameters;
619 # Convert $param array to individual variables
620 $lim = $param['lim'];
621 $conds = $param['conds'];
622 $showIfEmpty = $param['showIfEmpty'];
623 $msgKey = $param['msgKey'];
624 $wrap = $param['wrap'];
625 $flags = $param['flags'];
626 $extraUrlParams = $param['extraUrlParams'];
628 $useRequestParams = $param['useRequestParams'];
629 if ( !is_array( $msgKey ) ) {
630 $msgKey = [ $msgKey ];
633 if ( $out instanceof OutputPage
) {
634 $context = $out->getContext();
636 $context = RequestContext
::getMain();
639 // FIXME: Figure out how to inject this
640 $linkRenderer = MediaWikiServices
::getInstance()->getLinkRenderer();
642 # Insert list of top 50 (or top $lim) items
643 $loglist = new LogEventsList( $context, $linkRenderer, $flags );
644 $pager = new LogPager( $loglist, $types, $user, $page, '', $conds );
645 if ( !$useRequestParams ) {
646 # Reset vars that may have been taken from the request
648 $pager->mDefaultLimit
= 50;
649 $pager->mOffset
= "";
650 $pager->mIsBackwards
= false;
653 if ( $param['useMaster'] ) {
654 $pager->mDb
= wfGetDB( DB_MASTER
);
656 if ( isset( $param['offset'] ) ) { # Tell pager to ignore WebRequest offset
657 $pager->setOffset( $param['offset'] );
661 $pager->mLimit
= $lim;
663 // Fetch the log rows and build the HTML if needed
664 $logBody = $pager->getBody();
665 $numRows = $pager->getNumRows();
671 $dir = $context->getLanguage()->getDir();
672 $lang = $context->getLanguage()->getHtmlCode();
674 $s = Xml
::openElement( 'div', [
675 'class' => "mw-warning-with-logexcerpt mw-content-$dir",
680 if ( count( $msgKey ) == 1 ) {
681 $s .= $context->msg( $msgKey[0] )->parseAsBlock();
682 } else { // Process additional arguments
684 array_shift( $args );
685 $s .= $context->msg( $msgKey[0], $args )->parseAsBlock();
688 $s .= $loglist->beginLogEventsList() .
690 $loglist->endLogEventsList();
691 } elseif ( $showIfEmpty ) {
692 $s = Html
::rawElement( 'div', [ 'class' => 'mw-warning-logempty' ],
693 $context->msg( 'logempty' )->parse() );
696 if ( $numRows > $pager->mLimit
) { # Show "Full log" link
698 if ( $page instanceof Title
) {
699 $urlParam['page'] = $page->getPrefixedDBkey();
700 } elseif ( $page != '' ) {
701 $urlParam['page'] = $page;
705 $urlParam['user'] = $user;
708 if ( !is_array( $types ) ) { # Make it an array, if it isn't
712 # If there is exactly one log type, we can link to Special:Log?type=foo
713 if ( count( $types ) == 1 ) {
714 $urlParam['type'] = $types[0];
717 if ( $extraUrlParams !== false ) {
718 $urlParam = array_merge( $urlParam, $extraUrlParams );
721 $s .= $linkRenderer->makeKnownLink(
722 SpecialPage
::getTitleFor( 'Log' ),
723 $context->msg( 'log-fulllog' )->text(),
729 if ( $logBody && $msgKey[0] ) {
733 if ( $wrap != '' ) { // Wrap message in html
734 $s = str_replace( '$1', $s, $wrap );
737 /* hook can return false, if we don't want the message to be emitted (Wikia BugId:7093) */
738 if ( Hooks
::run( 'LogEventsListShowLogExtract', [ &$s, $types, $page, $user, $param ] ) ) {
739 // $out can be either an OutputPage object or a String-by-reference
740 if ( $out instanceof OutputPage
) {
751 * SQL clause to skip forbidden log types for this user
753 * @param IDatabase $db
754 * @param string $audience Public/user
755 * @param User|null $user User to check, or null to use $wgUser
756 * @return string|bool String on success, false on failure.
758 public static function getExcludeClause( $db, $audience = 'public', User
$user = null ) {
759 global $wgLogRestrictions;
761 if ( $audience != 'public' && $user === null ) {
766 // Reset the array, clears extra "where" clauses when $par is used
769 // Don't show private logs to unprivileged users
770 foreach ( $wgLogRestrictions as $logType => $right ) {
771 if ( $audience == 'public' ||
!$user->isAllowed( $right ) ) {
772 $hiddenLogs[] = $logType;
775 if ( count( $hiddenLogs ) == 1 ) {
776 return 'log_type != ' . $db->addQuotes( $hiddenLogs[0] );
777 } elseif ( $hiddenLogs ) {
778 return 'log_type NOT IN (' . $db->makeList( $hiddenLogs ) . ')';