Skip to content

fix(activesync): harden error handler against missing collection data #16

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
Mar 21, 2026
Merged

fix(activesync): harden error handler against missing collection data #16

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
64 changes: 61 additions & 3 deletions lib/Horde/ActiveSync/Request/Sync.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1242,26 +1242,84 @@ protected function _handleGlobalSyncError($limit = false)
* Helper for handling sync errors
*
* @param array $collection
*
* @see MS-ASCMD 2.2.2.18 Sync command response structure
* @see MS-ASCMD 2.2.3.29.4 Class element in EAS > 12.1 sent via OPTIONS
* @see Line 643-648 for similar CollectionId requirement handling
* @see Line 706-711 for class retrieval pattern
* @see Collections.php:1063-1065 for FolderGone exception pattern
*/
protected function _handleError(array $collection)
{
// Log detailed error context for diagnostics
if (isset($this->_logger)) {
$this->_logger->err(sprintf(
'SYNC ERROR: status=%s, collection_id=%s, class=%s, synckey=%s, keys=[%s]',
$this->_statusCode ?? 'UNKNOWN',
$collection['id'] ?? 'MISSING',
$collection['class'] ?? 'MISSING',
$collection['synckey'] ?? 'MISSING',
implode(',', array_keys($collection))
));
}

$this->_encoder->startWBXML();
$this->_encoder->startTag(Horde_ActiveSync::SYNC_SYNCHRONIZE);

$this->_encoder->startTag(Horde_ActiveSync::SYNC_FOLDERS);

// Get new synckey if needed
// Generate new synckey for initial sync, state reset, or when synckey missing/invalid
if ($this->_statusCode == self::STATUS_KEYMISM ||
!empty($collection['importedchanges']) ||
!empty($collection['getchanges']) ||
empty($collection['synckey']) ||
$collection['synckey'] == '0') {

$collection['newsynckey'] = Horde_ActiveSync_State_Base::getNewSyncKey(($this->_statusCode == self::STATUS_KEYMISM) ? 0 : $collection['synckey']);
if ($collection['synckey'] != '0') {
$collection['newsynckey'] = Horde_ActiveSync_State_Base::getNewSyncKey(($this->_statusCode == self::STATUS_KEYMISM) ? 0 : ($collection['synckey'] ?? 0));
if (!empty($collection['synckey']) && $collection['synckey'] != '0') {
$this->_state->removeState(array('synckey' => $collection['synckey']));
}
}

// Collection-specific error response requires CollectionId per MS-ASCMD; fallback to global error
if (empty($collection['id'])) {
if (isset($this->_logger)) {
$this->_logger->err('Cannot send SYNC error response: collection has no ID. This indicates a very early protocol error.');
$this->_logger->debug(sprintf(
'Collection state at error: synckey=%s, class=%s, available_keys=[%s]',
$collection['synckey'] ?? 'NONE',
$collection['class'] ?? 'NONE',
implode(',', array_keys($collection))
));
}
$this->_statusCode = self::STATUS_PROTERROR;
$this->_handleGlobalSyncError();
return;
}

// Collection class may be missing in EAS > 12.1; retrieve from cache or signal folder resync
if (empty($collection['class'])) {
$collection['class'] = $this->_collections->getCollectionClass($collection['id']);
if (!$collection['class']) {
// Cannot determine class - collection may be deleted/invalid, signal FOLDERSYNC required
if (isset($this->_logger)) {
$this->_logger->err(sprintf(
'Cannot determine collection class for id=%s - collection may be deleted or cache invalid',
$collection['id']
));
}
$this->_statusCode = self::STATUS_FOLDERSYNC_REQUIRED;
// Use fallback class value to prevent encoder crash while sending FOLDERSYNC_REQUIRED status
$collection['class'] = 'Email';
} elseif (isset($this->_logger)) {
$this->_logger->debug(sprintf(
'Retrieved missing collection class from cache: %s for id=%s',
$collection['class'],
$collection['id']
));
}
}

$this->_encoder->startTag(Horde_ActiveSync::SYNC_FOLDER);

$this->_encoder->startTag(Horde_ActiveSync::SYNC_FOLDERTYPE);
Expand Down
Loading