Skip to content

Refactor tasklist cache and sync list handling #28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ralflang merged 1 commit into from
May 28, 2026
Merged

Refactor tasklist cache and sync list handling #28

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
133 changes: 121 additions & 12 deletions lib/Nag.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,11 @@ class Nag
*/
public const SORT_DESCEND = 1;

/**
* Cache key prefix for cross-session task list invalidation markers.
*/
public const TASKLIST_CACHE_TS_PREFIX = 'nag.tasklist_cache_ts.';

/**
* Incomplete tasks
*/
Expand Down Expand Up @@ -623,6 +628,7 @@ public static function addTasklist(array $info, $display = true, $sync = false)
self::addTasklistToSyncLists($tasklist->getName());
self::notifyActiveSyncOfTaskListChange();
} elseif ($display) {
self::markTasklistCacheChanged();
self::persistPrefs();
}

Expand Down Expand Up @@ -1781,7 +1787,21 @@ protected static function _getOwner($task)
*/
public static function refreshWebSessionState()
{
if ($GLOBALS['registry']->getApp() !== 'nag') {
if ($GLOBALS['registry']->getApp() !== 'nag'
|| empty($GLOBALS['session'])) {
return;
}

$cacheTs = self::_getTasklistCacheTimestamp();
if (!$cacheTs) {
return;
}

$sessionTs = (float) $GLOBALS['session']->get(
'nag',
'tasklist_cache_ts'
);
if ($cacheTs <= $sessionTs) {
return;
}

Expand All @@ -1791,6 +1811,14 @@ public static function refreshWebSessionState()
if (!empty($GLOBALS['nag_shares'])) {
$GLOBALS['nag_shares']->expireListCache();
}

$tasklistIds = array_keys(self::listTasklists());
self::_pruneTasklistPrefList('display_tasklists', $tasklistIds);
self::getDefaultTasklist(Horde_Perms::EDIT);
self::getSyncLists(true);
self::persistPrefs();

$GLOBALS['session']->set('nag', 'tasklist_cache_ts', $cacheTs);
}

/**
Expand Down Expand Up @@ -1822,12 +1850,13 @@ public static function persistPrefs()
*/
public static function notifyActiveSyncOfTaskListChange()
{
self::markTasklistCacheChanged();
self::persistPrefs();

if (!self::_isActiveSyncEnabled()) {
return false;
}

self::persistPrefs();

if (!empty($GLOBALS['nag_shares'])) {
$GLOBALS['nag_shares']->expireListCache();
}
Expand All @@ -1850,6 +1879,22 @@ public static function notifyActiveSyncOfTaskListChange()
return $updated;
}

/**
* Mark task list data as changed for other web sessions.
*/
public static function markTasklistCacheChanged()
{
try {
$cache = $GLOBALS['injector']->getInstance('Horde_Cache');
$timestamp = sprintf('%.6F', microtime(true));
foreach (self::_tasklistCacheKeysForCurrentUser() as $key) {
$cache->set($key, $timestamp, 0);
}
} catch (Exception $e) {
Horde::log($e);
}
}

/**
* Tell all of a user's devices to run FolderSync on the next request.
*
Expand Down Expand Up @@ -2292,36 +2337,100 @@ protected static function _setPrefList($pref, array $list)
$GLOBALS['prefs']->setValue($pref, serialize(array_values($list)));
}

/**
* Remove stale task list ids from a serialized list preference.
*
* @param string $pref Preference name.
* @param array $tasklistIds Existing task list share ids.
*/
protected static function _pruneTasklistPrefList($pref, array $tasklistIds)
{
$list = self::_getPrefList($pref);
$pruned = array_values(array_intersect($list, $tasklistIds));
if ($pruned !== $list) {
self::_setPrefList($pref, $pruned);
}
}

/**
* Read the current cross-session task list marker.
*
* @return float Timestamp marker, or 0 if none exists.
*/
protected static function _getTasklistCacheTimestamp()
{
try {
$cache = $GLOBALS['injector']->getInstance('Horde_Cache');
$timestamp = 0;
foreach (self::_tasklistCacheKeysForCurrentUser() as $key) {
$value = $cache->get($key, 0);
if ($value !== false) {
$timestamp = max($timestamp, (float) $value);
}
}
return $timestamp;
} catch (Exception $e) {
Horde::log($e);
return 0;
}
}

/**
* Return cache keys for auth ids that may address the same user.
*
* @return array Cache keys.
*/
protected static function _tasklistCacheKeysForCurrentUser()
{
$registry = $GLOBALS['registry'];
$userIds = array_unique(array_filter([
$registry->getAuth(),
$registry->getAuth('original'),
]));

$keys = [];
foreach ($userIds as $userId) {
$keys[] = self::TASKLIST_CACHE_TS_PREFIX . hash('sha256', $userId);
}

return $keys;
}

/**
* Returns the tasklists that should be used for syncing.
*
* @param boolean $prune Persist removal of stale list ids from sync_lists.
*
* @return array An array of task list ids
*/
public static function getSyncLists()
public static function getSyncLists($prune = false)
{
$cs = unserialize($GLOBALS['prefs']->getValue('sync_lists'));

// Bug #14585 Filter out erroneous null values.
$cs = array_filter($cs);
$cs = array_filter(self::_getPrefList('sync_lists'));

if (!empty($cs)) {
// Have a pref, make sure it's still available
$lists = self::listTasklists(false, Horde_Perms::DELETE);
$lists = self::listTasklists(false, Horde_Perms::DELETE, false);
$cscopy = array_flip($cs);
$haveRemoved = false;
foreach ($cs as $c) {
if (empty($lists[$c])) {
unset($cscopy[$c]);
$haveRemoved = true;
}
}

// Have at least one
if ($haveRemoved && $prune) {
$cs = array_values(array_flip($cscopy));
self::_setPrefList('sync_lists', $cs);
}

if (count($cscopy)) {
return array_flip($cscopy);
}
}

if ($cs = self::getDefaultTasklist(Horde_Perms::EDIT)) {
return [$cs];
if ($default = self::getDefaultTasklist(Horde_Perms::EDIT)) {
return [$default];
}

return [];
Expand Down
Loading