Page Menu
Home
WickedGov Phorge
Search
Configure Global Search
Log In
Files
F5952406
NotifUser.php
No One
Temporary
Actions
Download File
Edit File
Delete File
View Transforms
Subscribe
Flag For Later
Award Token
Size
23 KB
Referenced Files
None
Subscribers
None
NotifUser.php
View Options
<?php
namespace
MediaWiki\Extension\Notifications
;
use
InvalidArgumentException
;
use
MediaWiki\Extension\Notifications\Gateway\UserNotificationGateway
;
use
MediaWiki\Extension\Notifications\Mapper\NotificationMapper
;
use
MediaWiki\Extension\Notifications\Mapper\TargetPageMapper
;
use
MediaWiki\Extension\Notifications\Model\Notification
;
use
MediaWiki\MediaWikiServices
;
use
MediaWiki\Request\WebRequest
;
use
MediaWiki\User\CentralId\CentralIdLookup
;
use
MediaWiki\User\Options\UserOptionsLookup
;
use
MediaWiki\User\UserFactory
;
use
MediaWiki\User\UserIdentity
;
use
MediaWiki\Utils\MWTimestamp
;
use
MediaWiki\WikiMap\WikiMap
;
use
Wikimedia\ObjectCache\WANObjectCache
;
use
Wikimedia\Rdbms\Database
;
use
Wikimedia\Rdbms\ReadOnlyMode
;
/**
* Entity that represents a notification target user
*/
class
NotifUser
{
/**
* Notification target user
* @var UserIdentity
*/
private
$mUser
;
/**
* Object cache
* @var WANObjectCache
*/
private
$cache
;
/**
* Database access gateway
* @var UserNotificationGateway
*/
private
$userNotifGateway
;
/**
* Notification mapper
* @var NotificationMapper
*/
private
$notifMapper
;
/**
* Target page mapper
* @var TargetPageMapper
*/
private
$targetPageMapper
;
/**
* @var ForeignNotifications|null
*/
private
$foreignNotifications
;
/**
* @var array[]|null
*/
private
$localCountsAndTimestamps
;
/**
* @var array[]|null
*/
private
$globalCountsAndTimestamps
;
/**
* @var UserOptionsLookup
*/
private
$userOptionsLookup
;
/**
* @var UserFactory
*/
private
$userFactory
;
/**
* @var ReadOnlyMode
*/
private
$readOnlyMode
;
// The max notification count shown in badge
// The max number shown in bundled message, eg, <user> and 99+ others <action>.
// This is really a totally separate thing, and could be its own constant.
// WARNING: If you change this, you should also change all references in the
// i18n messages (100 and 99) in all repositories using Echo.
public
const
MAX_BADGE_COUNT
=
99
;
private
const
CACHE_TTL
=
86400
;
private
const
CACHE_KEY
=
'echo-notification-counts'
;
private
const
CHECK_KEY
=
'echo-notification-updated'
;
/**
* Usually client code doesn't need to initialize the object directly
* because it could be obtained from factory method newFromUser()
*/
public
function
__construct
(
UserIdentity
$user
,
WANObjectCache
$cache
,
UserNotificationGateway
$userNotifGateway
,
NotificationMapper
$notifMapper
,
TargetPageMapper
$targetPageMapper
,
UserOptionsLookup
$userOptionsLookup
,
UserFactory
$userFactory
,
ReadOnlyMode
$readOnlyMode
)
{
$this
->
mUser
=
$user
;
$this
->
userNotifGateway
=
$userNotifGateway
;
$this
->
cache
=
$cache
;
$this
->
notifMapper
=
$notifMapper
;
$this
->
targetPageMapper
=
$targetPageMapper
;
$this
->
userOptionsLookup
=
$userOptionsLookup
;
$this
->
userFactory
=
$userFactory
;
$this
->
readOnlyMode
=
$readOnlyMode
;
}
/**
* Factory method. The caller should make sure that the user is registered.
* @param UserIdentity $user
* @return NotifUser
*/
public
static
function
newFromUser
(
UserIdentity
$user
)
{
if
(
!
$user
->
isRegistered
()
)
{
throw
new
InvalidArgumentException
(
'User must be logged in to view notification!'
);
}
$services
=
MediaWikiServices
::
getInstance
();
return
new
NotifUser
(
$user
,
$services
->
getMainWANObjectCache
(),
new
UserNotificationGateway
(
$user
,
DbFactory
::
newFromDefault
(),
$services
->
getMainConfig
()
),
new
NotificationMapper
(),
new
TargetPageMapper
(),
$services
->
getUserOptionsLookup
(),
$services
->
getUserFactory
(),
$services
->
getReadOnlyMode
()
);
}
/**
* Mark all edit-user-talk notifications as read. This is called when a user visits their user talk page.
*/
public
function
clearUserTalkNotifications
()
{
$this
->
markRead
(
$this
->
userNotifGateway
->
getUnreadNotifications
(
'edit-user-talk'
)
);
}
/**
* Get message count for this user.
*
* @return int
*/
public
function
getMessageCount
()
{
return
$this
->
getNotificationCount
(
AttributeManager
::
MESSAGE
);
}
/**
* Get alert count for this user.
*
* @return int
*/
public
function
getAlertCount
()
{
return
$this
->
getNotificationCount
(
AttributeManager
::
ALERT
);
}
/**
* Get the number of unread local notifications in a given section. This does not include
* foreign notifications, even if the user has cross-wiki notifications enabled.
*
* @param string $section Notification section
* @return int
*/
public
function
getLocalNotificationCount
(
$section
=
AttributeManager
::
ALL
)
{
return
$this
->
getNotificationCount
(
$section
,
false
);
}
/**
* Retrieves number of unread notifications that a user has, would return
* NotifUser::MAX_BADGE_COUNT + 1 at most.
*
* If $wgEchoCrossWikiNotifications is disabled, the $global parameter is ignored.
*
* @param string $section Notification section
* @param bool|string $global Whether to include foreign notifications.
* If set to 'preference', uses the user's preference.
* @return int
*/
public
function
getNotificationCount
(
$section
=
AttributeManager
::
ALL
,
$global
=
'preference'
)
{
if
(
!
$this
->
mUser
->
isRegistered
()
)
{
return
0
;
}
global
$wgEchoCrossWikiNotifications
;
if
(
!
$wgEchoCrossWikiNotifications
)
{
// Ignore the $global parameter
$global
=
false
;
}
if
(
$global
===
'preference'
)
{
$global
=
$this
->
getForeignNotifications
()->
isEnabledByUser
();
}
$data
=
$this
->
getCountsAndTimestamps
(
$global
);
if
(
$global
&&
$data
[
'global'
]
===
null
)
{
// No global user exists, no data. Use only local count
$global
=
false
;
}
$count
=
$data
[
$global
?
'global'
:
'local'
][
$section
][
'count'
];
return
(
int
)
$count
;
}
/**
* Get the timestamp of the latest unread alert
*
* @return bool|MWTimestamp Timestamp of latest unread alert, or false if there are no unread alerts.
*/
public
function
getLastUnreadAlertTime
()
{
return
$this
->
getLastUnreadNotificationTime
(
AttributeManager
::
ALERT
);
}
/**
* Get the timestamp of the latest unread message
*
* @return bool|MWTimestamp
*/
public
function
getLastUnreadMessageTime
()
{
return
$this
->
getLastUnreadNotificationTime
(
AttributeManager
::
MESSAGE
);
}
/**
* Returns the timestamp of the last unread notification.
*
* If $wgEchoCrossWikiNotifications is disabled, the $global parameter is ignored.
*
* @param string $section Notification section
* @param bool|string $global Whether to include foreign notifications.
* If set to 'preference', uses the user's preference.
* @return bool|MWTimestamp Timestamp of latest unread message, or false if there are no unread messages.
*/
public
function
getLastUnreadNotificationTime
(
$section
=
AttributeManager
::
ALL
,
$global
=
'preference'
)
{
if
(
!
$this
->
mUser
->
isRegistered
()
)
{
return
false
;
}
global
$wgEchoCrossWikiNotifications
;
if
(
!
$wgEchoCrossWikiNotifications
)
{
// Ignore the $global parameter
$global
=
false
;
}
if
(
$global
===
'preference'
)
{
$global
=
$this
->
getForeignNotifications
()->
isEnabledByUser
();
}
$data
=
$this
->
getCountsAndTimestamps
(
$global
);
if
(
$global
&&
$data
[
'global'
]
===
null
)
{
// No global user exists, no data. Use only local count
$global
=
false
;
}
$timestamp
=
$data
[
$global
?
'global'
:
'local'
][
$section
][
'timestamp'
];
return
$timestamp
===
-
1
?
false
:
new
MWTimestamp
(
$timestamp
);
}
/**
* Mark one or more notifications read for a user.
* @param array $eventIds Array of event IDs to mark read
* @return bool Returns true when data has been updated in DB, false on
* failure, or when there was nothing to update
*/
public
function
markRead
(
$eventIds
)
{
$eventIds
=
array_filter
(
(
array
)
$eventIds
,
'is_numeric'
);
if
(
!
$eventIds
||
$this
->
readOnlyMode
->
isReadOnly
()
)
{
return
false
;
}
$updated
=
$this
->
userNotifGateway
->
markRead
(
$eventIds
);
if
(
$updated
)
{
// Update notification count in cache
$this
->
resetNotificationCount
();
// After this 'mark read', is there any unread edit-user-talk
// remaining? If not, we should clear the newtalk flag.
$talkPageNotificationManager
=
MediaWikiServices
::
getInstance
()
->
getTalkPageNotificationManager
();
if
(
$talkPageNotificationManager
->
userHasNewMessages
(
$this
->
mUser
)
)
{
$attributeManager
=
Services
::
getInstance
()->
getAttributeManager
();
$categoryMap
=
$attributeManager
->
getEventsByCategory
();
$usertalkTypes
=
$categoryMap
[
'edit-user-talk'
];
$unreadEditUserTalk
=
$this
->
notifMapper
->
fetchUnreadByUser
(
$this
->
mUser
,
1
,
null
,
$usertalkTypes
,
null
,
DB_PRIMARY
);
if
(
$unreadEditUserTalk
===
[]
)
{
$talkPageNotificationManager
->
removeUserHasNewMessages
(
$this
->
mUser
);
}
}
}
return
$updated
;
}
/**
* Mark one or more notifications unread for a user.
* @param array $eventIds Array of event IDs to mark unread
* @return bool Returns true when data has been updated in DB, false on
* failure, or when there was nothing to update
*/
public
function
markUnRead
(
$eventIds
)
{
$eventIds
=
array_filter
(
(
array
)
$eventIds
,
'is_numeric'
);
if
(
!
$eventIds
||
$this
->
readOnlyMode
->
isReadOnly
()
)
{
return
false
;
}
$updated
=
$this
->
userNotifGateway
->
markUnRead
(
$eventIds
);
if
(
$updated
)
{
// Update notification count in cache
$this
->
resetNotificationCount
();
// After this 'mark unread', is there any unread edit-user-talk?
// If so, we should add the edit-user-talk flag
$talkPageNotificationManager
=
MediaWikiServices
::
getInstance
()
->
getTalkPageNotificationManager
();
if
(
!
$talkPageNotificationManager
->
userHasNewMessages
(
$this
->
mUser
)
)
{
$attributeManager
=
Services
::
getInstance
()->
getAttributeManager
();
$categoryMap
=
$attributeManager
->
getEventsByCategory
();
$usertalkTypes
=
$categoryMap
[
'edit-user-talk'
];
$unreadEditUserTalk
=
$this
->
notifMapper
->
fetchUnreadByUser
(
$this
->
mUser
,
1
,
null
,
$usertalkTypes
,
null
,
DB_PRIMARY
);
if
(
$unreadEditUserTalk
!==
[]
)
{
$talkPageNotificationManager
->
setUserHasNewMessages
(
$this
->
mUser
);
}
}
}
return
$updated
;
}
/**
* 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 bool
*/
public
function
markAllRead
(
array
$sections
=
[
AttributeManager
::
ALL
]
)
{
if
(
$this
->
readOnlyMode
->
isReadOnly
()
)
{
return
false
;
}
global
$wgEchoMaxUpdateCount
;
// Mark all sections as read if this is the case
if
(
in_array
(
AttributeManager
::
ALL
,
$sections
)
)
{
$sections
=
AttributeManager
::
$sections
;
}
$attributeManager
=
Services
::
getInstance
()->
getAttributeManager
();
$eventTypes
=
$attributeManager
->
getUserEnabledEventsBySections
(
$this
->
mUser
,
'web'
,
$sections
);
$notifs
=
$this
->
notifMapper
->
fetchUnreadByUser
(
$this
->
mUser
,
$wgEchoMaxUpdateCount
,
null
,
$eventTypes
);
$eventIds
=
array_filter
(
array_map
(
static
function
(
Notification
$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
();
}
return
0
;
},
$notifs
)
);
$updated
=
$this
->
markRead
(
$eventIds
);
if
(
$updated
)
{
// Delete records from echo_target_page
/**
* Keep the 'echo_target_page' records so they can be used for moderation.
*/
// $this->targetPageMapper->deleteByUserEvents( $this->mUser, $eventIds );
}
return
$updated
;
}
/**
* Mark one of more notifications as read on a foreign wiki.
*
* @param int[] $eventIds Event IDs to mark as read
* @param string $wiki Wiki name
* @param WebRequest|null $originalRequest Original request data to be sent with these requests
*/
public
function
markReadForeign
(
array
$eventIds
,
$wiki
,
?
WebRequest
$originalRequest
=
null
)
{
$foreignReq
=
new
ForeignWikiRequest
(
$this
->
userFactory
->
newFromUserIdentity
(
$this
->
mUser
),
[
'action'
=>
'echomarkread'
,
'list'
=>
implode
(
'|'
,
$eventIds
),
],
[
$wiki
],
'wikis'
,
'csrf'
);
$foreignReq
->
execute
(
$originalRequest
);
}
/**
* Get information about a set of unread notifications on a foreign wiki.
*
* @param int[] $eventIds Event IDs to look up. Only unread notifications can be found.
* @param string $wiki Wiki name
* @param WebRequest|null $originalRequest Original request data to be sent with these requests
* @return array[] Array of notification data as returned by api.php, keyed by event ID
*/
public
function
getForeignNotificationInfo
(
array
$eventIds
,
$wiki
,
?
WebRequest
$originalRequest
=
null
)
{
$foreignReq
=
new
ForeignWikiRequest
(
$this
->
userFactory
->
newFromUserIdentity
(
$this
->
mUser
),
[
'action'
=>
'query'
,
'meta'
=>
'notifications'
,
'notprop'
=>
'list'
,
'notfilter'
=>
'!read'
,
'notlimit'
=>
'max'
],
[
$wiki
],
'notwikis'
);
$foreignResults
=
$foreignReq
->
execute
(
$originalRequest
);
$list
=
$foreignResults
[
$wiki
][
'query'
][
'notifications'
][
'list'
]
??
[];
$result
=
[];
foreach
(
$list
as
$notif
)
{
if
(
in_array
(
$notif
[
'id'
],
$eventIds
)
)
{
$result
[
$notif
[
'id'
]]
=
$notif
;
}
}
return
$result
;
}
/**
* Invalidate cache and update echo_unread_wikis if x-wiki notifications is enabled.
*
* This updates the user's touched timestamp, as well as the value returned by getGlobalUpdateTime().
*
* NOTE: Consider calling this function from a deferred update, since it will read from and write to
* the primary DB if cross-wiki notifications are enabled.
*/
public
function
resetNotificationCount
()
{
global
$wgEchoCrossWikiNotifications
;
// Delete cached local counts and timestamps
$localMemcKey
=
$this
->
getMemcKey
(
self
::
CACHE_KEY
);
$this
->
cache
->
delete
(
$localMemcKey
);
// Update the user touched timestamp for the local user
$this
->
userFactory
->
newFromUserIdentity
(
$this
->
mUser
)->
invalidateCache
();
if
(
$wgEchoCrossWikiNotifications
)
{
// Delete cached global counts and timestamps
$globalMemcKey
=
$this
->
getGlobalMemcKey
(
self
::
CACHE_KEY
);
if
(
$globalMemcKey
!==
false
)
{
$this
->
cache
->
delete
(
$globalMemcKey
);
}
$uw
=
UnreadWikis
::
newFromUser
(
$this
->
mUser
);
if
(
$uw
)
{
// Immediately compute new local counts and timestamps
$newLocalData
=
$this
->
computeLocalCountsAndTimestamps
(
DB_PRIMARY
);
// Write the new values to the echo_unread_wikis table
$alertTs
=
$newLocalData
[
AttributeManager
::
ALERT
][
'timestamp'
];
$messageTs
=
$newLocalData
[
AttributeManager
::
MESSAGE
][
'timestamp'
];
$uw
->
updateCount
(
WikiMap
::
getCurrentWikiId
(),
$newLocalData
[
AttributeManager
::
ALERT
][
'count'
],
$alertTs
===
-
1
?
false
:
new
MWTimestamp
(
$alertTs
),
$newLocalData
[
AttributeManager
::
MESSAGE
][
'count'
],
$messageTs
===
-
1
?
false
:
new
MWTimestamp
(
$messageTs
)
);
// We could set() $newLocalData into the cache here, but we don't because that seems risky;
// instead we let it be recomputed on demand
}
// Update the global touched timestamp
$checkKey
=
$this
->
getGlobalMemcKey
(
self
::
CHECK_KEY
);
if
(
$checkKey
)
{
$this
->
cache
->
touchCheckKey
(
$checkKey
);
}
}
}
/**
* Get the timestamp of the last time the global notification counts/timestamps were updated, if available.
*
* If the timestamp of the last update is not known, this will return the current timestamp.
* If the user is not attached, this will return false.
*
* @return string|false MW timestamp of the last update, or false if the user is not attached
*/
public
function
getGlobalUpdateTime
()
{
$key
=
$this
->
getGlobalMemcKey
(
self
::
CHECK_KEY
);
if
(
$key
===
false
)
{
return
false
;
}
return
wfTimestamp
(
TS_MW
,
$this
->
cache
->
getCheckKeyTime
(
$key
)
);
}
/**
* Get the number of notifications in each section, and the timestamp of the latest notification in
* each section. This returns the raw data structure that is stored in the cache; unless you want
* all of this information, you're probably looking for getNotificationCount(),
* getLastUnreadNotificationTime() or one of its wrappers.
*
* The returned data structure looks like:
* [
* 'local' => [
* 'alert' => [ 'count' => N, 'timestamp' => TS ],
* 'message' => [ 'count' = N, 'timestamp' => TS ],
* 'all' => [ 'count' => N, 'timestamp' => TS ],
* ],
* 'global' => [
* 'alert' => [ 'count' => N, 'timestamp' => TS ],
* 'message' => [ 'count' = N, 'timestamp' => TS ],
* 'all' => [ 'count' => N, 'timestamp' => TS ],
* ],
* ]
* Where N is a number and TS is a timestamp in TS_MW format or -1. If $includeGlobal is false,
* the 'global' key will not be present. It could be null, if no global user exists.
*
* @param bool $includeGlobal Whether to include cross-wiki notifications as well
* @return array
*/
public
function
getCountsAndTimestamps
(
$includeGlobal
=
false
)
{
if
(
$this
->
localCountsAndTimestamps
===
null
)
{
$this
->
localCountsAndTimestamps
=
$this
->
cache
->
getWithSetCallback
(
$this
->
getMemcKey
(
self
::
CACHE_KEY
),
self
::
CACHE_TTL
,
function
(
$oldValue
,
&
$ttl
,
array
&
$setOpts
)
{
$dbr
=
$this
->
userNotifGateway
->
getDB
(
DB_REPLICA
);
$setOpts
+=
Database
::
getCacheSetOptions
(
$dbr
);
return
$this
->
computeLocalCountsAndTimestamps
();
}
);
}
$result
=
[
'local'
=>
$this
->
localCountsAndTimestamps
];
if
(
$includeGlobal
)
{
if
(
$this
->
globalCountsAndTimestamps
===
null
)
{
$memcKey
=
$this
->
getGlobalMemcKey
(
self
::
CACHE_KEY
);
// If getGlobalMemcKey returns false, we don't have a global user ID
// In that case, don't compute data that we can't cache or store
if
(
$memcKey
!==
false
)
{
$this
->
globalCountsAndTimestamps
=
$this
->
cache
->
getWithSetCallback
(
$memcKey
,
self
::
CACHE_TTL
,
function
(
$oldValue
,
&
$ttl
,
array
&
$setOpts
)
{
$dbr
=
$this
->
userNotifGateway
->
getDB
(
DB_REPLICA
);
$setOpts
+=
Database
::
getCacheSetOptions
(
$dbr
);
return
$this
->
computeGlobalCountsAndTimestamps
();
}
);
}
}
$result
[
'global'
]
=
$this
->
globalCountsAndTimestamps
;
}
return
$result
;
}
/**
* Compute the counts and timestamps for the local notifications in each section.
* @param int $dbSource DB_REPLICA or DB_PRIMARY
* @return array[] [ 'alert' => [ 'count' => N, 'timestamp' => TS ], ... ]
*/
protected
function
computeLocalCountsAndTimestamps
(
$dbSource
=
DB_REPLICA
)
{
$attributeManager
=
Services
::
getInstance
()->
getAttributeManager
();
$result
=
[];
$totals
=
[
'count'
=>
0
,
'timestamp'
=>
-
1
];
foreach
(
AttributeManager
::
$sections
as
$section
)
{
$eventTypesToLoad
=
$attributeManager
->
getUserEnabledEventsBySections
(
$this
->
mUser
,
'web'
,
[
$section
]
);
$count
=
$this
->
userNotifGateway
->
getCappedNotificationCount
(
$dbSource
,
$eventTypesToLoad
,
self
::
MAX_BADGE_COUNT
+
1
);
$result
[
$section
][
'count'
]
=
$count
;
$totals
[
'count'
]
+=
$count
;
$notifications
=
$this
->
notifMapper
->
fetchUnreadByUser
(
$this
->
mUser
,
1
,
null
,
$eventTypesToLoad
,
null
,
$dbSource
);
if
(
$notifications
)
{
$notification
=
reset
(
$notifications
);
$timestamp
=
$notification
->
getTimestamp
();
}
else
{
$timestamp
=
-
1
;
}
$result
[
$section
][
'timestamp'
]
=
$timestamp
;
$totals
[
'timestamp'
]
=
max
(
$totals
[
'timestamp'
],
$timestamp
);
}
$totals
[
'count'
]
=
self
::
capNotificationCount
(
$totals
[
'count'
]
);
$result
[
AttributeManager
::
ALL
]
=
$totals
;
return
$result
;
}
/**
* Compute the global counts and timestamps for each section.
*
* This calls getCountsAndTimestamps() to get data about local notifications, which may end up
* calling computeLocalCountsAndTimestamps() if there's a cache miss.
* @return array[] [ 'alert' => [ 'count' => N, 'timestamp' => TS ], ... ]
*/
protected
function
computeGlobalCountsAndTimestamps
()
{
$localData
=
$this
->
getCountsAndTimestamps
()[
'local'
];
$result
=
[];
$totals
=
[
'count'
=>
0
,
'timestamp'
=>
-
1
];
foreach
(
AttributeManager
::
$sections
as
$section
)
{
$localCount
=
$localData
[
$section
][
'count'
];
$globalCount
=
self
::
capNotificationCount
(
$localCount
+
$this
->
getForeignCount
(
$section
)
);
$result
[
$section
][
'count'
]
=
$globalCount
;
$totals
[
'count'
]
+=
$globalCount
;
$localTimestamp
=
$localData
[
$section
][
'timestamp'
];
$foreignTimestamp
=
$this
->
getForeignTimestamp
(
$section
);
$globalTimestamp
=
max
(
$localTimestamp
,
$foreignTimestamp
?
$foreignTimestamp
->
getTimestamp
(
TS_MW
)
:
-
1
);
$result
[
$section
][
'timestamp'
]
=
$globalTimestamp
;
$totals
[
'timestamp'
]
=
max
(
$totals
[
'timestamp'
],
$globalTimestamp
);
}
$totals
[
'count'
]
=
self
::
capNotificationCount
(
$totals
[
'count'
]
);
$result
[
AttributeManager
::
ALL
]
=
$totals
;
return
$result
;
}
/**
* Get the user's email notification format
* @return string
*/
public
function
getEmailFormat
()
{
global
$wgAllowHTMLEmail
;
if
(
$wgAllowHTMLEmail
)
{
return
$this
->
userOptionsLookup
->
getOption
(
$this
->
mUser
,
'echo-email-format'
);
}
return
EmailFormat
::
PLAIN_TEXT
;
}
/**
* Build a cache key for local use (local to this wiki)
*
* @param string $key Key, typically prefixed with echo-notification-
* @return string Cache key
*/
protected
function
getMemcKey
(
$key
)
{
global
$wgEchoCacheVersion
;
return
$this
->
cache
->
makeKey
(
$key
,
$this
->
mUser
->
getId
(),
$wgEchoCacheVersion
);
}
/**
* Build a cache key for global use
*
* @param string $key Key, typically prefixed with echo-notification-
* @return string|false Memcached key, or false if one could not be generated
*/
protected
function
getGlobalMemcKey
(
$key
)
{
global
$wgEchoCacheVersion
;
$globalId
=
MediaWikiServices
::
getInstance
()
->
getCentralIdLookup
()
->
centralIdFromLocalUser
(
$this
->
mUser
,
CentralIdLookup
::
AUDIENCE_RAW
);
if
(
!
$globalId
)
{
return
false
;
}
return
$this
->
cache
->
makeGlobalKey
(
$key
,
$globalId
,
$wgEchoCacheVersion
);
}
/**
* Lazy-construct an ForeignNotifications instance. This instance is force-enabled, so it
* returns information about cross-wiki notifications even if the user has them disabled.
* @return ForeignNotifications
*/
protected
function
getForeignNotifications
()
{
if
(
!
$this
->
foreignNotifications
)
{
$this
->
foreignNotifications
=
new
ForeignNotifications
(
$this
->
mUser
,
true
);
}
return
$this
->
foreignNotifications
;
}
/**
* Get the number of foreign notifications in a given section.
* @param string $section One of AttributeManager::$sections
* @return int Number of foreign notifications
*/
protected
function
getForeignCount
(
$section
=
AttributeManager
::
ALL
)
{
return
self
::
capNotificationCount
(
$this
->
getForeignNotifications
()->
getCount
(
$section
)
);
}
/**
* Get the timestamp of the most recent foreign notification in a given section.
* @param string $section One of AttributeManager::$sections
* @return MWTimestamp|false Timestamp of the most recent foreign notification, or false if
* there aren't any
*/
protected
function
getForeignTimestamp
(
$section
=
AttributeManager
::
ALL
)
{
return
$this
->
getForeignNotifications
()->
getTimestamp
(
$section
);
}
/**
* Helper function to produce the capped number of notifications
* based on the value of NotifUser::MAX_BADGE_COUNT
*
* @param int $number Raw notification count to cap
* @return int Capped notification count
*/
public
static
function
capNotificationCount
(
$number
)
{
return
min
(
$number
,
self
::
MAX_BADGE_COUNT
+
1
);
}
}
File Metadata
Details
Attached
Mime Type
text/x-php
Expires
Oct 3 2026, 01:26 (4 w, 4 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
8c/1f/141c9bc106d4bafce2cfe1628656
Default Alt Text
NotifUser.php (23 KB)
Attached To
Mode
rMWPROD MediaWiki Production
Attached
Detach File
Event Timeline
Log In to Comment