mediawiki-extensions-Echo/includes/UnreadWikis.php
Matthias Mullie 6be71f2fae Delete rows in echo_unread_wikis if there are no unread notifs
It used to be like this, but in order to get the messages badge to show
in the correct circumstances, I had to know if the user had ever had
foreign messages before & I also needed euw_messages_ts even if those
messages had already been read.

Now that we're unconditionally showing messages, we no longer need these
0-value rows.

Bug: T127731
Change-Id: I1fc13bf0e5133ae39224f66d1b5a59c769bfcee2
2016-02-23 16:21:28 +01:00

143 lines
2.8 KiB
PHP

<?php
/**
* Manages what wikis a user has unread notifications on
*/
class EchoUnreadWikis {
/**
* @var string
*/
const DEFAULT_TS = '00000000000000';
/**
* @var int
*/
private $id;
/**
* @var MWEchoDbFactory
*/
private $dbFactory;
/**
* @param int $id Central user id
*/
public function __construct( $id ) {
$this->id = $id;
$this->dbFactory = MWEchoDbFactory::newFromDefault();
}
/**
* Use the user id provided by the CentralIdLookup
*
* @param User $user
* @return EchoUnreadWikis|bool
*/
public static function newFromUser( User $user ) {
$lookup = CentralIdLookup::factory();
$id = $lookup->centralIdFromLocalUser( $user, CentralIdLookup::AUDIENCE_RAW );
if ( !$id ) {
return false;
}
return new self( $id );
}
/**
* @param int $index DB_* constant
* @return bool|DatabaseBase
*/
private function getDB( $index ) {
return $this->dbFactory->getSharedDb( $index );
}
/**
* @return array
*/
public function getUnreadCounts() {
$dbr = $this->getDB( DB_SLAVE );
if ( $dbr === false ) {
return array();
}
$rows = $dbr->select(
'echo_unread_wikis',
array(
'euw_wiki',
'euw_alerts', 'euw_alerts_ts',
'euw_messages', 'euw_messages_ts',
),
array( 'euw_user' => $this->id ),
__METHOD__
);
$wikis = array();
foreach ( $rows as $row ) {
if ( !$row->euw_alerts && !$row->euw_messages ) {
// This shouldn't happen, but lets be safe...
continue;
}
$wikis[$row->euw_wiki] = array(
EchoAttributeManager::ALERT => array(
'count' => $row->euw_alerts,
'ts' => $row->euw_alerts_ts,
),
EchoAttributeManager::MESSAGE => array(
'count' => $row->euw_messages,
'ts' => $row->euw_messages_ts,
),
);
}
return $wikis;
}
/**
* @param string $wiki
* @param int $alertCount
* @param MWTimestamp|bool $alertTime
* @param int $msgCount
* @param MWTimestamp|bool $msgTime
*/
public function updateCount( $wiki, $alertCount, $alertTime, $msgCount, $msgTime ) {
$dbw = $this->getDB( DB_MASTER );
if ( $dbw === false ) {
return;
}
$conditions = array(
'euw_user' => $this->id,
'euw_wiki' => $wiki,
);
if ( $alertCount || $msgCount ) {
$values = array(
'euw_alerts' => $alertCount,
'euw_alerts_ts' => $alertCount
? $alertTime->getTimestamp( TS_MW )
: static::DEFAULT_TS,
'euw_messages' => $msgCount,
'euw_messages_ts' => $msgCount
? $msgTime->getTimestamp( TS_MW )
: static::DEFAULT_TS,
);
// when there is unread alert(s) and/or message(s), upsert the row
$dbw->upsert(
'echo_unread_wikis',
$conditions + $values,
array( 'euw_user', 'euw_wiki' ),
$values,
__METHOD__
);
} else {
// No unread notifications, delete the row
$dbw->delete(
'echo_unread_wikis',
$conditions,
__METHOD__
);
}
}
}