path: root/includes/api/ApiSetNotificationTimestamp.php

<?php

/**
 * API for MediaWiki 1.14+
 *
 * Created on Jun 18, 2012
 *
 * Copyright © 2012 Brad Jorsch
 *
 * 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.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 * http://www.gnu.org/copyleft/gpl.html
 *
 * @file
 */

/**
 * API interface for setting the wl_notificationtimestamp field
 * @ingroup API
 */
class ApiSetNotificationTimestamp extends ApiBase {

	public function __construct( $main, $action ) {
		parent::__construct( $main, $action );
	}

	public function execute() {
		$user = $this->getUser();

		if ( $user->isAnon() ) {
			$this->dieUsage( 'Anonymous users cannot use watchlist change notifications', 'notloggedin' );
		}

		$params = $this->extractRequestParams();
		$this->requireMaxOneParameter( $params, 'timestamp', 'torevid', 'newerthanrevid' );

		$pageSet = new ApiPageSet( $this );
		$args = array_merge( array( $params, 'entirewatchlist' ), array_keys( $pageSet->getAllowedParams() ) );
		call_user_func_array( array( $this, 'requireOnlyOneParameter' ), $args );

		$dbw = $this->getDB( DB_MASTER );

		$timestamp = null;
		if ( isset( $params['timestamp'] ) ) {
			$timestamp = $dbw->timestamp( $params['timestamp'] );
		}

		if ( !$params['entirewatchlist'] ) {
			$pageSet->execute();
		}

		if ( isset( $params['torevid'] ) ) {
			if ( $params['entirewatchlist'] || $pageSet->getGoodTitleCount() > 1 ) {
				$this->dieUsage( 'torevid may only be used with a single page', 'multpages' );
			}
			$title = reset( $pageSet->getGoodTitles() );
			$timestamp = Revision::getTimestampFromId( $title, $params['torevid'] );
			if ( $timestamp ) {
				$timestamp = $dbw->timestamp( $timestamp );
			} else {
				$timestamp = null;
			}
		} elseif ( isset( $params['newerthanrevid'] ) ) {
			if ( $params['entirewatchlist'] || $pageSet->getGoodTitleCount() > 1 ) {
				$this->dieUsage( 'newerthanrevid may only be used with a single page', 'multpages' );
			}
			$title = reset( $pageSet->getGoodTitles() );
			$revid = $title->getNextRevisionID( $params['newerthanrevid'] );
			if ( $revid ) {
				$timestamp = $dbw->timestamp( Revision::getTimestampFromId( $title, $revid ) );
			} else {
				$timestamp = null;
			}
		}

		$apiResult = $this->getResult();
		$result = array();
		if ( $params['entirewatchlist'] ) {
			// Entire watchlist mode: Just update the thing and return a success indicator
			$dbw->update( 'watchlist', array( 'wl_notificationtimestamp' => $timestamp ),
				array( 'wl_user' => $user->getID() ),
				__METHOD__
			);

			$result['notificationtimestamp'] = ( is_null( $timestamp ) ? '' : wfTimestamp( TS_ISO_8601, $timestamp ) );
		} else {
			// First, log the invalid titles
			foreach( $pageSet->getInvalidTitles() as $title ) {
				$r = array();
				$r['title'] = $title;
				$r['invalid'] = '';
				$result[] = $r;
			}
			foreach( $pageSet->getMissingPageIDs() as $p ) {
				$page = array();
				$page['pageid'] = $p;
				$page['missing'] = '';
				$page['notwatched'] = '';
				$result[] = $page;
			}
			foreach( $pageSet->getMissingRevisionIDs() as $r ) {
				$rev = array();
				$rev['revid'] = $r;
				$rev['missing'] = '';
				$rev['notwatched'] = '';
				$result[] = $rev;
			}

			// Now process the valid titles
			$lb = new LinkBatch( $pageSet->getTitles() );
			$dbw->update( 'watchlist', array( 'wl_notificationtimestamp' => $timestamp ),
				array( 'wl_user' => $user->getID(), $lb->constructSet( 'wl', $dbw ) ),
				__METHOD__
			);

			// Query the results of our update
			$timestamps = array();
			$res = $dbw->select( 'watchlist', array( 'wl_namespace', 'wl_title', 'wl_notificationtimestamp' ),
				array( 'wl_user' => $user->getID(), $lb->constructSet( 'wl', $dbw ) ),
				__METHOD__
			);
			foreach ( $res as $row ) {
				$timestamps[$row->wl_namespace][$row->wl_title] = $row->wl_notificationtimestamp;
			}

			// Now, put the valid titles into the result
			foreach ( $pageSet->getTitles() as $title ) {
				$ns = $title->getNamespace();
				$dbkey = $title->getDBkey();
				$r = array(
					'ns' => intval( $ns ),
					'title' => $title->getPrefixedText(),
				);
				if ( !$title->exists() ) {
					$r['missing'] = '';
				}
				if ( isset( $timestamps[$ns] ) && array_key_exists( $dbkey, $timestamps[$ns] ) ) {
					$r['notificationtimestamp'] = '';
					if ( $timestamps[$ns][$dbkey] !== null ) {
						$r['notificationtimestamp'] = wfTimestamp( TS_ISO_8601, $timestamps[$ns][$dbkey] );
					}
				} else {
					$r['notwatched'] = '';
				}
				$result[] = $r;
			}

			$apiResult->setIndexedTagName( $result, 'page' );
		}
		$apiResult->addValue( null, $this->getModuleName(), $result );
	}

	public function mustBePosted() {
		return true;
	}

	public function isWriteMode() {
		return true;
	}

	public function needsToken() {
		return true;
	}

	public function getTokenSalt() {
		return '';
	}

	public function getAllowedParams() {
		$psModule = new ApiPageSet( $this );
		return $psModule->getAllowedParams() + array(
			'entirewatchlist' => array(
				ApiBase::PARAM_TYPE => 'boolean'
			),
			'token' => null,
			'timestamp' => array(
				ApiBase::PARAM_TYPE => 'timestamp'
			),
			'torevid' => array(
				ApiBase::PARAM_TYPE => 'integer'
			),
			'newerthanrevid' => array(
				ApiBase::PARAM_TYPE => 'integer'
			),
		);
	}

	public function getParamDescription() {
		$psModule = new ApiPageSet( $this );
		return $psModule->getParamDescription() + array(
			'entirewatchlist' => 'Work on all watched pages',
			'timestamp' => 'Timestamp to which to set the notification timestamp',
			'torevid' => 'Revision to set the notification timestamp to (one page only)',
			'newerthanrevid' => 'Revision to set the notification timestamp newer than (one page only)',
			'token' => 'A token previously acquired via prop=info',
		);
	}

	public function getResultProperties() {
		return array(
			ApiBase::PROP_LIST => true,
			ApiBase::PROP_ROOT => array(
				'notificationtimestamp' => array(
					ApiBase::PROP_TYPE => 'timestamp',
					ApiBase::PROP_NULLABLE => true
				)
			),
			'' => array(
				'ns' => array(
					ApiBase::PROP_TYPE => 'namespace',
					ApiBase::PROP_NULLABLE => true
				),
				'title' => array(
					ApiBase::PROP_TYPE => 'string',
					ApiBase::PROP_NULLABLE => true
				),
				'pageid' => array(
					ApiBase::PROP_TYPE => 'integer',
					ApiBase::PROP_NULLABLE => true
				),
				'revid' => array(
					ApiBase::PROP_TYPE => 'integer',
					ApiBase::PROP_NULLABLE => true
				),
				'invalid' => 'boolean',
				'missing' => 'boolean',
				'notwatched' => 'boolean',
				'notificationtimestamp' => array(
					ApiBase::PROP_TYPE => 'timestamp',
					ApiBase::PROP_NULLABLE => true
				)
			)
		);
	}

	public function getDescription() {
		return array( 'Update the notification timestamp for watched pages.',
			'This affects the highlighting of changed pages in the watchlist and history,',
			'and the sending of email when the "E-mail me when a page on my watchlist is',
			'changed" preference is enabled.'
		);
	}

	public function getPossibleErrors() {
		$psModule = new ApiPageSet( $this );
		return array_merge(
			parent::getPossibleErrors(),
			$psModule->getPossibleErrors(),
			$this->getRequireMaxOneParameterErrorMessages( array( 'timestamp', 'torevid', 'newerthanrevid' ) ),
			$this->getRequireOnlyOneParameterErrorMessages( array_merge( array( 'entirewatchlist' ), array_keys( $psModule->getAllowedParams() ) ) ),
			array(
				array( 'code' => 'notloggedin', 'info' => 'Anonymous users cannot use watchlist change notifications' ),
				array( 'code' => 'multpages', 'info' => 'torevid may only be used with a single page' ),
				array( 'code' => 'multpages', 'info' => 'newerthanrevid may only be used with a single page' ),
			)
		);
	}

	public function getExamples() {
		return array(
			'api.php?action=setnotificationtimestamp&entirewatchlist=&token=ABC123' => 'Reset the notification status for the entire watchlist',
			'api.php?action=setnotificationtimestamp&titles=Main_page&token=ABC123' => 'Reset the notification status for "Main page"',
			'api.php?action=setnotificationtimestamp&titles=Main_page&timestamp=2012-01-01T00:00:00Z&token=ABC123' => 'Set the notification timestamp for "Main page" so all edits since 1 January 2012 are unviewed',
		);
	}

	public function getHelpUrls() {
		return 'https://www.mediawiki.org/wiki/API:SetNotificationTimestamp';
	}

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