includes/api/ApiSetNotificationTimestamp.php
<?php
/**
* API for MediaWiki 1.14+
*
* Copyright © 2012 Wikimedia Foundation and contributors
*
* 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
*/
use MediaWiki\Revision\RevisionStore;
use MediaWiki\Title\Title;
use MediaWiki\Title\TitleFactory;
use MediaWiki\Title\TitleFormatter;
use MediaWiki\Watchlist\WatchedItemStoreInterface;
use Wikimedia\ParamValidator\ParamValidator;
use Wikimedia\Rdbms\IConnectionProvider;
/**
* API interface for setting the wl_notificationtimestamp field
* @ingroup API
*/
class ApiSetNotificationTimestamp extends ApiBase {
private $mPageSet = null;
private RevisionStore $revisionStore;
private IConnectionProvider $dbProvider;
private WatchedItemStoreInterface $watchedItemStore;
private TitleFormatter $titleFormatter;
private TitleFactory $titleFactory;
/**
* @param ApiMain $main
* @param string $action
* @param IConnectionProvider $dbProvider
* @param RevisionStore $revisionStore
* @param WatchedItemStoreInterface $watchedItemStore
* @param TitleFormatter $titleFormatter
* @param TitleFactory $titleFactory
*/
public function __construct(
ApiMain $main,
$action,
IConnectionProvider $dbProvider,
RevisionStore $revisionStore,
WatchedItemStoreInterface $watchedItemStore,
TitleFormatter $titleFormatter,
TitleFactory $titleFactory
) {
parent::__construct( $main, $action );
$this->dbProvider = $dbProvider;
$this->revisionStore = $revisionStore;
$this->watchedItemStore = $watchedItemStore;
$this->titleFormatter = $titleFormatter;
$this->titleFactory = $titleFactory;
}
public function execute() {
$user = $this->getUser();
if ( !$user->isRegistered() ) {
$this->dieWithError( 'watchlistanontext', 'notloggedin' );
}
$this->checkUserRightsAny( 'editmywatchlist' );
$params = $this->extractRequestParams();
$this->requireMaxOneParameter( $params, 'timestamp', 'torevid', 'newerthanrevid' );
$continuationManager = new ApiContinuationManager( $this, [], [] );
$this->setContinuationManager( $continuationManager );
$pageSet = $this->getPageSet();
if ( $params['entirewatchlist'] && $pageSet->getDataSource() !== null ) {
$this->dieWithError(
[
'apierror-invalidparammix-cannotusewith',
$this->encodeParamName( 'entirewatchlist' ),
$pageSet->encodeParamName( $pageSet->getDataSource() )
],
'multisource'
);
}
$dbw = $this->dbProvider->getPrimaryDatabase();
$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->dieWithError( [ 'apierror-multpages', $this->encodeParamName( 'torevid' ) ] );
}
$titles = $pageSet->getGoodPages();
$title = reset( $titles );
if ( $title ) {
// XXX $title isn't actually used, can we just get rid of the previous six lines?
$timestamp = $this->revisionStore->getTimestampFromId(
$params['torevid'],
IDBAccessObject::READ_LATEST
);
if ( $timestamp ) {
$timestamp = $dbw->timestamp( $timestamp );
} else {
$timestamp = null;
}
}
} elseif ( isset( $params['newerthanrevid'] ) ) {
if ( $params['entirewatchlist'] || $pageSet->getGoodTitleCount() > 1 ) {
$this->dieWithError( [ 'apierror-multpages', $this->encodeParamName( 'newerthanrevid' ) ] );
}
$titles = $pageSet->getGoodPages();
$title = reset( $titles );
if ( $title ) {
$timestamp = null;
$currRev = $this->revisionStore->getRevisionById(
$params['newerthanrevid'],
IDBAccessObject::READ_LATEST
);
if ( $currRev ) {
$nextRev = $this->revisionStore->getNextRevision(
$currRev,
IDBAccessObject::READ_LATEST
);
if ( $nextRev ) {
$timestamp = $dbw->timestamp( $nextRev->getTimestamp() );
}
}
}
}
$apiResult = $this->getResult();
$result = [];
if ( $params['entirewatchlist'] ) {
// Entire watchlist mode: Just update the thing and return a success indicator
$this->watchedItemStore->resetAllNotificationTimestampsForUser( $user, $timestamp );
$result['notificationtimestamp'] = $timestamp === null
? ''
: wfTimestamp( TS_ISO_8601, $timestamp );
} else {
// First, log the invalid titles
foreach ( $pageSet->getInvalidTitlesAndReasons() as $r ) {
$r['invalid'] = true;
$result[] = $r;
}
foreach ( $pageSet->getMissingPageIDs() as $p ) {
$page = [];
$page['pageid'] = $p;
$page['missing'] = true;
$page['notwatched'] = true;
$result[] = $page;
}
foreach ( $pageSet->getMissingRevisionIDs() as $r ) {
$rev = [];
$rev['revid'] = $r;
$rev['missing'] = true;
$rev['notwatched'] = true;
$result[] = $rev;
}
$pages = $pageSet->getPages();
if ( $pages ) {
// Now process the valid titles
$this->watchedItemStore->setNotificationTimestampsForUser(
$user,
$timestamp,
$pages
);
// Query the results of our update
$timestamps = $this->watchedItemStore->getNotificationTimestampsBatch(
$user,
$pages
);
// Now, put the valid titles into the result
/** @var \MediaWiki\Page\PageIdentity $page */
foreach ( $pages as $page ) {
$ns = $page->getNamespace();
$dbkey = $page->getDBkey();
$r = [
'ns' => $ns,
'title' => $this->titleFormatter->getPrefixedText( $page ),
];
if ( !$page->exists() ) {
$r['missing'] = true;
$title = $this->titleFactory->newFromPageIdentity( $page );
if ( $title->isKnown() ) {
$r['known'] = true;
}
}
if ( isset( $timestamps[$ns] ) && array_key_exists( $dbkey, $timestamps[$ns] )
&& $timestamps[$ns][$dbkey] !== false
) {
$r['notificationtimestamp'] = '';
if ( $timestamps[$ns][$dbkey] !== null ) {
$r['notificationtimestamp'] = wfTimestamp( TS_ISO_8601, $timestamps[$ns][$dbkey] );
}
} else {
$r['notwatched'] = true;
}
$result[] = $r;
}
}
ApiResult::setIndexedTagName( $result, 'page' );
}
$apiResult->addValue( null, $this->getModuleName(), $result );
$this->setContinuationManager( null );
$continuationManager->setContinuationIntoResult( $apiResult );
}
/**
* Get a cached instance of an ApiPageSet object
* @return ApiPageSet
*/
private function getPageSet() {
$this->mPageSet ??= new ApiPageSet( $this );
return $this->mPageSet;
}
public function mustBePosted() {
return true;
}
public function isWriteMode() {
return true;
}
public function needsToken() {
return 'csrf';
}
public function getAllowedParams( $flags = 0 ) {
$result = [
'entirewatchlist' => [
ParamValidator::PARAM_TYPE => 'boolean'
],
'timestamp' => [
ParamValidator::PARAM_TYPE => 'timestamp'
],
'torevid' => [
ParamValidator::PARAM_TYPE => 'integer'
],
'newerthanrevid' => [
ParamValidator::PARAM_TYPE => 'integer'
],
'continue' => [
ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
],
];
if ( $flags ) {
$result += $this->getPageSet()->getFinalParams( $flags );
}
return $result;
}
protected function getExamplesMessages() {
$title = Title::newMainPage()->getPrefixedText();
$mp = rawurlencode( $title );
return [
'action=setnotificationtimestamp&entirewatchlist=&token=123ABC'
=> 'apihelp-setnotificationtimestamp-example-all',
"action=setnotificationtimestamp&titles={$mp}&token=123ABC"
=> 'apihelp-setnotificationtimestamp-example-page',
"action=setnotificationtimestamp&titles={$mp}&" .
'timestamp=2012-01-01T00:00:00Z&token=123ABC'
=> 'apihelp-setnotificationtimestamp-example-pagetimestamp',
'action=setnotificationtimestamp&generator=allpages&gapnamespace=2&token=123ABC'
=> 'apihelp-setnotificationtimestamp-example-allpages',
];
}
public function getHelpUrls() {
return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:SetNotificationTimestamp';
}
}