X-Git-Url: https://git.heureux-cyclage.org/?a=blobdiff_plain;f=includes%2Fapi%2FApiQueryLogEvents.php;h=e017c4bdb6b5e2039b5d5dd892c40c92de3e0db0;hb=38a42ed82346c9e5bca0dc31b5d8256c2d6a63f7;hp=5c13172fe8785114e78d92e997fad5ce3243f83f;hpb=fb18f9d8e7e0f90ddf80e4dfce056271a3c52d7b;p=lhc%2Fweb%2Fwiklou.git diff --git a/includes/api/ApiQueryLogEvents.php b/includes/api/ApiQueryLogEvents.php index 5c13172fe8..e017c4bdb6 100644 --- a/includes/api/ApiQueryLogEvents.php +++ b/includes/api/ApiQueryLogEvents.php @@ -1,9 +1,8 @@ @gmail.com * @@ -19,15 +18,12 @@ * * 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' ); -} - /** * Query action to List the log events, with optional filtering by various parameters. * @@ -39,6 +35,11 @@ class ApiQueryLogEvents extends ApiQueryBase { 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(); @@ -50,14 +51,13 @@ class ApiQueryLogEvents extends ApiQueryBase { $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 ) { $this->addWhere( $hideLogs ); @@ -81,12 +81,10 @@ class ApiQueryLogEvents extends ApiQueryBase { 'log_deleted', ) ); - $this->addFieldsIf( 'log_id', $this->fld_ids ); - $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( array( 'log_id', 'page_id' ), $this->fld_ids ); + $this->addFieldsIf( array( 'log_user', 'user_name' ), $this->fld_user ); + $this->addFieldsIf( 'user_id', $this->fld_userid ); + $this->addFieldsIf( array( 'log_namespace', '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 ); @@ -108,13 +106,12 @@ class ApiQueryLogEvents extends ApiQueryBase { list( $type, $action ) = explode( '/', $params['action'] ); $this->addWhereFld( 'log_type', $type ); $this->addWhereFld( 'log_action', $action ); - } - else if ( !is_null( $params['type'] ) ) { + } elseif ( !is_null( $params['type'] ) ) { $this->addWhereFld( 'log_type', $params['type'] ); $index['logging'] = 'type_time'; } - $this->addWhereRange( 'log_timestamp', $params['dir'], $params['start'], $params['end'] ); + $this->addTimestampWhereRange( 'log_timestamp', $params['dir'], $params['start'], $params['end'] ); $limit = $params['limit']; $this->addOption( 'LIMIT', $limit + 1 ); @@ -142,6 +139,22 @@ class ApiQueryLogEvents extends ApiQueryBase { $index['logging'] = is_null( $user ) ? 'page_time' : array( 'page_time', 'user_time' ); } + $prefix = $params['prefix']; + + if ( !is_null( $prefix ) ) { + global $wgMiserMode; + if ( $wgMiserMode ) { + $this->dieUsage( 'Prefix search disabled in Miser Mode', 'prefixsearchdisabled' ); + } + + $title = Title::newFromText( $prefix ); + if ( is_null( $title ) ) { + $this->dieUsage( "Bad title value '$prefix'", 'param_prefix' ); + } + $this->addWhereFld( 'log_namespace', $title->getNamespace() ); + $this->addWhere( 'log_title ' . $db->buildLike( $title->getDBkey(), $db->anyString() ) ); + } + $this->addOption( 'USE INDEX', $index ); // Paranoia: avoid brute force searches (bug 17342) @@ -154,7 +167,8 @@ class ApiQueryLogEvents extends ApiQueryBase { $count = 0; $res = $this->select( __METHOD__ ); - while ( $row = $db->fetchObject( $res ) ) { + $result = $this->getResult(); + 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 ) ); @@ -165,37 +179,63 @@ class ApiQueryLogEvents extends ApiQueryBase { if ( !$vals ) { continue; } - $fit = $this->getResult()->addValue( array( 'query', $this->getModuleName() ), null, $vals ); + $fit = $result->addValue( array( 'query', $this->getModuleName() ), null, $vals ); 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' ); + $result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'item' ); } - public static function addLogParams( $result, &$vals, $params, $type, $ts ) { - $params = explode( "\n", $params ); + /** + * @param $result ApiResult + * @param $vals array + * @param $params string + * @param $type string + * @param $action string + * @param $ts + * @param $legacy bool + * @return array + */ + public static function addLogParams( $result, &$vals, $params, $type, $action, $ts, $legacy = false ) { switch ( $type ) { case 'move': - if ( isset( $params[0] ) ) { - $title = Title::newFromText( $params[0] ); + if ( $legacy ){ + $targetKey = 0; + $noredirKey = 1; + } else { + $targetKey = '4::target'; + $noredirKey = '5::noredir'; + } + + if ( isset( $params[ $targetKey ] ) ) { + $title = Title::newFromText( $params[ $targetKey ] ); if ( $title ) { $vals2 = array(); ApiQueryBase::addTitleInfo( $vals2, $title, 'new_' ); $vals[$type] = $vals2; } } - if ( isset( $params[1] ) && $params[1] ) { + if ( isset( $params[ $noredirKey ] ) && $params[ $noredirKey ] ) { $vals[$type]['suppressedredirect'] = ''; } $params = null; break; case 'patrol': + if ( $legacy ){ + $cur = 0; + $prev = 1; + $auto = 2; + } else { + $cur = '4::curid'; + $prev = '5::previd'; + $auto = '6::auto'; + } $vals2 = array(); - list( $vals2['cur'], $vals2['prev'], $vals2['auto'] ) = $params; + $vals2['cur'] = $params[$cur]; + $vals2['prev'] = $params[$prev]; + $vals2['auto'] = $params[$auto]; $vals[$type] = $vals2; $params = null; break; @@ -206,11 +246,14 @@ class ApiQueryLogEvents extends ApiQueryBase { $params = null; break; case 'block': + if ( $action == 'unblock' ) { + break; + } $vals2 = array(); list( $vals2['duration'], $vals2['flags'] ) = $params; - + // Indefinite blocks have no expiry time - if ( Block::parseExpiryInput( $params[0] ) !== Block::infinity() ) { + if ( SpecialBlock::parseExpiryInput( $params[0] ) !== wfGetDB( DB_SLAVE )->getInfinity() ) { $vals2['expiry'] = wfTimestamp( TS_ISO_8601, strtotime( $params[0], wfTimestamp( TS_UNIX, $ts ) ) ); } @@ -226,6 +269,7 @@ class ApiQueryLogEvents extends ApiQueryBase { } private function extractRowInfo( $row ) { + $logEntry = DatabaseLogEntry::newFromRow( $row ); $vals = array(); if ( $this->fld_ids ) { @@ -233,7 +277,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 ) ) { @@ -242,7 +288,7 @@ class ApiQueryLogEvents extends ApiQueryBase { ApiQueryBase::addTitleInfo( $vals, $title ); } } - + if ( $this->fld_type || $this->fld_action ) { $vals['type'] = $row->log_type; $vals['action'] = $row->log_action; @@ -253,20 +299,31 @@ class ApiQueryLogEvents extends ApiQueryBase { $vals['actionhidden'] = ''; } else { self::addLogParams( - $this->getResult(), $vals, - $row->log_params, $row->log_type, - $row->log_timestamp + $this->getResult(), + $vals, + $logEntry->getParameters(), + $logEntry->getType(), + $logEntry->getSubtype(), + $logEntry->getTimestamp(), + $logEntry->isLegacy() ); } } - 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 ) { @@ -282,8 +339,7 @@ class ApiQueryLogEvents extends ApiQueryBase { } if ( $this->fld_parsedcomment ) { - global $wgUser; - $vals['parsedcomment'] = $wgUser->getSkin()->formatComment( $row->log_comment, $title ); + $vals['parsedcomment'] = Linker::formatComment( $row->log_comment, $title ); } } } @@ -301,6 +357,15 @@ class ApiQueryLogEvents extends ApiQueryBase { return $vals; } + public function getCacheMode( $params ) { + if ( !is_null( $params['prop'] ) && in_array( 'parsedcomment', $params['prop'] ) ) { + // formatComment() calls wfMsg() among other things + return 'anon-public-user-private'; + } else { + return 'public'; + } + } + public function getAllowedParams() { global $wgLogTypes, $wgLogActions; return array( @@ -312,6 +377,7 @@ class ApiQueryLogEvents extends ApiQueryBase { 'title', 'type', 'user', + 'userid', 'timestamp', 'comment', 'parsedcomment', @@ -340,6 +406,7 @@ class ApiQueryLogEvents extends ApiQueryBase { ), 'user' => null, 'title' => null, + 'prefix' => null, 'tag' => null, 'limit' => array( ApiBase::PARAM_DFLT => 10, @@ -352,37 +419,57 @@ class ApiQueryLogEvents extends ApiQueryBase { } public function getParamDescription() { + $p = $this->getModulePrefix(); return array( - 'prop' => 'Which properties to get', - 'type' => 'Filter log entries to only this type(s)', - '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.', + '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', + 'action' => "Filter log actions to only this type. Overrides {$p}type", + 'start' => 'The timestamp to start enumerating from', + 'end' => 'The timestamp to end enumerating', + 'dir' => $this->getDirectionDescription( $p ), + 'user' => 'Filter entries to those made by the given user', + 'title' => 'Filter entries to those related to a page', + 'prefix' => 'Filter entries that start with this prefix. Disabled in Miser Mode', + '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' ), array( 'code' => 'param_title', 'info' => 'Bad title value \'title\'' ), + array( 'code' => 'param_prefix', 'info' => 'Bad title value \'prefix\'' ), + array( 'code' => 'prefixsearchdisabled', 'info' => 'Prefix search disabled in Miser Mode' ), ) ); } - protected function getExamples() { + public function getExamples() { return array( 'api.php?action=query&list=logevents' ); } + public function getHelpUrls() { + return 'https://www.mediawiki.org/wiki/API:Logevents'; + } + public function getVersion() { return __CLASS__ . ': $Id$'; }