wiki.techinc.nl/includes/api/ApiQueryRecentchanges.php

<?php


/*
 * Created on Oct 19, 2006
 *
 * API for MediaWiki 1.8+
 *
 * Copyright (C) 2006 Yuri Astrakhan <FirstnameLastname@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
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * 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.
 * http://www.gnu.org/copyleft/gpl.html
 */

if (!defined('MEDIAWIKI')) {
	// Eclipse helper - will be ignored in production
	require_once ('ApiQueryBase.php');
}

class ApiQueryRecentChanges extends ApiQueryBase {

	public function __construct($query, $moduleName) {
		parent :: __construct($query, $moduleName, 'rc');
	}

	public function execute() {
		$limit = $from = $namespace = $hide = $dir = $start = $end = null;
		extract($this->extractRequestParams());

		$this->addTables('recentchanges');
		$this->addWhereRange('rc_timestamp', $dir, $start, $end);
		$this->addWhereFld('rc_namespace', $namespace);

		if (!is_null($hide)) {
			$hide = array_flip($hide);
			$this->addWhereIf('rc_minor = 0', isset ($hide['minor']));
			$this->addWhereIf('rc_bot = 0', isset ($hide['bots']));
			$this->addWhereIf('rc_user != 0', isset ($hide['anons']));
			$this->addWhereIf('rc_user = 0', isset ($hide['liu']));
		}

		$this->addFields(array (
			'rc_timestamp',
			'rc_user',
			'rc_user_text',
			'rc_namespace',
			'rc_title',
			'rc_comment',
			'rc_minor',
			'rc_bot',
			'rc_new',
			'rc_cur_id',
			'rc_this_oldid',
			'rc_last_oldid',
			'rc_type',
			'rc_moved_to_ns',
			'rc_moved_to_title'
		));

		$this->addOption('LIMIT', $limit +1);

		$data = array ();
		$count = 0;
		$db = $this->getDB();
		$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('start', $row->rc_timestamp);
				break;
			}

			$title = Title :: makeTitle($row->rc_namespace, $row->rc_title);
			// skip any pages that user has no rights to read
			if ($title->userCanRead()) {

				$id = intval($row->rc_cur_id);
				$data[] = array (
					'id' => $id,
					'ns' => $title->getNamespace(), 'title' => $title->getPrefixedText(),
					'timestamp' => $row->rc_timestamp,
					'user' => $row->rc_user_text,
					'comment' => $row->rc_comment,
					'this_oldid' => $row->rc_this_oldid,
					'last_oldid' => $row->rc_last_oldid,
					'type' => $row->rc_type,
					'moved_to_ns' => $row->rc_moved_to_ns,
					'moved_to_title' => $row->rc_moved_to_title);
				
				if (!$row->rc_user)
					$vals['anon'] = '';
				if ($row->rc_new)
					$vals['new'] = '';
				if ($row->rc_bot)
					$vals['bot'] = '';
				if ($row->rc_minor)
					$vals['minor'] = '';
			}
		}
		$db->freeResult($res);

		$result = $this->getResult();
		$result->setIndexedTagName($data, 'rc');
		$result->addValue('query', $this->getModuleName(), $data);
	}

	protected function getAllowedParams() {
		$namespaces = $this->getQuery()->getValidNamespaces();
		return array (
			'dir' => array (
				ApiBase :: PARAM_DFLT => 'older',
				ApiBase :: PARAM_TYPE => array (
					'newer',
					'older'
				)
			),
			'start' => array (
				ApiBase :: PARAM_TYPE => 'timestamp'
			),
			'end' => array (
				ApiBase :: PARAM_TYPE => 'timestamp'
			),
			'namespace' => array (
				ApiBase :: PARAM_DFLT => 0,
				ApiBase :: PARAM_TYPE => $namespaces
			),
			'hide' => array (
				ApiBase :: PARAM_ISMULTI => true,
				ApiBase :: PARAM_TYPE => array (
					'minor',
					'bots',
					'anons',
					'liu'
				)
			),
			'limit' => array (
				ApiBase :: PARAM_DFLT => 10,
				ApiBase :: PARAM_TYPE => 'limit',
				ApiBase :: PARAM_MIN => 1,
				ApiBase :: PARAM_MAX1 => ApiBase :: LIMIT_BIG1,
				ApiBase :: PARAM_MAX2 => ApiBase :: LIMIT_BIG2
			)
		);
	}

	protected function getParamDescription() {
		return array (
			'start' => 'The timestamp to start enumerating from.',
			'end' => 'The timestamp to end enumerating.',
			'limit' => 'How many total pages to return.'
		);
	}

	protected function getDescription() {
		return 'Enumerate recent changes';
	}

	protected function getExamples() {
		return array (
			'api.php?action=query&list=recentchanges',
		);
	}

	public function getVersion() {
		return __CLASS__ . ': $Id$';
	}
}
?>