mediawiki-extensions-Echo/includes/Gateway/UserNotificationGateway.php
Reedy fb4478454d Namespace Gateway
Change-Id: I7501be6e57cec92b2b4175b8772d213c7fd031d4
2022-11-02 14:52:04 -06:00

232 lines
5 KiB
PHP

<?php
namespace MediaWiki\Extension\Notifications\Gateway;
use Config;
use MediaWiki\User\UserIdentity;
use MWEchoDbFactory;
use MWEchoNotifUser;
/**
* Database gateway which handles direct database interaction with the
* echo_notification & echo_event for a user, that wouldn't require
* loading data into models
*/
class UserNotificationGateway {
/**
* @var MWEchoDbFactory
*/
protected $dbFactory;
/**
* @var UserIdentity
*/
protected $user;
/**
* The tables for this gateway.
*
* @var string
*/
protected static $eventTable = 'echo_event';
/**
* The tables for this gateway.
*
* @var string
*/
protected static $notificationTable = 'echo_notification';
/**
* @var Config
*/
private $config;
/**
* @param UserIdentity $user
* @param MWEchoDbFactory $dbFactory
* @param Config $config
*/
public function __construct( UserIdentity $user, MWEchoDbFactory $dbFactory, Config $config ) {
$this->user = $user;
$this->dbFactory = $dbFactory;
$this->config = $config;
}
public function getDB( $dbSource ) {
return $this->dbFactory->getEchoDb( $dbSource );
}
/**
* Mark notifications as read
* @param array $eventIDs
* @return bool Returns true when data has been updated in DB, false on
* failure, or when there was nothing to update
*/
public function markRead( array $eventIDs ) {
if ( !$eventIDs ) {
return false;
}
$dbw = $this->getDB( DB_PRIMARY );
if ( $dbw->isReadOnly() ) {
return false;
}
$success = true;
foreach (
array_chunk( $eventIDs, $this->config->get( 'UpdateRowsPerQuery' ) ) as $batch
) {
$success = $dbw->update(
self::$notificationTable,
[ 'notification_read_timestamp' => $dbw->timestamp( wfTimestampNow() ) ],
[
'notification_user' => $this->user->getId(),
'notification_event' => $batch,
'notification_read_timestamp' => null,
],
__METHOD__
) && $success;
}
return $success;
}
/**
* Mark notifications as unread
* @param array $eventIDs
* @return bool Returns true when data has been updated in DB, false on
* failure, or when there was nothing to update
*/
public function markUnRead( array $eventIDs ) {
if ( !$eventIDs ) {
return false;
}
$dbw = $this->getDB( DB_PRIMARY );
if ( $dbw->isReadOnly() ) {
return false;
}
$success = true;
foreach (
array_chunk( $eventIDs, $this->config->get( 'UpdateRowsPerQuery' ) ) as $batch
) {
$success = $dbw->update(
self::$notificationTable,
[ 'notification_read_timestamp' => null ],
[
'notification_user' => $this->user->getId(),
'notification_event' => $batch,
'notification_read_timestamp IS NOT NULL'
],
__METHOD__
) && $success;
}
return $success;
}
/**
* Mark all notification as read, use MWEchoNotifUser::markAllRead() instead
* @deprecated may need this when running in a job or revive this when we
* have updateJoin()
*/
public function markAllRead() {
$dbw = $this->getDB( DB_PRIMARY );
if ( $dbw->isReadOnly() ) {
return false;
}
$dbw->update(
self::$notificationTable,
[ 'notification_read_timestamp' => $dbw->timestamp( wfTimestampNow() ) ],
[
'notification_user' => $this->user->getId(),
'notification_read_timestamp' => null,
],
__METHOD__
);
return true;
}
/**
* Get notification count for the types specified
* @param int $dbSource use primary database or replica storage to pull count
* @param array $eventTypesToLoad event types to retrieve
* @param int $cap Max count
* @return int
*/
public function getCappedNotificationCount(
$dbSource,
array $eventTypesToLoad = [],
$cap = MWEchoNotifUser::MAX_BADGE_COUNT
) {
// double check
if ( !in_array( $dbSource, [ DB_REPLICA, DB_PRIMARY ] ) ) {
$dbSource = DB_REPLICA;
}
if ( !$eventTypesToLoad ) {
return 0;
}
$db = $this->getDB( $dbSource );
return $db->selectRowCount(
[
self::$notificationTable,
self::$eventTable
],
'1',
[
'notification_user' => $this->user->getId(),
'notification_read_timestamp' => null,
'event_deleted' => 0,
'event_type' => $eventTypesToLoad,
],
__METHOD__,
[ 'LIMIT' => $cap ],
[
'echo_event' => [ 'LEFT JOIN', 'notification_event=event_id' ],
]
);
}
/**
* IMPORTANT: should only call this function if the number of unread notification
* is reasonable, for example, unread notification count is less than the max
* display defined in MWEchoNotifUser::MAX_BADGE_COUNT
* @param string $type
* @return int[]
*/
public function getUnreadNotifications( $type ) {
$dbr = $this->getDB( DB_REPLICA );
$res = $dbr->select(
[
self::$notificationTable,
self::$eventTable
],
[ 'notification_event' ],
[
'notification_user' => $this->user->getId(),
'notification_read_timestamp' => null,
'event_deleted' => 0,
'event_type' => $type,
'notification_event = event_id'
],
__METHOD__
);
$eventIds = [];
if ( $res ) {
foreach ( $res as $row ) {
$eventIds[$row->notification_event] = $row->notification_event;
}
}
return $eventIds;
}
}