mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/Echo
synced 2024-11-12 09:26:05 +00:00
434 lines
12 KiB
PHP
434 lines
12 KiB
PHP
<?php
|
|
|
|
/**
|
|
* Entity that represents a notification target user
|
|
*/
|
|
class MWEchoNotifUser {
|
|
|
|
/**
|
|
* Notification target user
|
|
* @var User
|
|
*/
|
|
private $mUser;
|
|
|
|
/**
|
|
* Object cache
|
|
* @var BagOStuff
|
|
*/
|
|
private $cache;
|
|
|
|
/**
|
|
* Database access gateway
|
|
* @var EchoUserNotificationGateway
|
|
*/
|
|
private $userNotifGateway;
|
|
|
|
/**
|
|
* Notification mapper
|
|
* @var EchoNotificationMapper
|
|
*/
|
|
private $notifMapper;
|
|
|
|
/**
|
|
* Target page mapper
|
|
* @var EchoTargetPageMapper
|
|
*/
|
|
private $targetPageMapper;
|
|
|
|
/**
|
|
* Whether to check cache for section status
|
|
*/
|
|
static $sectionStatusCheckCache = array (
|
|
EchoAttributeManager::ALERT => false,
|
|
EchoAttributeManager::MESSAGE => true
|
|
);
|
|
|
|
/**
|
|
* Usually client code doesn't need to initialize the object directly
|
|
* because it could be obtained from factory method newFromUser()
|
|
* @param User $user
|
|
* @param BagOStuff $cache
|
|
* @param EchoUserNotificationGateway $userNotifGateway
|
|
* @param EchoNotificationMapper $notifMapper
|
|
* @param EchoTargetPageMapper $targetPageMapper
|
|
*/
|
|
public function __construct(
|
|
User $user,
|
|
BagOStuff $cache,
|
|
EchoUserNotificationGateway $userNotifGateway,
|
|
EchoNotificationMapper $notifMapper,
|
|
EchoTargetPageMapper $targetPageMapper
|
|
) {
|
|
$this->mUser = $user;
|
|
$this->userNotifGateway = $userNotifGateway;
|
|
$this->cache = $cache;
|
|
$this->notifMapper = $notifMapper;
|
|
$this->targetPageMapper = $targetPageMapper;
|
|
}
|
|
|
|
/**
|
|
* Factory method
|
|
* @param $user User
|
|
* @throws MWException
|
|
* @return MWEchoNotifUser
|
|
*/
|
|
public static function newFromUser( User $user ) {
|
|
if ( $user->isAnon() ) {
|
|
throw new MWException( 'User must be logged in to view notification!' );
|
|
}
|
|
global $wgMemc;
|
|
return new MWEchoNotifUser(
|
|
$user, $wgMemc,
|
|
new EchoUserNotificationGateway( $user, MWEchoDbFactory::newFromDefault() ),
|
|
new EchoNotificationMapper(),
|
|
new EchoTargetPageMapper()
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Check whether should trigger a query to fetch data for a section when making
|
|
* such request. This method normally should return true for all section.
|
|
* For some sections, it's better to save the result in cache and check before
|
|
* triggering a query. Flow is in very limited deployment, Most *users would
|
|
* not have flow notifications, it's better to save *this status in cache
|
|
* to save a query. In addition, Flow notification is far less than other
|
|
* notifications for most users at this moment. Querying could be expensive
|
|
* in extreme cases
|
|
* @param string $section
|
|
* @return boolean
|
|
*/
|
|
public function shouldQuerySectionData( $section ) {
|
|
if ( !self::$sectionStatusCheckCache[$section] ) {
|
|
return true;
|
|
}
|
|
$cacheVal = $this->cache->get( $this->sectionStatusCacheKey( $section ) );
|
|
// '1' means should query
|
|
// '0' means should not query
|
|
// false means no cache and should query
|
|
if ( $cacheVal !== '0' ) {
|
|
return true;
|
|
} else {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Set section data status into cache, '1' means there is data for the section,
|
|
* '0' means there is no data for this section
|
|
* @param string $section
|
|
* @param int $num
|
|
*/
|
|
public function setSectionStatusCache( $section, $num ) {
|
|
if ( !self::$sectionStatusCheckCache[$section] ) {
|
|
return;
|
|
}
|
|
$key = $this->sectionStatusCacheKey( $section );
|
|
// Set cache for 5 days
|
|
if ( $num > 0 ) {
|
|
$this->cache->set( $key, '1', 432000 );
|
|
} else {
|
|
$this->cache->set( $key, '0', 432000 );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Clear section data cache for the section
|
|
* @param string
|
|
*/
|
|
public function clearSectionStatusCache( $section ) {
|
|
if ( !self::$sectionStatusCheckCache[$section] ) {
|
|
return;
|
|
}
|
|
$this->cache->delete(
|
|
$this->sectionStatusCacheKey( $section )
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Get the section data status cache key
|
|
* @param string $section
|
|
* @return string
|
|
*/
|
|
protected function sectionStatusCacheKey( $section ) {
|
|
global $wgEchoConfig;
|
|
return wfMemcKey(
|
|
'echo-notification-section-exist',
|
|
$section,
|
|
$this->mUser->getId(),
|
|
$wgEchoConfig['version']
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Clear talk page notification when users visit their talk pages. This
|
|
* only resets if the notification count is less than max notification
|
|
* count. If the user has 99+ notifications, decrementing 1 bundled talk
|
|
* page notification would not really affect the count
|
|
*/
|
|
public function clearTalkNotification() {
|
|
// There is no new talk notification
|
|
if ( $this->cache->get( $this->getTalkNotificationCacheKey() ) === '0' ) {
|
|
return;
|
|
}
|
|
|
|
// Do nothing if the count display meets the max 99+
|
|
if ( $this->notifCountHasReachedMax() ) {
|
|
return;
|
|
}
|
|
|
|
// Mark the talk page notification as read
|
|
$this->markRead(
|
|
$this->userNotifGateway->getUnreadNotifications(
|
|
'edit-user-talk'
|
|
)
|
|
);
|
|
|
|
$this->flagCacheWithNoTalkNotification();
|
|
}
|
|
|
|
/**
|
|
* Flag the cache with new talk notification
|
|
*/
|
|
public function flagCacheWithNewTalkNotification() {
|
|
$this->cache->set( $this->getTalkNotificationCacheKey(), '1', 86400 );
|
|
}
|
|
|
|
/**
|
|
* Flag the cache with no talk notification
|
|
*/
|
|
public function flagCacheWithNoTalkNotification() {
|
|
$this->cache->set( $this->getTalkNotificationCacheKey(), '0', 86400 );
|
|
}
|
|
|
|
/**
|
|
* Memcache key for talk notification
|
|
*/
|
|
public function getTalkNotificationCacheKey() {
|
|
global $wgEchoConfig;
|
|
|
|
return wfMemcKey( 'echo-new-talk-notification', $this->mUser->getId(), $wgEchoConfig['version'] );
|
|
}
|
|
|
|
/**
|
|
* Check if the user has more notification count than max count display
|
|
* @return bool
|
|
*/
|
|
public function notifCountHasReachedMax() {
|
|
global $wgEchoMaxNotificationCount;
|
|
|
|
if ( $this->getNotificationCount() > $wgEchoMaxNotificationCount ) {
|
|
return true;
|
|
} else {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Retrieves number of unread notifications that a user has, would return
|
|
* $wgEchoMaxNotificationCount + 1 at most
|
|
*
|
|
* @param boolean $cached Set to false to bypass the cache.
|
|
* @param int $dbSource Use master or slave database to pull count
|
|
* @param string $section Notification section
|
|
* @return int
|
|
*/
|
|
public function getNotificationCount( $cached = true, $dbSource = DB_SLAVE, $section = EchoAttributeManager::ALL ) {
|
|
global $wgEchoConfig;
|
|
|
|
if ( $this->mUser->isAnon() ) {
|
|
return 0;
|
|
}
|
|
|
|
$memcKey = wfMemcKey(
|
|
'echo-notification-count' . ( $section === EchoAttributeManager::ALL ? '' : ( '-' . $section ) ),
|
|
$this->mUser->getId(),
|
|
$wgEchoConfig['version']
|
|
);
|
|
|
|
if ( $cached ) {
|
|
$data = $this->cache->get( $memcKey );
|
|
if ( $data !== false ) {
|
|
return (int)$data;
|
|
}
|
|
}
|
|
|
|
$attributeManager = EchoAttributeManager::newFromGlobalVars();
|
|
if ( $section === EchoAttributeManager::ALL ) {
|
|
$eventTypesToLoad = $attributeManager->getUserEnabledEvents( $this->mUser, 'web' );
|
|
} else {
|
|
$eventTypesToLoad = $attributeManager->getUserEnabledEventsbySections( $this->mUser, 'web', array( $section ) );
|
|
}
|
|
|
|
$count = $this->userNotifGateway->getNotificationCount( $dbSource, $eventTypesToLoad );
|
|
|
|
$this->cache->set( $memcKey, $count, 86400 );
|
|
|
|
return (int)$count;
|
|
}
|
|
|
|
/**
|
|
* Returns the timestamp of the last unread notification.
|
|
*
|
|
* @param boolean $cached Set to false to bypass the cache.
|
|
* @param int $dbSource Use master or slave database to pull count
|
|
* @param string $section Notification section
|
|
* @return bool|MWTimestamp Timestamp of last notification, or false if there is none
|
|
*/
|
|
public function getLastUnreadNotificationTime( $cached = true, $dbSource = DB_SLAVE, $section = EchoAttributeManager::ALL ) {
|
|
global $wgEchoConfig;
|
|
|
|
if ( $this->mUser->isAnon() ) {
|
|
return false;
|
|
}
|
|
|
|
$memcKey = wfMemcKey(
|
|
'echo-notification-timestamp' . ( $section === EchoAttributeManager::ALL ? '' : ( '-' . $section ) ),
|
|
$this->mUser->getId(),
|
|
$wgEchoConfig['version']
|
|
);
|
|
|
|
// read from cache, if allowed
|
|
if ( $cached ) {
|
|
$timestamp = $this->cache->get( $memcKey );
|
|
if ( $timestamp !== false ) {
|
|
return new MWTimestamp( $timestamp );
|
|
}
|
|
}
|
|
|
|
$attributeManager = EchoAttributeManager::newFromGlobalVars();
|
|
if ( $section === EchoAttributeManager::ALL ) {
|
|
$eventTypesToLoad = $attributeManager->getUserEnabledEvents( $this->mUser, 'web' );
|
|
} else {
|
|
$eventTypesToLoad = $attributeManager->getUserEnabledEventsbySections( $this->mUser, 'web', array( $section ) );
|
|
}
|
|
|
|
$notifications = $this->notifMapper->fetchUnreadByUser( $this->mUser, 1, $eventTypesToLoad, $dbSource );
|
|
if ( $notifications ) {
|
|
$notification = reset( $notifications );
|
|
$timestamp = $notification->getTimestamp();
|
|
|
|
// store to cache & return
|
|
$this->cache->set($memcKey, $timestamp, 86400);
|
|
return new MWTimestamp( $timestamp );
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Mark one or more notifications read for a user.
|
|
* @param $eventIds Array of event IDs to mark read
|
|
* @return boolean
|
|
*/
|
|
public function markRead( $eventIds ) {
|
|
$eventIds = array_filter( (array)$eventIds, 'is_numeric' );
|
|
if ( !$eventIds || wfReadOnly() ) {
|
|
return false;
|
|
}
|
|
|
|
$res = $this->userNotifGateway->markRead( $eventIds );
|
|
if ( $res ) {
|
|
// Delete records from echo_target_page
|
|
$this->targetPageMapper->deleteByUserEvents( $this->mUser, $eventIds );
|
|
// Update notification count in cache
|
|
$this->resetNotificationCount( DB_MASTER );
|
|
}
|
|
return $res;
|
|
}
|
|
|
|
/**
|
|
* Attempt to mark all or sections of notifications as read, this only
|
|
* updates up to $wgEchoMaxUpdateCount records per request, see more
|
|
* detail about this in Echo.php, the other reason is that mediawiki
|
|
* database interface doesn't support updateJoin() that would update
|
|
* across multiple tables, we would visit this later
|
|
*
|
|
* @param string[] $sections
|
|
* @return boolean
|
|
*/
|
|
public function markAllRead( array $sections = array( EchoAttributeManager::ALL ) ) {
|
|
if ( wfReadOnly() ) {
|
|
return false;
|
|
}
|
|
|
|
global $wgEchoMaxUpdateCount;
|
|
|
|
// Mark all sections as read if this is the case
|
|
if ( in_array( EchoAttributeManager::ALL, $sections ) ) {
|
|
$sections = EchoAttributeManager::$sections;
|
|
}
|
|
|
|
$attributeManager = EchoAttributeManager::newFromGlobalVars();
|
|
$eventTypes = $attributeManager->getUserEnabledEventsbySections( $this->mUser, 'web', $sections );
|
|
|
|
$notifs = $this->notifMapper->fetchUnreadByUser( $this->mUser, $wgEchoMaxUpdateCount, $eventTypes );
|
|
|
|
$eventIds = array_filter(
|
|
array_map( function( EchoNotification $notif ) {
|
|
// This should not happen at all, but use 0 in
|
|
// such case so to keep the code running
|
|
if ( $notif->getEvent() ) {
|
|
return $notif->getEvent()->getId();
|
|
} else {
|
|
return 0;
|
|
}
|
|
}, $notifs )
|
|
);
|
|
|
|
$res = $this->markRead( $eventIds );
|
|
if ( $res ) {
|
|
// Delete records from echo_target_page
|
|
$this->targetPageMapper->deleteByUserEvents( $this->mUser, $eventIds );
|
|
if ( count( $notifs ) < $wgEchoMaxUpdateCount ) {
|
|
$this->flagCacheWithNoTalkNotification();
|
|
}
|
|
}
|
|
return $res;
|
|
}
|
|
|
|
/**
|
|
* Recalculates the number of notifications that a user has.
|
|
* @param $dbSource int use master or slave database to pull count
|
|
*/
|
|
public function resetNotificationCount( $dbSource = DB_SLAVE ) {
|
|
// Reset notification count for all sections as well
|
|
$this->getNotificationCount( false, $dbSource, EchoAttributeManager::ALL );
|
|
$this->getNotificationCount( false, $dbSource, EchoAttributeManager::ALERT );
|
|
$this->getNotificationCount( false, $dbSource, EchoAttributeManager::MESSAGE );
|
|
// when notification count needs to be updated, last notification may have
|
|
// changed too, so we need to invalidate that cache too
|
|
$this->getLastUnreadNotificationTime( false, $dbSource, EchoAttributeManager::ALL );
|
|
$this->getLastUnreadNotificationTime( false, $dbSource, EchoAttributeManager::ALERT );
|
|
$this->getLastUnreadNotificationTime( false, $dbSource, EchoAttributeManager::MESSAGE );
|
|
$this->mUser->invalidateCache();
|
|
}
|
|
|
|
/**
|
|
* Retrieves formatted number of unread notifications that a user has.
|
|
* @param boolean $cached Set to false to bypass the cache.
|
|
* @param int $dbSource use master or slave database to pull count
|
|
* @param string $section
|
|
* @return string
|
|
*/
|
|
public function getFormattedNotificationCount( $cached = true, $dbSource = DB_SLAVE, $section = EchoAttributeManager::ALL ) {
|
|
return EchoNotificationController::formatNotificationCount(
|
|
$this->getNotificationCount( $cached, $dbSource, $section )
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Get the user's email notification format
|
|
* @return string
|
|
*/
|
|
public function getEmailFormat() {
|
|
global $wgAllowHTMLEmail;
|
|
|
|
if ( $wgAllowHTMLEmail ) {
|
|
return $this->mUser->getOption( 'echo-email-format' );
|
|
} else {
|
|
return EchoHooks::EMAIL_FORMAT_PLAIN_TEXT;
|
|
}
|
|
}
|
|
|
|
}
|