mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/Echo
synced 2024-11-28 01:30:15 +00:00
b2f816d0af
This seems strange, because markseen sounds like a write action, but it writes to the seentime cache rather than the database. For multi-DC support, we need writes to the seentime cache to happen in the local data center, and the easiest way to do that is to make it a GET request rather than a POST request. It would be nice if marking as seen could be consolidated into the GET request for fetching notifications, but I didn't do that because the code for those fetches is pretty complicated, and some fetches (like polling) should not mark as seen. Bug: T222851 Change-Id: If4c504a9dc562b1d4e626e155fba8ebb5cdb0579
64 lines
1.7 KiB
PHP
64 lines
1.7 KiB
PHP
<?php
|
|
|
|
// This is a GET module, not a POST module, for multi-DC support. See T222851.
|
|
// Note that this module doesn't write to the database, only to the seentime cache.
|
|
class ApiEchoMarkSeen extends ApiBase {
|
|
|
|
public function execute() {
|
|
// To avoid API warning, register the parameter used to bust browser cache
|
|
$this->getMain()->getVal( '_' );
|
|
|
|
$user = $this->getUser();
|
|
if ( $user->isAnon() ) {
|
|
$this->dieWithError( 'apierror-mustbeloggedin-generic', 'login-required' );
|
|
}
|
|
|
|
$params = $this->extractRequestParams();
|
|
$timestamp = wfTimestamp( TS_MW );
|
|
$seenTime = EchoSeenTime::newFromUser( $user );
|
|
$seenTime->setTime( $timestamp, $params['type'] );
|
|
|
|
if ( $params['timestampFormat'] === 'ISO_8601' ) {
|
|
$outputTimestamp = wfTimestamp( TS_ISO_8601, $timestamp );
|
|
} else {
|
|
// MW
|
|
$this->addDeprecation( 'apiwarn-echo-deprecation-timestampformat', 'action=echomarkseen×tampFormat=MW' );
|
|
|
|
$outputTimestamp = $timestamp;
|
|
}
|
|
|
|
$this->getResult()->addValue( 'query', $this->getModuleName(), [
|
|
'result' => 'success',
|
|
'timestamp' => $outputTimestamp,
|
|
] );
|
|
}
|
|
|
|
public function getAllowedParams() {
|
|
return [
|
|
'type' => [
|
|
ApiBase::PARAM_REQUIRED => true,
|
|
ApiBase::PARAM_TYPE => [ 'alert', 'message', 'all' ],
|
|
],
|
|
'timestampFormat' => [
|
|
// Not using the TS constants, since clients can't.
|
|
ApiBase::PARAM_DFLT => 'MW',
|
|
ApiBase::PARAM_TYPE => [ 'ISO_8601', 'MW' ],
|
|
],
|
|
];
|
|
}
|
|
|
|
/**
|
|
* @see ApiBase::getExamplesMessages()
|
|
* @return string[]
|
|
*/
|
|
protected function getExamplesMessages() {
|
|
return [
|
|
'action=echomarkseen&type=all' => 'apihelp-echomarkseen-example-1',
|
|
];
|
|
}
|
|
|
|
public function getHelpUrls() {
|
|
return 'https://www.mediawiki.org/wiki/Special:MyLanguage/Echo_(Notifications)/API';
|
|
}
|
|
}
|