<?php
-
/**
- * Created on Oct 16, 2006
*
- * API for MediaWiki 1.8+
+ *
+ * Created on Oct 16, 2006
*
* Copyright © 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
*
*
* 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' ) ) {
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();
$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 );
'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 );
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';
}
$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)
$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 ) );
break;
}
}
- $db->freeResult( $res );
-
$this->getResult()->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'item' );
}
- public static function addLogParams( $result, &$vals, $params, $type, $ts ) {
+ /**
+ * @param $result ApiResult
+ * @param $vals array
+ * @param $params string
+ * @param $type string
+ * @param $action string
+ * @param $ts
+ * @return array
+ */
+ public static function addLogParams( $result, &$vals, $params, $type, $action, $ts ) {
$params = explode( "\n", $params );
switch ( $type ) {
case 'move':
$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 ) ) );
}
$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 ) ) {
ApiQueryBase::addTitleInfo( $vals, $title );
}
}
-
+
if ( $this->fld_type || $this->fld_action ) {
$vals['type'] = $row->log_type;
$vals['action'] = $row->log_action;
$vals['actionhidden'] = '';
} else {
self::addLogParams(
- $this->getResult(), $vals,
- $row->log_params, $row->log_type,
+ $this->getResult(),
+ $vals,
+ $row->log_params,
+ $row->log_type,
+ $row->log_action,
$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 ) {
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(
'title',
'type',
'user',
+ 'userid',
'timestamp',
'comment',
'parsedcomment',
),
'user' => null,
'title' => null,
+ 'prefix' => null,
'tag' => null,
'limit' => array(
ApiBase::PARAM_DFLT => 10,
}
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",
+ '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' => 'In which direction to enumerate',
+ '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',
);
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' ),
) );
}