includes/api/ApiQueryLogEvents.php

   1 <?php
   2 /**
   3  *
   4  *
   5  * Created on Oct 16, 2006
   6  *
   7  * Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License along
  20  * with this program; if not, write to the Free Software Foundation, Inc.,
  21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  22  * http://www.gnu.org/copyleft/gpl.html
  23  *
  24  * @file
  25  */
  26
  27 /**
  28  * Query action to List the log events, with optional filtering by various parameters.
  29  *
  30  * @ingroup API
  31  */
  32 class ApiQueryLogEvents extends ApiQueryBase {
  33
  34         public function __construct( ApiQuery $query, $moduleName ) {
  35                 parent::__construct( $query, $moduleName, 'le' );
  36         }
  37
  38         private $fld_ids = false, $fld_title = false, $fld_type = false,
  39                 $fld_user = false, $fld_userid = false,
  40                 $fld_timestamp = false, $fld_comment = false, $fld_parsedcomment = false,
  41                 $fld_details = false, $fld_tags = false;
  42
  43         public function execute() {
  44                 $params = $this->extractRequestParams();
  45                 $db = $this->getDB();
  46                 $this->requireMaxOneParameter( $params, 'title', 'prefix', 'namespace' );
  47
  48                 $prop = array_flip( $params['prop'] );
  49
  50                 $this->fld_ids = isset( $prop['ids'] );
  51                 $this->fld_title = isset( $prop['title'] );
  52                 $this->fld_type = isset( $prop['type'] );
  53                 $this->fld_user = isset( $prop['user'] );
  54                 $this->fld_userid = isset( $prop['userid'] );
  55                 $this->fld_timestamp = isset( $prop['timestamp'] );
  56                 $this->fld_comment = isset( $prop['comment'] );
  57                 $this->fld_parsedcomment = isset( $prop['parsedcomment'] );
  58                 $this->fld_details = isset( $prop['details'] );
  59                 $this->fld_tags = isset( $prop['tags'] );
  60
  61                 $hideLogs = LogEventsList::getExcludeClause( $db, 'user', $this->getUser() );
  62                 if ( $hideLogs !== false ) {
  63                         $this->addWhere( $hideLogs );
  64                 }
  65
  66                 // Order is significant here
  67                 $this->addTables( array( 'logging', 'user', 'page' ) );
  68                 $this->addJoinConds( array(
  69                         'user' => array( 'LEFT JOIN',
  70                                 'user_id=log_user' ),
  71                         'page' => array( 'LEFT JOIN',
  72                                 array( 'log_namespace=page_namespace',
  73                                         'log_title=page_title' ) ) ) );
  74
  75                 $this->addFields( array(
  76                         'log_id',
  77                         'log_type',
  78                         'log_action',
  79                         'log_timestamp',
  80                         'log_deleted',
  81                 ) );
  82
  83                 $this->addFieldsIf( 'page_id', $this->fld_ids );
  84                 // log_page is the page_id saved at log time, whereas page_id is from a
  85                 // join at query time.  This leads to different results in various
  86                 // scenarios, e.g. deletion, recreation.
  87                 $this->addFieldsIf( 'log_page', $this->fld_ids );
  88                 $this->addFieldsIf( array( 'log_user', 'log_user_text', 'user_name' ), $this->fld_user );
  89                 $this->addFieldsIf( 'log_user', $this->fld_userid );
  90                 $this->addFieldsIf(
  91                         array( 'log_namespace', 'log_title' ),
  92                         $this->fld_title || $this->fld_parsedcomment
  93                 );
  94                 $this->addFieldsIf( 'log_comment', $this->fld_comment || $this->fld_parsedcomment );
  95                 $this->addFieldsIf( 'log_params', $this->fld_details );
  96
  97                 if ( $this->fld_tags ) {
  98                         $this->addTables( 'tag_summary' );
  99                         $this->addJoinConds( array( 'tag_summary' => array( 'LEFT JOIN', 'log_id=ts_log_id' ) ) );
 100                         $this->addFields( 'ts_tags' );
 101                 }
 102
 103                 if ( !is_null( $params['tag'] ) ) {
 104                         $this->addTables( 'change_tag' );
 105                         $this->addJoinConds( array( 'change_tag' => array( 'INNER JOIN',
 106                                 array( 'log_id=ct_log_id' ) ) ) );
 107                         $this->addWhereFld( 'ct_tag', $params['tag'] );
 108                 }
 109
 110                 if ( !is_null( $params['action'] ) ) {
 111                         // Do validation of action param, list of allowed actions can contains wildcards
 112                         // Allow the param, when the actions is in the list or a wildcard version is listed.
 113                         $logAction = $params['action'];
 114                         if ( strpos( $logAction, '/' ) === false ) {
 115                                 // all items in the list have a slash
 116                                 $valid = false;
 117                         } else {
 118                                 $logActions = array_flip( $this->getAllowedLogActions() );
 119                                 list( $type, $action ) = explode( '/', $logAction, 2 );
 120                                 $valid = isset( $logActions[$logAction] ) || isset( $logActions[$type . '/*'] );
 121                         }
 122
 123                         if ( !$valid ) {
 124                                 $valueName = $this->encodeParamName( 'action' );
 125                                 $this->dieUsage(
 126                                         "Unrecognized value for parameter '$valueName': {$logAction}",
 127                                         "unknown_$valueName"
 128                                 );
 129                         }
 130
 131                         $this->addWhereFld( 'log_type', $type );
 132                         $this->addWhereFld( 'log_action', $action );
 133                 } elseif ( !is_null( $params['type'] ) ) {
 134                         $this->addWhereFld( 'log_type', $params['type'] );
 135                 }
 136
 137                 $this->addTimestampWhereRange(
 138                         'log_timestamp',
 139                         $params['dir'],
 140                         $params['start'],
 141                         $params['end']
 142                 );
 143                 // Include in ORDER BY for uniqueness
 144                 $this->addWhereRange( 'log_id', $params['dir'], null, null );
 145
 146                 if ( !is_null( $params['continue'] ) ) {
 147                         $cont = explode( '|', $params['continue'] );
 148                         $this->dieContinueUsageIf( count( $cont ) != 2 );
 149                         $op = ( $params['dir'] === 'newer' ? '>' : '<' );
 150                         $continueTimestamp = $db->addQuotes( $db->timestamp( $cont[0] ) );
 151                         $continueId = (int)$cont[1];
 152                         $this->dieContinueUsageIf( $continueId != $cont[1] );
 153                         $this->addWhere( "log_timestamp $op $continueTimestamp OR " .
 154                                 "(log_timestamp = $continueTimestamp AND " .
 155                                 "log_id $op= $continueId)"
 156                         );
 157                 }
 158
 159                 $limit = $params['limit'];
 160                 $this->addOption( 'LIMIT', $limit + 1 );
 161
 162                 $user = $params['user'];
 163                 if ( !is_null( $user ) ) {
 164                         $userid = User::idFromName( $user );
 165                         if ( $userid ) {
 166                                 $this->addWhereFld( 'log_user', $userid );
 167                         } else {
 168                                 $this->addWhereFld( 'log_user_text', IP::sanitizeIP( $user ) );
 169                         }
 170                 }
 171
 172                 $title = $params['title'];
 173                 if ( !is_null( $title ) ) {
 174                         $titleObj = Title::newFromText( $title );
 175                         if ( is_null( $titleObj ) ) {
 176                                 $this->dieUsage( "Bad title value '$title'", 'param_title' );
 177                         }
 178                         $this->addWhereFld( 'log_namespace', $titleObj->getNamespace() );
 179                         $this->addWhereFld( 'log_title', $titleObj->getDBkey() );
 180                 }
 181
 182                 if ( $params['namespace'] !== null ) {
 183                         $this->addWhereFld( 'log_namespace', $params['namespace'] );
 184                 }
 185
 186                 $prefix = $params['prefix'];
 187
 188                 if ( !is_null( $prefix ) ) {
 189                         if ( $this->getConfig()->get( 'MiserMode' ) ) {
 190                                 $this->dieUsage( 'Prefix search disabled in Miser Mode', 'prefixsearchdisabled' );
 191                         }
 192
 193                         $title = Title::newFromText( $prefix );
 194                         if ( is_null( $title ) ) {
 195                                 $this->dieUsage( "Bad title value '$prefix'", 'param_prefix' );
 196                         }
 197                         $this->addWhereFld( 'log_namespace', $title->getNamespace() );
 198                         $this->addWhere( 'log_title ' . $db->buildLike( $title->getDBkey(), $db->anyString() ) );
 199                 }
 200
 201                 // Paranoia: avoid brute force searches (bug 17342)
 202                 if ( $params['namespace'] !== null || !is_null( $title ) || !is_null( $user ) ) {
 203                         if ( !$this->getUser()->isAllowed( 'deletedhistory' ) ) {
 204                                 $titleBits = LogPage::DELETED_ACTION;
 205                                 $userBits = LogPage::DELETED_USER;
 206                         } elseif ( !$this->getUser()->isAllowedAny( 'suppressrevision', 'viewsuppressed' ) ) {
 207                                 $titleBits = LogPage::DELETED_ACTION | LogPage::DELETED_RESTRICTED;
 208                                 $userBits = LogPage::DELETED_USER | LogPage::DELETED_RESTRICTED;
 209                         } else {
 210                                 $titleBits = 0;
 211                                 $userBits = 0;
 212                         }
 213                         if ( ( $params['namespace'] !== null || !is_null( $title ) ) && $titleBits ) {
 214                                 $this->addWhere( $db->bitAnd( 'log_deleted', $titleBits ) . " != $titleBits" );
 215                         }
 216                         if ( !is_null( $user ) && $userBits ) {
 217                                 $this->addWhere( $db->bitAnd( 'log_deleted', $userBits ) . " != $userBits" );
 218                         }
 219                 }
 220
 221                 $count = 0;
 222                 $res = $this->select( __METHOD__ );
 223                 $result = $this->getResult();
 224                 foreach ( $res as $row ) {
 225                         if ( ++$count > $limit ) {
 226                                 // We've reached the one extra which shows that there are
 227                                 // additional pages to be had. Stop here...
 228                                 $this->setContinueEnumParameter( 'continue', "$row->log_timestamp|$row->log_id" );
 229                                 break;
 230                         }
 231
 232                         $vals = $this->extractRowInfo( $row );
 233                         $fit = $result->addValue( array( 'query', $this->getModuleName() ), null, $vals );
 234                         if ( !$fit ) {
 235                                 $this->setContinueEnumParameter( 'continue', "$row->log_timestamp|$row->log_id" );
 236                                 break;
 237                         }
 238                 }
 239                 $result->addIndexedTagName( array( 'query', $this->getModuleName() ), 'item' );
 240         }
 241
 242         /**
 243          * @deprecated since 1.25 Use LogFormatter::formatParametersForApi instead
 244          * @param ApiResult $result
 245          * @param array $vals
 246          * @param string $params
 247          * @param string $type
 248          * @param string $action
 249          * @param string $ts
 250          * @param bool $legacy
 251          * @return array
 252          */
 253         public static function addLogParams( $result, &$vals, $params, $type,
 254                 $action, $ts, $legacy = false
 255         ) {
 256                 wfDeprecated( __METHOD__, '1.25' );
 257
 258                 $entry = new ManualLogEntry( $type, $action );
 259                 $entry->setParameters( $params );
 260                 $entry->setTimestamp( $ts );
 261                 $entry->setLegacy( $legacy );
 262                 $formatter = LogFormatter::newFromEntry( $entry );
 263                 $vals['params'] = $formatter->formatParametersForApi();
 264
 265                 return $vals;
 266         }
 267
 268         private function extractRowInfo( $row ) {
 269                 $logEntry = DatabaseLogEntry::newFromRow( $row );
 270                 $vals = array(
 271                         ApiResult::META_TYPE => 'assoc',
 272                 );
 273                 $anyHidden = false;
 274                 $user = $this->getUser();
 275
 276                 if ( $this->fld_ids ) {
 277                         $vals['logid'] = intval( $row->log_id );
 278                 }
 279
 280                 if ( $this->fld_title || $this->fld_parsedcomment ) {
 281                         $title = Title::makeTitle( $row->log_namespace, $row->log_title );
 282                 }
 283
 284                 if ( $this->fld_title || $this->fld_ids || $this->fld_details && $row->log_params !== '' ) {
 285                         if ( LogEventsList::isDeleted( $row, LogPage::DELETED_ACTION ) ) {
 286                                 $vals['actionhidden'] = true;
 287                                 $anyHidden = true;
 288                         }
 289                         if ( LogEventsList::userCan( $row, LogPage::DELETED_ACTION, $user ) ) {
 290                                 if ( $this->fld_title ) {
 291                                         ApiQueryBase::addTitleInfo( $vals, $title );
 292                                 }
 293                                 if ( $this->fld_ids ) {
 294                                         $vals['pageid'] = intval( $row->page_id );
 295                                         $vals['logpage'] = intval( $row->log_page );
 296                                 }
 297                                 if ( $this->fld_details ) {
 298                                         $vals['params'] = LogFormatter::newFromEntry( $logEntry )->formatParametersForApi();
 299                                 }
 300                         }
 301                 }
 302
 303                 if ( $this->fld_type ) {
 304                         $vals['type'] = $row->log_type;
 305                         $vals['action'] = $row->log_action;
 306                 }
 307
 308                 if ( $this->fld_user || $this->fld_userid ) {
 309                         if ( LogEventsList::isDeleted( $row, LogPage::DELETED_USER ) ) {
 310                                 $vals['userhidden'] = true;
 311                                 $anyHidden = true;
 312                         }
 313                         if ( LogEventsList::userCan( $row, LogPage::DELETED_USER, $user ) ) {
 314                                 if ( $this->fld_user ) {
 315                                         $vals['user'] = $row->user_name === null ? $row->log_user_text : $row->user_name;
 316                                 }
 317                                 if ( $this->fld_userid ) {
 318                                         $vals['userid'] = intval( $row->log_user );
 319                                 }
 320
 321                                 if ( !$row->log_user ) {
 322                                         $vals['anon'] = true;
 323                                 }
 324                         }
 325                 }
 326                 if ( $this->fld_timestamp ) {
 327                         $vals['timestamp'] = wfTimestamp( TS_ISO_8601, $row->log_timestamp );
 328                 }
 329
 330                 if ( ( $this->fld_comment || $this->fld_parsedcomment ) && isset( $row->log_comment ) ) {
 331                         if ( LogEventsList::isDeleted( $row, LogPage::DELETED_COMMENT ) ) {
 332                                 $vals['commenthidden'] = true;
 333                                 $anyHidden = true;
 334                         }
 335                         if ( LogEventsList::userCan( $row, LogPage::DELETED_COMMENT, $user ) ) {
 336                                 if ( $this->fld_comment ) {
 337                                         $vals['comment'] = $row->log_comment;
 338                                 }
 339
 340                                 if ( $this->fld_parsedcomment ) {
 341                                         $vals['parsedcomment'] = Linker::formatComment( $row->log_comment, $title );
 342                                 }
 343                         }
 344                 }
 345
 346                 if ( $this->fld_tags ) {
 347                         if ( $row->ts_tags ) {
 348                                 $tags = explode( ',', $row->ts_tags );
 349                                 ApiResult::setIndexedTagName( $tags, 'tag' );
 350                                 $vals['tags'] = $tags;
 351                         } else {
 352                                 $vals['tags'] = array();
 353                         }
 354                 }
 355
 356                 if ( $anyHidden && LogEventsList::isDeleted( $row, LogPage::DELETED_RESTRICTED ) ) {
 357                         $vals['suppressed'] = true;
 358                 }
 359
 360                 return $vals;
 361         }
 362
 363         /**
 364          * @return array
 365          */
 366         private function getAllowedLogActions() {
 367                 $config = $this->getConfig();
 368                 return array_keys( array_merge(
 369                         $config->get( 'LogActions' ),
 370                         $config->get( 'LogActionsHandlers' )
 371                 ) );
 372         }
 373
 374         public function getCacheMode( $params ) {
 375                 if ( $this->userCanSeeRevDel() ) {
 376                         return 'private';
 377                 }
 378                 if ( !is_null( $params['prop'] ) && in_array( 'parsedcomment', $params['prop'] ) ) {
 379                         // formatComment() calls wfMessage() among other things
 380                         return 'anon-public-user-private';
 381                 } elseif ( LogEventsList::getExcludeClause( $this->getDB(), 'user', $this->getUser() )
 382                         === LogEventsList::getExcludeClause( $this->getDB(), 'public' )
 383                 ) { // Output can only contain public data.
 384                         return 'public';
 385                 } else {
 386                         return 'anon-public-user-private';
 387                 }
 388         }
 389
 390         public function getAllowedParams( $flags = 0 ) {
 391                 $config = $this->getConfig();
 392                 $ret = array(
 393                         'prop' => array(
 394                                 ApiBase::PARAM_ISMULTI => true,
 395                                 ApiBase::PARAM_DFLT => 'ids|title|type|user|timestamp|comment|details',
 396                                 ApiBase::PARAM_TYPE => array(
 397                                         'ids',
 398                                         'title',
 399                                         'type',
 400                                         'user',
 401                                         'userid',
 402                                         'timestamp',
 403                                         'comment',
 404                                         'parsedcomment',
 405                                         'details',
 406                                         'tags'
 407                                 ),
 408                                 ApiBase::PARAM_HELP_MSG_PER_VALUE => array(),
 409                         ),
 410                         'type' => array(
 411                                 ApiBase::PARAM_TYPE => $config->get( 'LogTypes' )
 412                         ),
 413                         'action' => array(
 414                                 // validation on request is done in execute()
 415                                 ApiBase::PARAM_TYPE => ( $flags & ApiBase::GET_VALUES_FOR_HELP )
 416                                         ? $this->getAllowedLogActions()
 417                                         : null
 418                         ),
 419                         'start' => array(
 420                                 ApiBase::PARAM_TYPE => 'timestamp'
 421                         ),
 422                         'end' => array(
 423                                 ApiBase::PARAM_TYPE => 'timestamp'
 424                         ),
 425                         'dir' => array(
 426                                 ApiBase::PARAM_DFLT => 'older',
 427                                 ApiBase::PARAM_TYPE => array(
 428                                         'newer',
 429                                         'older'
 430                                 ),
 431                                 ApiBase::PARAM_HELP_MSG => 'api-help-param-direction',
 432                         ),
 433                         'user' => null,
 434                         'title' => null,
 435                         'namespace' => array(
 436                                 ApiBase::PARAM_TYPE => 'namespace'
 437                         ),
 438                         'prefix' => array(),
 439                         'tag' => null,
 440                         'limit' => array(
 441                                 ApiBase::PARAM_DFLT => 10,
 442                                 ApiBase::PARAM_TYPE => 'limit',
 443                                 ApiBase::PARAM_MIN => 1,
 444                                 ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
 445                                 ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
 446                         ),
 447                         'continue' => array(
 448                                 ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
 449                         ),
 450                 );
 451
 452                 if ( $config->get( 'MiserMode' ) ) {
 453                         $ret['prefix'][ApiBase::PARAM_HELP_MSG] = 'api-help-param-disabled-in-miser-mode';
 454                 }
 455
 456                 return $ret;
 457         }
 458
 459         protected function getExamplesMessages() {
 460                 return array(
 461                         'action=query&list=logevents'
 462                                 => 'apihelp-query+logevents-example-simple',
 463                 );
 464         }
 465
 466         public function getHelpUrls() {
 467                 return 'https://www.mediawiki.org/wiki/API:Logevents';
 468         }
 469 }