includes/LogEventsList.php

   1 <?php
   2 # Copyright (C) 2004 Brion Vibber <brion@pobox.com>, 2008 Aaron Schulz
   3 # http://www.mediawiki.org/
   4 #
   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.
   9 #
  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.
  14 #
  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
  19
  20 class LogEventsList {
  21         const NO_ACTION_LINK = 1;
  22
  23         private $skin;
  24         private $out;
  25         public $flags;
  26
  27         public function __construct( $skin, $out, $flags = 0 ) {
  28                 $this->skin = $skin;
  29                 $this->out = $out;
  30                 $this->flags = $flags;
  31                 $this->preCacheMessages();
  32         }
  33
  34         /**
  35          * As we use the same small set of messages in various methods and that
  36          * they are called often, we call them once and save them in $this->message
  37          */
  38         private function preCacheMessages() {
  39                 // Precache various messages
  40                 if( !isset( $this->message ) ) {
  41                         $messages = array( 'revertmerge', 'protect_change', 'unblocklink', 'change-blocklink',
  42                                 'revertmove', 'undeletelink', 'undeleteviewlink', 'revdel-restore', 'rev-delundel', 'hist', 'diff',
  43                                 'pipe-separator' );
  44                         foreach( $messages as $msg ) {
  45                                 $this->message[$msg] = wfMsgExt( $msg, array( 'escapenoentities' ) );
  46                         }
  47                 }
  48         }
  49
  50         /**
  51          * Set page title and show header for this log type
  52          * @param $type Array
  53          */
  54         public function showHeader( $type ) {
  55                 // If only one log type is used, then show a special message...
  56                 $headerType = (count($type) == 1) ? $type[0] : '';
  57                 if( LogPage::isLogType( $headerType ) ) {
  58                         $this->out->setPageTitle( LogPage::logName( $headerType ) );
  59                         $this->out->addHTML( LogPage::logHeader( $headerType ) );
  60                 } else {
  61                         $this->out->addHTML( wfMsgExt('alllogstext',array('parseinline')) );
  62                 }
  63         }
  64
  65         /**
  66          * Show options for the log list
  67          * @param $types string or Array
  68          * @param $user String
  69          * @param $page String
  70          * @param $pattern String
  71          * @param $year Integer: year
  72          * @param $month Integer: month
  73          * @param $filter: array
  74          * @param $tagFilter: array?
  75          */
  76         public function showOptions( $types=array(), $user='', $page='', $pattern='', $year='',
  77                 $month = '', $filter = null, $tagFilter='' )
  78         {
  79                 global $wgScript, $wgMiserMode;
  80
  81                 $action = $wgScript;
  82                 $title = SpecialPage::getTitleFor( 'Log' );
  83                 $special = $title->getPrefixedDBkey();
  84
  85                 // For B/C, we take strings, but make sure they are converted...
  86                 $types = ($types === '') ? array() : (array)$types;
  87
  88                 $tagSelector = ChangeTags::buildTagFilterSelector( $tagFilter );
  89
  90                 $html = '';
  91                 $html .= Xml::hidden( 'title', $special );
  92
  93                 // Basic selectors
  94                 $html .= $this->getTypeMenu( $types ) . "\n";
  95                 $html .= $this->getUserInput( $user ) . "\n";
  96                 $html .= $this->getTitleInput( $page ) . "\n";
  97                 $html .= $this->getExtraInputs( $types ) . "\n";
  98
  99                 // Title pattern, if allowed
 100                 if (!$wgMiserMode) {
 101                         $html .= $this->getTitlePattern( $pattern ) . "\n";
 102                 }
 103
 104                 // date menu
 105                 $html .= Xml::tags( 'p', null, Xml::dateMenu( $year, $month ) );
 106
 107                 // Tag filter
 108                 if ($tagSelector) {
 109                         $html .= Xml::tags( 'p', null, implode( '&nbsp;', $tagSelector ) );
 110                 }
 111
 112                 // Filter links
 113                 if ($filter) {
 114                         $html .= Xml::tags( 'p', null, $this->getFilterLinks( $filter ) );
 115                 }
 116
 117                 // Submit button
 118                 $html .= Xml::submitButton( wfMsg( 'allpagessubmit' ) );
 119
 120                 // Fieldset
 121                 $html = Xml::fieldset( wfMsg( 'log' ), $html );
 122
 123                 // Form wrapping
 124                 $html = Xml::tags( 'form', array( 'action' => $action, 'method' => 'get' ), $html );
 125
 126                 $this->out->addHTML( $html );
 127         }
 128
 129         /**
 130          * @param $filter Array
 131          * @return String: Formatted HTML
 132          */
 133         private function getFilterLinks( $filter ) {
 134                 global $wgTitle, $wgLang;
 135                 // show/hide links
 136                 $messages = array( wfMsgHtml( 'show' ), wfMsgHtml( 'hide' ) );
 137                 // Option value -> message mapping
 138                 $links = array();
 139                 $hiddens = ''; // keep track for "go" button
 140                 foreach( $filter as $type => $val ) {
 141                         // Should the below assignment be outside the foreach?
 142                         // Then it would have to be copied. Not certain what is more expensive.
 143                         $query = $this->getDefaultQuery();
 144                         $queryKey = "hide_{$type}_log";
 145
 146                         $hideVal = 1 - intval($val);
 147                         $query[$queryKey] = $hideVal;
 148
 149                         $link = $this->skin->link(
 150                                 $wgTitle,
 151                                 $messages[$hideVal],
 152                                 array(),
 153                                 $query,
 154                                 array( 'known', 'noclasses' )
 155                         );
 156
 157                         $links[$type] = wfMsgHtml( "log-show-hide-{$type}", $link );
 158                         $hiddens .= Xml::hidden( "hide_{$type}_log", $val ) . "\n";
 159                 }
 160                 // Build links
 161                 return '<small>'.$wgLang->pipeList( $links ) . '</small>' . $hiddens;
 162         }
 163
 164         private function getDefaultQuery() {
 165                 if ( !isset( $this->mDefaultQuery ) ) {
 166                         $this->mDefaultQuery = $_GET;
 167                         unset( $this->mDefaultQuery['title'] );
 168                         unset( $this->mDefaultQuery['dir'] );
 169                         unset( $this->mDefaultQuery['offset'] );
 170                         unset( $this->mDefaultQuery['limit'] );
 171                         unset( $this->mDefaultQuery['order'] );
 172                         unset( $this->mDefaultQuery['month'] );
 173                         unset( $this->mDefaultQuery['year'] );
 174                 }
 175                 return $this->mDefaultQuery;
 176         }
 177
 178         /**
 179          * @param $queryTypes Array
 180          * @return String: Formatted HTML
 181          */
 182         private function getTypeMenu( $queryTypes ) {
 183                 global $wgLogRestrictions, $wgUser;
 184
 185                 $html = "<select name='type'>\n";
 186
 187                 $validTypes = LogPage::validTypes();
 188                 $typesByName = array(); // Temporary array
 189
 190                 // First pass to load the log names
 191                 foreach( $validTypes as $type ) {
 192                         $text = LogPage::logName( $type );
 193                         $typesByName[$text] = $type;
 194                 }
 195
 196                 // Second pass to sort by name
 197                 ksort($typesByName);
 198
 199                 // Note the query type
 200                 $queryType = count($queryTypes) == 1 ? $queryTypes[0] : '';
 201                 // Third pass generates sorted XHTML content
 202                 foreach( $typesByName as $text => $type ) {
 203                         $selected = ($type == $queryType);
 204                         // Restricted types
 205                         if ( isset($wgLogRestrictions[$type]) ) {
 206                                 if ( $wgUser->isAllowed( $wgLogRestrictions[$type] ) ) {
 207                                         $html .= Xml::option( $text, $type, $selected ) . "\n";
 208                                 }
 209                         } else {
 210                                 $html .= Xml::option( $text, $type, $selected ) . "\n";
 211                         }
 212                 }
 213
 214                 $html .= '</select>';
 215                 return $html;
 216         }
 217
 218         /**
 219          * @param $user String
 220          * @return String: Formatted HTML
 221          */
 222         private function getUserInput( $user ) {
 223                 return Xml::inputLabel( wfMsg( 'specialloguserlabel' ), 'user', 'mw-log-user', 15, $user );
 224         }
 225
 226         /**
 227          * @param $title String
 228          * @return String: Formatted HTML
 229          */
 230         private function getTitleInput( $title ) {
 231                 return Xml::inputLabel( wfMsg( 'speciallogtitlelabel' ), 'page', 'mw-log-page', 20, $title );
 232         }
 233
 234         /**
 235          * @return boolean Checkbox
 236          */
 237         private function getTitlePattern( $pattern ) {
 238                 return '<span style="white-space: nowrap">' .
 239                         Xml::checkLabel( wfMsg( 'log-title-wildcard' ), 'pattern', 'pattern', $pattern ) .
 240                         '</span>';
 241         }
 242
 243         private function getExtraInputs( $types ) {
 244                 global $wgRequest;
 245                 if( count($types) == 1 && $types[0] == 'suppress' ) {
 246                         return Xml::inputLabel( wfMsg('revdelete-offender'), 'offender',
 247                                 'mw-log-offender', 20, $wgRequest->getVal('offender') );
 248                 }
 249                 return '';
 250         }
 251
 252         public function beginLogEventsList() {
 253                 return "<ul>\n";
 254         }
 255
 256         public function endLogEventsList() {
 257                 return "</ul>\n";
 258         }
 259
 260         /**
 261          * @param $row Row: a single row from the result set
 262          * @return String: Formatted HTML list item
 263          */
 264         public function logLine( $row ) {
 265                 global $wgLang, $wgUser, $wgContLang;
 266
 267                 $title = Title::makeTitle( $row->log_namespace, $row->log_title );
 268                 $classes = array( "mw-logline-{$row->log_type}" );
 269                 $time = $wgLang->timeanddate( wfTimestamp(TS_MW, $row->log_timestamp), true );
 270                 // User links
 271                 if( self::isDeleted($row,LogPage::DELETED_USER) ) {
 272                         $userLink = '<span class="history-deleted">' . wfMsgHtml( 'rev-deleted-user' ) . '</span>';
 273                 } else {
 274                         $userLink = $this->skin->userLink( $row->log_user, $row->user_name ) .
 275                                 $this->skin->userToolLinks( $row->log_user, $row->user_name, true, 0, $row->user_editcount );
 276                 }
 277                 // Comment
 278                 if( self::isDeleted($row,LogPage::DELETED_COMMENT) ) {
 279                         $comment = '<span class="history-deleted">' . wfMsgHtml('rev-deleted-comment') . '</span>';
 280                 } else {
 281                         $comment = $wgContLang->getDirMark() . $this->skin->commentBlock( $row->log_comment );
 282                 }
 283                 // Extract extra parameters
 284                 $paramArray = LogPage::extractParams( $row->log_params );
 285                 $revert = $del = '';
 286                 // Some user can hide log items and have review links
 287                 if( !($this->flags & self::NO_ACTION_LINK) && $wgUser->isAllowed( 'deletedhistory' ) ) {
 288                         // Don't show useless link to people who cannot hide revisions
 289                         if( $row->log_deleted || $wgUser->isAllowed( 'deleterevision' ) ) {
 290                                 $del = $this->getShowHideLinks( $row ) . ' ';
 291                         }
 292                 }
 293                 // Add review links and such...
 294                 if( ($this->flags & self::NO_ACTION_LINK) || ($row->log_deleted & LogPage::DELETED_ACTION) ) {
 295                         // Action text is suppressed...
 296                 } else if( self::typeAction($row,'move','move','move') && !empty($paramArray[0]) ) {
 297                         $destTitle = Title::newFromText( $paramArray[0] );
 298                         if( $destTitle ) {
 299                                 $revert = '(' . $this->skin->link(
 300                                         SpecialPage::getTitleFor( 'Movepage' ),
 301                                         $this->message['revertmove'],
 302                                         array(),
 303                                         array(
 304                                                 'wpOldTitle' => $destTitle->getPrefixedDBkey(),
 305                                                 'wpNewTitle' => $title->getPrefixedDBkey(),
 306                                                 'wpReason' => wfMsgForContent( 'revertmove' ),
 307                                                 'wpMovetalk' => 0
 308                                         ),
 309                                         array( 'known', 'noclasses' )
 310                                 ) . ')';
 311                         }
 312                 // Show undelete link
 313                 } else if( self::typeAction($row,array('delete','suppress'),'delete','deletedhistory') ) {
 314                         if( !$wgUser->isAllowed( 'undelete' ) ) {
 315                                 $viewdeleted = $this->message['undeleteviewlink'];
 316                         } else {
 317                                 $viewdeleted = $this->message['undeletelink'];
 318                         }
 319
 320                         $revert = '(' . $this->skin->link(
 321                                 SpecialPage::getTitleFor( 'Undelete' ),
 322                                 $viewdeleted,
 323                                 array(),
 324                                 array( 'target' => $title->getPrefixedDBkey() ),
 325                                 array( 'known', 'noclasses' )
 326                          ) . ')';
 327                 // Show unblock/change block link
 328                 } else if( self::typeAction($row,array('block','suppress'),array('block','reblock'),'block') ) {
 329                         $revert = '(' .
 330                                 $this->skin->link(
 331                                         SpecialPage::getTitleFor( 'Ipblocklist' ),
 332                                         $this->message['unblocklink'],
 333                                         array(),
 334                                         array(
 335                                                 'action' => 'unblock',
 336                                                 'ip' => $row->log_title
 337                                         ),
 338                                         'known'
 339                                 ) .
 340                                 $this->message['pipe-separator'] .
 341                                 $this->skin->link(
 342                                         SpecialPage::getTitleFor( 'Blockip', $row->log_title ),
 343                                         $this->message['change-blocklink'],
 344                                         array(),
 345                                         array(),
 346                                         'known'
 347                                 ) .
 348                                 ')';
 349                 // Show change protection link
 350                 } else if( self::typeAction( $row, 'protect', array( 'modify', 'protect', 'unprotect' ) ) ) {
 351                         $revert .= ' (' .
 352                                 $this->skin->link( $title,
 353                                         $this->message['hist'],
 354                                         array(),
 355                                         array(
 356                                                 'action' => 'history',
 357                                                 'offset' => $row->log_timestamp
 358                                         )
 359                                 );
 360                         if( $wgUser->isAllowed( 'protect' ) ) {
 361                                 $revert .= $this->message['pipe-separator'] .
 362                                         $this->skin->link( $title,
 363                                                 $this->message['protect_change'],
 364                                                 array(),
 365                                                 array( 'action' => 'protect' ),
 366                                                 'known' );
 367                         }
 368                         $revert .= ')';
 369                 // Show unmerge link
 370                 } else if( self::typeAction($row,'merge','merge','mergehistory') ) {
 371                         $merge = SpecialPage::getTitleFor( 'Mergehistory' );
 372                         $revert = '(' .  $this->skin->link(
 373                                 $merge,
 374                                 $this->message['revertmerge'],
 375                                 array(),
 376                                 array(
 377                                         'target' => $paramArray[0],
 378                                         'dest' => $title->getPrefixedDBkey(),
 379                                         'mergepoint' => $paramArray[1]
 380                                 ),
 381                                 array( 'known', 'noclasses' )
 382                         ) . ')';
 383                 // If an edit was hidden from a page give a review link to the history
 384                 } else if( self::typeAction($row,array('delete','suppress'),'revision','deletedhistory') ) {
 385                         if( count($paramArray) >= 2 ) {
 386                                 // Different revision types use different URL params...
 387                                 $key = $paramArray[0];
 388                                 // $paramArray[1] is a CSV of the IDs
 389                                 $Ids = explode( ',', $paramArray[1] );
 390                                 $query = $paramArray[1];
 391                                 $revert = array();
 392                                 // Diff link for single rev deletions
 393                                 if( count($Ids) == 1 ) {
 394                                         // Live revision diffs...
 395                                         if( in_array($key, array('oldid','revision')) ) {
 396                                                 $revert[] = $this->skin->link(
 397                                                         $title,
 398                                                         $this->message['diff'],
 399                                                         array(),
 400                                                         array(
 401                                                                 'diff' => intval( $Ids[0] ),
 402                                                                 'unhide' => 1
 403                                                         ),
 404                                                         array( 'known', 'noclasses' )
 405                                                 );
 406                                         // Deleted revision diffs...
 407                                         } else if( in_array($key, array('artimestamp','archive')) ) {
 408                                                 $revert[] = $this->skin->link(
 409                                                         SpecialPage::getTitleFor( 'Undelete' ),
 410                                                         $this->message['diff'],
 411                                                         array(),
 412                                                         array(
 413                                                                 'target'    => $title->getPrefixedDBKey(),
 414                                                                 'diff'      => 'prev',
 415                                                                 'timestamp' => $Ids[0]
 416                                                         ),
 417                                                         array( 'known', 'noclasses' )
 418                                                 );
 419                                         }
 420                                 }
 421                                 // View/modify link...
 422                                 $revert[] = $this->skin->link(
 423                                         SpecialPage::getTitleFor( 'Revisiondelete' ),
 424                                         $this->message['revdel-restore'],
 425                                         array(),
 426                                         array(
 427                                                 'target' => $title->getPrefixedText(),
 428                                                 'type' => $key,
 429                                                 'ids' => $query
 430                                         ),
 431                                         array( 'known', 'noclasses' )
 432                                 );
 433                                 // Pipe links
 434                                 $revert = wfMsg( 'parentheses', $wgLang->pipeList( $revert ) );
 435                         }
 436                 // Hidden log items, give review link
 437                 } else if( self::typeAction($row,array('delete','suppress'),'event','deletedhistory') ) {
 438                         if( count($paramArray) >= 1 ) {
 439                                 $revdel = SpecialPage::getTitleFor( 'Revisiondelete' );
 440                                 // $paramArray[1] is a CSV of the IDs
 441                                 $Ids = explode( ',', $paramArray[0] );
 442                                 $query = $paramArray[0];
 443                                 // Link to each hidden object ID, $paramArray[1] is the url param
 444                                 $revert = '(' . $this->skin->link(
 445                                         $revdel,
 446                                         $this->message['revdel-restore'],
 447                                         array(),
 448                                         array(
 449                                                 'target' => $title->getPrefixedText(),
 450                                                 'type' => 'logging',
 451                                                 'ids' => $query
 452                                         ),
 453                                         array( 'known', 'noclasses' )
 454                                 ) . ')';
 455                         }
 456                 // Self-created users
 457                 } else if( self::typeAction($row,'newusers','create2') ) {
 458                         if( isset( $paramArray[0] ) ) {
 459                                 $revert = $this->skin->userToolLinks( $paramArray[0], $title->getDBkey(), true );
 460                         } else {
 461                                 # Fall back to a blue contributions link
 462                                 $revert = $this->skin->userToolLinks( 1, $title->getDBkey() );
 463                         }
 464                         if( $time < '20080129000000' ) {
 465                                 # Suppress $comment from old entries (before 2008-01-29),
 466                                 # not needed and can contain incorrect links
 467                                 $comment = '';
 468                         }
 469                 // Do nothing. The implementation is handled by the hook modifiying the passed-by-ref parameters.
 470                 } else {
 471                         wfRunHooks( 'LogLine', array( $row->log_type, $row->log_action, $title, $paramArray,
 472                                 &$comment, &$revert, $row->log_timestamp ) );
 473                 }
 474                 // Event description
 475                 if( self::isDeleted($row,LogPage::DELETED_ACTION) ) {
 476                         $action = '<span class="history-deleted">' . wfMsgHtml('rev-deleted-event') . '</span>';
 477                 } else {
 478                         $action = LogPage::actionText( $row->log_type, $row->log_action, $title,
 479                                 $this->skin, $paramArray, true );
 480                 }
 481
 482                 // Any tags...
 483                 list($tagDisplay, $newClasses) = ChangeTags::formatSummaryRow( $row->ts_tags, 'logevent' );
 484                 $classes = array_merge( $classes, $newClasses );
 485
 486                 if( $revert != '' ) {
 487                         $revert = '<span class="mw-logevent-actionlink">' . $revert . '</span>';
 488                 }
 489
 490                 $time = htmlspecialchars( $time );
 491
 492                 return Xml::tags( 'li', array( "class" => implode( ' ', $classes ) ),
 493                         $del . $time . ' ' . $userLink . ' ' . $action . ' ' . $comment . ' ' . $revert . " $tagDisplay" ) . "\n";
 494         }
 495
 496         /**
 497          * @param $row Row
 498          * @return string
 499          */
 500         private function getShowHideLinks( $row ) {
 501                 // If event was hidden from sysops
 502                 if( !self::userCan( $row, LogPage::DELETED_RESTRICTED ) ) {
 503                         $del = Xml::tags( 'span', array( 'class'=>'mw-revdelundel-link' ),
 504                                 '('.$this->message['rev-delundel'].')' );
 505                 } else if( $row->log_type == 'suppress' ) {
 506                         $del = ''; // No one should be hiding from the oversight log
 507                 } else {
 508                         $target = SpecialPage::getTitleFor( 'Log', $row->log_type );
 509                         $page = Title::makeTitle( $row->log_namespace, $row->log_title );
 510                         $query = array(
 511                                 'target' => $target->getPrefixedDBkey(),
 512                                 'type' => 'logging',
 513                                 'ids' => $row->log_id,
 514                         );
 515                         $del = $this->skin->revDeleteLink( $query,
 516                                 self::isDeleted( $row, LogPage::DELETED_RESTRICTED ) );
 517                 }
 518                 return $del;
 519         }
 520
 521         /**
 522          * @param $row Row
 523          * @param $type Mixed: string/array
 524          * @param $action Mixed: string/array
 525          * @param $right string
 526          * @return bool
 527          */
 528         public static function typeAction( $row, $type, $action, $right='' ) {
 529                 $match = is_array($type) ?
 530                         in_array($row->log_type,$type) : $row->log_type == $type;
 531                 if( $match ) {
 532                         $match = is_array($action) ?
 533                                 in_array($row->log_action,$action) : $row->log_action == $action;
 534                         if( $match && $right ) {
 535                                 global $wgUser;
 536                                 $match = $wgUser->isAllowed( $right );
 537                         }
 538                 }
 539                 return $match;
 540         }
 541
 542         /**
 543          * Determine if the current user is allowed to view a particular
 544          * field of this log row, if it's marked as deleted.
 545          * @param $row Row
 546          * @param $field Integer
 547          * @return Boolean
 548          */
 549         public static function userCan( $row, $field ) {
 550                 if( $row->log_deleted & $field ) {
 551                         global $wgUser;
 552                         $permission = ( $row->log_deleted & LogPage::DELETED_RESTRICTED )
 553                                 ? 'suppressrevision'
 554                                 : 'deletedhistory';
 555                         wfDebug( "Checking for $permission due to $field match on $row->log_deleted\n" );
 556                         return $wgUser->isAllowed( $permission );
 557                 } else {
 558                         return true;
 559                 }
 560         }
 561
 562         /**
 563          * @param $row Row
 564          * @param $field Integer: one of DELETED_* bitfield constants
 565          * @return Boolean
 566          */
 567         public static function isDeleted( $row, $field ) {
 568                 return ($row->log_deleted & $field) == $field;
 569         }
 570
 571         /**
 572          * Show log extract. Either with text and a box (set $msgKey) or without (don't set $msgKey)
 573          * @param $out OutputPage or String-by-reference
 574          * @param $types String or Array
 575          * @param $page String The page title to show log entries for
 576          * @param $user String The user who made the log entries
 577          * @param $param Associative Array with the following additional options:
 578          *      lim Integer Limit of items to show, default is 50
 579          *      conds Array Extra conditions for the query (e.g. "log_action != 'revision'")
 580          *      showIfEmpty boolean Set to false if you don't want any output in case the loglist is empty
 581          *              if set to true (default), "No matching items in log" is displayed if loglist is empty
 582          *      msgKey Array If you want a nice box with a message, set this
 583          *              to the key of the message. First element is the message
 584          *              key, additional optional elements are parameters for the
 585          *              key that are processed with wgMsgExt and option 'parse'
 586          *      offset Set to overwrite offset parameter in $wgRequest
 587          *              set to '' to unset offset
 588          * @return Integer Number of total log items (not limited by $lim)
 589          */
 590         public static function showLogExtract( &$out, $types=array(), $page='', $user='',
 591                         $param = array() ) {
 592
 593                 $defaultParameters = array(
 594                         'lim' => 0,
 595                         'conds' => array(),
 596                         'showIfEmpty' => true,
 597                         'msgKey' => array('')
 598                 );
 599
 600                 # The + operator appends elements of remaining keys from the right
 601                 # handed array to the left handed, whereas duplicated keys are NOT overwritten.
 602                 $param += $defaultParameters;
 603
 604                 global $wgUser, $wgOut;
 605                 # Convert $param array to individual variables
 606                 $lim = $param['lim'];
 607                 $conds = $param['conds'];
 608                 $showIfEmpty = $param['showIfEmpty'];
 609                 $msgKey = $param['msgKey'];
 610                 if ( !is_array($msgKey) )
 611                         $msgKey = array( $msgKey );
 612                 # Insert list of top 50 (or top $lim) items
 613                 $loglist = new LogEventsList( $wgUser->getSkin(), $wgOut, 0 );
 614                 $pager = new LogPager( $loglist, $types, $user, $page, '', $conds );
 615                 if ( isset( $param['offset'] ) ) # Tell pager to ignore $wgRequest offset
 616                         $pager->setOffset( $param['offset'] );
 617                 if( $lim > 0 ) $pager->mLimit = $lim;
 618                 $logBody = $pager->getBody();
 619                 $s = '';
 620                 if( $logBody ) {
 621                         if ( $msgKey[0] ) {
 622                                 $s = '<div class="mw-warning-with-logexcerpt">';
 623
 624                                 if ( count( $msgKey ) == 1 ) {
 625                                         $s .= wfMsgExt( $msgKey[0], array('parse') );
 626                                 } else { // Process additional arguments
 627                                         $args = $msgKey;
 628                                         array_shift( $args );
 629                                         $s .= wfMsgExt( $msgKey[0], array('parse'), $args );
 630                                 }
 631                         }
 632                         $s .= $loglist->beginLogEventsList() .
 633                                  $logBody .
 634                                  $loglist->endLogEventsList();
 635                 } else {
 636                         if ( $showIfEmpty )
 637                                 $s = wfMsgExt( 'logempty', array('parse') );
 638                 }
 639                 if( $pager->getNumRows() > $pager->mLimit ) { # Show "Full log" link
 640                         $urlParam = array();
 641                         if ( $page != '')
 642                                 $urlParam['page'] = $page;
 643                         if ( $user != '')
 644                                 $urlParam['user'] = $user;
 645                         if ( !is_array( $types ) ) # Make it an array, if it isn't
 646                                 $types = array( $types );
 647                         # If there is exactly one log type, we can link to Special:Log?type=foo
 648                         if ( count( $types ) == 1 )
 649                                 $urlParam['type'] = $types[0];
 650                         $s .= $wgUser->getSkin()->link(
 651                                 SpecialPage::getTitleFor( 'Log' ),
 652                                 wfMsgHtml( 'log-fulllog' ),
 653                                 array(),
 654                                 $urlParam
 655                         );
 656
 657                 }
 658                 if ( $logBody && $msgKey[0] )
 659                         $s .= '</div>';
 660
 661                 if( $out instanceof OutputPage ){
 662                         $out->addHTML( $s );
 663                 } else {
 664                         $out = $s;
 665                 }
 666                 return $pager->getNumRows();
 667         }
 668
 669         /**
 670          * SQL clause to skip forbidden log types for this user
 671          * @param $db Database
 672          * @param $audience string, public/user
 673          * @return mixed (string or false)
 674          */
 675         public static function getExcludeClause( $db, $audience = 'public' ) {
 676                 global $wgLogRestrictions, $wgUser;
 677                 // Reset the array, clears extra "where" clauses when $par is used
 678                 $hiddenLogs = array();
 679                 // Don't show private logs to unprivileged users
 680                 foreach( $wgLogRestrictions as $logType => $right ) {
 681                         if( $audience == 'public' || !$wgUser->isAllowed($right) ) {
 682                                 $safeType = $db->strencode( $logType );
 683                                 $hiddenLogs[] = $safeType;
 684                         }
 685                 }
 686                 if( count($hiddenLogs) == 1 ) {
 687                         return 'log_type != ' . $db->addQuotes( $hiddenLogs[0] );
 688                 } elseif( $hiddenLogs ) {
 689                         return 'log_type NOT IN (' . $db->makeList($hiddenLogs) . ')';
 690                 }
 691                 return false;
 692         }
 693 }
 694
 695 /**
 696  * @ingroup Pager
 697  */
 698 class LogPager extends ReverseChronologicalPager {
 699         private $types = array(), $user = '', $title = '', $pattern = '';
 700         private $typeCGI = '';
 701         public $mLogEventsList;
 702
 703         /**
 704          * constructor
 705          * @param $list LogEventsList
 706          * @param $types String or Array log types to show
 707          * @param $user String The user who made the log entries
 708          * @param $title String The page title the log entries are for
 709          * @param $pattern String Do a prefix search rather than an exact title match
 710          * @param $conds Array Extra conditions for the query
 711          * @param $year Integer The year to start from
 712          * @param $month Integer The month to start from
 713          */
 714         public function __construct( $list, $types = array(), $user = '', $title = '', $pattern = '',
 715                 $conds = array(), $year = false, $month = false, $tagFilter = '' )
 716         {
 717                 parent::__construct();
 718                 $this->mConds = $conds;
 719
 720                 $this->mLogEventsList = $list;
 721
 722                 $this->limitType( $types ); // also excludes hidden types
 723                 $this->limitUser( $user );
 724                 $this->limitTitle( $title, $pattern );
 725                 $this->getDateCond( $year, $month );
 726                 $this->mTagFilter = $tagFilter;
 727         }
 728
 729         public function getDefaultQuery() {
 730                 $query = parent::getDefaultQuery();
 731                 $query['type'] = $this->typeCGI; // arrays won't work here
 732                 $query['user'] = $this->user;
 733                 $query['month'] = $this->mMonth;
 734                 $query['year'] = $this->mYear;
 735                 return $query;
 736         }
 737
 738         // Call ONLY after calling $this->limitType() already!
 739         public function getFilterParams() {
 740                 global $wgFilterLogTypes, $wgUser, $wgRequest;
 741                 $filters = array();
 742                 if( count($this->types) ) {
 743                         return $filters;
 744                 }
 745                 foreach( $wgFilterLogTypes as $type => $default ) {
 746                         // Avoid silly filtering
 747                         if( $type !== 'patrol' || $wgUser->useNPPatrol() ) {
 748                                 $hide = $wgRequest->getInt( "hide_{$type}_log", $default );
 749                                 $filters[$type] = $hide;
 750                                 if( $hide )
 751                                         $this->mConds[] = 'log_type != ' . $this->mDb->addQuotes( $type );
 752                         }
 753                 }
 754                 return $filters;
 755         }
 756
 757         /**
 758          * Set the log reader to return only entries of the given type.
 759          * Type restrictions enforced here
 760          * @param $types String or array: Log types ('upload', 'delete', etc);
 761          *   empty string means no restriction
 762          */
 763         private function limitType( $types ) {
 764                 global $wgLogRestrictions, $wgUser;
 765                 // If $types is not an array, make it an array
 766                 $types = ($types === '') ? array() : (array)$types;
 767                 // Don't even show header for private logs; don't recognize it...
 768                 foreach ( $types as $type ) {
 769                         if( isset( $wgLogRestrictions[$type] ) && !$wgUser->isAllowed($wgLogRestrictions[$type]) ) {
 770                                 $types = array_diff( $types, array( $type ) );
 771                         }
 772                 }
 773                 // Don't show private logs to unprivileged users.
 774                 // Also, only show them upon specific request to avoid suprises.
 775                 $audience = $types ? 'user' : 'public';
 776                 $hideLogs = LogEventsList::getExcludeClause( $this->mDb, $audience );
 777                 if( $hideLogs !== false ) {
 778                         $this->mConds[] = $hideLogs;
 779                 }
 780                 if( count($types) ) {
 781                         $this->types = $types;
 782                         $this->mConds['log_type'] = $types;
 783                         // Set typeCGI; used in url param for paging
 784                         if( count($types) == 1 ) $this->typeCGI = $types[0];
 785                 }
 786         }
 787
 788         /**
 789          * Set the log reader to return only entries by the given user.
 790          * @param $name String: (In)valid user name
 791          */
 792         private function limitUser( $name ) {
 793                 if( $name == '' ) {
 794                         return false;
 795                 }
 796                 $usertitle = Title::makeTitleSafe( NS_USER, $name );
 797                 if( is_null($usertitle) ) {
 798                         return false;
 799                 }
 800                 /* Fetch userid at first, if known, provides awesome query plan afterwards */
 801                 $userid = User::idFromName( $name );
 802                 if( !$userid ) {
 803                         /* It should be nicer to abort query at all,
 804                            but for now it won't pass anywhere behind the optimizer */
 805                         $this->mConds[] = "NULL";
 806                 } else {
 807                         global $wgUser;
 808                         $this->mConds['log_user'] = $userid;
 809                         // Paranoia: avoid brute force searches (bug 17342)
 810                         if( !$wgUser->isAllowed( 'deletedhistory' ) ) {
 811                                 $this->mConds[] = $this->mDb->bitAnd('log_deleted', LogPage::DELETED_USER) . ' = 0';
 812                         } else if( !$wgUser->isAllowed( 'suppressrevision' ) ) {
 813                                 $this->mConds[] = $this->mDb->bitAnd('log_deleted', LogPage::SUPPRESSED_USER) .
 814                                         ' != ' . LogPage::SUPPRESSED_USER;
 815                         }
 816                         $this->user = $usertitle->getText();
 817                 }
 818         }
 819
 820         /**
 821          * Set the log reader to return only entries affecting the given page.
 822          * (For the block and rights logs, this is a user page.)
 823          * @param $page String: Title name as text
 824          * @param $pattern String
 825          */
 826         private function limitTitle( $page, $pattern ) {
 827                 global $wgMiserMode, $wgUser;
 828
 829                 $title = Title::newFromText( $page );
 830                 if( strlen($page) == 0 || !$title instanceof Title )
 831                         return false;
 832
 833                 $this->title = $title->getPrefixedText();
 834                 $ns = $title->getNamespace();
 835                 # Using the (log_namespace, log_title, log_timestamp) index with a
 836                 # range scan (LIKE) on the first two parts, instead of simple equality,
 837                 # makes it unusable for sorting.  Sorted retrieval using another index
 838                 # would be possible, but then we might have to scan arbitrarily many
 839                 # nodes of that index. Therefore, we need to avoid this if $wgMiserMode
 840                 # is on.
 841                 #
 842                 # This is not a problem with simple title matches, because then we can
 843                 # use the page_time index.  That should have no more than a few hundred
 844                 # log entries for even the busiest pages, so it can be safely scanned
 845                 # in full to satisfy an impossible condition on user or similar.
 846                 if( $pattern && !$wgMiserMode ) {
 847                         # use escapeLike to avoid expensive search patterns like 't%st%'
 848                         $safetitle = $this->mDb->escapeLike( $title->getDBkey() );
 849                         $this->mConds['log_namespace'] = $ns;
 850                         $this->mConds[] = "log_title LIKE '$safetitle%'";
 851                         $this->pattern = $pattern;
 852                 } else {
 853                         $this->mConds['log_namespace'] = $ns;
 854                         $this->mConds['log_title'] = $title->getDBkey();
 855                 }
 856                 // Paranoia: avoid brute force searches (bug 17342)
 857                 if( !$wgUser->isAllowed( 'deletedhistory' ) ) {
 858                         $this->mConds[] = $this->mDb->bitAnd('log_deleted', LogPage::DELETED_ACTION) . ' = 0';
 859                 } else if( !$wgUser->isAllowed( 'suppressrevision' ) ) {
 860                         $this->mConds[] = $this->mDb->bitAnd('log_deleted', LogPage::SUPPRESSED_ACTION) .
 861                                 ' != ' . LogPage::SUPPRESSED_ACTION;
 862                 }
 863         }
 864
 865         public function getQueryInfo() {
 866                 $tables = array( 'logging', 'user' );
 867                 $this->mConds[] = 'user_id = log_user';
 868                 $groupBy = false;
 869                 # Add log_search table if there are conditions on it
 870                 if( array_key_exists('ls_field',$this->mConds) ) {
 871                         $tables[] = 'log_search';
 872                         $index = array( 'log_search' => 'ls_field_val', 'logging' => 'PRIMARY' );
 873                         $groupBy = 'ls_log_id';
 874                 # Don't use the wrong logging index
 875                 } else if( $this->title || $this->pattern || $this->user ) {
 876                         $index = array( 'logging' => array('page_time','user_time') );
 877                 } else if( $this->types ) {
 878                         $index = array( 'logging' => 'type_time' );
 879                 } else {
 880                         $index = array( 'logging' => 'times' );
 881                 }
 882                 $options = array( 'USE INDEX' => $index );
 883                 # Don't show duplicate rows when using log_search
 884                 if( $groupBy ) $options['GROUP BY'] = $groupBy;
 885                 $info = array(
 886                         'tables'     => $tables,
 887                         'fields'     => array( 'log_type', 'log_action', 'log_user', 'log_namespace',
 888                                 'log_title', 'log_params', 'log_comment', 'log_id', 'log_deleted',
 889                                 'log_timestamp', 'user_name', 'user_editcount' ),
 890                         'conds'      => $this->mConds,
 891                         'options'    => $options,
 892                         'join_conds' => array(
 893                                 'user' => array( 'INNER JOIN', 'user_id=log_user' ),
 894                                 'log_search' => array( 'INNER JOIN', 'ls_log_id=log_id' )
 895                         )
 896                 );
 897                 # Add ChangeTags filter query
 898                 ChangeTags::modifyDisplayQuery( $info['tables'], $info['fields'], $info['conds'],
 899                         $info['join_conds'], $info['options'], $this->mTagFilter );
 900
 901                 return $info;
 902         }
 903
 904         function getIndexField() {
 905                 return 'log_timestamp';
 906         }
 907
 908         public function getStartBody() {
 909                 wfProfileIn( __METHOD__ );
 910                 # Do a link batch query
 911                 if( $this->getNumRows() > 0 ) {
 912                         $lb = new LinkBatch;
 913                         while( $row = $this->mResult->fetchObject() ) {
 914                                 $lb->add( $row->log_namespace, $row->log_title );
 915                                 $lb->addObj( Title::makeTitleSafe( NS_USER, $row->user_name ) );
 916                                 $lb->addObj( Title::makeTitleSafe( NS_USER_TALK, $row->user_name ) );
 917                         }
 918                         $lb->execute();
 919                         $this->mResult->seek( 0 );
 920                 }
 921                 wfProfileOut( __METHOD__ );
 922                 return '';
 923         }
 924
 925         public function formatRow( $row ) {
 926                 return $this->mLogEventsList->logLine( $row );
 927         }
 928
 929         public function getType() {
 930                 return $this->types;
 931         }
 932
 933         public function getUser() {
 934                 return $this->user;
 935         }
 936
 937         public function getPage() {
 938                 return $this->title;
 939         }
 940
 941         public function getPattern() {
 942                 return $this->pattern;
 943         }
 944
 945         public function getYear() {
 946                 return $this->mYear;
 947         }
 948
 949         public function getMonth() {
 950                 return $this->mMonth;
 951         }
 952
 953         public function getTagFilter() {
 954                 return $this->mTagFilter;
 955         }
 956
 957         public function doQuery() {
 958                 // Workaround MySQL optimizer bug
 959                 $this->mDb->setBigSelects();
 960                 parent::doQuery();
 961                 $this->mDb->setBigSelects( 'default' );
 962         }
 963 }
 964
 965 /**
 966  * @deprecated
 967  * @ingroup SpecialPage
 968  */
 969 class LogReader {
 970         var $pager;
 971         /**
 972          * @param $request WebRequest: for internal use use a FauxRequest object to pass arbitrary parameters.
 973          */
 974         function __construct( $request ) {
 975                 global $wgUser, $wgOut;
 976                 wfDeprecated(__METHOD__);
 977                 # Get parameters
 978                 $type = $request->getVal( 'type' );
 979                 $user = $request->getText( 'user' );
 980                 $title = $request->getText( 'page' );
 981                 $pattern = $request->getBool( 'pattern' );
 982                 $year = $request->getIntOrNull( 'year' );
 983                 $month = $request->getIntOrNull( 'month' );
 984                 $tagFilter = $request->getVal( 'tagfilter' );
 985                 # Don't let the user get stuck with a certain date
 986                 $skip = $request->getText( 'offset' ) || $request->getText( 'dir' ) == 'prev';
 987                 if( $skip ) {
 988                         $year = '';
 989                         $month = '';
 990                 }
 991                 # Use new list class to output results
 992                 $loglist = new LogEventsList( $wgUser->getSkin(), $wgOut, 0 );
 993                 $this->pager = new LogPager( $loglist, $type, $user, $title, $pattern, $year, $month, $tagFilter );
 994         }
 995
 996         /**
 997         * Is there at least one row?
 998         * @return bool
 999         */
1000         public function hasRows() {
1001                 return isset($this->pager) ? ($this->pager->getNumRows() > 0) : false;
1002         }
1003 }
1004
1005 /**
1006  * @deprecated
1007  * @ingroup SpecialPage
1008  */
1009 class LogViewer {
1010         const NO_ACTION_LINK = 1;
1011
1012         /**
1013          * LogReader object
1014          */
1015         var $reader;
1016
1017         /**
1018          * @param &$reader LogReader: where to get our data from
1019          * @param $flags Integer: Bitwise combination of flags:
1020          *     LogEventsList::NO_ACTION_LINK   Don't show restore/unblock/block links
1021          */
1022         function __construct( &$reader, $flags = 0 ) {
1023                 wfDeprecated(__METHOD__);
1024                 $this->reader =& $reader;
1025                 $this->reader->pager->mLogEventsList->flags = $flags;
1026                 # Aliases for shorter code...
1027                 $this->pager =& $this->reader->pager;
1028                 $this->list =& $this->reader->pager->mLogEventsList;
1029         }
1030
1031         /**
1032          * Take over the whole output page in $wgOut with the log display.
1033          */
1034         public function show() {
1035                 # Set title and add header
1036                 $this->list->showHeader( $pager->getType() );
1037                 # Show form options
1038                 $this->list->showOptions( $this->pager->getType(), $this->pager->getUser(), $this->pager->getPage(),
1039                         $this->pager->getPattern(), $this->pager->getYear(), $this->pager->getMonth() );
1040                 # Insert list
1041                 $logBody = $this->pager->getBody();
1042                 if( $logBody ) {
1043                         $wgOut->addHTML(
1044                                 $this->pager->getNavigationBar() .
1045                                 $this->list->beginLogEventsList() .
1046                                 $logBody .
1047                                 $this->list->endLogEventsList() .
1048                                 $this->pager->getNavigationBar()
1049                         );
1050                 } else {
1051                         $wgOut->addWikiMsg( 'logempty' );
1052                 }
1053         }
1054
1055         /**
1056          * Output just the list of entries given by the linked LogReader,
1057          * with extraneous UI elements. Use for displaying log fragments in
1058          * another page (eg at Special:Undelete)
1059          * @param $out OutputPage: where to send output
1060          */
1061         public function showList( &$out ) {
1062                 $logBody = $this->pager->getBody();
1063                 if( $logBody ) {
1064                         $out->addHTML(
1065                                 $this->list->beginLogEventsList() .
1066                                 $logBody .
1067                                 $this->list->endLogEventsList()
1068                         );
1069                 } else {
1070                         $out->addWikiMsg( 'logempty' );
1071                 }
1072         }
1073 }