LoopDetection::IgnoreNextMessage() - Code Metrics - grommunio/grommunio-sync - Measure and Improve Code Quality continuously with Scrutinizer

LoopDetection::IgnoreNextMessage() C
last analyzed 2025-10-30 18:17 UTC

↳ Parent: LoopDetection
Complexity

Conditions	14
Paths	76
Size

Total Lines	83
Code Lines	36
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	14
eloc	36
nop	3
dl	0
loc	83
rs	6.2666
c	0
b	0
f	0
nc	76
How to fix Long Method Complexity

<?php

/*
 * SPDX-License-Identifier: AGPL-3.0-only
 * SPDX-FileCopyrightText: Copyright 2007-2016 Zarafa Deutschland GmbH
 * SPDX-FileCopyrightText: Copyright 2020-2025 grommunio GmbH
 *
 * Detects an outgoing loop by looking if subsequent requests do try to get
 * changes for the same sync key. If more than once a synckey is requested,
 * the amount of items to be sent to the mobile is reduced to one. If then
 * (again) the same synckey is requested, we have most probably found the
 * "broken" item.
 */

class LoopDetection extends InterProcessData {
	public const INTERPROCESSLD = "processstack";
	public const BROKENMSGS = "brokenmsgs";
	private static $processident;
	private static $processentry;
	private $ignore_messageid;
	private $broken_message_uuid;
	private $broken_message_counter;

	/**
	 * Constructor.
	 */
	public function __construct() {
		// initialize super parameters
		$this->allocate = 1024000; // 1 MB
		$this->type = "grommunio-sync:loopdetection";
		parent::__construct();

		$this->ignore_messageid = false;
	}

	/**
	 * PROCESS LOOP DETECTION.
	 */

	/**
	 * Adds the process entry to the process stack.
	 *
	 * @return bool
	 */
	public function ProcessLoopDetectionInit() {
		return $this->updateProcessStack();
	}

	/**
	 * Marks the process entry as termineted successfully on the process stack.
	 *
	 * @return bool
	 */
	public function ProcessLoopDetectionTerminate() {
		// just to be sure that the entry is there
		self::GetProcessEntry();

		self::$processentry['end'] = time();
		SLog::Write(LOGLEVEL_DEBUG, "LoopDetection->ProcessLoopDetectionTerminate()");

		return $this->updateProcessStack();
	}

	/**
	 * Returns a unique identifier for the internal process tracking.
	 *
	 * @return string
	 */
	public static function GetProcessIdentifier() {
		if (!isset(self::$processident)) {
			self::$processident = sprintf('%04x%04x', mt_rand(0, 0xFFFF), mt_rand(0, 0xFFFF));
		}

		return self::$processident;
	}

	/**
	 * Returns a unique entry with information about the current process.
	 *
	 * @return array
	 */
	public static function GetProcessEntry() {
		if (!isset(self::$processentry)) {
			self::$processentry = [];
			self::$processentry['id'] = self::GetProcessIdentifier();
			self::$processentry['pid'] = self::$pid;
			self::$processentry['time'] = self::$start;
			self::$processentry['cc'] = Request::GetCommandCode();
		}

		return self::$processentry;
	}

	/**
	 * Adds an Exceptions to the process tracking.
	 *
	 * @param Exception $exception
	 *
	 * @return bool
	 */
	public function ProcessLoopDetectionAddException($exception) {
		// generate entry if not already there
		self::GetProcessEntry();

		if (!isset(self::$processentry['stat'])) {
			self::$processentry['stat'] = [];
		}

		self::$processentry['stat'][$exception::class] = $exception->getCode();

		$this->updateProcessStack();

		return true;
	}

	/**
	 * Adds a folderid and connected status code to the process tracking.
	 *
	 * @param string $folderid
	 * @param int    $status
	 *
	 * @return bool
	 */
	public function ProcessLoopDetectionAddStatus($folderid, $status) {
		SLog::Write(LOGLEVEL_DEBUG, sprintf("LoopDetection->ProcessLoopDetectionAddStatus: '%s' with status %d", $folderid ?: 'hierarchy', $status));
		// generate entry if not already there
		self::GetProcessEntry();

		if ($folderid === false) {

			$folderid = "hierarchy";
		}

		if (!isset(self::$processentry['stat'])) {
			self::$processentry['stat'] = [];
		}

		self::$processentry['stat'][$folderid] = $status;

		$this->updateProcessStack();

		return true;
	}

	/**
	 * Marks the current process as a PUSH connection.
	 *
	 * @return bool
	 */
	public function ProcessLoopDetectionSetAsPush() {
		// generate entry if not already there
		self::GetProcessEntry();
		self::$processentry['push'] = true;

		return $this->updateProcessStack();
	}

	/**
	 * Indicates if a simple Hierarchy sync should be done after Ping.
	 *
	 * When trying to sync a non existing folder, Sync will return Status 12.
	 * This should trigger a hierarchy sync by the client, but this is not always done.
	 * Clients continue trying to Ping, which fails as well and triggers a Sync again.
	 *
	 * Ping could indicate to perform a FolderSync as well after a few Sync/Ping cycles.
	 *
	 * @return bool
	 */
	public function ProcessLoopDetectionIsHierarchySyncAdvised() {
		$me = self::GetProcessEntry();
		if ($me['cc'] !== GSync::COMMAND_PING) {
			return false;
		}

		$loopingFolders = [];

		$lookback = self::$start - 600; // look at the last 5 min
		foreach ($this->getProcessStack() as $se) {
			if ($se['time'] > $lookback && $se['time'] < (self::$start - 1)) {
				// look for sync command
				if (isset($se['stat']) && ($se['cc'] == GSync::COMMAND_SYNC || $se['cc'] == GSync::COMMAND_PING)) {
					foreach ($se['stat'] as $key => $value) {
						// we only care about hierarchy errors of this folder
						if ($se['cc'] == GSync::COMMAND_SYNC) {
							if ($value == SYNC_STATUS_FOLDERHIERARCHYCHANGED) {
								SLog::Write(LOGLEVEL_DEBUG, sprintf("LoopDetection->ProcessLoopDetectionIsHierarchySyncAdvised(): seen Sync command with Exception or folderid '%s' and code '%s'", $key, $value));
							}
						}
						if (!isset($loopingFolders[$key])) {
							$loopingFolders[$key] = [GSync::COMMAND_SYNC => [], GSync::COMMAND_PING => []];
						}
						if (!isset($loopingFolders[$key][$se['cc']][$value])) {
							$loopingFolders[$key][$se['cc']][$value] = 0;
						}
						++$loopingFolders[$key][$se['cc']][$value];
					}
				}
			}
		}

		$filtered = [];

		foreach ($loopingFolders as $fid => $data) {
			// Ping is constantly generating changes for this folder
			if (isset($data[GSync::COMMAND_PING][SYNC_PINGSTATUS_CHANGES]) && $data[GSync::COMMAND_PING][SYNC_PINGSTATUS_CHANGES] >= 3) {
				// but the Sync request is not treating it (not being requested)
				if (count($data[GSync::COMMAND_SYNC]) == 0) {
					SLog::Write(LOGLEVEL_INFO, sprintf("LoopDetection->ProcessLoopDetectionIsHierarchySyncAdvised(): Ping loop of folderid '%s' detected that is not being synchronized.", $fid));

					return true;
				}
				// Sync is executed, but a foldersync should be executed (hierarchy errors)
				if (isset($data[GSync::COMMAND_SYNC][SYNC_STATUS_FOLDERHIERARCHYCHANGED]) &&
						$data[GSync::COMMAND_SYNC][SYNC_STATUS_FOLDERHIERARCHYCHANGED] > 3) {
					SLog::Write(LOGLEVEL_INFO, sprintf("LoopDetection->ProcessLoopDetectionIsHierarchySyncAdvised(): Sync(with error)/Ping loop of folderid '%s' detected.", $fid));

					return true;
				}
			}
		}

		return false;
	}

	/**
	 * Indicates if a full Hierarchy Resync is necessary.
	 *
	 * In some occasions the mobile tries to sync a folder with an invalid/not-existing ID.
	 * In these cases a status exception like SYNC_STATUS_FOLDERHIERARCHYCHANGED is returned
	 * so the mobile executes a FolderSync expecting that some action is taken on that folder (e.g. remove).
	 *
	 * If the FolderSync is not doing anything relevant, then the Sync is attempted again
	 * resulting in the same error and looping between these two processes.
	 *
	 * This method checks if in the last process stack a Sync and FolderSync were triggered to
	 * catch the loop at the 2nd interaction (Sync->FolderSync->Sync->FolderSync => ReSync)
	 *
	 * @return bool
	 */
	public function ProcessLoopDetectionIsHierarchyResyncRequired() {
		$seenFailed = [];
		$seenFolderSync = false;

		$lookback = self::$start - 600; // look at the last 5 min
		foreach ($this->getProcessStack() as $se) {
			if ($se['time'] > $lookback && $se['time'] < (self::$start - 1)) {
				// look for sync command
				if (isset($se['stat']) && ($se['cc'] == GSync::COMMAND_SYNC || $se['cc'] == GSync::COMMAND_PING)) {
					foreach ($se['stat'] as $key => $value) {
						// don't count PING with changes on a folder or sync with success
						if (($se['cc'] == GSync::COMMAND_PING && $value == SYNC_PINGSTATUS_CHANGES) ||
								($se['cc'] == GSync::COMMAND_SYNC && $value == SYNC_STATUS_SUCCESS)) {
							continue;
						}
						if (!isset($seenFailed[$key])) {
							$seenFailed[$key] = 0;
						}
						++$seenFailed[$key];
						SLog::Write(LOGLEVEL_DEBUG, sprintf("LoopDetection->ProcessLoopDetectionIsHierarchyResyncRequired(): seen command with Exception or folderid '%s' and code '%s'", $key, $value));
					}
				}
				// look for FolderSync command with previous failed commands
				if ($se['cc'] == GSync::COMMAND_FOLDERSYNC && !empty($seenFailed) && $se['id'] != self::GetProcessIdentifier()) {
					// a full folderresync was already triggered
					if (isset($se['stat'], $se['stat']['hierarchy']) && $se['stat']['hierarchy'] == SYNC_FSSTATUS_SYNCKEYERROR) {
						SLog::Write(LOGLEVEL_DEBUG, "LoopDetection->ProcessLoopDetectionIsHierarchyResyncRequired(): a full FolderReSync was already requested. Resetting fail counter.");
						$seenFailed = [];
					}
					else {
						$seenFolderSync = true;
						SLog::Write(LOGLEVEL_DEBUG, "LoopDetection->ProcessLoopDetectionIsHierarchyResyncRequired(): seen FolderSync after other failing command");
					}
				}
			}
		}

		$filtered = [];
		foreach ($seenFailed as $k => $count) {
			if ($count > 1) {
				$filtered[] = $k;
			}
		}

		if ($seenFolderSync && !empty($filtered)) {
			SLog::Write(LOGLEVEL_INFO, "LoopDetection->ProcessLoopDetectionIsHierarchyResyncRequired(): Potential loop detected. Full hierarchysync indicated.");

			return true;
		}

		return false;
	}

	/**
	 * Indicates if a previous process could not be terminated.
	 *
	 * Checks if there is an end time for the last entry on the stack
	 *
	 * @return bool
	 */
	public function ProcessLoopDetectionPreviousConnectionFailed() {
		$stack = $this->getProcessStack();
		$errors = false;
		if (count($stack) > 1) {
			$se = $stack[0];
			if (!isset($se['end']) && $se['cc'] != GSync::COMMAND_PING && !isset($se['push'])) {
				// there is no end time
				SLog::Write(LOGLEVEL_ERROR, sprintf("LoopDetection->ProcessLoopDetectionPreviousConnectionFailed(): Command '%s' at %s with pid '%d' terminated unexpectedly or is still running.", Utils::GetCommandFromCode($se['cc']), Utils::GetFormattedTime($se['time']), $se['pid']));
				SLog::Write(LOGLEVEL_ERROR, "Please check your logs for this PID and errors like PHP-Fatals or Apache segmentation faults and report your results to the grommunio dev team.");
				$errors = true;
			}
		}

		return $errors;
	}

	/**
	 * Gets the PID of an outdated search process.
	 *
	 * Returns false if there isn't any process
	 *
	 * @return bool
	 */
	public function ProcessLoopDetectionGetOutdatedSearchPID() {
		$stack = $this->getProcessStack();
		if (count($stack) > 1) {
			$se = $stack[0];
			if ($se['cc'] == GSync::COMMAND_SEARCH || $se['cc'] == GSync::COMMAND_FIND) {
				return $se['pid'];
			}
		}

		return false;
	}

	/**
	 * Inserts or updates the current process entry on the stack.
	 *
	 * @return bool
	 */
	private function updateProcessStack() {
		// initialize params
		$this->initializeParams();

		$ok = false;
		$tryCount = 1;
		while (!$ok && $tryCount < 5) {
			[$stack, $stackRaw] = $this->getDeviceUserData($this->type, parent::$devid, parent::$user, self::INTERPROCESSLD, true);

			// insert/update current process entry
			$nstack = [];
			$updateentry = self::GetProcessEntry();
			$found = false;

			foreach ($stack as $entry) {
				if ($entry['id'] != $updateentry['id']) {
					$nstack[] = $entry;
				}
				else {
					$nstack[] = $updateentry;
					$found = true;
				}
			}

			if (!$found) {
				$nstack[] = $updateentry;
			}

			if (count($nstack) > 10) {
				$nstack = array_slice($nstack, -10, 10);
			}

			// update loop data
			$ok = $this->setDeviceUserData($this->type, $nstack, parent::$devid, parent::$user, self::INTERPROCESSLD, $doCas = "replace", $stackRaw);
			if (!$ok) {
				$l = LOGLEVEL_INFO;
				if ($tryCount > 1) {
					$l = LOGLEVEL_WARN;
				}
				SLog::Write($l, sprintf("LoopDetection->updateProcessStack(): CAS failed on try %d!", $tryCount));
				usleep(100000);
				++$tryCount;
			}
		}

		return $ok;
	}

	/**
	 * Returns the current process stack.
	 *
	 * @return array
	 */
	private function getProcessStack() {
		// initialize params
		$this->initializeParams();

		return $this->getDeviceUserData($this->type, parent::$devid, parent::$user, self::INTERPROCESSLD);
	}

	/*
	 * TRACKING OF BROKEN MESSAGES
	 * if a previousily ignored message is streamed again to the device it's tracked here.
	 *
	 * There are two outcomes:
	 * - next uuid counter is higher than current -> message is fixed and successfully synchronized
	 * - next uuid counter is the same or uuid changed -> message is still broken
	 */

	/**
	 * Adds a message to the tracking of broken messages
	 * Being tracked means that a broken message was streamed to the device.
	 * We save the latest uuid and counter so if on the next sync the counter is higher
	 * the message was accepted by the device.
	 *
	 * @param string $folderid the parent folder of the message
	 * @param string $id       the id of the message
	 *
	 * @return bool
	 */
	public function SetBrokenMessage($folderid, $id) {
		if ($folderid == false ||

				!isset($this->broken_message_uuid) ||
				!isset($this->broken_message_counter) ||
				$this->broken_message_uuid == false ||
				$this->broken_message_counter == false) {
			return false;
		}

		$ok = false;
		$brokenkey = self::BROKENMSGS . "-" . $folderid;

		// initialize params
		$this->initializeParams();
		$tryCount = 1;
		while (!$ok && $tryCount < 5) {
			[$brokenmsgs, $brokenmsgsRaw] = $this->getDeviceUserData($this->type, parent::$devid, parent::$user, $brokenkey, true);

			$brokenmsgs[$id] = ['uuid' => $this->broken_message_uuid, 'counter' => $this->broken_message_counter];
			SLog::Write(LOGLEVEL_DEBUG, sprintf("LoopDetection->SetBrokenMessage('%s', '%s'): tracking broken message", $folderid, $id));

			// update data
			$ok = $this->setDeviceUserData($this->type, $brokenmsgs, parent::$devid, parent::$user, $brokenkey, $doCas = "replace", $brokenmsgsRaw);
			if (!$ok) {
				SLog::Write(LOGLEVEL_WARN, sprintf("LoopDetection->SetBrokenMessage(): CAS failed on try %d!", $tryCount));
				usleep(100000);
				++$tryCount;
			}
		}

		return $ok;
	}

	/**
	 * Gets a list of all ids of a folder which were tracked and which were
	 * accepted by the device from the last sync.
	 *
	 * @param string $folderid the parent folder of the message
	 *
	 * @return array
	 */
	public function GetSyncedButBeforeIgnoredMessages($folderid) {
		if ($folderid == false ||

				!isset($this->broken_message_uuid) ||
				!isset($this->broken_message_counter) ||
				$this->broken_message_uuid == false ||
				$this->broken_message_counter == false) {
			return [];
		}

		$brokenkey = self::BROKENMSGS . "-" . $folderid;
		$removeIds = [];
		$okIds = [];

		// initialize params
		$this->initializeParams();

		$ok = false;
		$tryCount = 1;
		while (!$ok && $tryCount < 5) {
			[$brokenmsgs, $brokenmsgsRaw] = $this->getDeviceUserData($this->type, parent::$devid, parent::$user, $brokenkey, true);

			if (empty($brokenmsgs)) {
				break;
			}

			foreach ($brokenmsgs as $id => $data) {
				// previously broken message was successfully synced!
				if ($data['uuid'] == $this->broken_message_uuid && $data['counter'] < $this->broken_message_counter) {
					SLog::Write(LOGLEVEL_DEBUG, sprintf("LoopDetection->GetSyncedButBeforeIgnoredMessages('%s'): message '%s' was successfully synchronized", $folderid, $id));
					$okIds[] = $id;
				}

				// if the uuid has changed this is old data which should also be removed
				if ($data['uuid'] != $this->broken_message_uuid) {
					SLog::Write(LOGLEVEL_DEBUG, sprintf("LoopDetection->GetSyncedButBeforeIgnoredMessages('%s'): stored message id '%s' for uuid '%s' is obsolete", $folderid, $id, $data['uuid']));
					$removeIds[] = $id;
				}
			}

			// remove data
			foreach (array_merge($okIds, $removeIds) as $id) {
				unset($brokenmsgs[$id]);
			}

			if (empty($brokenmsgs)) {
				$this->delDeviceUserData($this->type, parent::$devid, parent::$user, $brokenkey);
				SLog::Write(LOGLEVEL_DEBUG, sprintf("LoopDetection->GetSyncedButBeforeIgnoredMessages('%s'): removed folder from tracking of ignored messages", $folderid));

				break;
			}

			// update data
			$ok = $this->setDeviceUserData($this->type, $brokenmsgs, parent::$devid, parent::$user, $brokenkey, $doCas = "replace", $brokenmsgsRaw);
			if (!$ok) {
				SLog::Write(LOGLEVEL_WARN, sprintf("LoopDetection->GetSyncedButBeforeIgnoredMessages(): CAS failed on try %d!", $tryCount));
				usleep(100000);
				++$tryCount;
			}
		}

		return $okIds;
	}

	/**
	 * Marks a SyncState as "already used", e.g. when an import process started.
	 * This is most critical for DiffBackends, as an imported message would be exported again
	 * in the heartbeat if the notification is triggered before the import is complete.
	 *
	 * @param string $folderid folder id
	 * @param string $uuid     synkkey
	 * @param string $counter  synckey counter
	 *
	 * @return bool
	 */
	public function SetSyncStateUsage($folderid, $uuid, $counter) {
		// initialize params
		$this->initializeParams();

		SLog::Write(LOGLEVEL_DEBUG, sprintf("LoopDetection->SetSyncStateUsage(): uuid: %s  counter: %d", $uuid, $counter));

		$ok = false;
		$tryCount = 1;
		while (!$ok && $tryCount < 5) {
			[$current, $currentRaw] = $this->getDeviceUserData($this->type, parent::$devid, parent::$user, $folderid, true);

			if (!isset($current["uuid"])) {
				$current["uuid"] = $uuid;
			}
			if (!isset($current["count"])) {
				$current["count"] = $counter;
			}
			if (!isset($current["queued"])) {
				$current["queued"] = 0;
			}

			// update the usage flag
			$current["usage"] = $counter;

			// update loop data
			$ok = $this->setDeviceUserData($this->type, $current, parent::$devid, parent::$user, $folderid, $doCas = "replace", $currentRaw);
			if (!$ok) {
				SLog::Write(LOGLEVEL_WARN, sprintf("LoopDetection->SetSyncStateUsage(): CAS failed on try %d!", $tryCount));
				usleep(100000);
				++$tryCount;
			}
		}

		return $ok;
	}

	/**
	 * Checks if the given counter for a certain uuid+folderid was exported before.
	 * Returns also true if the counter are the same but previously there were
	 * changes to be exported.
	 *
	 * @param string $folderid folder id
	 * @param string $uuid     synkkey
	 * @param string $counter  synckey counter
	 *
	 * @return bool indicating if an uuid+counter were exported (with changes) before
	 */
	public function IsSyncStateObsolete($folderid, $uuid, $counter) {
		// initialize params
		$this->initializeParams();

		$obsolete = false;

		$current = $this->getDeviceUserData($this->type, parent::$devid, parent::$user, $folderid);

		if (!empty($current)) {
			if (!isset($current["uuid"]) || $current["uuid"] != $uuid) {
				SLog::Write(LOGLEVEL_DEBUG, "LoopDetection->IsSyncStateObsolete(): yes, uuid changed or not set");
				$obsolete = true;
			}
			else {
				SLog::Write(LOGLEVEL_DEBUG, sprintf(
					"LoopDetection->IsSyncStateObsolete(): check folderid: '%s' uuid '%s' counter: %d - last counter: %d with %d queued",
					$folderid,
					$uuid,
					$counter,
					$current["count"],
					$current["queued"]
				));

				if ($current["uuid"] == $uuid && (
					$current["count"] > $counter ||
						($current["count"] == $counter && $current["queued"] > 0) ||
						(isset($current["usage"]) && $current["usage"] >= $counter)
				)) {
					$usage = isset($current["usage"]) ? sprintf(" - counter %d already expired", $current["usage"]) : "";
					SLog::Write(LOGLEVEL_DEBUG, "LoopDetection->IsSyncStateObsolete(): yes, counter already processed" . $usage);
					$obsolete = true;
				}
			}
		}
		else {
			SLog::Write(LOGLEVEL_DEBUG, sprintf("LoopDetection->IsSyncStateObsolete(): check folderid: '%s' uuid '%s' counter: %d - no data found: not obsolete", $folderid, $uuid, $counter));
		}

		return $obsolete;
	}

	/*
	 * MESSAGE LOOP DETECTION.
	 */

	/**
	 * Loop detection mechanism.
	 *
	 *    1. request counter is higher than the previous counter (somehow default)
	 *      1.1)   standard situation                                   -> do nothing
	 *      1.2)   loop information exists
	 *      1.2.1) request counter < maxCounter AND no ignored data     -> continue in loop mode
	 *      1.2.2) request counter < maxCounter AND ignored data        -> we have already encountered issue, return to normal
	 *
	 *    2. request counter is the same as the previous, but no data was sent on the last request (standard situation)
	 *
	 *    3. request counter is the same as the previous and last time objects were sent (loop!)
	 *      3.0)   no loop was detected before, but with big window size -> lower window size first - NO LOOP mode yet
	 *      3.1)   no loop was detected before, entering loop mode      -> save loop data, loopcount = 1
	 *      3.2)   loop was detected before, but are gone               -> loop resolved
	 *      3.3)   loop was detected before, continuing in loop mode    -> this is probably the broken element,loopcount++,
	 *      3.3.1) item identified, loopcount >= 3                      -> ignore item, set ignoredata flag
	 *
	 * @param string $folderid       the current folder id to be worked on
	 * @param string $uuid           the synkkey
	 * @param string $counter        the synckey counter
	 * @param string $maxItems       the current amount of items to be sent to the mobile
	 * @param string $queuedMessages the amount of messages which were found by the exporter
	 *
	 * @return bool|int when returning true if a loop has been identified - returns new suggested window size if window might have been too big
	 */
	public function Detect($folderid, $uuid, $counter, $maxItems, $queuedMessages) {
		SLog::Write(LOGLEVEL_DEBUG, sprintf("LoopDetection->Detect(): folderid:'%s' uuid:'%s' counter:'%s' max:'%s' queued:'%s'", $folderid, $uuid, $counter, $maxItems, $queuedMessages));
		$this->broken_message_uuid = $uuid;
		$this->broken_message_counter = $counter;

		// if an incoming loop is already detected, do nothing
		if ($maxItems === 0 && $queuedMessages > 0) {

			GSync::GetTopCollector()->AnnounceInformation("Incoming loop!", true);

			return true;
		}

		// initialize params
		$this->initializeParams();

		$loop = false;

		$ok = false;
		$tryCount = 1;
		while (!$ok && $tryCount < 5) {
			[$current, $currentRaw] = $this->getDeviceUserData($this->type, parent::$devid, parent::$user, $folderid, true);

			// completely new/unknown UUID
			if (empty($current)) {
				$current = ["uuid" => $uuid, "count" => $counter - 1, "queued" => $queuedMessages];
			}

			// old UUID in cache - the device requested a new state!!
			if (isset($current['uuid']) && $current['uuid'] != $uuid) {
				SLog::Write(LOGLEVEL_DEBUG, "LoopDetection->Detect(): UUID changed for folder");

				// some devices (iPhones) may request new UUIDs after broken items were sent several times
				if (isset($current['queued']) && $current['queued'] > 0 &&
					(isset($current['maxCount']) && $current['maxCount'] > $current['count'] + 1 || $counter == 1)) {
					SLog::Write(LOGLEVEL_DEBUG, "LoopDetection->Detect(): UUID changed and while items where sent to device - forcing loop mode");
					$loop = true; // force loop mode
					$current['queued'] = $queuedMessages;
				}
				else {
					$current['queued'] = 0;
				}

				// set new data, unset old loop information
				$current["uuid"] = $uuid;
				$current['count'] = $counter;
				unset($current['loopcount'], $current['ignored'], $current['maxCount'], $current['potential'], $current['windowLimit']);
			}

			// see if there are values
			if (isset($current['uuid']) && $current['uuid'] == $uuid &&
				isset($current['count'])) {
				// case 1 - standard, during loop-resolving & resolving
				if ($current['count'] < $counter) {
					// case 1.1
					$current['count'] = $counter;
					$current['queued'] = $queuedMessages;
					if (isset($current["usage"]) && $current["usage"] < $current['count']) {
						unset($current["usage"]);
					}

					// case 1.2
					if (isset($current['maxCount'])) {
						SLog::Write(LOGLEVEL_DEBUG, "LoopDetection->Detect(): case 1.2 detected");

						// case 1.2.1
						// broken item not identified yet
						if (!isset($current['ignored']) && $counter < $current['maxCount']) {
							$current['loopcount'] = 1;
							$loop = true; // continue in loop-resolving
							SLog::Write(LOGLEVEL_DEBUG, "LoopDetection->Detect(): case 1.2.1 detected");
						}
						// case 1.2.2 - if there were any broken items they should be gone, return to normal
						else {
							SLog::Write(LOGLEVEL_DEBUG, "LoopDetection->Detect(): case 1.2.2 detected");
							unset($current['loopcount'], $current['ignored'], $current['maxCount'], $current['potential'], $current['windowLimit']);
						}
					}
				}

				// case 2 - same counter, but there were no changes before and are there now
				elseif ($current['count'] == $counter && $current['queued'] == 0 && $queuedMessages > 0) {
					$current['queued'] = $queuedMessages;
					if (isset($current["usage"]) && $current["usage"] < $current['count']) {
						unset($current["usage"]);
					}
				}

				// case 3 - same counter, changes sent before, hanging loop and ignoring
				elseif ($current['count'] == $counter && $current['queued'] > 0) {
					if (!isset($current['loopcount'])) {
						// We are potentially syncing a lot of data, e.g. OL with 512 WindowSize
						// In case there are more then 40 items in the last request, we limit to 25 items
						// before entering 1-by-1 loop detection if counter is re-requested
						if ($maxItems > 40 && !isset($current['windowLimit'])) {
							// case 3.0) we have just encountered a loop, but with a big window size, lower window first
							SLog::Write(LOGLEVEL_DEBUG, sprintf("LoopDetection->Detect(): case 3.0 detected - big windowsize of %d, lowering before entering loop mode", $maxItems));
							// return suggested new window size
							$current['windowLimit'] = 25;
							$loop = $current['windowLimit'];
						}
						else {
							// case 3.1) we have just encountered a loop!
							SLog::Write(LOGLEVEL_DEBUG, "LoopDetection->Detect(): case 3.1 detected - loop detected, init loop mode");
							if (isset($current['windowLimit'])) {
								$maxItems = $current['windowLimit'];
								unset($current['windowLimit']);
							}
							$current['loopcount'] = 1;
							// the MaxCount is the max number of messages exported before
							$current['maxCount'] = $counter + (($maxItems < $queuedMessages) ? $maxItems : $queuedMessages);
							$loop = true;   // loop mode!!
						}
					}
					elseif ($queuedMessages == 0) {
						// case 3.2) there was a loop before but now the changes are GONE
						SLog::Write(LOGLEVEL_DEBUG, "LoopDetection->Detect(): case 3.2 detected - changes gone - clearing loop data");
						$current['queued'] = 0;
						unset($current['loopcount'], $current['ignored'], $current['maxCount'], $current['potential'], $current['windowLimit']);
					}
					else {
						// case 3.3) still looping the same message! Increase counter
						SLog::Write(LOGLEVEL_DEBUG, "LoopDetection->Detect(): case 3.3 detected - in loop mode, increase loop counter");
						++$current['loopcount'];

						// case 3.3.1 - we got our broken item!
						if ($current['loopcount'] >= 3 && isset($current['potential'])) {
							SLog::Write(LOGLEVEL_DEBUG, sprintf("LoopDetection->Detect(): case 3.3.1 detected - broken item should be next, attempt to ignore it - id '%s'", $current['potential']));
							$this->ignore_messageid = $current['potential'];
						}
						$current['maxCount'] = $counter + (($maxItems < $queuedMessages) ? $maxItems : $queuedMessages);
						$loop = true;   // loop mode!!
					}
				}
			}
			if (isset($current['loopcount'])) {
				SLog::Write(LOGLEVEL_DEBUG, sprintf("LoopDetection->Detect(): loop data: loopcount(%d), maxCount(%d), queued(%d), ignored(%s)", $current['loopcount'], $current['maxCount'], $current['queued'], $current['ignored'] ?? 'false'));
			}

			// update loop data
			$ok = $this->setDeviceUserData($this->type, $current, parent::$devid, parent::$user, $folderid, $doCas = "replace", $currentRaw);
			if (!$ok) {
				SLog::Write(LOGLEVEL_WARN, sprintf("LoopDetection->Detect(): CAS failed on try %d!", $tryCount));
				usleep(100000);
				++$tryCount;
			}
		}
		// end exclusive block

		if ($loop === true && $this->ignore_messageid === false) {
			GSync::GetTopCollector()->AnnounceInformation("Loop detection", true);
		}

		return $loop;
	}

	/**
	 * Indicates if the next messages should be ignored (not be sent to the mobile!).
	 *
	 * @param string $messageid     (opt) id of the message which is to be exported next
	 * @param string $folderid      (opt) parent id of the message
	 * @param bool   $markAsIgnored (opt) to peek without setting the next message to be
	 *                              ignored, set this value to false
	 *
	 * @return bool
	 */
	public function IgnoreNextMessage($markAsIgnored = true, $messageid = false, $folderid = false) {
		// as the next message id is not available at all point this method is called, we use different indicators.
		// potentialbroken indicates that we know that the broken message should be exported next,
		// alltho we do not know for sure as it's export message orders can change
		// if the $messageid is available and matches then we are sure and only then really ignore it

		$potentialBroken = false;
		$realBroken = false;
		if (Request::GetCommandCode() == GSync::COMMAND_SYNC && $this->ignore_messageid !== false) {
			$potentialBroken = true;
		}

		if ($messageid !== false && $this->ignore_messageid == $messageid) {
			$realBroken = true;
		}

		// this call is just to know what should be happening
		// no further actions necessary
		if ($markAsIgnored === false) {
			return $potentialBroken;
		}

		// we should really do something here

		// first we check if we are in the loop mode, if so,
		// we update the potential broken id message so we loop count the same message

		$changedData = false;
		$ok = false;
		$tryCount = 1;
		while (!$ok && $tryCount < 5) {
			[$current, $currentRaw] = $this->getDeviceUserData($this->type, parent::$devid, parent::$user, $folderid, true);

			// we found our broken message!
			if ($realBroken) {
				$this->ignore_messageid = false;
				$current['ignored'] = $messageid;
				$changedData = true;

				// check if this message was broken before - here we know that it still is and remove it from the tracking
				$brokenkey = self::BROKENMSGS . "-" . $folderid;
				$brokenkey = self::BROKENMSGS . "-" . /** @scrutinizer ignore-type */ $folderid;
			// TODO: this is currently not supported here! It's in a different structure now!
			//                if (isset($loopdata[self::$devid][self::$user][$brokenkey]) && isset($loopdata[self::$devid][self::$user][$brokenkey][$messageid])) {
			//                    SLog::Write(LOGLEVEL_DEBUG, sprintf("LoopDetection->IgnoreNextMessage(): previously broken message '%s' is still broken and will not be tracked anymore", $messageid));
			//                    unset($loopdata[self::$devid][self::$user][$brokenkey][$messageid]);
			//                }
			}
			// not the broken message yet
			else {
				// update potential id if looping on an item
				if (isset($current['loopcount'])) {
					$current['potential'] = $messageid;

					// this message should be the broken one, but is not!!
					// we should reset the loop count because this is certainly not the broken one
					if ($potentialBroken) {
						$current['loopcount'] = 1;
						SLog::Write(LOGLEVEL_DEBUG, "LoopDetection->IgnoreNextMessage(): this should be the broken one, but is not! Resetting loop count.");
					}

					SLog::Write(LOGLEVEL_DEBUG, sprintf("LoopDetection->IgnoreNextMessage(): Loop mode, potential broken message id '%s'", $current['potential']));

					$changedData = true;
				}
			}

			if ($changedData !== true) {
				break;
			}
			// update loop data
			$ok = $this->setDeviceUserData($this->type, $current, parent::$devid, parent::$user, $folderid, $doCas = "replace", $currentRaw);
			if (!$ok) {
				SLog::Write(LOGLEVEL_WARN, sprintf("LoopDetection->Detect(): CAS failed on try %d!", $tryCount));
				usleep(100000);
				++$tryCount;
			}
		}

		if ($realBroken) {
			GSync::GetTopCollector()->AnnounceInformation("Broken message ignored", true);
		}

		return $realBroken;
	}

	/**
	 * Clears loop detection data.
	 *
	 * @param string $user  (opt) user which data should be removed - user can not be specified without
	 * @param string $devid (opt) device id which data to be removed
	 *
	 * @return bool
	 */
	public function ClearData($user = false, $devid = false) {
		$stat = true;
		$ok = false;
		// TODO: implement this
		// exclusive block
		if ($this->blockMutex()) {
			$loopdata = ($this->hasData()) ? $this->getData() : [];

			if ($user == false && $devid == false) {

				$loopdata = [];
			}
			elseif ($user == false && $devid != false) {

				$loopdata[$devid] = [];
			}
			elseif ($user != false && $devid != false) {

				$loopdata[$devid][$user] = [];
			}
			elseif ($user != false && $devid == false) {

				SLog::Write(LOGLEVEL_WARN, sprintf("Not possible to reset loop detection data for user '%s' without a specifying a device id", $user));
				$stat = false;
			}

			if ($stat) {
				$ok = $this->setData($loopdata);
			}

			$this->releaseMutex();
		}
		// end exclusive block

		return $stat && $ok;
	}

	/**
	 * Returns loop detection data for a user and device.
	 *
	 * @param string $user
	 * @param string $devid
	 *
	 * @return array|bool returns false if data not available
	 */
	public function GetCachedData($user, $devid) {
	public function GetCachedData(/** @scrutinizer ignore-unused */ $user, $devid) {
		// not implemented (also nowhere used apparently)
		return false;
		// exclusive block
		if ($this->blockMutex()) {
function fx() {
    try {
        doSomething();
        return true;
    }
    catch (\Exception $e) {
        return false;
    }

    return false;
}
			$loopdata = ($this->hasData()) ? $this->getData() : [];
			$this->releaseMutex();
		}
		// end exclusive block
		if (isset($loopdata, $loopdata[$devid], $loopdata[$devid][$user])) {
			return $loopdata[$devid][$user];
		}

		return false;
	}
}

grommunio / grommunio-sync

LoopDetection::IgnoreNextMessage() C last analyzed 2025-10-30 18:17 UTC

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like

LoopDetection::IgnoreNextMessage() C
last analyzed 2025-10-30 18:17 UTC
