mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/Echo
synced 2024-11-14 19:28:31 +00:00
f751e96839
The query shouldn't be too expensive: it'll use an index to narrow down the resultset for 1 user. After that, it'll be sorted based on a grouped by value, but that should fit in memory: it'll never be on more than 2000 entries, which is the max amount of notifications per user. Change-Id: I271ea7f7a6e010284739bfce02c4ec8a077148fc
140 lines
3.5 KiB
PHP
140 lines
3.5 KiB
PHP
<?php
|
|
|
|
class ApiEchoUnreadNotificationPages extends ApiCrossWikiBase {
|
|
/**
|
|
* @var bool
|
|
*/
|
|
protected $crossWikiSummary = false;
|
|
|
|
/**
|
|
* @param ApiQuery $query
|
|
* @param string $moduleName
|
|
*/
|
|
public function __construct( $query, $moduleName ) {
|
|
parent::__construct( $query, $moduleName, 'unp' );
|
|
}
|
|
|
|
/**
|
|
* @throws UsageException
|
|
*/
|
|
public function execute() {
|
|
// To avoid API warning, register the parameter used to bust browser cache
|
|
$this->getMain()->getVal( '_' );
|
|
|
|
if ( $this->getUser()->isAnon() ) {
|
|
$this->dieUsage( 'Login is required', 'login-required' );
|
|
}
|
|
|
|
$params = $this->extractRequestParams();
|
|
|
|
$result = array();
|
|
if ( in_array( wfWikiId(), $this->getRequestedWikis() ) ) {
|
|
$result[wfWikiID()] = $this->getFromLocal( $params['limit'] );
|
|
}
|
|
|
|
if ( $this->getRequestedForeignWikis() ) {
|
|
$result += $this->getFromForeign();
|
|
}
|
|
|
|
$apis = $this->foreignNotifications->getApiEndpoints( $this->getRequestedWikis() );
|
|
foreach ( $result as $wiki => $data ) {
|
|
$result[$wiki]['source'] = $apis[$wiki];
|
|
// StdClass to ensure empty data is json_encoded to `{}` instead of `[]`
|
|
$result[$wiki]['pages'] = $data['pages'] ?: new StdClass;
|
|
}
|
|
|
|
$this->getResult()->addValue( 'query', $this->getModuleName(), $result );
|
|
}
|
|
|
|
/**
|
|
* @param int $limit
|
|
* @return array
|
|
*/
|
|
protected function getFromLocal( $limit ) {
|
|
$dbr = MWEchoDbFactory::newFromDefault()->getEchoDb( DB_SLAVE );
|
|
$rows = $dbr->select(
|
|
array( 'echo_event', 'echo_notification' ),
|
|
array( 'event_page_id', 'count' => 'COUNT(*)' ),
|
|
array(
|
|
'notification_user' => $this->getUser()->getId(),
|
|
'notification_read_timestamp' => null,
|
|
'event_page_id IS NOT NULL',
|
|
),
|
|
__METHOD__,
|
|
array(
|
|
'GROUP BY' => 'event_page_id',
|
|
'ORDER BY' => 'count DESC',
|
|
'LIMIT' => $limit,
|
|
),
|
|
array( 'echo_notification' => array( 'INNER JOIN', 'notification_event = event_id' ) )
|
|
);
|
|
|
|
if ( $rows === false ) {
|
|
return array();
|
|
}
|
|
|
|
$pages = array();
|
|
foreach ( $rows as $row ) {
|
|
$pages[$row->event_page_id] = $row->count;
|
|
}
|
|
|
|
$result = array();
|
|
$titles = Title::newFromIDs( array_keys( $pages ) );
|
|
foreach ( $titles as $title ) {
|
|
$result[$title->getArticleID()] = array(
|
|
'title' => $title->getPrefixedText(),
|
|
'count' => $pages[$title->getArticleID()],
|
|
);
|
|
}
|
|
|
|
return array( 'pages' => $result );
|
|
}
|
|
|
|
/**
|
|
* @return array
|
|
*/
|
|
protected function getFromForeign() {
|
|
$result = array();
|
|
foreach ( parent::getFromForeign() as $wiki => $data ) {
|
|
$result[$wiki] = $data['query'][$this->getModuleName()][$wiki];
|
|
}
|
|
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* @return array
|
|
*/
|
|
public function getAllowedParams() {
|
|
global $wgEchoMaxUpdateCount;
|
|
|
|
return parent::getAllowedParams() + array(
|
|
'limit' => array(
|
|
ApiBase::PARAM_TYPE => 'limit',
|
|
ApiBase::PARAM_DFLT => 20,
|
|
ApiBase::PARAM_MIN => 1,
|
|
ApiBase::PARAM_MAX => $wgEchoMaxUpdateCount,
|
|
ApiBase::PARAM_MAX2 => $wgEchoMaxUpdateCount,
|
|
),
|
|
// there is no `offset` or `continue` value: the set of possible
|
|
// notifications is small enough to allow fetching all of them at
|
|
// once, and any sort of fetching would be unreliable because
|
|
// they're sorted based on count of notifications, which could
|
|
// change in between requests
|
|
);
|
|
}
|
|
|
|
/**
|
|
* @see ApiBase::getExamplesMessages()
|
|
*/
|
|
protected function getExamplesMessages() {
|
|
return array(
|
|
'action=query&meta=unreadnotificationpages' => 'apihelp-query+unreadnotificationpages-example-1',
|
|
);
|
|
}
|
|
|
|
public function getHelpUrls() {
|
|
return 'https://www.mediawiki.org/wiki/Echo_(Notifications)/API';
|
|
}
|
|
}
|