3 * Contain classes to list log entries
5 * Copyright © 2004 Brion Vibber <brion@pobox.com>, 2008 Aaron Schulz
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 class LogEventsList
extends ContextSource
{
27 const NO_ACTION_LINK
= 1;
28 const NO_EXTRA_USER_LINKS
= 2;
29 const USE_REVDEL_CHECKBOXES
= 4;
36 protected $mDefaultQuery;
40 * The first two parameters used to be $skin and $out, but now only a context
41 * is needed, that's why there's a second unused parameter.
43 * @param IContextSource|Skin $context Context to use; formerly it was
44 * a Skin object. Use of Skin is deprecated.
45 * @param null $unused Unused; used to be an OutputPage object.
46 * @param int $flags Can be a combination of self::NO_ACTION_LINK,
47 * self::NO_EXTRA_USER_LINKS or self::USE_REVDEL_CHECKBOXES.
49 public function __construct( $context, $unused = null, $flags = 0 ) {
50 if ( $context instanceof IContextSource
) {
51 $this->setContext( $context );
53 // Old parameters, $context should be a Skin object
54 $this->setContext( $context->getContext() );
57 $this->flags
= $flags;
61 * Show options for the log list
63 * @param array|string $types
66 * @param string $pattern
67 * @param int $year Year
68 * @param int $month Month
69 * @param array $filter
70 * @param string $tagFilter Tag to select by default
72 public function showOptions( $types = array(), $user = '', $page = '', $pattern = '', $year = 0,
73 $month = 0, $filter = null, $tagFilter = ''
75 global $wgScript, $wgMiserMode;
77 $title = SpecialPage
::getTitleFor( 'Log' );
79 // For B/C, we take strings, but make sure they are converted...
80 $types = ( $types === '' ) ?
array() : (array)$types;
82 $tagSelector = ChangeTags
::buildTagFilterSelector( $tagFilter );
84 $html = Html
::hidden( 'title', $title->getPrefixedDBkey() );
87 $html .= $this->getTypeMenu( $types ) . "\n";
88 $html .= $this->getUserInput( $user ) . "\n";
89 $html .= $this->getTitleInput( $page ) . "\n";
90 $html .= $this->getExtraInputs( $types ) . "\n";
92 // Title pattern, if allowed
93 if ( !$wgMiserMode ) {
94 $html .= $this->getTitlePattern( $pattern ) . "\n";
98 $html .= Xml
::tags( 'p', null, Xml
::dateMenu( (int)$year, (int)$month ) );
101 if ( $tagSelector ) {
102 $html .= Xml
::tags( 'p', null, implode( ' ', $tagSelector ) );
107 $html .= Xml
::tags( 'p', null, $this->getFilterLinks( $filter ) );
111 $html .= Xml
::submitButton( $this->msg( 'allpagessubmit' )->text() );
114 $html = Xml
::fieldset( $this->msg( 'log' )->text(), $html );
117 $html = Xml
::tags( 'form', array( 'action' => $wgScript, 'method' => 'get' ), $html );
119 $this->getOutput()->addHTML( $html );
123 * @param array $filter
124 * @return string Formatted HTML
126 private function getFilterLinks( $filter ) {
128 $messages = array( $this->msg( 'show' )->escaped(), $this->msg( 'hide' )->escaped() );
129 // Option value -> message mapping
131 $hiddens = ''; // keep track for "go" button
132 foreach ( $filter as $type => $val ) {
133 // Should the below assignment be outside the foreach?
134 // Then it would have to be copied. Not certain what is more expensive.
135 $query = $this->getDefaultQuery();
136 $queryKey = "hide_{$type}_log";
138 $hideVal = 1 - intval( $val );
139 $query[$queryKey] = $hideVal;
141 $link = Linker
::linkKnown(
148 // Message: log-show-hide-patrol
149 $links[$type] = $this->msg( "log-show-hide-{$type}" )->rawParams( $link )->escaped();
150 $hiddens .= Html
::hidden( "hide_{$type}_log", $val ) . "\n";
154 return '<small>' . $this->getLanguage()->pipeList( $links ) . '</small>' . $hiddens;
157 private function getDefaultQuery() {
158 if ( !isset( $this->mDefaultQuery
) ) {
159 $this->mDefaultQuery
= $this->getRequest()->getQueryValues();
160 unset( $this->mDefaultQuery
['title'] );
161 unset( $this->mDefaultQuery
['dir'] );
162 unset( $this->mDefaultQuery
['offset'] );
163 unset( $this->mDefaultQuery
['limit'] );
164 unset( $this->mDefaultQuery
['order'] );
165 unset( $this->mDefaultQuery
['month'] );
166 unset( $this->mDefaultQuery
['year'] );
169 return $this->mDefaultQuery
;
173 * @param array $queryTypes
174 * @return string Formatted HTML
176 private function getTypeMenu( $queryTypes ) {
177 $queryType = count( $queryTypes ) == 1 ?
$queryTypes[0] : '';
178 $selector = $this->getTypeSelector();
179 $selector->setDefault( $queryType );
181 return $selector->getHtml();
185 * Returns log page selector.
189 public function getTypeSelector() {
190 $typesByName = array(); // Temporary array
191 // First pass to load the log names
192 foreach ( LogPage
::validTypes() as $type ) {
193 $page = new LogPage( $type );
194 $restriction = $page->getRestriction();
195 if ( $this->getUser()->isAllowed( $restriction ) ) {
196 $typesByName[$type] = $page->getName()->text();
200 // Second pass to sort by name
201 asort( $typesByName );
203 // Always put "All public logs" on top
204 $public = $typesByName[''];
205 unset( $typesByName[''] );
206 $typesByName = array( '' => $public ) +
$typesByName;
208 $select = new XmlSelect( 'type' );
209 foreach ( $typesByName as $type => $name ) {
210 $select->addOption( $name, $type );
217 * @param string $user
218 * @return string Formatted HTML
220 private function getUserInput( $user ) {
221 $label = Xml
::inputLabel(
222 $this->msg( 'specialloguserlabel' )->text(),
227 array( 'class' => 'mw-autocomplete-user' )
230 return '<span style="white-space: nowrap">' . $label . '</span>';
234 * @param string $title
235 * @return string Formatted HTML
237 private function getTitleInput( $title ) {
238 $label = Xml
::inputLabel(
239 $this->msg( 'speciallogtitlelabel' )->text(),
246 return '<span style="white-space: nowrap">' . $label . '</span>';
250 * @param string $pattern
251 * @return string Checkbox
253 private function getTitlePattern( $pattern ) {
254 return '<span style="white-space: nowrap">' .
255 Xml
::checkLabel( $this->msg( 'log-title-wildcard' )->text(), 'pattern', 'pattern', $pattern ) .
260 * @param array $types
263 private function getExtraInputs( $types ) {
264 $offender = $this->getRequest()->getVal( 'offender' );
265 $user = User
::newFromName( $offender, false );
266 if ( !$user ||
( $user->getId() == 0 && !IP
::isIPAddress( $offender ) ) ) {
267 $offender = ''; // Blank field if invalid
269 if ( count( $types ) == 1 && $types[0] == 'suppress' ) {
270 return Xml
::inputLabel( $this->msg( 'revdelete-offender' )->text(), 'offender',
271 'mw-log-offender', 20, $offender );
280 public function beginLogEventsList() {
287 public function endLogEventsList() {
292 * @param stdClass $row A single row from the result set
293 * @return string Formatted HTML list item
295 public function logLine( $row ) {
296 $entry = DatabaseLogEntry
::newFromRow( $row );
297 $formatter = LogFormatter
::newFromEntry( $entry );
298 $formatter->setContext( $this->getContext() );
299 $formatter->setShowUserToolLinks( !( $this->flags
& self
::NO_EXTRA_USER_LINKS
) );
301 $time = htmlspecialchars( $this->getLanguage()->userTimeAndDate(
302 $entry->getTimestamp(), $this->getUser() ) );
304 $action = $formatter->getActionText();
306 if ( $this->flags
& self
::NO_ACTION_LINK
) {
309 $revert = $formatter->getActionLinks();
310 if ( $revert != '' ) {
311 $revert = '<span class="mw-logevent-actionlink">' . $revert . '</span>';
315 $comment = $formatter->getComment();
317 // Some user can hide log items and have review links
318 $del = $this->getShowHideLinks( $row );
321 list( $tagDisplay, $newClasses ) = ChangeTags
::formatSummaryRow( $row->ts_tags
, 'logevent' );
322 $classes = array_merge(
323 array( 'mw-logline-' . $entry->getType() ),
327 return Html
::rawElement( 'li', array( 'class' => $classes ),
328 "$del $time $action $comment $revert $tagDisplay" ) . "\n";
332 * @param stdClass $row Row
335 private function getShowHideLinks( $row ) {
336 // We don't want to see the links and
337 // no one can hide items from the suppress log.
338 if ( ( $this->flags
== self
::NO_ACTION_LINK
)
339 ||
$row->log_type
== 'suppress'
344 $user = $this->getUser();
345 // Don't show useless checkbox to people who cannot hide log entries
346 if ( $user->isAllowed( 'deletedhistory' ) ) {
347 $canHide = $user->isAllowed( 'deletelogentry' );
348 $canViewSuppressedOnly = $user->isAllowed( 'viewsuppressed' ) &&
349 !$user->isAllowed( 'suppressrevision' );
350 $entryIsSuppressed = self
::isDeleted( $row, LogPage
::DELETED_RESTRICTED
);
351 $canViewThisSuppressedEntry = $canViewSuppressedOnly && $entryIsSuppressed;
352 if ( $row->log_deleted ||
$canHide ) {
353 // Show checkboxes instead of links.
354 if ( $canHide && $this->flags
& self
::USE_REVDEL_CHECKBOXES
&& !$canViewThisSuppressedEntry ) {
355 // If event was hidden from sysops
356 if ( !self
::userCan( $row, LogPage
::DELETED_RESTRICTED
, $user ) ) {
357 $del = Xml
::check( 'deleterevisions', false, array( 'disabled' => 'disabled' ) );
362 array( 'name' => 'ids[' . $row->log_id
. ']' )
366 // If event was hidden from sysops
367 if ( !self
::userCan( $row, LogPage
::DELETED_RESTRICTED
, $user ) ) {
368 $del = Linker
::revDeleteLinkDisabled( $canHide );
371 'target' => SpecialPage
::getTitleFor( 'Log', $row->log_type
)->getPrefixedDBkey(),
373 'ids' => $row->log_id
,
375 $del = Linker
::revDeleteLink(
378 $canHide && !$canViewThisSuppressedEntry
389 * @param stdClass $row Row
390 * @param string|array $type
391 * @param string|array $action
392 * @param string $right
395 public static function typeAction( $row, $type, $action, $right = '' ) {
396 $match = is_array( $type ) ?
397 in_array( $row->log_type
, $type ) : $row->log_type
== $type;
399 $match = is_array( $action ) ?
400 in_array( $row->log_action
, $action ) : $row->log_action
== $action;
401 if ( $match && $right ) {
403 $match = $wgUser->isAllowed( $right );
411 * Determine if the current user is allowed to view a particular
412 * field of this log row, if it's marked as deleted.
414 * @param stdClass $row Row
416 * @param User $user User to check, or null to use $wgUser
419 public static function userCan( $row, $field, User
$user = null ) {
420 return self
::userCanBitfield( $row->log_deleted
, $field, $user );
424 * Determine if the current user is allowed to view a particular
425 * field of this log row, if it's marked as deleted.
427 * @param int $bitfield Current field
429 * @param User $user User to check, or null to use $wgUser
432 public static function userCanBitfield( $bitfield, $field, User
$user = null ) {
433 if ( $bitfield & $field ) {
434 if ( $user === null ) {
438 if ( $bitfield & LogPage
::DELETED_RESTRICTED
) {
439 $permissions = array( 'suppressrevision', 'viewsuppressed' );
441 $permissions = array( 'deletedhistory' );
443 $permissionlist = implode( ', ', $permissions );
444 wfDebug( "Checking for $permissionlist due to $field match on $bitfield\n" );
445 return call_user_func_array( array( $user, 'isAllowedAny' ), $permissions );
451 * @param stdClass $row Row
452 * @param int $field One of DELETED_* bitfield constants
455 public static function isDeleted( $row, $field ) {
456 return ( $row->log_deleted
& $field ) == $field;
460 * Show log extract. Either with text and a box (set $msgKey) or without (don't set $msgKey)
462 * @param OutputPage|string $out By-reference
463 * @param string|array $types Log types to show
464 * @param string|Title $page The page title to show log entries for
465 * @param string $user The user who made the log entries
466 * @param array $param Associative Array with the following additional options:
467 * - lim Integer Limit of items to show, default is 50
468 * - conds Array Extra conditions for the query (e.g. "log_action != 'revision'")
469 * - showIfEmpty boolean Set to false if you don't want any output in case the loglist is empty
470 * if set to true (default), "No matching items in log" is displayed if loglist is empty
471 * - msgKey Array If you want a nice box with a message, set this to the key of the message.
472 * First element is the message key, additional optional elements are parameters for the key
473 * that are processed with wfMessage
474 * - offset Set to overwrite offset parameter in WebRequest
475 * set to '' to unset offset
476 * - wrap String Wrap the message in html (usually something like "<div ...>$1</div>").
477 * - flags Integer display flags (NO_ACTION_LINK,NO_EXTRA_USER_LINKS)
478 * - useRequestParams boolean Set true to use Pager-related parameters in the WebRequest
479 * - useMaster boolean Use master DB
480 * @return int Number of total log items (not limited by $lim)
482 public static function showLogExtract(
483 &$out, $types = array(), $page = '', $user = '', $param = array()
485 $defaultParameters = array(
488 'showIfEmpty' => true,
489 'msgKey' => array( '' ),
492 'useRequestParams' => false,
493 'useMaster' => false,
495 # The + operator appends elements of remaining keys from the right
496 # handed array to the left handed, whereas duplicated keys are NOT overwritten.
497 $param +
= $defaultParameters;
498 # Convert $param array to individual variables
499 $lim = $param['lim'];
500 $conds = $param['conds'];
501 $showIfEmpty = $param['showIfEmpty'];
502 $msgKey = $param['msgKey'];
503 $wrap = $param['wrap'];
504 $flags = $param['flags'];
505 $useRequestParams = $param['useRequestParams'];
506 if ( !is_array( $msgKey ) ) {
507 $msgKey = array( $msgKey );
510 if ( $out instanceof OutputPage
) {
511 $context = $out->getContext();
513 $context = RequestContext
::getMain();
516 # Insert list of top 50 (or top $lim) items
517 $loglist = new LogEventsList( $context, null, $flags );
518 $pager = new LogPager( $loglist, $types, $user, $page, '', $conds );
519 if ( !$useRequestParams ) {
520 # Reset vars that may have been taken from the request
522 $pager->mDefaultLimit
= 50;
523 $pager->mOffset
= "";
524 $pager->mIsBackwards
= false;
527 if ( $param['useMaster'] ) {
528 $pager->mDb
= wfGetDB( DB_MASTER
);
530 if ( isset( $param['offset'] ) ) { # Tell pager to ignore WebRequest offset
531 $pager->setOffset( $param['offset'] );
535 $pager->mLimit
= $lim;
539 // Check if we can avoid the DB query all together
540 if ( $page !== '' && !$param['useMaster'] ) {
541 $title = ( $page instanceof Title
) ?
$page : Title
::newFromText( $page );
543 $member = $title->getNamespace() . ':' . $title->getDBkey();
544 if ( !BloomCache
::get( 'main' )->check( wfWikiId(), 'TitleHasLogs', $member ) ) {
552 // Fetch the log rows and build the HTML if needed
553 $logBody = ( $logBody === null ) ?
$pager->getBody() : $logBody;
559 $dir = $context->getLanguage()->getDir();
560 $lang = $context->getLanguage()->getCode();
562 $s = Xml
::openElement( 'div', array(
563 'class' => "mw-warning-with-logexcerpt mw-content-$dir",
568 if ( count( $msgKey ) == 1 ) {
569 $s .= $context->msg( $msgKey[0] )->parseAsBlock();
570 } else { // Process additional arguments
572 array_shift( $args );
573 $s .= $context->msg( $msgKey[0], $args )->parseAsBlock();
576 $s .= $loglist->beginLogEventsList() .
578 $loglist->endLogEventsList();
579 } elseif ( $showIfEmpty ) {
580 $s = Html
::rawElement( 'div', array( 'class' => 'mw-warning-logempty' ),
581 $context->msg( 'logempty' )->parse() );
584 if ( $pager->getNumRows() > $pager->mLimit
) { # Show "Full log" link
586 if ( $page instanceof Title
) {
587 $urlParam['page'] = $page->getPrefixedDBkey();
588 } elseif ( $page != '' ) {
589 $urlParam['page'] = $page;
593 $urlParam['user'] = $user;
596 if ( !is_array( $types ) ) { # Make it an array, if it isn't
597 $types = array( $types );
600 # If there is exactly one log type, we can link to Special:Log?type=foo
601 if ( count( $types ) == 1 ) {
602 $urlParam['type'] = $types[0];
606 SpecialPage
::getTitleFor( 'Log' ),
607 $context->msg( 'log-fulllog' )->escaped(),
613 if ( $logBody && $msgKey[0] ) {
617 if ( $wrap != '' ) { // Wrap message in html
618 $s = str_replace( '$1', $s, $wrap );
621 /* hook can return false, if we don't want the message to be emitted (Wikia BugId:7093) */
622 if ( wfRunHooks( 'LogEventsListShowLogExtract', array( &$s, $types, $page, $user, $param ) ) ) {
623 // $out can be either an OutputPage object or a String-by-reference
624 if ( $out instanceof OutputPage
) {
631 return $pager->getNumRows();
635 * SQL clause to skip forbidden log types for this user
637 * @param DatabaseBase $db
638 * @param string $audience Public/user
639 * @param User $user User to check, or null to use $wgUser
640 * @return string|bool String on success, false on failure.
642 public static function getExcludeClause( $db, $audience = 'public', User
$user = null ) {
643 global $wgLogRestrictions;
645 if ( $audience != 'public' && $user === null ) {
650 // Reset the array, clears extra "where" clauses when $par is used
651 $hiddenLogs = array();
653 // Don't show private logs to unprivileged users
654 foreach ( $wgLogRestrictions as $logType => $right ) {
655 if ( $audience == 'public' ||
!$user->isAllowed( $right ) ) {
656 $hiddenLogs[] = $logType;
659 if ( count( $hiddenLogs ) == 1 ) {
660 return 'log_type != ' . $db->addQuotes( $hiddenLogs[0] );
661 } elseif ( $hiddenLogs ) {
662 return 'log_type NOT IN (' . $db->makeList( $hiddenLogs ) . ')';