diff options
Diffstat (limited to 'includes/api/ApiQueryLogEvents.php')
| -rw-r--r-- | includes/api/ApiQueryLogEvents.php | 221 |
1 files changed, 138 insertions, 83 deletions
diff --git a/includes/api/ApiQueryLogEvents.php b/includes/api/ApiQueryLogEvents.php index bdeee952..7d69ca39 100644 --- a/includes/api/ApiQueryLogEvents.php +++ b/includes/api/ApiQueryLogEvents.php @@ -1,11 +1,10 @@ <?php - -/* - * Created on Oct 16, 2006 - * +/** * API for MediaWiki 1.8+ * - * Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com + * Created on Oct 16, 2006 + * + * Copyright © 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -19,13 +18,15 @@ * * You should have received a copy of the GNU General Public License along * with this program; if not, write to the Free Software Foundation, Inc., - * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. * http://www.gnu.org/copyleft/gpl.html + * + * @file */ if ( !defined( 'MEDIAWIKI' ) ) { // Eclipse helper - will be ignored in production - require_once ( 'ApiQueryBase.php' ); + require_once( 'ApiQueryBase.php' ); } /** @@ -36,30 +37,36 @@ if ( !defined( 'MEDIAWIKI' ) ) { class ApiQueryLogEvents extends ApiQueryBase { public function __construct( $query, $moduleName ) { - parent :: __construct( $query, $moduleName, 'le' ); + parent::__construct( $query, $moduleName, 'le' ); } + private $fld_ids = false, $fld_title = false, $fld_type = false, + $fld_action = false, $fld_user = false, $fld_userid = false, + $fld_timestamp = false, $fld_comment = false, $fld_parsedcomment = false, + $fld_details = false, $fld_tags = false; + public function execute() { $params = $this->extractRequestParams(); $db = $this->getDB(); - + $prop = array_flip( $params['prop'] ); - + $this->fld_ids = isset( $prop['ids'] ); $this->fld_title = isset( $prop['title'] ); $this->fld_type = isset( $prop['type'] ); + $this->fld_action = isset ( $prop['action'] ); $this->fld_user = isset( $prop['user'] ); + $this->fld_userid = isset( $prop['userid'] ); $this->fld_timestamp = isset( $prop['timestamp'] ); $this->fld_comment = isset( $prop['comment'] ); $this->fld_parsedcomment = isset ( $prop['parsedcomment'] ); $this->fld_details = isset( $prop['details'] ); $this->fld_tags = isset( $prop['tags'] ); - list( $tbl_logging, $tbl_page, $tbl_user ) = $db->tableNamesN( 'logging', 'page', 'user' ); - $hideLogs = LogEventsList::getExcludeClause( $db ); - if ( $hideLogs !== false ) + if ( $hideLogs !== false ) { $this->addWhere( $hideLogs ); + } // Order is significant here $this->addTables( array( 'logging', 'user', 'page' ) ); @@ -72,7 +79,7 @@ class ApiQueryLogEvents extends ApiQueryBase { 'log_title=page_title' ) ) ) ); $index = array( 'logging' => 'times' ); // default, may change - $this->addFields( array ( + $this->addFields( array( 'log_type', 'log_action', 'log_timestamp', @@ -83,30 +90,36 @@ class ApiQueryLogEvents extends ApiQueryBase { $this->addFieldsIf( 'page_id', $this->fld_ids ); $this->addFieldsIf( 'log_user', $this->fld_user ); $this->addFieldsIf( 'user_name', $this->fld_user ); - $this->addFieldsIf( 'log_namespace', $this->fld_title ); - $this->addFieldsIf( 'log_title', $this->fld_title ); + $this->addFieldsIf( 'user_id', $this->fld_userid ); + $this->addFieldsIf( 'log_namespace', $this->fld_title || $this->fld_parsedcomment ); + $this->addFieldsIf( 'log_title', $this->fld_title || $this->fld_parsedcomment ); $this->addFieldsIf( 'log_comment', $this->fld_comment || $this->fld_parsedcomment ); $this->addFieldsIf( 'log_params', $this->fld_details ); - + if ( $this->fld_tags ) { $this->addTables( 'tag_summary' ); $this->addJoinConds( array( 'tag_summary' => array( 'LEFT JOIN', 'log_id=ts_log_id' ) ) ); $this->addFields( 'ts_tags' ); } - + if ( !is_null( $params['tag'] ) ) { $this->addTables( 'change_tag' ); $this->addJoinConds( array( 'change_tag' => array( 'INNER JOIN', array( 'log_id=ct_log_id' ) ) ) ); $this->addWhereFld( 'ct_tag', $params['tag'] ); global $wgOldChangeTagsIndex; - $index['change_tag'] = $wgOldChangeTagsIndex ? 'ct_tag' : 'change_tag_tag_id'; + $index['change_tag'] = $wgOldChangeTagsIndex ? 'ct_tag' : 'change_tag_tag_id'; } - - if ( !is_null( $params['type'] ) ) { + + if ( !is_null( $params['action'] ) ) { + list( $type, $action ) = explode( '/', $params['action'] ); + $this->addWhereFld( 'log_type', $type ); + $this->addWhereFld( 'log_action', $action ); + } + else if ( !is_null( $params['type'] ) ) { $this->addWhereFld( 'log_type', $params['type'] ); $index['logging'] = 'type_time'; } - + $this->addWhereRange( 'log_timestamp', $params['dir'], $params['start'], $params['end'] ); $limit = $params['limit']; @@ -115,17 +128,19 @@ class ApiQueryLogEvents extends ApiQueryBase { $user = $params['user']; if ( !is_null( $user ) ) { $userid = User::idFromName( $user ); - if ( !$userid ) + if ( !$userid ) { $this->dieUsage( "User name $user not found", 'param_user' ); + } $this->addWhereFld( 'log_user', $userid ); $index['logging'] = 'user_time'; } $title = $params['title']; if ( !is_null( $title ) ) { - $titleObj = Title :: newFromText( $title ); - if ( is_null( $titleObj ) ) + $titleObj = Title::newFromText( $title ); + if ( is_null( $titleObj ) ) { $this->dieUsage( "Bad title value '$title'", 'param_title' ); + } $this->addWhereFld( 'log_namespace', $titleObj->getNamespace() ); $this->addWhereFld( 'log_title', $titleObj->getDBkey() ); @@ -145,7 +160,7 @@ class ApiQueryLogEvents extends ApiQueryBase { $count = 0; $res = $this->select( __METHOD__ ); - while ( $row = $db->fetchObject( $res ) ) { + foreach ( $res as $row ) { if ( ++ $count > $limit ) { // We've reached the one extra which shows that there are additional pages to be had. Stop here... $this->setContinueEnumParameter( 'start', wfTimestamp( TS_ISO_8601, $row->log_timestamp ) ); @@ -153,33 +168,40 @@ class ApiQueryLogEvents extends ApiQueryBase { } $vals = $this->extractRowInfo( $row ); - if ( !$vals ) + if ( !$vals ) { continue; + } $fit = $this->getResult()->addValue( array( 'query', $this->getModuleName() ), null, $vals ); - if ( !$fit ) - { + if ( !$fit ) { $this->setContinueEnumParameter( 'start', wfTimestamp( TS_ISO_8601, $row->log_timestamp ) ); break; } } - $db->freeResult( $res ); - $this->getResult()->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'item' ); } - + + /** + * @static + * @param $result ApiResult + * @param $vals + * @param $params + * @param $type + * @param $ts + * @return array + */ public static function addLogParams( $result, &$vals, $params, $type, $ts ) { $params = explode( "\n", $params ); switch ( $type ) { case 'move': - if ( isset ( $params[0] ) ) { - $title = Title :: newFromText( $params[0] ); + if ( isset( $params[0] ) ) { + $title = Title::newFromText( $params[0] ); if ( $title ) { $vals2 = array(); - ApiQueryBase :: addTitleInfo( $vals2, $title, "new_" ); + ApiQueryBase::addTitleInfo( $vals2, $title, 'new_' ); $vals[$type] = $vals2; } } - if ( isset ( $params[1] ) && $params[1] ) { + if ( isset( $params[1] ) && $params[1] ) { $vals[$type]['suppressedredirect'] = ''; } $params = null; @@ -199,8 +221,12 @@ class ApiQueryLogEvents extends ApiQueryBase { case 'block': $vals2 = array(); list( $vals2['duration'], $vals2['flags'] ) = $params; - $vals2['expiry'] = wfTimestamp( TS_ISO_8601, + + // Indefinite blocks have no expiry time + if ( Block::parseExpiryInput( $params[0] ) !== Block::infinity() ) { + $vals2['expiry'] = wfTimestamp( TS_ISO_8601, strtotime( $params[0], wfTimestamp( TS_UNIX, $ts ) ) ); + } $vals[$type] = $vals2; $params = null; break; @@ -220,7 +246,9 @@ class ApiQueryLogEvents extends ApiQueryBase { $vals['pageid'] = intval( $row->page_id ); } - $title = Title::makeTitle( $row->log_namespace, $row->log_title ); + if ( $this->fld_title || $this->fld_parsedcomment ) { + $title = Title::makeTitle( $row->log_namespace, $row->log_title ); + } if ( $this->fld_title ) { if ( LogEventsList::isDeleted( $row, LogPage::DELETED_ACTION ) ) { @@ -230,7 +258,7 @@ class ApiQueryLogEvents extends ApiQueryBase { } } - if ( $this->fld_type ) { + if ( $this->fld_type || $this->fld_action ) { $vals['type'] = $row->log_type; $vals['action'] = $row->log_action; } @@ -239,32 +267,42 @@ class ApiQueryLogEvents extends ApiQueryBase { if ( LogEventsList::isDeleted( $row, LogPage::DELETED_ACTION ) ) { $vals['actionhidden'] = ''; } else { - self::addLogParams( $this->getResult(), $vals, + self::addLogParams( + $this->getResult(), $vals, $row->log_params, $row->log_type, - $row->log_timestamp ); + $row->log_timestamp + ); } } - if ( $this->fld_user ) { + if ( $this->fld_user || $this->fld_userid ) { if ( LogEventsList::isDeleted( $row, LogPage::DELETED_USER ) ) { $vals['userhidden'] = ''; } else { - $vals['user'] = $row->user_name; - if ( !$row->log_user ) + if ( $this->fld_user ) { + $vals['user'] = $row->user_name; + } + if ( $this->fld_userid ) { + $vals['userid'] = $row->user_id; + } + + if ( !$row->log_user ) { $vals['anon'] = ''; + } } } if ( $this->fld_timestamp ) { $vals['timestamp'] = wfTimestamp( TS_ISO_8601, $row->log_timestamp ); } - + if ( ( $this->fld_comment || $this->fld_parsedcomment ) && isset( $row->log_comment ) ) { if ( LogEventsList::isDeleted( $row, LogPage::DELETED_COMMENT ) ) { $vals['commenthidden'] = ''; } else { - if ( $this->fld_comment ) + if ( $this->fld_comment ) { $vals['comment'] = $row->log_comment; - + } + if ( $this->fld_parsedcomment ) { global $wgUser; $vals['parsedcomment'] = $wgUser->getSkin()->formatComment( $row->log_comment, $title ); @@ -281,10 +319,10 @@ class ApiQueryLogEvents extends ApiQueryBase { $vals['tags'] = array(); } } - + return $vals; } - + public function getCacheMode( $params ) { if ( !is_null( $params['prop'] ) && in_array( 'parsedcomment', $params['prop'] ) ) { // formatComment() calls wfMsg() among other things @@ -295,16 +333,17 @@ class ApiQueryLogEvents extends ApiQueryBase { } public function getAllowedParams() { - global $wgLogTypes; - return array ( - 'prop' => array ( - ApiBase :: PARAM_ISMULTI => true, - ApiBase :: PARAM_DFLT => 'ids|title|type|user|timestamp|comment|details', - ApiBase :: PARAM_TYPE => array ( + global $wgLogTypes, $wgLogActions; + return array( + 'prop' => array( + ApiBase::PARAM_ISMULTI => true, + ApiBase::PARAM_DFLT => 'ids|title|type|user|timestamp|comment|details', + ApiBase::PARAM_TYPE => array( 'ids', 'title', 'type', 'user', + 'userid', 'timestamp', 'comment', 'parsedcomment', @@ -312,18 +351,21 @@ class ApiQueryLogEvents extends ApiQueryBase { 'tags' ) ), - 'type' => array ( - ApiBase :: PARAM_TYPE => $wgLogTypes + 'type' => array( + ApiBase::PARAM_TYPE => $wgLogTypes + ), + 'action' => array( + ApiBase::PARAM_TYPE => array_keys( $wgLogActions ) ), - 'start' => array ( - ApiBase :: PARAM_TYPE => 'timestamp' + 'start' => array( + ApiBase::PARAM_TYPE => 'timestamp' ), - 'end' => array ( - ApiBase :: PARAM_TYPE => 'timestamp' + 'end' => array( + ApiBase::PARAM_TYPE => 'timestamp' ), - 'dir' => array ( - ApiBase :: PARAM_DFLT => 'older', - ApiBase :: PARAM_TYPE => array ( + 'dir' => array( + ApiBase::PARAM_DFLT => 'older', + ApiBase::PARAM_TYPE => array( 'newer', 'older' ) @@ -331,34 +373,47 @@ class ApiQueryLogEvents extends ApiQueryBase { 'user' => null, 'title' => null, 'tag' => null, - 'limit' => array ( - ApiBase :: PARAM_DFLT => 10, - ApiBase :: PARAM_TYPE => 'limit', - ApiBase :: PARAM_MIN => 1, - ApiBase :: PARAM_MAX => ApiBase :: LIMIT_BIG1, - ApiBase :: PARAM_MAX2 => ApiBase :: LIMIT_BIG2 + 'limit' => array( + ApiBase::PARAM_DFLT => 10, + ApiBase::PARAM_TYPE => 'limit', + ApiBase::PARAM_MIN => 1, + ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1, + ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2 ) ); } public function getParamDescription() { - return array ( - 'prop' => 'Which properties to get', + return array( + 'prop' => array( + 'Which properties to get', + ' ids - Adds the id of the log event', + ' title - Adds the title of the page for the log event', + ' type - Adds the type of log event', + ' user - Adds the user responsible for the log event', + ' userid - Adds the user id who was responsible for the log event', + ' timestamp - Adds the timestamp for the event', + ' comment - Adds the comment of the event', + ' parsedcomment - Adds the parsed comment of the event', + ' details - Lists addtional details about the event', + ' tags - Lists tags for the event', + ), 'type' => 'Filter log entries to only this type(s)', - 'start' => 'The timestamp to start enumerating from.', - 'end' => 'The timestamp to end enumerating.', - 'dir' => 'In which direction to enumerate.', - 'user' => 'Filter entries to those made by the given user.', - 'title' => 'Filter entries to those related to a page.', - 'limit' => 'How many total event entries to return.', - 'tag' => 'Only list event entries tagged with this tag.', + 'action' => "Filter log actions to only this type. Overrides {$this->getModulePrefix()}type", + 'start' => 'The timestamp to start enumerating from', + 'end' => 'The timestamp to end enumerating', + 'dir' => 'In which direction to enumerate', + 'user' => 'Filter entries to those made by the given user', + 'title' => 'Filter entries to those related to a page', + 'limit' => 'How many total event entries to return', + 'tag' => 'Only list event entries tagged with this tag', ); } public function getDescription() { - return 'Get events from logs.'; + return 'Get events from logs'; } - + public function getPossibleErrors() { return array_merge( parent::getPossibleErrors(), array( array( 'code' => 'param_user', 'info' => 'User name $user not found' ), @@ -367,12 +422,12 @@ class ApiQueryLogEvents extends ApiQueryBase { } protected function getExamples() { - return array ( + return array( 'api.php?action=query&list=logevents' ); } public function getVersion() { - return __CLASS__ . ': $Id: ApiQueryLogEvents.php 69932 2010-07-26 08:03:21Z tstarling $'; + return __CLASS__ . ': $Id: ApiQueryLogEvents.php 74535 2010-10-09 00:01:45Z reedy $'; } } |