includes/logging/LogPager.php

   1 <?php
   2 /**
   3  * Contain classes to list log entries
   4  *
   5  * Copyright © 2004 Brion Vibber <brion@pobox.com>, 2008 Aaron Schulz
   6  * https://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 /**
  27  * @ingroup Pager
  28  */
  29 class LogPager extends ReverseChronologicalPager {
  30         /** @var array Log types */
  31         private $types = array();
  32
  33         /** @var string Events limited to those by performer when set */
  34         private $performer = '';
  35
  36         /** @var string|Title Events limited to those about Title when set */
  37         private $title = '';
  38
  39         /** @var string */
  40         private $pattern = '';
  41
  42         /** @var string */
  43         private $typeCGI = '';
  44
  45         /** @var LogEventsList */
  46         public $mLogEventsList;
  47
  48         /**
  49          * Constructor
  50          *
  51          * @param LogEventsList $list
  52          * @param string|array $types Log types to show
  53          * @param string $performer the user who made the log entries
  54          * @param string|Title $title the page title the log entries are for
  55          * @param string $pattern do a prefix search rather than an exact title match
  56          * @param array $conds extra conditions for the query
  57          * @param int|bool $year The year to start from. Default: false
  58          * @param int|bool $month The month to start from. Default: false
  59          * @param string $tagFilter tag
  60          */
  61         public function __construct( $list, $types = array(), $performer = '', $title = '', $pattern = '',
  62                 $conds = array(), $year = false, $month = false, $tagFilter = '' ) {
  63                 parent::__construct( $list->getContext() );
  64                 $this->mConds = $conds;
  65
  66                 $this->mLogEventsList = $list;
  67
  68                 $this->limitType( $types ); // also excludes hidden types
  69                 $this->limitPerformer( $performer );
  70                 $this->limitTitle( $title, $pattern );
  71                 $this->getDateCond( $year, $month );
  72                 $this->mTagFilter = $tagFilter;
  73
  74                 $this->mDb = wfGetDB( DB_SLAVE, 'logpager' );
  75         }
  76
  77         public function getDefaultQuery() {
  78                 $query = parent::getDefaultQuery();
  79                 $query['type'] = $this->typeCGI; // arrays won't work here
  80                 $query['user'] = $this->performer;
  81                 $query['month'] = $this->mMonth;
  82                 $query['year'] = $this->mYear;
  83
  84                 return $query;
  85         }
  86
  87         // Call ONLY after calling $this->limitType() already!
  88         public function getFilterParams() {
  89                 global $wgFilterLogTypes;
  90                 $filters = array();
  91                 if ( count( $this->types ) ) {
  92                         return $filters;
  93                 }
  94                 foreach ( $wgFilterLogTypes as $type => $default ) {
  95                         // Avoid silly filtering
  96                         if ( $type !== 'patrol' || $this->getUser()->useNPPatrol() ) {
  97                                 $hide = $this->getRequest()->getInt( "hide_{$type}_log", $default );
  98                                 $filters[$type] = $hide;
  99                                 if ( $hide ) {
 100                                         $this->mConds[] = 'log_type != ' . $this->mDb->addQuotes( $type );
 101                                 }
 102                         }
 103                 }
 104
 105                 return $filters;
 106         }
 107
 108         /**
 109          * Set the log reader to return only entries of the given type.
 110          * Type restrictions enforced here
 111          *
 112          * @param string|array $types Log types ('upload', 'delete', etc);
 113          *   empty string means no restriction
 114          */
 115         private function limitType( $types ) {
 116                 global $wgLogRestrictions;
 117
 118                 $user = $this->getUser();
 119                 // If $types is not an array, make it an array
 120                 $types = ( $types === '' ) ? array() : (array)$types;
 121                 // Don't even show header for private logs; don't recognize it...
 122                 $needReindex = false;
 123                 foreach ( $types as $type ) {
 124                         if ( isset( $wgLogRestrictions[$type] )
 125                                 && !$user->isAllowed( $wgLogRestrictions[$type] )
 126                         ) {
 127                                 $needReindex = true;
 128                                 $types = array_diff( $types, array( $type ) );
 129                         }
 130                 }
 131                 if ( $needReindex ) {
 132                         // Lots of this code makes assumptions that
 133                         // the first entry in the array is $types[0].
 134                         $types = array_values( $types );
 135                 }
 136                 $this->types = $types;
 137                 // Don't show private logs to unprivileged users.
 138                 // Also, only show them upon specific request to avoid suprises.
 139                 $audience = $types ? 'user' : 'public';
 140                 $hideLogs = LogEventsList::getExcludeClause( $this->mDb, $audience, $user );
 141                 if ( $hideLogs !== false ) {
 142                         $this->mConds[] = $hideLogs;
 143                 }
 144                 if ( count( $types ) ) {
 145                         $this->mConds['log_type'] = $types;
 146                         // Set typeCGI; used in url param for paging
 147                         if ( count( $types ) == 1 ) {
 148                                 $this->typeCGI = $types[0];
 149                         }
 150                 }
 151         }
 152
 153         /**
 154          * Set the log reader to return only entries by the given user.
 155          *
 156          * @param string $name (In)valid user name
 157          * @return void
 158          */
 159         private function limitPerformer( $name ) {
 160                 if ( $name == '' ) {
 161                         return;
 162                 }
 163                 $usertitle = Title::makeTitleSafe( NS_USER, $name );
 164                 if ( is_null( $usertitle ) ) {
 165                         return;
 166                 }
 167                 /* Fetch userid at first, if known, provides awesome query plan afterwards */
 168                 $userid = User::idFromName( $name );
 169                 if ( !$userid ) {
 170                         $this->mConds['log_user_text'] = IP::sanitizeIP( $name );
 171                 } else {
 172                         $this->mConds['log_user'] = $userid;
 173                 }
 174                 // Paranoia: avoid brute force searches (bug 17342)
 175                 $user = $this->getUser();
 176                 if ( !$user->isAllowed( 'deletedhistory' ) ) {
 177                         $this->mConds[] = $this->mDb->bitAnd( 'log_deleted', LogPage::DELETED_USER ) . ' = 0';
 178                 } elseif ( !$user->isAllowed( 'suppressrevision' ) ) {
 179                         $this->mConds[] = $this->mDb->bitAnd( 'log_deleted', LogPage::SUPPRESSED_USER ) .
 180                                 ' != ' . LogPage::SUPPRESSED_USER;
 181                 }
 182
 183                 $this->performer = $usertitle->getText();
 184         }
 185
 186         /**
 187          * Set the log reader to return only entries affecting the given page.
 188          * (For the block and rights logs, this is a user page.)
 189          *
 190          * @param string|Title $page Title name
 191          * @param string $pattern
 192          * @return void
 193          */
 194         private function limitTitle( $page, $pattern ) {
 195                 global $wgMiserMode;
 196
 197                 if ( $page instanceof Title ) {
 198                         $title = $page;
 199                 } else {
 200                         $title = Title::newFromText( $page );
 201                         if ( strlen( $page ) == 0 || !$title instanceof Title ) {
 202                                 return;
 203                         }
 204                 }
 205
 206                 $this->title = $title->getPrefixedText();
 207                 $ns = $title->getNamespace();
 208                 $db = $this->mDb;
 209
 210                 # Using the (log_namespace, log_title, log_timestamp) index with a
 211                 # range scan (LIKE) on the first two parts, instead of simple equality,
 212                 # makes it unusable for sorting.  Sorted retrieval using another index
 213                 # would be possible, but then we might have to scan arbitrarily many
 214                 # nodes of that index. Therefore, we need to avoid this if $wgMiserMode
 215                 # is on.
 216                 #
 217                 # This is not a problem with simple title matches, because then we can
 218                 # use the page_time index.  That should have no more than a few hundred
 219                 # log entries for even the busiest pages, so it can be safely scanned
 220                 # in full to satisfy an impossible condition on user or similar.
 221                 if ( $pattern && !$wgMiserMode ) {
 222                         $this->mConds['log_namespace'] = $ns;
 223                         $this->mConds[] = 'log_title ' . $db->buildLike( $title->getDBkey(), $db->anyString() );
 224                         $this->pattern = $pattern;
 225                 } else {
 226                         $this->mConds['log_namespace'] = $ns;
 227                         $this->mConds['log_title'] = $title->getDBkey();
 228                 }
 229                 // Paranoia: avoid brute force searches (bug 17342)
 230                 $user = $this->getUser();
 231                 if ( !$user->isAllowed( 'deletedhistory' ) ) {
 232                         $this->mConds[] = $db->bitAnd( 'log_deleted', LogPage::DELETED_ACTION ) . ' = 0';
 233                 } elseif ( !$user->isAllowed( 'suppressrevision' ) ) {
 234                         $this->mConds[] = $db->bitAnd( 'log_deleted', LogPage::SUPPRESSED_ACTION ) .
 235                                 ' != ' . LogPage::SUPPRESSED_ACTION;
 236                 }
 237         }
 238
 239         /**
 240          * Constructs the most part of the query. Extra conditions are sprinkled in
 241          * all over this class.
 242          * @return array
 243          */
 244         public function getQueryInfo() {
 245                 $basic = DatabaseLogEntry::getSelectQueryData();
 246
 247                 $tables = $basic['tables'];
 248                 $fields = $basic['fields'];
 249                 $conds = $basic['conds'];
 250                 $options = $basic['options'];
 251                 $joins = $basic['join_conds'];
 252
 253                 $index = array();
 254                 # Add log_search table if there are conditions on it.
 255                 # This filters the results to only include log rows that have
 256                 # log_search records with the specified ls_field and ls_value values.
 257                 if ( array_key_exists( 'ls_field', $this->mConds ) ) {
 258                         $tables[] = 'log_search';
 259                         $index['log_search'] = 'ls_field_val';
 260                         $index['logging'] = 'PRIMARY';
 261                         if ( !$this->hasEqualsClause( 'ls_field' )
 262                                 || !$this->hasEqualsClause( 'ls_value' )
 263                         ) {
 264                                 # Since (ls_field,ls_value,ls_logid) is unique, if the condition is
 265                                 # to match a specific (ls_field,ls_value) tuple, then there will be
 266                                 # no duplicate log rows. Otherwise, we need to remove the duplicates.
 267                                 $options[] = 'DISTINCT';
 268                         }
 269                 }
 270                 if ( count( $index ) ) {
 271                         $options['USE INDEX'] = $index;
 272                 }
 273                 # Don't show duplicate rows when using log_search
 274                 $joins['log_search'] = array( 'INNER JOIN', 'ls_log_id=log_id' );
 275
 276                 $info = array(
 277                         'tables' => $tables,
 278                         'fields' => $fields,
 279                         'conds' => array_merge( $conds, $this->mConds ),
 280                         'options' => $options,
 281                         'join_conds' => $joins,
 282                 );
 283                 # Add ChangeTags filter query
 284                 ChangeTags::modifyDisplayQuery( $info['tables'], $info['fields'], $info['conds'],
 285                         $info['join_conds'], $info['options'], $this->mTagFilter );
 286
 287                 return $info;
 288         }
 289
 290         /**
 291          * Checks if $this->mConds has $field matched to a *single* value
 292          * @param $field
 293          * @return bool
 294          */
 295         protected function hasEqualsClause( $field ) {
 296                 return (
 297                         array_key_exists( $field, $this->mConds ) &&
 298                         ( !is_array( $this->mConds[$field] ) || count( $this->mConds[$field] ) == 1 )
 299                 );
 300         }
 301
 302         function getIndexField() {
 303                 return 'log_timestamp';
 304         }
 305
 306         public function getStartBody() {
 307                 wfProfileIn( __METHOD__ );
 308                 # Do a link batch query
 309                 if ( $this->getNumRows() > 0 ) {
 310                         $lb = new LinkBatch;
 311                         foreach ( $this->mResult as $row ) {
 312                                 $lb->add( $row->log_namespace, $row->log_title );
 313                                 $lb->addObj( Title::makeTitleSafe( NS_USER, $row->user_name ) );
 314                                 $lb->addObj( Title::makeTitleSafe( NS_USER_TALK, $row->user_name ) );
 315                                 $formatter = LogFormatter::newFromRow( $row );
 316                                 foreach ( $formatter->getPreloadTitles() as $title ) {
 317                                         $lb->addObj( $title );
 318                                 }
 319                         }
 320                         $lb->execute();
 321                         $this->mResult->seek( 0 );
 322                 }
 323                 wfProfileOut( __METHOD__ );
 324
 325                 return '';
 326         }
 327
 328         public function formatRow( $row ) {
 329                 return $this->mLogEventsList->logLine( $row );
 330         }
 331
 332         public function getType() {
 333                 return $this->types;
 334         }
 335
 336         /**
 337          * @return string
 338          */
 339         public function getPerformer() {
 340                 return $this->performer;
 341         }
 342
 343         /**
 344          * @return string
 345          */
 346         public function getPage() {
 347                 return $this->title;
 348         }
 349
 350         public function getPattern() {
 351                 return $this->pattern;
 352         }
 353
 354         public function getYear() {
 355                 return $this->mYear;
 356         }
 357
 358         public function getMonth() {
 359                 return $this->mMonth;
 360         }
 361
 362         public function getTagFilter() {
 363                 return $this->mTagFilter;
 364         }
 365
 366         public function doQuery() {
 367                 // Workaround MySQL optimizer bug
 368                 $this->mDb->setBigSelects();
 369                 parent::doQuery();
 370                 $this->mDb->setBigSelects( 'default' );
 371         }
 372 }