includes/logging/LogEventsList.php

   1 <?php
   2 /**
   3  * Contain classes to list log entries
   4  *
   5  * Copyright © 2004 Brion Vibber <brion@pobox.com>, 2008 Aaron Schulz
   6  * http://www.mediawiki.org/
   7  *
   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.
  12  *
  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.
  17  *
  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
  22  *
  23  * @file
  24  */
  25
  26 class LogEventsList {
  27         const NO_ACTION_LINK = 1;
  28         const NO_EXTRA_USER_LINKS = 2;
  29
  30         /**
  31          * @var Skin
  32          */
  33         private $skin;
  34
  35         /**
  36          * @var OutputPage
  37          */
  38         private $out;
  39         public $flags;
  40
  41         /**
  42          * @var Array
  43          */
  44         protected $message;
  45
  46         /**
  47          * @var Array
  48          */
  49         protected $mDefaultQuery;
  50
  51         public function __construct( $skin, $out, $flags = 0 ) {
  52                 $this->skin = $skin;
  53                 $this->out = $out;
  54                 $this->flags = $flags;
  55                 $this->preCacheMessages();
  56         }
  57
  58         /**
  59          * As we use the same small set of messages in various methods and that
  60          * they are called often, we call them once and save them in $this->message
  61          */
  62         private function preCacheMessages() {
  63                 // Precache various messages
  64                 if( !isset( $this->message ) ) {
  65                         $messages = array( 'revertmerge', 'protect_change', 'unblocklink', 'change-blocklink',
  66                                 'revertmove', 'undeletelink', 'undeleteviewlink', 'revdel-restore', 'hist', 'diff',
  67                                 'pipe-separator', 'revdel-restore-deleted', 'revdel-restore-visible' );
  68                         foreach( $messages as $msg ) {
  69                                 $this->message[$msg] = wfMsgExt( $msg, array( 'escapenoentities' ) );
  70                         }
  71                 }
  72         }
  73
  74         /**
  75          * Set page title and show header for this log type
  76          * @param $type Array
  77          * @deprecated in 1.19
  78          */
  79         public function showHeader( $type ) {
  80                 wfDeprecated( __METHOD__, '1.19' );
  81                 // If only one log type is used, then show a special message...
  82                 $headerType = (count($type) == 1) ? $type[0] : '';
  83                 if( LogPage::isLogType( $headerType ) ) {
  84                         $page = new LogPage( $headerType );
  85                         $this->out->setPageTitle( $page->getName()->text() );
  86                         $this->out->addHTML( $page->getDescription()->parseAsBlock() );
  87                 } else {
  88                         $this->out->addHTML( wfMsgExt('alllogstext',array('parseinline')) );
  89                 }
  90         }
  91
  92         /**
  93          * Show options for the log list
  94          *
  95          * @param $types string or Array
  96          * @param $user String
  97          * @param $page String
  98          * @param $pattern String
  99          * @param $year Integer: year
 100          * @param $month Integer: month
 101          * @param $filter: array
 102          * @param $tagFilter: array?
 103          */
 104         public function showOptions( $types=array(), $user='', $page='', $pattern='', $year='',
 105                 $month = '', $filter = null, $tagFilter='' ) {
 106                 global $wgScript, $wgMiserMode;
 107
 108                 $action = $wgScript;
 109                 $title = SpecialPage::getTitleFor( 'Log' );
 110                 $special = $title->getPrefixedDBkey();
 111
 112                 // For B/C, we take strings, but make sure they are converted...
 113                 $types = ($types === '') ? array() : (array)$types;
 114
 115                 $tagSelector = ChangeTags::buildTagFilterSelector( $tagFilter );
 116
 117                 $html = Html::hidden( 'title', $special );
 118
 119                 // Basic selectors
 120                 $html .= $this->getTypeMenu( $types ) . "\n";
 121                 $html .= $this->getUserInput( $user ) . "\n";
 122                 $html .= $this->getTitleInput( $page ) . "\n";
 123                 $html .= $this->getExtraInputs( $types ) . "\n";
 124
 125                 // Title pattern, if allowed
 126                 if (!$wgMiserMode) {
 127                         $html .= $this->getTitlePattern( $pattern ) . "\n";
 128                 }
 129
 130                 // date menu
 131                 $html .= Xml::tags( 'p', null, Xml::dateMenu( $year, $month ) );
 132
 133                 // Tag filter
 134                 if ($tagSelector) {
 135                         $html .= Xml::tags( 'p', null, implode( '&#160;', $tagSelector ) );
 136                 }
 137
 138                 // Filter links
 139                 if ($filter) {
 140                         $html .= Xml::tags( 'p', null, $this->getFilterLinks( $filter ) );
 141                 }
 142
 143                 // Submit button
 144                 $html .= Xml::submitButton( wfMsg( 'allpagessubmit' ) );
 145
 146                 // Fieldset
 147                 $html = Xml::fieldset( wfMsg( 'log' ), $html );
 148
 149                 // Form wrapping
 150                 $html = Xml::tags( 'form', array( 'action' => $action, 'method' => 'get' ), $html );
 151
 152                 $this->out->addHTML( $html );
 153         }
 154
 155         /**
 156          * @param $filter Array
 157          * @return String: Formatted HTML
 158          */
 159         private function getFilterLinks( $filter ) {
 160                 global $wgLang;
 161                 // show/hide links
 162                 $messages = array( wfMsgHtml( 'show' ), wfMsgHtml( 'hide' ) );
 163                 // Option value -> message mapping
 164                 $links = array();
 165                 $hiddens = ''; // keep track for "go" button
 166                 foreach( $filter as $type => $val ) {
 167                         // Should the below assignment be outside the foreach?
 168                         // Then it would have to be copied. Not certain what is more expensive.
 169                         $query = $this->getDefaultQuery();
 170                         $queryKey = "hide_{$type}_log";
 171
 172                         $hideVal = 1 - intval($val);
 173                         $query[$queryKey] = $hideVal;
 174
 175                         $link = Linker::link(
 176                                 $this->getDisplayTitle(),
 177                                 $messages[$hideVal],
 178                                 array(),
 179                                 $query,
 180                                 array( 'known', 'noclasses' )
 181                         );
 182
 183                         $links[$type] = wfMsgHtml( "log-show-hide-{$type}", $link );
 184                         $hiddens .= Html::hidden( "hide_{$type}_log", $val ) . "\n";
 185                 }
 186                 // Build links
 187                 return '<small>'.$wgLang->pipeList( $links ) . '</small>' . $hiddens;
 188         }
 189
 190         private function getDefaultQuery() {
 191                 global $wgRequest;
 192
 193                 if ( !isset( $this->mDefaultQuery ) ) {
 194                         $this->mDefaultQuery = $wgRequest->getQueryValues();
 195                         unset( $this->mDefaultQuery['title'] );
 196                         unset( $this->mDefaultQuery['dir'] );
 197                         unset( $this->mDefaultQuery['offset'] );
 198                         unset( $this->mDefaultQuery['limit'] );
 199                         unset( $this->mDefaultQuery['order'] );
 200                         unset( $this->mDefaultQuery['month'] );
 201                         unset( $this->mDefaultQuery['year'] );
 202                 }
 203                 return $this->mDefaultQuery;
 204         }
 205
 206         /**
 207          * Get the Title object of the page the links should point to.
 208          * This is NOT the Title of the page the entries should be restricted to.
 209          *
 210          * @return Title object
 211          */
 212         public function getDisplayTitle() {
 213                 return $this->out->getTitle();
 214         }
 215
 216         public function getContext() {
 217                 return $this->out->getContext();
 218         }
 219
 220         /**
 221          * @param $queryTypes Array
 222          * @return String: Formatted HTML
 223          */
 224         private function getTypeMenu( $queryTypes ) {
 225                 $queryType = count($queryTypes) == 1 ? $queryTypes[0] : '';
 226                 $selector = $this->getTypeSelector();
 227                 $selector->setDefault( $queryType );
 228                 return $selector->getHtml();
 229         }
 230
 231         /**
 232          * Returns log page selector.
 233          * @return XmlSelect
 234          * @since 1.19
 235          */
 236         public function getTypeSelector() {
 237                 global $wgUser;
 238
 239                 $typesByName = array(); // Temporary array
 240                 // First pass to load the log names
 241                 foreach(  LogPage::validTypes() as $type ) {
 242                         $page = new LogPage( $type );
 243                         $restriction = $page->getRestriction();
 244                         if ( $wgUser->isAllowed( $restriction ) ) {
 245                                 $typesByName[$type] = $page->getName()->text();
 246                         }
 247                 }
 248
 249                 // Second pass to sort by name
 250                 asort($typesByName);
 251
 252                 // Always put "All public logs" on top
 253                 $public = $typesByName[''];
 254                 unset( $typesByName[''] );
 255                 $typesByName = array( '' => $public ) + $typesByName;
 256
 257                 $select = new XmlSelect( 'type' );
 258                 foreach( $typesByName as $type => $name ) {
 259                         $select->addOption( $name, $type );
 260                 }
 261
 262                 return $select;
 263         }
 264
 265         /**
 266          * @param $user String
 267          * @return String: Formatted HTML
 268          */
 269         private function getUserInput( $user ) {
 270                 return '<span style="white-space: nowrap">' .
 271                         Xml::inputLabel( wfMsg( 'specialloguserlabel' ), 'user', 'mw-log-user', 15, $user ) .
 272                         '</span>';
 273         }
 274
 275         /**
 276          * @param $title String
 277          * @return String: Formatted HTML
 278          */
 279         private function getTitleInput( $title ) {
 280                 return '<span style="white-space: nowrap">' .
 281                         Xml::inputLabel( wfMsg( 'speciallogtitlelabel' ), 'page', 'mw-log-page', 20, $title ) .
 282                         '</span>';
 283         }
 284
 285         /**
 286          * @param $pattern
 287          * @return string Checkbox
 288          */
 289         private function getTitlePattern( $pattern ) {
 290                 return '<span style="white-space: nowrap">' .
 291                         Xml::checkLabel( wfMsg( 'log-title-wildcard' ), 'pattern', 'pattern', $pattern ) .
 292                         '</span>';
 293         }
 294
 295         /**
 296          * @param $types
 297          * @return string
 298          */
 299         private function getExtraInputs( $types ) {
 300                 global $wgRequest;
 301                 $offender = $wgRequest->getVal('offender');
 302                 $user = User::newFromName( $offender, false );
 303                 if( !$user || ($user->getId() == 0 && !IP::isIPAddress($offender) ) ) {
 304                         $offender = ''; // Blank field if invalid
 305                 }
 306                 if( count($types) == 1 && $types[0] == 'suppress' ) {
 307                         return Xml::inputLabel( wfMsg('revdelete-offender'), 'offender',
 308                                 'mw-log-offender', 20, $offender );
 309                 }
 310                 return '';
 311         }
 312
 313         /**
 314          * @return string
 315          */
 316         public function beginLogEventsList() {
 317                 return "<ul>\n";
 318         }
 319
 320         /**
 321          * @return string
 322          */
 323         public function endLogEventsList() {
 324                 return "</ul>\n";
 325         }
 326
 327         /**
 328          * @param $row Row: a single row from the result set
 329          * @return String: Formatted HTML list item
 330          */
 331         public function logLine( $row ) {
 332                 $entry = DatabaseLogEntry::newFromRow( $row );
 333                 $formatter = LogFormatter::newFromEntry( $entry );
 334                 $formatter->setShowUserToolLinks( !( $this->flags & self::NO_EXTRA_USER_LINKS ) );
 335
 336                 $action = $formatter->getActionText();
 337                 $comment = $formatter->getComment();
 338
 339                 $classes = array( 'mw-logline-' . $entry->getType() );
 340                 $title = $entry->getTarget();
 341                 $time = $this->logTimestamp( $entry );
 342
 343                 // Extract extra parameters
 344                 $paramArray = LogPage::extractParams( $row->log_params );
 345                 // Add review/revert links and such...
 346                 $revert = $this->logActionLinks( $row, $title, $paramArray, $comment );
 347
 348                 // Some user can hide log items and have review links
 349                 $del = $this->getShowHideLinks( $row );
 350                 if( $del != '' ) $del .= ' ';
 351
 352                 // Any tags...
 353                 list( $tagDisplay, $newClasses ) = ChangeTags::formatSummaryRow( $row->ts_tags, 'logevent' );
 354                 $classes = array_merge( $classes, $newClasses );
 355
 356                 return Xml::tags( 'li', array( "class" => implode( ' ', $classes ) ),
 357                         $del . "$time $action $comment $revert $tagDisplay" ) . "\n";
 358         }
 359
 360         private function logTimestamp( LogEntry $entry ) {
 361                 global $wgLang;
 362                 $time = $wgLang->timeanddate( wfTimestamp( TS_MW, $entry->getTimestamp() ), true );
 363                 return htmlspecialchars( $time );
 364         }
 365
 366         /**
 367          * @TODO: split up!
 368          *
 369          * @param  $row
 370          * @param Title $title
 371          * @param Array $paramArray
 372          * @param  $comment
 373          * @return String
 374          */
 375         private function logActionLinks( $row, $title, $paramArray, &$comment ) {
 376                 global $wgUser;
 377                 if( ( $this->flags & self::NO_ACTION_LINK ) // we don't want to see the action
 378                         || self::isDeleted( $row, LogPage::DELETED_ACTION ) ) // action is hidden
 379                 {
 380                         return '';
 381                 }
 382                 $revert = '';
 383                 if( self::typeAction( $row, 'move', 'move', 'move' ) && !empty( $paramArray[0] ) ) {
 384                         $destTitle = Title::newFromText( $paramArray[0] );
 385                         if( $destTitle ) {
 386                                 $revert = '(' . Linker::link(
 387                                         SpecialPage::getTitleFor( 'Movepage' ),
 388                                         $this->message['revertmove'],
 389                                         array(),
 390                                         array(
 391                                                 'wpOldTitle' => $destTitle->getPrefixedDBkey(),
 392                                                 'wpNewTitle' => $title->getPrefixedDBkey(),
 393                                                 'wpReason'   => wfMsgForContent( 'revertmove' ),
 394                                                 'wpMovetalk' => 0
 395                                         ),
 396                                         array( 'known', 'noclasses' )
 397                                 ) . ')';
 398                         }
 399                 // Show undelete link
 400                 } elseif( self::typeAction( $row, array( 'delete', 'suppress' ), 'delete', 'deletedhistory' ) ) {
 401                         if( !$wgUser->isAllowed( 'undelete' ) ) {
 402                                 $viewdeleted = $this->message['undeleteviewlink'];
 403                         } else {
 404                                 $viewdeleted = $this->message['undeletelink'];
 405                         }
 406                         $revert = '(' . Linker::link(
 407                                 SpecialPage::getTitleFor( 'Undelete' ),
 408                                 $viewdeleted,
 409                                 array(),
 410                                 array( 'target' => $title->getPrefixedDBkey() ),
 411                                 array( 'known', 'noclasses' )
 412                          ) . ')';
 413                 // Show unblock/change block link
 414                 } elseif( self::typeAction( $row, array( 'block', 'suppress' ), array( 'block', 'reblock' ), 'block' ) ) {
 415                         $revert = '(' .
 416                                 Linker::link(
 417                                         SpecialPage::getTitleFor( 'Unblock', $row->log_title ),
 418                                         $this->message['unblocklink'],
 419                                         array(),
 420                                         array(),
 421                                         'known'
 422                                 ) .
 423                                 $this->message['pipe-separator'] .
 424                                 Linker::link(
 425                                         SpecialPage::getTitleFor( 'Block', $row->log_title ),
 426                                         $this->message['change-blocklink'],
 427                                         array(),
 428                                         array(),
 429                                         'known'
 430                                 ) .
 431                                 ')';
 432                 // Show change protection link
 433                 } elseif( self::typeAction( $row, 'protect', array( 'modify', 'protect', 'unprotect' ) ) ) {
 434                         $revert .= ' (' .
 435                                 Linker::link( $title,
 436                                         $this->message['hist'],
 437                                         array(),
 438                                         array(
 439                                                 'action' => 'history',
 440                                                 'offset' => $row->log_timestamp
 441                                         )
 442                                 );
 443                         if( $wgUser->isAllowed( 'protect' ) ) {
 444                                 $revert .= $this->message['pipe-separator'] .
 445                                         Linker::link( $title,
 446                                                 $this->message['protect_change'],
 447                                                 array(),
 448                                                 array( 'action' => 'protect' ),
 449                                                 'known' );
 450                         }
 451                         $revert .= ')';
 452                 // Show unmerge link
 453                 } elseif( self::typeAction( $row, 'merge', 'merge', 'mergehistory' ) ) {
 454                         $revert = '(' . Linker::link(
 455                                 SpecialPage::getTitleFor( 'MergeHistory' ),
 456                                 $this->message['revertmerge'],
 457                                 array(),
 458                                 array(
 459                                         'target' => $paramArray[0],
 460                                         'dest' => $title->getPrefixedDBkey(),
 461                                         'mergepoint' => $paramArray[1]
 462                                 ),
 463                                 array( 'known', 'noclasses' )
 464                         ) . ')';
 465                 // If an edit was hidden from a page give a review link to the history
 466                 } elseif( self::typeAction( $row, array( 'delete', 'suppress' ), 'revision', 'deletedhistory' ) ) {
 467                         $revert = RevisionDeleter::getLogLinks( $title, $paramArray,
 468                                                                 $this->message );
 469                 // Hidden log items, give review link
 470                 } elseif( self::typeAction( $row, array( 'delete', 'suppress' ), 'event', 'deletedhistory' ) ) {
 471                         if( count($paramArray) >= 1 ) {
 472                                 $revdel = SpecialPage::getTitleFor( 'Revisiondelete' );
 473                                 // $paramArray[1] is a CSV of the IDs
 474                                 $query = $paramArray[0];
 475                                 // Link to each hidden object ID, $paramArray[1] is the url param
 476                                 $revert = '(' . Linker::link(
 477                                         $revdel,
 478                                         $this->message['revdel-restore'],
 479                                         array(),
 480                                         array(
 481                                                 'target' => $title->getPrefixedText(),
 482                                                 'type' => 'logging',
 483                                                 'ids' => $query
 484                                         ),
 485                                         array( 'known', 'noclasses' )
 486                                 ) . ')';
 487                         }
 488                 // Do nothing. The implementation is handled by the hook modifiying the passed-by-ref parameters.
 489                 } else {
 490                         wfRunHooks( 'LogLine', array( $row->log_type, $row->log_action, $title, $paramArray,
 491                                 &$comment, &$revert, $row->log_timestamp ) );
 492                 }
 493                 if( $revert != '' ) {
 494                         $revert = '<span class="mw-logevent-actionlink">' . $revert . '</span>';
 495                 }
 496                 return $revert;
 497         }
 498
 499         /**
 500          * @param $row Row
 501          * @return string
 502          */
 503         private function getShowHideLinks( $row ) {
 504                 global $wgUser;
 505                 if( ( $this->flags & self::NO_ACTION_LINK ) // we don't want to see the links
 506                         || $row->log_type == 'suppress' ) { // no one can hide items from the suppress log
 507                         return '';
 508                 }
 509                 $del = '';
 510                 // Don't show useless link to people who cannot hide revisions
 511                 if( $wgUser->isAllowed( 'deletedhistory' ) ) {
 512                         if( $row->log_deleted || $wgUser->isAllowed( 'deleterevision' ) ) {
 513                                 $canHide = $wgUser->isAllowed( 'deleterevision' );
 514                                 // If event was hidden from sysops
 515                                 if( !self::userCan( $row, LogPage::DELETED_RESTRICTED ) ) {
 516                                         $del = Linker::revDeleteLinkDisabled( $canHide );
 517                                 } else {
 518                                         $target = SpecialPage::getTitleFor( 'Log', $row->log_type );
 519                                         $query = array(
 520                                                 'target' => $target->getPrefixedDBkey(),
 521                                                 'type'   => 'logging',
 522                                                 'ids'    => $row->log_id,
 523                                         );
 524                                         $del = Linker::revDeleteLink( $query,
 525                                                 self::isDeleted( $row, LogPage::DELETED_RESTRICTED ), $canHide );
 526                                 }
 527                         }
 528                 }
 529                 return $del;
 530         }
 531
 532         /**
 533          * @param $row Row
 534          * @param $type Mixed: string/array
 535          * @param $action Mixed: string/array
 536          * @param $right string
 537          * @return Boolean
 538          */
 539         public static function typeAction( $row, $type, $action, $right='' ) {
 540                 $match = is_array($type) ?
 541                         in_array( $row->log_type, $type ) : $row->log_type == $type;
 542                 if( $match ) {
 543                         $match = is_array( $action ) ?
 544                                 in_array( $row->log_action, $action ) : $row->log_action == $action;
 545                         if( $match && $right ) {
 546                                 global $wgUser;
 547                                 $match = $wgUser->isAllowed( $right );
 548                         }
 549                 }
 550                 return $match;
 551         }
 552
 553         /**
 554          * Determine if the current user is allowed to view a particular
 555          * field of this log row, if it's marked as deleted.
 556          *
 557          * @param $row Row
 558          * @param $field Integer
 559          * @param $user User object to check, or null to use $wgUser
 560          * @return Boolean
 561          */
 562         public static function userCan( $row, $field, User $user = null ) {
 563                 return self::userCanBitfield( $row->log_deleted, $field, $user );
 564         }
 565
 566         /**
 567          * Determine if the current user is allowed to view a particular
 568          * field of this log row, if it's marked as deleted.
 569          *
 570          * @param $bitfield Integer (current field)
 571          * @param $field Integer
 572          * @param $user User object to check, or null to use $wgUser
 573          * @return Boolean
 574          */
 575         public static function userCanBitfield( $bitfield, $field, User $user = null ) {
 576                 if( $bitfield & $field ) {
 577                         if ( $bitfield & LogPage::DELETED_RESTRICTED ) {
 578                                 $permission = 'suppressrevision';
 579                         } else {
 580                                 $permission = 'deletedhistory';
 581                         }
 582                         wfDebug( "Checking for $permission due to $field match on $bitfield\n" );
 583                         if ( $user === null ) {
 584                                 global $wgUser;
 585                                 $user = $wgUser;
 586                         }
 587                         return $user->isAllowed( $permission );
 588                 } else {
 589                         return true;
 590                 }
 591         }
 592
 593         /**
 594          * @param $row Row
 595          * @param $field Integer: one of DELETED_* bitfield constants
 596          * @return Boolean
 597          */
 598         public static function isDeleted( $row, $field ) {
 599                 return ( $row->log_deleted & $field ) == $field;
 600         }
 601
 602         /**
 603          * Show log extract. Either with text and a box (set $msgKey) or without (don't set $msgKey)
 604          *
 605          * @param $out OutputPage|String-by-reference
 606          * @param $types String|Array Log types to show
 607          * @param $page String|Title The page title to show log entries for
 608          * @param $user String The user who made the log entries
 609          * @param $param Associative Array with the following additional options:
 610          * - lim Integer Limit of items to show, default is 50
 611          * - conds Array Extra conditions for the query (e.g. "log_action != 'revision'")
 612          * - showIfEmpty boolean Set to false if you don't want any output in case the loglist is empty
 613          *   if set to true (default), "No matching items in log" is displayed if loglist is empty
 614          * - msgKey Array If you want a nice box with a message, set this to the key of the message.
 615          *   First element is the message key, additional optional elements are parameters for the key
 616          *   that are processed with wfMsgExt and option 'parse'
 617          * - offset Set to overwrite offset parameter in $wgRequest
 618          *   set to '' to unset offset
 619          * - wrap String Wrap the message in html (usually something like "<div ...>$1</div>").
 620          * - flags Integer display flags (NO_ACTION_LINK,NO_EXTRA_USER_LINKS)
 621          * @return Integer Number of total log items (not limited by $lim)
 622          */
 623         public static function showLogExtract(
 624                 &$out, $types=array(), $page='', $user='', $param = array()
 625         ) {
 626                 $defaultParameters = array(
 627                         'lim' => 25,
 628                         'conds' => array(),
 629                         'showIfEmpty' => true,
 630                         'msgKey' => array(''),
 631                         'wrap' => "$1",
 632                         'flags' => 0
 633                 );
 634                 # The + operator appends elements of remaining keys from the right
 635                 # handed array to the left handed, whereas duplicated keys are NOT overwritten.
 636                 $param += $defaultParameters;
 637                 # Convert $param array to individual variables
 638                 $lim = $param['lim'];
 639                 $conds = $param['conds'];
 640                 $showIfEmpty = $param['showIfEmpty'];
 641                 $msgKey = $param['msgKey'];
 642                 $wrap = $param['wrap'];
 643                 $flags = $param['flags'];
 644                 if ( !is_array( $msgKey ) ) {
 645                         $msgKey = array( $msgKey );
 646                 }
 647
 648                 if ( $out instanceof OutputPage ) {
 649                         $context = $out->getContext();
 650                 } else {
 651                         $context = RequestContext::getMain();
 652                 }
 653
 654                 # Insert list of top 50 (or top $lim) items
 655                 $loglist = new LogEventsList( $context->getSkin(), $context->getOutput(), $flags );
 656                 $pager = new LogPager( $loglist, $types, $user, $page, '', $conds );
 657                 if ( isset( $param['offset'] ) ) { # Tell pager to ignore $wgRequest offset
 658                         $pager->setOffset( $param['offset'] );
 659                 }
 660                 if( $lim > 0 ) $pager->mLimit = $lim;
 661                 $logBody = $pager->getBody();
 662                 $s = '';
 663                 if( $logBody ) {
 664                         if ( $msgKey[0] ) {
 665                                 $s = '<div class="mw-warning-with-logexcerpt">';
 666
 667                                 if ( count( $msgKey ) == 1 ) {
 668                                         $s .= wfMsgExt( $msgKey[0], array( 'parse' ) );
 669                                 } else { // Process additional arguments
 670                                         $args = $msgKey;
 671                                         array_shift( $args );
 672                                         $s .= wfMsgExt( $msgKey[0], array( 'parse' ), $args );
 673                                 }
 674                         }
 675                         $s .= $loglist->beginLogEventsList() .
 676                                  $logBody .
 677                                  $loglist->endLogEventsList();
 678                 } else {
 679                         if ( $showIfEmpty ) {
 680                                 $s = Html::rawElement( 'div', array( 'class' => 'mw-warning-logempty' ),
 681                                         wfMsgExt( 'logempty', array( 'parseinline' ) ) );
 682                         }
 683                 }
 684                 if( $pager->getNumRows() > $pager->mLimit ) { # Show "Full log" link
 685                         $urlParam = array();
 686                         if ( $page instanceof Title ) {
 687                                 $urlParam['page'] = $page->getPrefixedDBkey();
 688                         } elseif ( $page != '' ) {
 689                                 $urlParam['page'] = $page;
 690                         }
 691                         if ( $user != '')
 692                                 $urlParam['user'] = $user;
 693                         if ( !is_array( $types ) ) # Make it an array, if it isn't
 694                                 $types = array( $types );
 695                         # If there is exactly one log type, we can link to Special:Log?type=foo
 696                         if ( count( $types ) == 1 )
 697                                 $urlParam['type'] = $types[0];
 698                         $s .= Linker::link(
 699                                 SpecialPage::getTitleFor( 'Log' ),
 700                                 wfMsgHtml( 'log-fulllog' ),
 701                                 array(),
 702                                 $urlParam
 703                         );
 704                 }
 705                 if ( $logBody && $msgKey[0] ) {
 706                         $s .= '</div>';
 707                 }
 708
 709                 if ( $wrap != '' ) { // Wrap message in html
 710                         $s = str_replace( '$1', $s, $wrap );
 711                 }
 712
 713                 /* hook can return false, if we don't want the message to be emitted (Wikia BugId:7093) */
 714                 if ( wfRunHooks( 'LogEventsListShowLogExtract', array( &$s, $types, $page, $user, $param ) ) ) {
 715                         // $out can be either an OutputPage object or a String-by-reference
 716                         if ( $out instanceof OutputPage ){
 717                                 $out->addHTML( $s );
 718                         } else {
 719                                 $out = $s;
 720                         }
 721                 }
 722
 723                 return $pager->getNumRows();
 724         }
 725
 726         /**
 727          * SQL clause to skip forbidden log types for this user
 728          *
 729          * @param $db DatabaseBase
 730          * @param $audience string, public/user
 731          * @return Mixed: string or false
 732          */
 733         public static function getExcludeClause( $db, $audience = 'public' ) {
 734                 global $wgLogRestrictions, $wgUser;
 735                 // Reset the array, clears extra "where" clauses when $par is used
 736                 $hiddenLogs = array();
 737                 // Don't show private logs to unprivileged users
 738                 foreach( $wgLogRestrictions as $logType => $right ) {
 739                         if( $audience == 'public' || !$wgUser->isAllowed($right) ) {
 740                                 $safeType = $db->strencode( $logType );
 741                                 $hiddenLogs[] = $safeType;
 742                         }
 743                 }
 744                 if( count($hiddenLogs) == 1 ) {
 745                         return 'log_type != ' . $db->addQuotes( $hiddenLogs[0] );
 746                 } elseif( $hiddenLogs ) {
 747                         return 'log_type NOT IN (' . $db->makeList($hiddenLogs) . ')';
 748                 }
 749                 return false;
 750         }
 751  }