<?php
-
/*
* Created on Oct 16, 2006
*
* API for MediaWiki 1.8+
*
- * Copyright (C) 2006 Yuri Astrakhan <FirstnameLastname@gmail.com>
+ * Copyright (C) 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
require_once ('ApiQueryBase.php');
}
+/**
+ * Query action to List the log events, with optional filtering by various parameters.
+ *
+ * @ingroup API
+ */
class ApiQueryLogEvents extends ApiQueryBase {
public function __construct($query, $moduleName) {
}
public function execute() {
- $limit = $type = $from = $to = $dir = $user = $title = $namespace = null;
- extract($this->extractRequestParams());
-
+ $params = $this->extractRequestParams();
$db = $this->getDB();
- extract($db->tableNames('logging', 'page', 'user'), EXTR_PREFIX_ALL, 'tbl');
+ $prop = $params['prop'];
+ $this->fld_ids = in_array('ids', $prop);
+ $this->fld_title = in_array('title', $prop);
+ $this->fld_type = in_array('type', $prop);
+ $this->fld_user = in_array('user', $prop);
+ $this->fld_timestamp = in_array('timestamp', $prop);
+ $this->fld_comment = in_array('comment', $prop);
+ $this->fld_details = in_array('details', $prop);
+
+ list($tbl_logging, $tbl_page, $tbl_user) = $db->tableNamesN('logging', 'page', 'user');
+
+ $hideLogs = LogEventsList::getExcludeClause($db);
+ if($hideLogs !== false)
+ $this->addWhere($hideLogs);
- $tables = "$tbl_logging LEFT OUTER JOIN $tbl_page ON log_namespace=page_namespace AND log_title=page_title " .
- "INNER JOIN $tbl_user ON user_id=log_user";
+ // Order is significant here
+ $this->addTables(array('logging', 'user', 'page'));
+ $this->addOption('STRAIGHT_JOIN');
+ $this->addJoinConds(array(
+ 'user' => array('JOIN',
+ 'user_id=log_user'),
+ 'page' => array('LEFT JOIN',
+ array( 'log_namespace=page_namespace',
+ 'log_title=page_title'))));
+ $index = 'times'; // default, may change
- $fields = array (
+ $this->addFields(array (
'log_type',
'log_action',
'log_timestamp',
- 'log_user',
- 'user_name',
- 'log_namespace',
- 'log_title',
- 'page_id',
- 'log_comment',
- 'log_params'
- );
+ '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('log_comment', $this->fld_comment);
+ $this->addFieldsIf('log_params', $this->fld_details);
+
+ if( !is_null($params['type']) ) {
+ $this->addWhereFld('log_type', $params['type']);
+ $index = 'type_time';
+ }
+
+ $this->addWhereRange('log_timestamp', $params['dir'], $params['start'], $params['end']);
- $where = array ();
- if (!is_null($type))
- $where['log_type'] = $type;
+ $limit = $params['limit'];
+ $this->addOption('LIMIT', $limit +1);
+ $user = $params['user'];
if (!is_null($user)) {
- $userid = $db->selectField('user', 'user_id', array (
- 'user_name' => $user
- ));
+ $userid = User::idFromName($user);
if (!$userid)
$this->dieUsage("User name $user not found", 'param_user');
- $where['log_user'] = $userid;
+ $this->addWhereFld('log_user', $userid);
+ $index = 'user_time';
}
+ $title = $params['title'];
if (!is_null($title)) {
$titleObj = Title :: newFromText($title);
if (is_null($titleObj))
$this->dieUsage("Bad title value '$title'", 'param_title');
- $where['log_namespace'] = $titleObj->getNamespace();
- $where['log_title'] = $titleObj->getDBkey();
- }
+ $this->addWhereFld('log_namespace', $titleObj->getNamespace());
+ $this->addWhereFld('log_title', $titleObj->getDBkey());
- // $where[] = "log_timestamp $direction '$safetime'";
+ // Use the title index in preference to the user index if there is a conflict
+ $index = is_null($user) ? 'page_time' : array('page_time','user_time');
+ }
- $options = array (
- 'LIMIT' => $limit +1
- );
+ $this->addOption( 'USE INDEX', array( 'logging' => $index ) );
- $this->profileDBIn();
- $res = $db->select($tables, $fields, $where, __METHOD__, $options);
- $this->profileDBOut();
+ // Paranoia: avoid brute force searches (bug 17342)
+ if (!is_null($title)) {
+ $this->addWhere('log_deleted & ' . LogPage::DELETED_ACTION . ' = 0');
+ }
+ if (!is_null($user)) {
+ $this->addWhere('log_deleted & ' . LogPage::DELETED_USER . ' = 0');
+ }
- $data = array ();
$count = 0;
+ $res = $this->select(__METHOD__);
while ($row = $db->fetchObject($res)) {
if (++ $count > $limit) {
// We've reached the one extra which shows that there are additional pages to be had. Stop here...
- $this->setContinueEnumParameter('from', ApiQueryBase :: keyToTitle($row->page_title));
+ $this->setContinueEnumParameter('start', wfTimestamp(TS_ISO_8601, $row->log_timestamp));
break;
}
- $vals = array (
- 'type' => $row->log_type,
- 'action' => $row->log_action,
- 'timestamp' => $row->log_timestamp,
- 'comment' => $row->log_comment,
- 'params' => $row->log_params,
- 'pageid' => intval($row->page_id)
- );
-
- $title = Title :: makeTitle($row->log_namespace, $row->log_title);
- $vals['ns'] = $title->getNamespace();
- $vals['title'] = $title->getPrefixedText();
-
- if (!$row->log_user)
- $vals['anon'] = '';
- $vals['user'] = $row->user_name;
-
- $data[] = $vals;
+ $vals = $this->extractRowInfo($row);
+ if(!$vals)
+ continue;
+ $fit = $this->getResult()->addValue(array('query', $this->getModuleName()), null, $vals);
+ if(!$fit)
+ {
+ $this->setContinueEnumParameter('start', wfTimestamp(TS_ISO_8601, $row->log_timestamp));
+ break;
+ }
}
$db->freeResult($res);
- ApiResult :: setIndexedTagName($data, 'item');
- $this->getResult()->addValue('query', $this->getModuleName(), $data);
+ $this->getResult()->setIndexedTagName_internal(array('query', $this->getModuleName()), 'item');
+ }
+
+ 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 ($title) {
+ $vals2 = array();
+ ApiQueryBase :: addTitleInfo($vals2, $title, "new_");
+ $vals[$type] = $vals2;
+ }
+ }
+ if (isset ($params[1]) && $params[1]) {
+ $vals[$type]['suppressedredirect'] = '';
+ }
+ $params = null;
+ break;
+ case 'patrol':
+ $vals2 = array();
+ list( $vals2['cur'], $vals2['prev'], $vals2['auto'] ) = $params;
+ $vals[$type] = $vals2;
+ $params = null;
+ break;
+ case 'rights':
+ $vals2 = array();
+ list( $vals2['old'], $vals2['new'] ) = $params;
+ $vals[$type] = $vals2;
+ $params = null;
+ break;
+ case 'block':
+ $vals2 = array();
+ list( $vals2['duration'], $vals2['flags'] ) = $params;
+ $vals2['expiry'] = wfTimestamp(TS_ISO_8601,
+ strtotime($params[0], wfTimestamp(TS_UNIX, $ts)));
+ $vals[$type] = $vals2;
+ $params = null;
+ break;
+ }
+ if (!is_null($params)) {
+ $result->setIndexedTagName($params, 'param');
+ $vals = array_merge($vals, $params);
+ }
+ return $vals;
+ }
+
+ private function extractRowInfo($row) {
+ $vals = array();
+
+ if ($this->fld_ids) {
+ $vals['logid'] = intval($row->log_id);
+ $vals['pageid'] = intval($row->page_id);
+ }
+
+ if ($this->fld_title) {
+ if (LogEventsList::isDeleted($row, LogPage::DELETED_ACTION)) {
+ $vals['actionhidden'] = '';
+ } else {
+ $title = Title :: makeTitle($row->log_namespace, $row->log_title);
+ ApiQueryBase :: addTitleInfo($vals, $title);
+ }
+ }
+
+ if ($this->fld_type) {
+ $vals['type'] = $row->log_type;
+ $vals['action'] = $row->log_action;
+ }
+
+ if ($this->fld_details && $row->log_params !== '') {
+ if (LogEventsList::isDeleted($row, LogPage::DELETED_ACTION)) {
+ $vals['actionhidden'] = '';
+ } else {
+ self::addLogParams($this->getResult(), $vals,
+ $row->log_params, $row->log_type,
+ $row->log_timestamp);
+ }
+ }
+
+ if ($this->fld_user) {
+ if (LogEventsList::isDeleted($row, LogPage::DELETED_USER)) {
+ $vals['userhidden'] = '';
+ } else {
+ $vals['user'] = $row->user_name;
+ if(!$row->log_user)
+ $vals['anon'] = '';
+ }
+ }
+ if ($this->fld_timestamp) {
+ $vals['timestamp'] = wfTimestamp(TS_ISO_8601, $row->log_timestamp);
+ }
+ if ($this->fld_comment && isset($row->log_comment)) {
+ if (LogEventsList::isDeleted($row, LogPage::DELETED_COMMENT)) {
+ $vals['commenthidden'] = '';
+ } else {
+ $vals['comment'] = $row->log_comment;
+ }
+ }
+
+ return $vals;
}
- protected function getAllowedParams() {
+ 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 (
+ 'ids',
+ 'title',
+ 'type',
+ 'user',
+ 'timestamp',
+ 'comment',
+ 'details',
+ )
+ ),
+ 'type' => array (
+ ApiBase :: PARAM_TYPE => $wgLogTypes
+ ),
+ 'start' => array (
+ ApiBase :: PARAM_TYPE => 'timestamp'
+ ),
+ 'end' => array (
+ ApiBase :: PARAM_TYPE => 'timestamp'
+ ),
+ 'dir' => array (
+ ApiBase :: PARAM_DFLT => 'older',
+ ApiBase :: PARAM_TYPE => array (
+ 'newer',
+ 'older'
+ )
+ ),
+ 'user' => null,
+ 'title' => null,
'limit' => array (
ApiBase :: PARAM_DFLT => 10,
ApiBase :: PARAM_TYPE => 'limit',
ApiBase :: PARAM_MIN => 1,
- ApiBase :: PARAM_MAX1 => 500,
- ApiBase :: PARAM_MAX2 => 5000
+ ApiBase :: PARAM_MAX => ApiBase :: LIMIT_BIG1,
+ ApiBase :: PARAM_MAX2 => ApiBase :: LIMIT_BIG2
)
);
}
- protected function getParamDescription() {
+ public function getParamDescription() {
return array (
- 'limit' => 'How many total items to return.'
+ 'prop' => 'Which properties to get',
+ '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.'
);
}
- protected function getDescription() {
+ public function getDescription() {
return 'Get events from logs.';
}
}
public function getVersion() {
- return __CLASS__ . ': $Id:$';
+ return __CLASS__ . ': $Id$';
}
}
-?>
\ No newline at end of file
dépôts / lhc / web / wiklou.git / blobdiff