grommunio / grommunio-sync

lib/core/userstoreinfo.php

Indentation +59 added lines, -59 removed lines

@@ -8,69 +8,69 @@
  */
 
 class UserStoreInfo {
-	private $foldercount;
-	private $storesize;
-	private $fullname;
-	private $emailaddress;
+    private $foldercount;
+    private $storesize;
+    private $fullname;
+    private $emailaddress;
 
-	/**
-	 * Constructor.
-	 */
-	public function __construct() {
-		$this->foldercount = 0;
-		$this->storesize = 0;
-		$this->fullname = null;
-		$this->emailaddress = null;
-	}
+    /**
+     * Constructor.
+     */
+    public function __construct() {
+        $this->foldercount = 0;
+        $this->storesize = 0;
+        $this->fullname = null;
+        $this->emailaddress = null;
+    }
 
-	/**
-	 * Sets data for the user's store.
-	 *
-	 * @param int    $foldercount
-	 * @param int    $storesize
-	 * @param string $fullname
-	 * @param string $emailaddress
-	 */
-	public function SetData($foldercount, $storesize, $fullname, $emailaddress) {
-		$this->foldercount = $foldercount;
-		$this->storesize = $storesize;
-		$this->fullname = $fullname;
-		$this->emailaddress = $emailaddress;
-	}
+    /**
+     * Sets data for the user's store.
+     *
+     * @param int    $foldercount
+     * @param int    $storesize
+     * @param string $fullname
+     * @param string $emailaddress
+     */
+    public function SetData($foldercount, $storesize, $fullname, $emailaddress) {
+        $this->foldercount = $foldercount;
+        $this->storesize = $storesize;
+        $this->fullname = $fullname;
+        $this->emailaddress = $emailaddress;
+    }
 
-	/**
-	 * Returns the number of folders in user's store.
-	 *
-	 * @return int
-	 */
-	public function GetFolderCount() {
-		return $this->foldercount;
-	}
+    /**
+     * Returns the number of folders in user's store.
+     *
+     * @return int
+     */
+    public function GetFolderCount() {
+        return $this->foldercount;
+    }
 
-	/**
-	 * Returns the user's store size in bytes.
-	 *
-	 * @return int
-	 */
-	public function GetStoreSize() {
-		return $this->storesize;
-	}
+    /**
+     * Returns the user's store size in bytes.
+     *
+     * @return int
+     */
+    public function GetStoreSize() {
+        return $this->storesize;
+    }
 
-	/**
-	 * Returns the fullname of the user.
-	 *
-	 * @return string
-	 */
-	public function GetFullName() {
-		return $this->fullname;
-	}
+    /**
+     * Returns the fullname of the user.
+     *
+     * @return string
+     */
+    public function GetFullName() {
+        return $this->fullname;
+    }
 
-	/**
-	 * Returns the email address of the user.
-	 *
-	 * @return string
-	 */
-	public function GetEmailAddress() {
-		return $this->emailaddress;
-	}
+    /**
+     * Returns the email address of the user.
+     *
+     * @return string
+     */
+    public function GetEmailAddress() {
+        return $this->emailaddress;
+    }
 }

lib/core/loopdetection.php

Indentation +935 added lines, -935 removed lines

@@ -12,389 +12,389 @@ 
  */
 
 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'][get_class($exception)] = $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 ? $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.
-	 * This goes on forever, like here: https://jira.z-hub.io/browse/ZP-1077
-	 *
-	 * 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)
-	 * Ticket: https://jira.zarafa.com/browse/ZP-5
-	 *
-	 * @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;
-						if (!empty($seenFailed)) {
-							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) {
-				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) {
-			list($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) {
-				SLog::Write(LOGLEVEL_WARN, 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);
-	}
-
-	/*
+    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'][get_class($exception)] = $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 ? $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.
+     * This goes on forever, like here: https://jira.z-hub.io/browse/ZP-1077
+     *
+     * 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)
+     * Ticket: https://jira.zarafa.com/browse/ZP-5
+     *
+     * @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;
+                        if (!empty($seenFailed)) {
+                            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) {
+                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) {
+            list($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) {
+                SLog::Write(LOGLEVEL_WARN, 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.
 	 *
@@ -403,563 +403,563 @@ 
 	 * - 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) {
-			list($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
-	 * @param string $id       the id 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) {
-			list($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) {
-			list($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;
-	}
-
-	/*
+    /**
+     * 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) {
+            list($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
+     * @param string $id       the id 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) {
+            list($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) {
+            list($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 boolean/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) {
-			list($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'])) {
-						// ZP-1213 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'], (isset($current['ignored']) ? $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) {
-			list($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;
-			// TODO: this is currently not supported here! It's in a different structure now!
+    /**
+     * 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 boolean/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) {
+            list($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'])) {
+                        // ZP-1213 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'], (isset($current['ignored']) ? $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) {
+            list($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;
+            // 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/boolean    returns false if data not available
-	 */
-	public function GetCachedData($user, $devid) {
-		// not implemented (also nowhere used apparently)
-		return false;
-		// exclusive block
-		if ($this->blockMutex()) {
-			$loopdata = ($this->hasData()) ? $this->getData() : [];
-			$this->releaseMutex();
-		}
-		// end exclusive block
-		if (isset($loopdata, $loopdata[$devid], $loopdata[$devid][$user])) {
-			return $loopdata[$devid][$user];
-		}
-
-		return false;
-	}
+            }
+            // 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/boolean    returns false if data not available
+     */
+    public function GetCachedData($user, $devid) {
+        // not implemented (also nowhere used apparently)
+        return false;
+        // exclusive block
+        if ($this->blockMutex()) {
+            $loopdata = ($this->hasData()) ? $this->getData() : [];
+            $this->releaseMutex();
+        }
+        // end exclusive block
+        if (isset($loopdata, $loopdata[$devid], $loopdata[$devid][$user])) {
+            return $loopdata[$devid][$user];
+        }
+
+        return false;
+    }
 }

Spacing +6 added lines, -6 removed lines

@@ -424,7 +424,7 @@ 
 		}
 
 		$ok = false;
-		$brokenkey = self::BROKENMSGS . "-" . $folderid;
+		$brokenkey = self::BROKENMSGS."-".$folderid;
 
 		// initialize params
 		$this->initializeParams();
@@ -465,7 +465,7 @@ 
 			return [];
 		}
 
-		$brokenkey = self::BROKENMSGS . "-" . $folderid;
+		$brokenkey = self::BROKENMSGS."-".$folderid;
 		$removeIds = [];
 		$okIds = [];
 
@@ -606,7 +606,7 @@ 
 						(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);
+					SLog::Write(LOGLEVEL_DEBUG, "LoopDetection->IsSyncStateObsolete(): yes, counter already processed".$usage);
 					$obsolete = true;
 				}
 			}
@@ -758,7 +758,7 @@ 
 							$current['loopcount'] = 1;
 							// the MaxCount is the max number of messages exported before
 							$current['maxCount'] = $counter + (($maxItems < $queuedMessages) ? $maxItems : $queuedMessages);
-							$loop = true;   // loop mode!!
+							$loop = true; // loop mode!!
 						}
 					}
 					elseif ($queuedMessages == 0) {
@@ -778,7 +778,7 @@ 
 							$this->ignore_messageid = $current['potential'];
 						}
 						$current['maxCount'] = $counter + (($maxItems < $queuedMessages) ? $maxItems : $queuedMessages);
-						$loop = true;   // loop mode!!
+						$loop = true; // loop mode!!
 					}
 				}
 			}
@@ -853,7 +853,7 @@ 
 				$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."-".$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));

Braces +11 added lines, -22 removed lines

@@ -264,8 +264,7 @@ 
 					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 {
+					} else {
 						$seenFolderSync = true;
 						if (!empty($seenFailed)) {
 							SLog::Write(LOGLEVEL_DEBUG, "LoopDetection->ProcessLoopDetectionIsHierarchyResyncRequired(): seen FolderSync after other failing command");
@@ -355,8 +354,7 @@ 
 			foreach ($stack as $entry) {
 				if ($entry['id'] != $updateentry['id']) {
 					$nstack[] = $entry;
-				}
-				else {
+				} else {
 					$nstack[] = $updateentry;
 					$found = true;
 				}
@@ -589,8 +587,7 @@ 
 			if (!isset($current["uuid"]) || $current["uuid"] != $uuid) {
 				SLog::Write(LOGLEVEL_DEBUG, "LoopDetection->IsSyncStateObsolete(): yes, uuid changed or not set");
 				$obsolete = true;
-			}
-			else {
+			} else {
 				SLog::Write(LOGLEVEL_DEBUG, sprintf(
 					"LoopDetection->IsSyncStateObsolete(): check folderid: '%s' uuid '%s' counter: %d - last counter: %d with %d queued",
 					$folderid,
@@ -610,8 +607,7 @@ 
 					$obsolete = true;
 				}
 			}
-		}
-		else {
+		} else {
 			SLog::Write(LOGLEVEL_DEBUG, sprintf("LoopDetection->IsSyncStateObsolete(): check folderid: '%s' uuid '%s' counter: %d - no data found: not obsolete", $folderid, $uuid, $counter));
 		}
 
@@ -685,8 +681,7 @@ 
 					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 {
+				} else {
 					$current['queued'] = 0;
 				}
 
@@ -747,8 +742,7 @@ 
 							// return suggested new window size
 							$current['windowLimit'] = 25;
 							$loop = $current['windowLimit'];
-						}
-						else {
+						} 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'])) {
@@ -760,14 +754,12 @@ 
 							$current['maxCount'] = $counter + (($maxItems < $queuedMessages) ? $maxItems : $queuedMessages);
 							$loop = true;   // loop mode!!
 						}
-					}
-					elseif ($queuedMessages == 0) {
+					} 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 {
+					} 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'];
@@ -916,14 +908,11 @@ 
 
 			if ($user == false && $devid == false) {
 				$loopdata = [];
-			}
-			elseif ($user == false && $devid != false) {
+			} elseif ($user == false && $devid != false) {
 				$loopdata[$devid] = [];
-			}
-			elseif ($user != false && $devid != false) {
+			} elseif ($user != false && $devid != false) {
 				$loopdata[$devid][$user] = [];
-			}
-			elseif ($user != false && $devid == false) {
+			} 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;
 			}

lib/core/gsync.php

Indentation +870 added lines, -870 removed lines

@@ -8,682 +8,682 @@ 
  */
 
 class GSync {
-	public const UNAUTHENTICATED = 1;
-	public const UNPROVISIONED = 2;
-	public const NOACTIVESYNCCOMMAND = 3;
-	public const WEBSERVICECOMMAND = 4;    // DEPRECATED
-	public const HIERARCHYCOMMAND = 5;
-	public const PLAININPUT = 6;
-	public const REQUESTHANDLER = 7;
-	public const CLASS_NAME = 1;
-	public const CLASS_REQUIRESPROTOCOLVERSION = 2;
-	public const CLASS_DEFAULTTYPE = 3;
-	public const CLASS_OTHERTYPES = 4;
-
-	// AS versions
-	public const ASV_1 = "1.0";
-	public const ASV_2 = "2.0";
-	public const ASV_21 = "2.1";
-	public const ASV_25 = "2.5";
-	public const ASV_12 = "12.0";
-	public const ASV_121 = "12.1";
-	public const ASV_14 = "14.0";
-	public const ASV_141 = "14.1";
-
-	/**
-	 * Command codes for base64 encoded requests (AS >= 12.1).
-	 */
-	public const COMMAND_SYNC = 0;
-	public const COMMAND_SENDMAIL = 1;
-	public const COMMAND_SMARTFORWARD = 2;
-	public const COMMAND_SMARTREPLY = 3;
-	public const COMMAND_GETATTACHMENT = 4;
-	public const COMMAND_FOLDERSYNC = 9;
-	public const COMMAND_FOLDERCREATE = 10;
-	public const COMMAND_FOLDERDELETE = 11;
-	public const COMMAND_FOLDERUPDATE = 12;
-	public const COMMAND_MOVEITEMS = 13;
-	public const COMMAND_GETITEMESTIMATE = 14;
-	public const COMMAND_MEETINGRESPONSE = 15;
-	public const COMMAND_SEARCH = 16;
-	public const COMMAND_SETTINGS = 17;
-	public const COMMAND_PING = 18;
-	public const COMMAND_ITEMOPERATIONS = 19;
-	public const COMMAND_PROVISION = 20;
-	public const COMMAND_RESOLVERECIPIENTS = 21;
-	public const COMMAND_VALIDATECERT = 22;
-
-	// Deprecated commands
-	public const COMMAND_GETHIERARCHY = -1;
-	public const COMMAND_CREATECOLLECTION = -2;
-	public const COMMAND_DELETECOLLECTION = -3;
-	public const COMMAND_MOVECOLLECTION = -4;
-	public const COMMAND_NOTIFY = -5;
-
-	// Latest supported State version
-	public const STATE_VERSION = IStateMachine::STATEVERSION_02;
-
-	// Versions 1.0, 2.0, 2.1 and 2.5 are deprecated (ZP-604)
-	private static $supportedASVersions = [
-		self::ASV_12,
-		self::ASV_121,
-		self::ASV_14,
-		self::ASV_141,
-	];
-
-	private static $supportedCommands = [
-		// COMMAND             AS VERSION   REQUESTHANDLER                                  OTHER SETTINGS
-		self::COMMAND_SYNC => [self::ASV_1, self::REQUESTHANDLER => "Sync"],
-		self::COMMAND_SENDMAIL => [self::ASV_1, self::REQUESTHANDLER => "SendMail"],
-		self::COMMAND_SMARTFORWARD => [self::ASV_1, self::REQUESTHANDLER => "SendMail"],
-		self::COMMAND_SMARTREPLY => [self::ASV_1, self::REQUESTHANDLER => "SendMail"],
-		self::COMMAND_GETATTACHMENT => [self::ASV_1, self::REQUESTHANDLER => "GetAttachment"],
-		self::COMMAND_GETHIERARCHY => [self::ASV_1, self::REQUESTHANDLER => "GetHierarchy", self::HIERARCHYCOMMAND], // deprecated but implemented
-		self::COMMAND_CREATECOLLECTION => [self::ASV_1], // deprecated & not implemented
-		self::COMMAND_DELETECOLLECTION => [self::ASV_1], // deprecated & not implemented
-		self::COMMAND_MOVECOLLECTION => [self::ASV_1], // deprecated & not implemented
-		self::COMMAND_FOLDERSYNC => [self::ASV_2, self::REQUESTHANDLER => "FolderSync", self::HIERARCHYCOMMAND],
-		self::COMMAND_FOLDERCREATE => [self::ASV_2, self::REQUESTHANDLER => "FolderChange", self::HIERARCHYCOMMAND],
-		self::COMMAND_FOLDERDELETE => [self::ASV_2, self::REQUESTHANDLER => "FolderChange", self::HIERARCHYCOMMAND],
-		self::COMMAND_FOLDERUPDATE => [self::ASV_2, self::REQUESTHANDLER => "FolderChange", self::HIERARCHYCOMMAND],
-		self::COMMAND_MOVEITEMS => [self::ASV_1, self::REQUESTHANDLER => "MoveItems"],
-		self::COMMAND_GETITEMESTIMATE => [self::ASV_1, self::REQUESTHANDLER => "GetItemEstimate"],
-		self::COMMAND_MEETINGRESPONSE => [self::ASV_1, self::REQUESTHANDLER => "MeetingResponse"],
-		self::COMMAND_RESOLVERECIPIENTS => [self::ASV_1, self::REQUESTHANDLER => "ResolveRecipients"],
-		self::COMMAND_VALIDATECERT => [self::ASV_1, self::REQUESTHANDLER => "ValidateCert"],
-		self::COMMAND_PROVISION => [self::ASV_25, self::REQUESTHANDLER => "Provisioning", self::UNAUTHENTICATED, self::UNPROVISIONED],
-		self::COMMAND_SEARCH => [self::ASV_1, self::REQUESTHANDLER => "Search"],
-		self::COMMAND_PING => [self::ASV_2, self::REQUESTHANDLER => "Ping", self::UNPROVISIONED],
-		self::COMMAND_NOTIFY => [self::ASV_1, self::REQUESTHANDLER => "Notify"], // deprecated & not implemented
-		self::COMMAND_ITEMOPERATIONS => [self::ASV_12, self::REQUESTHANDLER => "ItemOperations"],
-		self::COMMAND_SETTINGS => [self::ASV_12, self::REQUESTHANDLER => "Settings"],
-	];
-
-	private static $classes = [
-		"Email" => [
-			self::CLASS_NAME => "SyncMail",
-			self::CLASS_REQUIRESPROTOCOLVERSION => false,
-			self::CLASS_DEFAULTTYPE => SYNC_FOLDER_TYPE_INBOX,
-			self::CLASS_OTHERTYPES => [
-				SYNC_FOLDER_TYPE_OTHER,
-				SYNC_FOLDER_TYPE_DRAFTS,
-				SYNC_FOLDER_TYPE_WASTEBASKET,
-				SYNC_FOLDER_TYPE_SENTMAIL,
-				SYNC_FOLDER_TYPE_OUTBOX,
-				SYNC_FOLDER_TYPE_USER_MAIL,
-				SYNC_FOLDER_TYPE_JOURNAL,
-				SYNC_FOLDER_TYPE_USER_JOURNAL,
-			],
-		],
-		"Contacts" => [
-			self::CLASS_NAME => "SyncContact",
-			self::CLASS_REQUIRESPROTOCOLVERSION => true,
-			self::CLASS_DEFAULTTYPE => SYNC_FOLDER_TYPE_CONTACT,
-			self::CLASS_OTHERTYPES => [SYNC_FOLDER_TYPE_USER_CONTACT, SYNC_FOLDER_TYPE_UNKNOWN],
-		],
-		"Calendar" => [
-			self::CLASS_NAME => "SyncAppointment",
-			self::CLASS_REQUIRESPROTOCOLVERSION => false,
-			self::CLASS_DEFAULTTYPE => SYNC_FOLDER_TYPE_APPOINTMENT,
-			self::CLASS_OTHERTYPES => [SYNC_FOLDER_TYPE_USER_APPOINTMENT],
-		],
-		"Tasks" => [
-			self::CLASS_NAME => "SyncTask",
-			self::CLASS_REQUIRESPROTOCOLVERSION => false,
-			self::CLASS_DEFAULTTYPE => SYNC_FOLDER_TYPE_TASK,
-			self::CLASS_OTHERTYPES => [SYNC_FOLDER_TYPE_USER_TASK],
-		],
-		"Notes" => [
-			self::CLASS_NAME => "SyncNote",
-			self::CLASS_REQUIRESPROTOCOLVERSION => false,
-			self::CLASS_DEFAULTTYPE => SYNC_FOLDER_TYPE_NOTE,
-			self::CLASS_OTHERTYPES => [SYNC_FOLDER_TYPE_USER_NOTE],
-		],
-	];
-
-	private static $stateMachine;
-	private static $deviceManager;
-	private static $provisioningManager;
-	private static $topCollector;
-	private static $backend;
-	private static $addSyncFolders;
-	private static $policies;
-	private static $redis;
-
-	/**
-	 * Verifies configuration.
-	 *
-	 * @throws FatalMisconfigurationException
-	 *
-	 * @return bool
-	 */
-	public static function CheckConfig() {
-		// check the php version
-		if (version_compare(phpversion(), '5.4.0') < 0) {
-			throw new FatalException("The configured PHP version is too old. Please make sure at least PHP 5.4 is used.");
-		}
-
-		// some basic checks
-		if (!defined('BASE_PATH')) {
-			throw new FatalMisconfigurationException("The BASE_PATH is not configured. Check if the config.php file is in place.");
-		}
-
-		if (substr(BASE_PATH, -1, 1) != "/") {
-			throw new FatalMisconfigurationException("The BASE_PATH should terminate with a '/'");
-		}
-
-		if (!file_exists(BASE_PATH)) {
-			throw new FatalMisconfigurationException("The configured BASE_PATH does not exist or can not be accessed.");
-		}
-
-		if (defined('BASE_PATH_CLI') && file_exists(BASE_PATH_CLI)) {
-			define('REAL_BASE_PATH', BASE_PATH_CLI);
-		}
-		else {
-			define('REAL_BASE_PATH', BASE_PATH);
-		}
-
-		if (!defined('LOGBACKEND')) {
-			define('LOGBACKEND', 'filelog');
-		}
-
-		if (strtolower(LOGBACKEND) == 'syslog') {
-			define('LOGBACKEND_CLASS', 'Syslog');
-			if (!defined('LOG_SYSLOG_FACILITY')) {
-				define('LOG_SYSLOG_FACILITY', LOG_LOCAL0);
-			}
-
-			if (!defined('LOG_SYSLOG_HOST')) {
-				define('LOG_SYSLOG_HOST', false);
-			}
-
-			if (!defined('LOG_SYSLOG_PORT')) {
-				define('LOG_SYSLOG_PORT', 514);
-			}
-
-			if (!defined('LOG_SYSLOG_PROGRAM')) {
-				define('LOG_SYSLOG_PROGRAM', 'grommunio-sync');
-			}
-
-			if (!is_numeric(LOG_SYSLOG_PORT)) {
-				throw new FatalMisconfigurationException("The LOG_SYSLOG_PORT must a be a number.");
-			}
-
-			if (LOG_SYSLOG_HOST && LOG_SYSLOG_PORT <= 0) {
-				throw new FatalMisconfigurationException("LOG_SYSLOG_HOST is defined but the LOG_SYSLOG_PORT does not seem to be valid.");
-			}
-		}
-		elseif (strtolower(LOGBACKEND) == 'filelog') {
-			define('LOGBACKEND_CLASS', 'FileLog');
-			if (!defined('LOGFILEDIR')) {
-				throw new FatalMisconfigurationException("The LOGFILEDIR is not configured. Check if the config.php file is in place.");
-			}
-
-			if (substr(LOGFILEDIR, -1, 1) != "/") {
-				throw new FatalMisconfigurationException("The LOGFILEDIR should terminate with a '/'");
-			}
-
-			if (!file_exists(LOGFILEDIR)) {
-				throw new FatalMisconfigurationException("The configured LOGFILEDIR does not exist or can not be accessed.");
-			}
-
-			if ((!file_exists(LOGFILE) && !touch(LOGFILE)) || !is_writable(LOGFILE)) {
-				throw new FatalMisconfigurationException("The configured LOGFILE can not be modified.");
-			}
-
-			if ((!file_exists(LOGERRORFILE) && !touch(LOGERRORFILE)) || !is_writable(LOGERRORFILE)) {
-				throw new FatalMisconfigurationException("The configured LOGERRORFILE can not be modified.");
-			}
-
-			// check ownership on the (eventually) just created files
-			Utils::FixFileOwner(LOGFILE);
-			Utils::FixFileOwner(LOGERRORFILE);
-		}
-		else {
-			define('LOGBACKEND_CLASS', LOGBACKEND);
-		}
-
-		// set time zone
-		// code contributed by Robert Scheck (rsc)
-		if (defined('TIMEZONE') ? constant('TIMEZONE') : false) {
-			if (!@date_default_timezone_set(TIMEZONE)) {
-				throw new FatalMisconfigurationException(sprintf("The configured TIMEZONE '%s' is not valid. Please check supported timezones at http://www.php.net/manual/en/timezones.php", constant('TIMEZONE')));
-			}
-		}
-		elseif (!ini_get('date.timezone')) {
-			date_default_timezone_set('Europe/Vienna');
-		}
-
-		if (defined('USE_X_FORWARDED_FOR_HEADER')) {
-			SLog::Write(LOGLEVEL_INFO, "The configuration parameter 'USE_X_FORWARDED_FOR_HEADER' was deprecated in favor of 'USE_CUSTOM_REMOTE_IP_HEADER'. Please update your configuration.");
-		}
-
-		// check redis configuration - set defaults
-		if (!defined('REDIS_HOST')) {
-			define('REDIS_HOST', 'localhost');
-		}
-		if (!defined('REDIS_PORT')) {
-			define('REDIS_PORT', 6379);
-		}
-		if (!defined('REDIS_AUTH')) {
-			define('REDIS_AUTH', '');
-		}
-
-		return true;
-	}
-
-	/**
-	 * Verifies Timezone, StateMachine and Backend configuration.
-	 *
-	 * @return bool
-	 * @trows FatalMisconfigurationException
-	 */
-	public static function CheckAdvancedConfig() {
-		global $specialLogUsers, $additionalFolders;
-
-		if (!is_array($specialLogUsers)) {
-			throw new FatalMisconfigurationException("The WBXML log users is not an array.");
-		}
-
-		if (!defined('SYNC_CONTACTS_MAXPICTURESIZE')) {
-			define('SYNC_CONTACTS_MAXPICTURESIZE', 49152);
-		}
-		elseif ((!is_int(SYNC_CONTACTS_MAXPICTURESIZE) || SYNC_CONTACTS_MAXPICTURESIZE < 1)) {
-			throw new FatalMisconfigurationException("The SYNC_CONTACTS_MAXPICTURESIZE value must be a number higher than 0.");
-		}
-
-		if (!defined('USE_PARTIAL_FOLDERSYNC')) {
-			define('USE_PARTIAL_FOLDERSYNC', false);
-		}
-
-		if (!defined('PING_LOWER_BOUND_LIFETIME')) {
-			define('PING_LOWER_BOUND_LIFETIME', false);
-		}
-		elseif (PING_LOWER_BOUND_LIFETIME !== false && (!is_int(PING_LOWER_BOUND_LIFETIME) || PING_LOWER_BOUND_LIFETIME < 1 || PING_LOWER_BOUND_LIFETIME > 3540)) {
-			throw new FatalMisconfigurationException("The PING_LOWER_BOUND_LIFETIME value must be 'false' or a number between 1 and 3540 inclusively.");
-		}
-		if (!defined('PING_HIGHER_BOUND_LIFETIME')) {
-			define('PING_HIGHER_BOUND_LIFETIME', false);
-		}
-		elseif (PING_HIGHER_BOUND_LIFETIME !== false && (!is_int(PING_HIGHER_BOUND_LIFETIME) || PING_HIGHER_BOUND_LIFETIME < 1 || PING_HIGHER_BOUND_LIFETIME > 3540)) {
-			throw new FatalMisconfigurationException("The PING_HIGHER_BOUND_LIFETIME value must be 'false' or a number between 1 and 3540 inclusively.");
-		}
-		if (PING_HIGHER_BOUND_LIFETIME !== false && PING_LOWER_BOUND_LIFETIME !== false && PING_HIGHER_BOUND_LIFETIME < PING_LOWER_BOUND_LIFETIME) {
-			throw new FatalMisconfigurationException("The PING_HIGHER_BOUND_LIFETIME value must be greater or equal to PING_LOWER_BOUND_LIFETIME.");
-		}
-
-		if (!defined('RETRY_AFTER_DELAY')) {
-			define('RETRY_AFTER_DELAY', 300);
-		}
-		elseif (RETRY_AFTER_DELAY !== false && (!is_int(RETRY_AFTER_DELAY) || RETRY_AFTER_DELAY < 1)) {
-			throw new FatalMisconfigurationException("The RETRY_AFTER_DELAY value must be 'false' or a number greater than 0.");
-		}
-
-		// set Grommunio backend defaults if not set
-		if (!defined('MAPI_SERVER')) {
-			define('MAPI_SERVER', 'default:');
-		}
-		if (!defined('STORE_STATE_FOLDER')) {
-			define('STORE_STATE_FOLDER', 'GS-SyncState');
-		}
-
-		// the check on additional folders will not throw hard errors, as this is probably changed on live systems
-		if (isset($additionalFolders) && !is_array($additionalFolders)) {
-			SLog::Write(LOGLEVEL_ERROR, "GSync::CheckConfig(): The additional folders synchronization not available as array.");
-		}
-		else {
-			// check configured data
-			foreach ($additionalFolders as $af) {
-				if (!is_array($af) || !isset($af['store']) || !isset($af['folderid']) || !isset($af['name']) || !isset($af['type'])) {
-					SLog::Write(LOGLEVEL_ERROR, "GSync::CheckConfig(): the additional folder synchronization is not configured correctly. Missing parameters. Entry will be ignored.");
-
-					continue;
-				}
-
-				if ($af['store'] == "" || $af['folderid'] == "" || $af['name'] == "" || $af['type'] == "") {
-					SLog::Write(LOGLEVEL_WARN, "GSync::CheckConfig(): the additional folder synchronization is not configured correctly. Empty parameters. Entry will be ignored.");
-
-					continue;
-				}
-
-				if (!in_array($af['type'], [SYNC_FOLDER_TYPE_USER_NOTE, SYNC_FOLDER_TYPE_USER_CONTACT, SYNC_FOLDER_TYPE_USER_APPOINTMENT, SYNC_FOLDER_TYPE_USER_TASK, SYNC_FOLDER_TYPE_USER_MAIL])) {
-					SLog::Write(LOGLEVEL_ERROR, sprintf("GSync::CheckConfig(): the type of the additional synchronization folder '%s is not permitted.", $af['name']));
-
-					continue;
-				}
-				// the data will be initialized when used via self::getAddFolders()
-			}
-		}
-
-		SLog::Write(LOGLEVEL_DEBUG, sprintf("Used timezone '%s'", date_default_timezone_get()));
-
-		// get the statemachine, which will also try to load the backend.. This could throw errors
-		self::GetStateMachine();
-
-		return true;
-	}
-
-	/**
-	 * Returns the StateMachine object
-	 * which has to be an IStateMachine implementation.
-	 *
-	 * @throws FatalNotImplementedException
-	 * @throws HTTPReturnCodeException
-	 *
-	 * @return object implementation of IStateMachine
-	 */
-	public static function GetStateMachine() {
-		if (!isset(GSync::$stateMachine)) {
-			// the backend could also return an own IStateMachine implementation
-			GSync::$stateMachine = self::GetBackend()->GetStateMachine();
-
-			if (GSync::$stateMachine->GetStateVersion() !== GSync::GetLatestStateVersion()) {
-				if (class_exists("TopCollector")) {
-					self::GetTopCollector()->AnnounceInformation("Run migration script!", true);
-				}
-
-				throw new ServiceUnavailableException(sprintf("The state version available to the %s is not the latest version - please run the state upgrade script. See release notes for more information.", get_class(GSync::$stateMachine)));
-			}
-		}
-
-		return GSync::$stateMachine;
-	}
-
-	/**
-	 * Returns the Redis object.
-	 *
-	 * @return object Redis
-	 */
-	public static function GetRedis() {
-		if (!isset(GSync::$redis)) {
-			GSync::$redis = new RedisConnection();
-		}
-
-		return GSync::$redis;
-	}
-
-	/**
-	 * Returns the latest version of supported states.
-	 *
-	 * @return int
-	 */
-	public static function GetLatestStateVersion() {
-		return self::STATE_VERSION;
-	}
-
-	/**
-	 * Returns the ProvisioningManager object.
-	 *
-	 * @return object ProvisioningManager
-	 */
-	public static function GetProvisioningManager() {
-		if (!isset(self::$provisioningManager)) {
-			self::$provisioningManager = new ProvisioningManager();
-		}
-
-		return self::$provisioningManager;
-	}
-
-	/**
-	 * Returns the DeviceManager object.
-	 *
-	 * @param bool $initialize (opt) default true: initializes the DeviceManager if not already done
-	 *
-	 * @return object DeviceManager
-	 */
-	public static function GetDeviceManager($initialize = true) {
-		if (!isset(GSync::$deviceManager) && $initialize) {
-			GSync::$deviceManager = new DeviceManager();
-		}
-
-		return GSync::$deviceManager;
-	}
-
-	/**
-	 * Returns the Top data collector object.
-	 *
-	 * @return object TopCollector
-	 */
-	public static function GetTopCollector() {
-		if (!isset(GSync::$topCollector)) {
-			GSync::$topCollector = new TopCollector();
-		}
-
-		return GSync::$topCollector;
-	}
-
-	/**
-	 * Loads a backend file.
-	 *
-	 * @param string $backendname
-	 *
-	 * @throws FatalNotImplementedException
-	 *
-	 * @return bool
-	 */
-	public static function IncludeBackend($backendname) {
-		if ($backendname == false) {
-			return false;
-		}
-
-		$backendname = strtolower($backendname);
-		if (substr($backendname, 0, 7) !== 'backend') {
-			throw new FatalNotImplementedException(sprintf("Backend '%s' is not allowed", $backendname));
-		}
-
-		$rbn = substr($backendname, 7);
-
-		$subdirbackend = REAL_BASE_PATH . "backend/" . $rbn . "/" . $rbn . ".php";
-		$stdbackend = REAL_BASE_PATH . "backend/" . $rbn . ".php";
-
-		if (is_file($subdirbackend)) {
-			$toLoad = $subdirbackend;
-		}
-		elseif (is_file($stdbackend)) {
-			$toLoad = $stdbackend;
-		}
-		else {
-			return false;
-		}
-
-		SLog::Write(LOGLEVEL_DEBUG, sprintf("Including backend file: '%s'", $toLoad));
-
-		return include_once $toLoad;
-	}
-
-	/**
-	 * Returns the Backend for this request
-	 * the backend has to be an IBackend implementation.
-	 *
-	 * @return object IBackend implementation
-	 */
-	public static function GetBackend() {
-		// if the backend is not yet loaded, load backend drivers and instantiate it
-		if (!isset(GSync::$backend)) {
-			// Initialize Grommunio
-			GSync::$backend = new Grommunio();
-		}
-
-		return GSync::$backend;
-	}
-
-	/**
-	 * Returns additional folder objects which should be synchronized to the device.
-	 *
-	 * @param bool $backendIdsAsKeys if true the keys are backendids else folderids, default: true
-	 *
-	 * @return array
-	 */
-	public static function GetAdditionalSyncFolders($backendIdsAsKeys = true) {
-		// get user based folders which should be synchronized
-		$userFolder = self::GetDeviceManager()->GetAdditionalUserSyncFolders();
-		$addfolders = self::getAddSyncFolders() + $userFolder;
-		// if requested, we rewrite the backendids to folderids here
-		if ($backendIdsAsKeys === false && !empty($addfolders)) {
-			SLog::Write(LOGLEVEL_DEBUG, "GSync::GetAdditionalSyncFolders(): Requested AS folderids as keys for additional folders array, converting");
-			$faddfolders = [];
-			foreach ($addfolders as $backendId => $addFolder) {
-				$fid = self::GetDeviceManager()->GetFolderIdForBackendId($backendId);
-				$faddfolders[$fid] = $addFolder;
-			}
-			$addfolders = $faddfolders;
-		}
-
-		return $addfolders;
-	}
-
-	/**
-	 * Returns additional folder objects which should be synchronized to the device.
-	 *
-	 * @param string $backendid
-	 * @param bool   $noDebug   (opt) by default, debug message is shown
-	 *
-	 * @return string
-	 */
-	public static function GetAdditionalSyncFolderStore($backendid, $noDebug = false) {
-		if (isset(self::getAddSyncFolders()[$backendid]->Store)) {
-			$val = self::getAddSyncFolders()[$backendid]->Store;
-		}
-		else {
-			$val = self::GetDeviceManager()->GetAdditionalUserSyncFolder($backendid);
-			if (isset($val['store'])) {
-				$val = $val['store'];
-			}
-		}
-
-		if (!$noDebug) {
-			SLog::Write(LOGLEVEL_DEBUG, sprintf("GSync::GetAdditionalSyncFolderStore('%s'): '%s'", $backendid, Utils::PrintAsString($val)));
-		}
-
-		return $val;
-	}
-
-	/**
-	 * Returns a SyncObject class name for a folder class.
-	 *
-	 * @param string $folderclass
-	 *
-	 * @throws FatalNotImplementedException
-	 *
-	 * @return string
-	 */
-	public static function getSyncObjectFromFolderClass($folderclass) {
-		if (!isset(self::$classes[$folderclass])) {
-			throw new FatalNotImplementedException("Class '{$folderclass}' is not supported");
-		}
-
-		$class = self::$classes[$folderclass][self::CLASS_NAME];
-		if (self::$classes[$folderclass][self::CLASS_REQUIRESPROTOCOLVERSION]) {
-			return new $class(Request::GetProtocolVersion());
-		}
-
-		return new $class();
-	}
-
-	/**
-	 * Initializes the SyncObjects for additional folders on demand.
-	 * Uses DeviceManager->BuildSyncFolderObject() to do patching required for ZP-907.
-	 *
-	 * @return array
-	 */
-	private static function getAddSyncFolders() {
-		global $additionalFolders;
-		if (!isset(self::$addSyncFolders)) {
-			self::$addSyncFolders = [];
-
-			if (isset($additionalFolders) && !is_array($additionalFolders)) {
-				SLog::Write(LOGLEVEL_ERROR, "GSync::getAddSyncFolders() : The additional folders synchronization not available as array.");
-			}
-			else {
-				foreach ($additionalFolders as $af) {
-					if (!is_array($af) || !isset($af['store']) || !isset($af['folderid']) || !isset($af['name']) || !isset($af['type'])) {
-						SLog::Write(LOGLEVEL_ERROR, "GSync::getAddSyncFolders() : the additional folder synchronization is not configured correctly. Missing parameters. Entry will be ignored.");
-
-						continue;
-					}
-
-					if ($af['store'] == "" || $af['folderid'] == "" || $af['name'] == "" || $af['type'] == "") {
-						SLog::Write(LOGLEVEL_WARN, "GSync::getAddSyncFolders() : the additional folder synchronization is not configured correctly. Empty parameters. Entry will be ignored.");
-
-						continue;
-					}
-
-					if (!in_array($af['type'], [SYNC_FOLDER_TYPE_USER_NOTE, SYNC_FOLDER_TYPE_USER_CONTACT, SYNC_FOLDER_TYPE_USER_APPOINTMENT, SYNC_FOLDER_TYPE_USER_TASK, SYNC_FOLDER_TYPE_USER_MAIL])) {
-						SLog::Write(LOGLEVEL_ERROR, sprintf("GSync::getAddSyncFolders() : the type of the additional synchronization folder '%s is not permitted.", $af['name']));
-
-						continue;
-					}
-
-					// don't fail hard if no flags are set, but we at least warn about it
-					if (!isset($af['flags'])) {
-						SLog::Write(LOGLEVEL_WARN, sprintf("GSync::getAddSyncFolders() : the additional folder '%s' is not configured completely. Missing 'flags' parameter, defaulting to DeviceManager::FLD_FLAGS_NONE.", $af['name']));
-						$af['flags'] = DeviceManager::FLD_FLAGS_NONE;
-					}
-
-					$folder = self::GetDeviceManager()->BuildSyncFolderObject($af['store'], $af['folderid'], '0', $af['name'], $af['type'], $af['flags'], DeviceManager::FLD_ORIGIN_CONFIG);
-					self::$addSyncFolders[$folder->BackendId] = $folder;
-				}
-			}
-		}
-
-		return self::$addSyncFolders;
-	}
-
-	/**
-	 * Returns the default foldertype for a folder class.
-	 *
-	 * @param string $folderclass folderclass sent by the mobile
-	 *
-	 * @return string
-	 */
-	public static function getDefaultFolderTypeFromFolderClass($folderclass) {
-		SLog::Write(LOGLEVEL_DEBUG, sprintf("GSync::getDefaultFolderTypeFromFolderClass('%s'): '%d'", $folderclass, self::$classes[$folderclass][self::CLASS_DEFAULTTYPE]));
-
-		return self::$classes[$folderclass][self::CLASS_DEFAULTTYPE];
-	}
-
-	/**
-	 * Returns the folder class for a foldertype.
-	 *
-	 * @param string $foldertype
-	 *
-	 * @return string/false     false if no class for this type is available
-	 */
-	public static function GetFolderClassFromFolderType($foldertype) {
-		$class = false;
-		foreach (self::$classes as $aClass => $cprops) {
-			if ($cprops[self::CLASS_DEFAULTTYPE] == $foldertype || in_array($foldertype, $cprops[self::CLASS_OTHERTYPES])) {
-				$class = $aClass;
-
-				break;
-			}
-		}
-		SLog::Write(LOGLEVEL_DEBUG, sprintf("GSync::GetFolderClassFromFolderType('%s'): %s", $foldertype, Utils::PrintAsString($class)));
-
-		return $class;
-	}
-
-	/**
-	 * Prints the grommunio-sync legal header to STDOUT
-	 * Using this breaks ActiveSync synchronization if wbxml is expected.
-	 *
-	 * @param string $message           (opt) message to be displayed
-	 * @param string $additionalMessage (opt) additional message to be displayed
-	 *
-	 * @return
-	 */
-	public static function PrintGrommunioSyncLegal($message = "", $additionalMessage = "") {
-		SLog::Write(LOGLEVEL_DEBUG, "GSync::PrintGrommunioSyncLegal()");
-
-		if ($message) {
-			$message = "<h3>" . $message . "</h3>";
-		}
-		if ($additionalMessage) {
-			$additionalMessage .= "<br>";
-		}
-
-		header("Content-type: text/html");
-		echo <<<END
+    public const UNAUTHENTICATED = 1;
+    public const UNPROVISIONED = 2;
+    public const NOACTIVESYNCCOMMAND = 3;
+    public const WEBSERVICECOMMAND = 4;    // DEPRECATED
+    public const HIERARCHYCOMMAND = 5;
+    public const PLAININPUT = 6;
+    public const REQUESTHANDLER = 7;
+    public const CLASS_NAME = 1;
+    public const CLASS_REQUIRESPROTOCOLVERSION = 2;
+    public const CLASS_DEFAULTTYPE = 3;
+    public const CLASS_OTHERTYPES = 4;
+
+    // AS versions
+    public const ASV_1 = "1.0";
+    public const ASV_2 = "2.0";
+    public const ASV_21 = "2.1";
+    public const ASV_25 = "2.5";
+    public const ASV_12 = "12.0";
+    public const ASV_121 = "12.1";
+    public const ASV_14 = "14.0";
+    public const ASV_141 = "14.1";
+
+    /**
+     * Command codes for base64 encoded requests (AS >= 12.1).
+     */
+    public const COMMAND_SYNC = 0;
+    public const COMMAND_SENDMAIL = 1;
+    public const COMMAND_SMARTFORWARD = 2;
+    public const COMMAND_SMARTREPLY = 3;
+    public const COMMAND_GETATTACHMENT = 4;
+    public const COMMAND_FOLDERSYNC = 9;
+    public const COMMAND_FOLDERCREATE = 10;
+    public const COMMAND_FOLDERDELETE = 11;
+    public const COMMAND_FOLDERUPDATE = 12;
+    public const COMMAND_MOVEITEMS = 13;
+    public const COMMAND_GETITEMESTIMATE = 14;
+    public const COMMAND_MEETINGRESPONSE = 15;
+    public const COMMAND_SEARCH = 16;
+    public const COMMAND_SETTINGS = 17;
+    public const COMMAND_PING = 18;
+    public const COMMAND_ITEMOPERATIONS = 19;
+    public const COMMAND_PROVISION = 20;
+    public const COMMAND_RESOLVERECIPIENTS = 21;
+    public const COMMAND_VALIDATECERT = 22;
+
+    // Deprecated commands
+    public const COMMAND_GETHIERARCHY = -1;
+    public const COMMAND_CREATECOLLECTION = -2;
+    public const COMMAND_DELETECOLLECTION = -3;
+    public const COMMAND_MOVECOLLECTION = -4;
+    public const COMMAND_NOTIFY = -5;
+
+    // Latest supported State version
+    public const STATE_VERSION = IStateMachine::STATEVERSION_02;
+
+    // Versions 1.0, 2.0, 2.1 and 2.5 are deprecated (ZP-604)
+    private static $supportedASVersions = [
+        self::ASV_12,
+        self::ASV_121,
+        self::ASV_14,
+        self::ASV_141,
+    ];
+
+    private static $supportedCommands = [
+        // COMMAND             AS VERSION   REQUESTHANDLER                                  OTHER SETTINGS
+        self::COMMAND_SYNC => [self::ASV_1, self::REQUESTHANDLER => "Sync"],
+        self::COMMAND_SENDMAIL => [self::ASV_1, self::REQUESTHANDLER => "SendMail"],
+        self::COMMAND_SMARTFORWARD => [self::ASV_1, self::REQUESTHANDLER => "SendMail"],
+        self::COMMAND_SMARTREPLY => [self::ASV_1, self::REQUESTHANDLER => "SendMail"],
+        self::COMMAND_GETATTACHMENT => [self::ASV_1, self::REQUESTHANDLER => "GetAttachment"],
+        self::COMMAND_GETHIERARCHY => [self::ASV_1, self::REQUESTHANDLER => "GetHierarchy", self::HIERARCHYCOMMAND], // deprecated but implemented
+        self::COMMAND_CREATECOLLECTION => [self::ASV_1], // deprecated & not implemented
+        self::COMMAND_DELETECOLLECTION => [self::ASV_1], // deprecated & not implemented
+        self::COMMAND_MOVECOLLECTION => [self::ASV_1], // deprecated & not implemented
+        self::COMMAND_FOLDERSYNC => [self::ASV_2, self::REQUESTHANDLER => "FolderSync", self::HIERARCHYCOMMAND],
+        self::COMMAND_FOLDERCREATE => [self::ASV_2, self::REQUESTHANDLER => "FolderChange", self::HIERARCHYCOMMAND],
+        self::COMMAND_FOLDERDELETE => [self::ASV_2, self::REQUESTHANDLER => "FolderChange", self::HIERARCHYCOMMAND],
+        self::COMMAND_FOLDERUPDATE => [self::ASV_2, self::REQUESTHANDLER => "FolderChange", self::HIERARCHYCOMMAND],
+        self::COMMAND_MOVEITEMS => [self::ASV_1, self::REQUESTHANDLER => "MoveItems"],
+        self::COMMAND_GETITEMESTIMATE => [self::ASV_1, self::REQUESTHANDLER => "GetItemEstimate"],
+        self::COMMAND_MEETINGRESPONSE => [self::ASV_1, self::REQUESTHANDLER => "MeetingResponse"],
+        self::COMMAND_RESOLVERECIPIENTS => [self::ASV_1, self::REQUESTHANDLER => "ResolveRecipients"],
+        self::COMMAND_VALIDATECERT => [self::ASV_1, self::REQUESTHANDLER => "ValidateCert"],
+        self::COMMAND_PROVISION => [self::ASV_25, self::REQUESTHANDLER => "Provisioning", self::UNAUTHENTICATED, self::UNPROVISIONED],
+        self::COMMAND_SEARCH => [self::ASV_1, self::REQUESTHANDLER => "Search"],
+        self::COMMAND_PING => [self::ASV_2, self::REQUESTHANDLER => "Ping", self::UNPROVISIONED],
+        self::COMMAND_NOTIFY => [self::ASV_1, self::REQUESTHANDLER => "Notify"], // deprecated & not implemented
+        self::COMMAND_ITEMOPERATIONS => [self::ASV_12, self::REQUESTHANDLER => "ItemOperations"],
+        self::COMMAND_SETTINGS => [self::ASV_12, self::REQUESTHANDLER => "Settings"],
+    ];
+
+    private static $classes = [
+        "Email" => [
+            self::CLASS_NAME => "SyncMail",
+            self::CLASS_REQUIRESPROTOCOLVERSION => false,
+            self::CLASS_DEFAULTTYPE => SYNC_FOLDER_TYPE_INBOX,
+            self::CLASS_OTHERTYPES => [
+                SYNC_FOLDER_TYPE_OTHER,
+                SYNC_FOLDER_TYPE_DRAFTS,
+                SYNC_FOLDER_TYPE_WASTEBASKET,
+                SYNC_FOLDER_TYPE_SENTMAIL,
+                SYNC_FOLDER_TYPE_OUTBOX,
+                SYNC_FOLDER_TYPE_USER_MAIL,
+                SYNC_FOLDER_TYPE_JOURNAL,
+                SYNC_FOLDER_TYPE_USER_JOURNAL,
+            ],
+        ],
+        "Contacts" => [
+            self::CLASS_NAME => "SyncContact",
+            self::CLASS_REQUIRESPROTOCOLVERSION => true,
+            self::CLASS_DEFAULTTYPE => SYNC_FOLDER_TYPE_CONTACT,
+            self::CLASS_OTHERTYPES => [SYNC_FOLDER_TYPE_USER_CONTACT, SYNC_FOLDER_TYPE_UNKNOWN],
+        ],
+        "Calendar" => [
+            self::CLASS_NAME => "SyncAppointment",
+            self::CLASS_REQUIRESPROTOCOLVERSION => false,
+            self::CLASS_DEFAULTTYPE => SYNC_FOLDER_TYPE_APPOINTMENT,
+            self::CLASS_OTHERTYPES => [SYNC_FOLDER_TYPE_USER_APPOINTMENT],
+        ],
+        "Tasks" => [
+            self::CLASS_NAME => "SyncTask",
+            self::CLASS_REQUIRESPROTOCOLVERSION => false,
+            self::CLASS_DEFAULTTYPE => SYNC_FOLDER_TYPE_TASK,
+            self::CLASS_OTHERTYPES => [SYNC_FOLDER_TYPE_USER_TASK],
+        ],
+        "Notes" => [
+            self::CLASS_NAME => "SyncNote",
+            self::CLASS_REQUIRESPROTOCOLVERSION => false,
+            self::CLASS_DEFAULTTYPE => SYNC_FOLDER_TYPE_NOTE,
+            self::CLASS_OTHERTYPES => [SYNC_FOLDER_TYPE_USER_NOTE],
+        ],
+    ];
+
+    private static $stateMachine;
+    private static $deviceManager;
+    private static $provisioningManager;
+    private static $topCollector;
+    private static $backend;
+    private static $addSyncFolders;
+    private static $policies;
+    private static $redis;
+
+    /**
+     * Verifies configuration.
+     *
+     * @throws FatalMisconfigurationException
+     *
+     * @return bool
+     */
+    public static function CheckConfig() {
+        // check the php version
+        if (version_compare(phpversion(), '5.4.0') < 0) {
+            throw new FatalException("The configured PHP version is too old. Please make sure at least PHP 5.4 is used.");
+        }
+
+        // some basic checks
+        if (!defined('BASE_PATH')) {
+            throw new FatalMisconfigurationException("The BASE_PATH is not configured. Check if the config.php file is in place.");
+        }
+
+        if (substr(BASE_PATH, -1, 1) != "/") {
+            throw new FatalMisconfigurationException("The BASE_PATH should terminate with a '/'");
+        }
+
+        if (!file_exists(BASE_PATH)) {
+            throw new FatalMisconfigurationException("The configured BASE_PATH does not exist or can not be accessed.");
+        }
+
+        if (defined('BASE_PATH_CLI') && file_exists(BASE_PATH_CLI)) {
+            define('REAL_BASE_PATH', BASE_PATH_CLI);
+        }
+        else {
+            define('REAL_BASE_PATH', BASE_PATH);
+        }
+
+        if (!defined('LOGBACKEND')) {
+            define('LOGBACKEND', 'filelog');
+        }
+
+        if (strtolower(LOGBACKEND) == 'syslog') {
+            define('LOGBACKEND_CLASS', 'Syslog');
+            if (!defined('LOG_SYSLOG_FACILITY')) {
+                define('LOG_SYSLOG_FACILITY', LOG_LOCAL0);
+            }
+
+            if (!defined('LOG_SYSLOG_HOST')) {
+                define('LOG_SYSLOG_HOST', false);
+            }
+
+            if (!defined('LOG_SYSLOG_PORT')) {
+                define('LOG_SYSLOG_PORT', 514);
+            }
+
+            if (!defined('LOG_SYSLOG_PROGRAM')) {
+                define('LOG_SYSLOG_PROGRAM', 'grommunio-sync');
+            }
+
+            if (!is_numeric(LOG_SYSLOG_PORT)) {
+                throw new FatalMisconfigurationException("The LOG_SYSLOG_PORT must a be a number.");
+            }
+
+            if (LOG_SYSLOG_HOST && LOG_SYSLOG_PORT <= 0) {
+                throw new FatalMisconfigurationException("LOG_SYSLOG_HOST is defined but the LOG_SYSLOG_PORT does not seem to be valid.");
+            }
+        }
+        elseif (strtolower(LOGBACKEND) == 'filelog') {
+            define('LOGBACKEND_CLASS', 'FileLog');
+            if (!defined('LOGFILEDIR')) {
+                throw new FatalMisconfigurationException("The LOGFILEDIR is not configured. Check if the config.php file is in place.");
+            }
+
+            if (substr(LOGFILEDIR, -1, 1) != "/") {
+                throw new FatalMisconfigurationException("The LOGFILEDIR should terminate with a '/'");
+            }
+
+            if (!file_exists(LOGFILEDIR)) {
+                throw new FatalMisconfigurationException("The configured LOGFILEDIR does not exist or can not be accessed.");
+            }
+
+            if ((!file_exists(LOGFILE) && !touch(LOGFILE)) || !is_writable(LOGFILE)) {
+                throw new FatalMisconfigurationException("The configured LOGFILE can not be modified.");
+            }
+
+            if ((!file_exists(LOGERRORFILE) && !touch(LOGERRORFILE)) || !is_writable(LOGERRORFILE)) {
+                throw new FatalMisconfigurationException("The configured LOGERRORFILE can not be modified.");
+            }
+
+            // check ownership on the (eventually) just created files
+            Utils::FixFileOwner(LOGFILE);
+            Utils::FixFileOwner(LOGERRORFILE);
+        }
+        else {
+            define('LOGBACKEND_CLASS', LOGBACKEND);
+        }
+
+        // set time zone
+        // code contributed by Robert Scheck (rsc)
+        if (defined('TIMEZONE') ? constant('TIMEZONE') : false) {
+            if (!@date_default_timezone_set(TIMEZONE)) {
+                throw new FatalMisconfigurationException(sprintf("The configured TIMEZONE '%s' is not valid. Please check supported timezones at http://www.php.net/manual/en/timezones.php", constant('TIMEZONE')));
+            }
+        }
+        elseif (!ini_get('date.timezone')) {
+            date_default_timezone_set('Europe/Vienna');
+        }
+
+        if (defined('USE_X_FORWARDED_FOR_HEADER')) {
+            SLog::Write(LOGLEVEL_INFO, "The configuration parameter 'USE_X_FORWARDED_FOR_HEADER' was deprecated in favor of 'USE_CUSTOM_REMOTE_IP_HEADER'. Please update your configuration.");
+        }
+
+        // check redis configuration - set defaults
+        if (!defined('REDIS_HOST')) {
+            define('REDIS_HOST', 'localhost');
+        }
+        if (!defined('REDIS_PORT')) {
+            define('REDIS_PORT', 6379);
+        }
+        if (!defined('REDIS_AUTH')) {
+            define('REDIS_AUTH', '');
+        }
+
+        return true;
+    }
+
+    /**
+     * Verifies Timezone, StateMachine and Backend configuration.
+     *
+     * @return bool
+     * @trows FatalMisconfigurationException
+     */
+    public static function CheckAdvancedConfig() {
+        global $specialLogUsers, $additionalFolders;
+
+        if (!is_array($specialLogUsers)) {
+            throw new FatalMisconfigurationException("The WBXML log users is not an array.");
+        }
+
+        if (!defined('SYNC_CONTACTS_MAXPICTURESIZE')) {
+            define('SYNC_CONTACTS_MAXPICTURESIZE', 49152);
+        }
+        elseif ((!is_int(SYNC_CONTACTS_MAXPICTURESIZE) || SYNC_CONTACTS_MAXPICTURESIZE < 1)) {
+            throw new FatalMisconfigurationException("The SYNC_CONTACTS_MAXPICTURESIZE value must be a number higher than 0.");
+        }
+
+        if (!defined('USE_PARTIAL_FOLDERSYNC')) {
+            define('USE_PARTIAL_FOLDERSYNC', false);
+        }
+
+        if (!defined('PING_LOWER_BOUND_LIFETIME')) {
+            define('PING_LOWER_BOUND_LIFETIME', false);
+        }
+        elseif (PING_LOWER_BOUND_LIFETIME !== false && (!is_int(PING_LOWER_BOUND_LIFETIME) || PING_LOWER_BOUND_LIFETIME < 1 || PING_LOWER_BOUND_LIFETIME > 3540)) {
+            throw new FatalMisconfigurationException("The PING_LOWER_BOUND_LIFETIME value must be 'false' or a number between 1 and 3540 inclusively.");
+        }
+        if (!defined('PING_HIGHER_BOUND_LIFETIME')) {
+            define('PING_HIGHER_BOUND_LIFETIME', false);
+        }
+        elseif (PING_HIGHER_BOUND_LIFETIME !== false && (!is_int(PING_HIGHER_BOUND_LIFETIME) || PING_HIGHER_BOUND_LIFETIME < 1 || PING_HIGHER_BOUND_LIFETIME > 3540)) {
+            throw new FatalMisconfigurationException("The PING_HIGHER_BOUND_LIFETIME value must be 'false' or a number between 1 and 3540 inclusively.");
+        }
+        if (PING_HIGHER_BOUND_LIFETIME !== false && PING_LOWER_BOUND_LIFETIME !== false && PING_HIGHER_BOUND_LIFETIME < PING_LOWER_BOUND_LIFETIME) {
+            throw new FatalMisconfigurationException("The PING_HIGHER_BOUND_LIFETIME value must be greater or equal to PING_LOWER_BOUND_LIFETIME.");
+        }
+
+        if (!defined('RETRY_AFTER_DELAY')) {
+            define('RETRY_AFTER_DELAY', 300);
+        }
+        elseif (RETRY_AFTER_DELAY !== false && (!is_int(RETRY_AFTER_DELAY) || RETRY_AFTER_DELAY < 1)) {
+            throw new FatalMisconfigurationException("The RETRY_AFTER_DELAY value must be 'false' or a number greater than 0.");
+        }
+
+        // set Grommunio backend defaults if not set
+        if (!defined('MAPI_SERVER')) {
+            define('MAPI_SERVER', 'default:');
+        }
+        if (!defined('STORE_STATE_FOLDER')) {
+            define('STORE_STATE_FOLDER', 'GS-SyncState');
+        }
+
+        // the check on additional folders will not throw hard errors, as this is probably changed on live systems
+        if (isset($additionalFolders) && !is_array($additionalFolders)) {
+            SLog::Write(LOGLEVEL_ERROR, "GSync::CheckConfig(): The additional folders synchronization not available as array.");
+        }
+        else {
+            // check configured data
+            foreach ($additionalFolders as $af) {
+                if (!is_array($af) || !isset($af['store']) || !isset($af['folderid']) || !isset($af['name']) || !isset($af['type'])) {
+                    SLog::Write(LOGLEVEL_ERROR, "GSync::CheckConfig(): the additional folder synchronization is not configured correctly. Missing parameters. Entry will be ignored.");
+
+                    continue;
+                }
+
+                if ($af['store'] == "" || $af['folderid'] == "" || $af['name'] == "" || $af['type'] == "") {
+                    SLog::Write(LOGLEVEL_WARN, "GSync::CheckConfig(): the additional folder synchronization is not configured correctly. Empty parameters. Entry will be ignored.");
+
+                    continue;
+                }
+
+                if (!in_array($af['type'], [SYNC_FOLDER_TYPE_USER_NOTE, SYNC_FOLDER_TYPE_USER_CONTACT, SYNC_FOLDER_TYPE_USER_APPOINTMENT, SYNC_FOLDER_TYPE_USER_TASK, SYNC_FOLDER_TYPE_USER_MAIL])) {
+                    SLog::Write(LOGLEVEL_ERROR, sprintf("GSync::CheckConfig(): the type of the additional synchronization folder '%s is not permitted.", $af['name']));
+
+                    continue;
+                }
+                // the data will be initialized when used via self::getAddFolders()
+            }
+        }
+
+        SLog::Write(LOGLEVEL_DEBUG, sprintf("Used timezone '%s'", date_default_timezone_get()));
+
+        // get the statemachine, which will also try to load the backend.. This could throw errors
+        self::GetStateMachine();
+
+        return true;
+    }
+
+    /**
+     * Returns the StateMachine object
+     * which has to be an IStateMachine implementation.
+     *
+     * @throws FatalNotImplementedException
+     * @throws HTTPReturnCodeException
+     *
+     * @return object implementation of IStateMachine
+     */
+    public static function GetStateMachine() {
+        if (!isset(GSync::$stateMachine)) {
+            // the backend could also return an own IStateMachine implementation
+            GSync::$stateMachine = self::GetBackend()->GetStateMachine();
+
+            if (GSync::$stateMachine->GetStateVersion() !== GSync::GetLatestStateVersion()) {
+                if (class_exists("TopCollector")) {
+                    self::GetTopCollector()->AnnounceInformation("Run migration script!", true);
+                }
+
+                throw new ServiceUnavailableException(sprintf("The state version available to the %s is not the latest version - please run the state upgrade script. See release notes for more information.", get_class(GSync::$stateMachine)));
+            }
+        }
+
+        return GSync::$stateMachine;
+    }
+
+    /**
+     * Returns the Redis object.
+     *
+     * @return object Redis
+     */
+    public static function GetRedis() {
+        if (!isset(GSync::$redis)) {
+            GSync::$redis = new RedisConnection();
+        }
+
+        return GSync::$redis;
+    }
+
+    /**
+     * Returns the latest version of supported states.
+     *
+     * @return int
+     */
+    public static function GetLatestStateVersion() {
+        return self::STATE_VERSION;
+    }
+
+    /**
+     * Returns the ProvisioningManager object.
+     *
+     * @return object ProvisioningManager
+     */
+    public static function GetProvisioningManager() {
+        if (!isset(self::$provisioningManager)) {
+            self::$provisioningManager = new ProvisioningManager();
+        }
+
+        return self::$provisioningManager;
+    }
+
+    /**
+     * Returns the DeviceManager object.
+     *
+     * @param bool $initialize (opt) default true: initializes the DeviceManager if not already done
+     *
+     * @return object DeviceManager
+     */
+    public static function GetDeviceManager($initialize = true) {
+        if (!isset(GSync::$deviceManager) && $initialize) {
+            GSync::$deviceManager = new DeviceManager();
+        }
+
+        return GSync::$deviceManager;
+    }
+
+    /**
+     * Returns the Top data collector object.
+     *
+     * @return object TopCollector
+     */
+    public static function GetTopCollector() {
+        if (!isset(GSync::$topCollector)) {
+            GSync::$topCollector = new TopCollector();
+        }
+
+        return GSync::$topCollector;
+    }
+
+    /**
+     * Loads a backend file.
+     *
+     * @param string $backendname
+     *
+     * @throws FatalNotImplementedException
+     *
+     * @return bool
+     */
+    public static function IncludeBackend($backendname) {
+        if ($backendname == false) {
+            return false;
+        }
+
+        $backendname = strtolower($backendname);
+        if (substr($backendname, 0, 7) !== 'backend') {
+            throw new FatalNotImplementedException(sprintf("Backend '%s' is not allowed", $backendname));
+        }
+
+        $rbn = substr($backendname, 7);
+
+        $subdirbackend = REAL_BASE_PATH . "backend/" . $rbn . "/" . $rbn . ".php";
+        $stdbackend = REAL_BASE_PATH . "backend/" . $rbn . ".php";
+
+        if (is_file($subdirbackend)) {
+            $toLoad = $subdirbackend;
+        }
+        elseif (is_file($stdbackend)) {
+            $toLoad = $stdbackend;
+        }
+        else {
+            return false;
+        }
+
+        SLog::Write(LOGLEVEL_DEBUG, sprintf("Including backend file: '%s'", $toLoad));
+
+        return include_once $toLoad;
+    }
+
+    /**
+     * Returns the Backend for this request
+     * the backend has to be an IBackend implementation.
+     *
+     * @return object IBackend implementation
+     */
+    public static function GetBackend() {
+        // if the backend is not yet loaded, load backend drivers and instantiate it
+        if (!isset(GSync::$backend)) {
+            // Initialize Grommunio
+            GSync::$backend = new Grommunio();
+        }
+
+        return GSync::$backend;
+    }
+
+    /**
+     * Returns additional folder objects which should be synchronized to the device.
+     *
+     * @param bool $backendIdsAsKeys if true the keys are backendids else folderids, default: true
+     *
+     * @return array
+     */
+    public static function GetAdditionalSyncFolders($backendIdsAsKeys = true) {
+        // get user based folders which should be synchronized
+        $userFolder = self::GetDeviceManager()->GetAdditionalUserSyncFolders();
+        $addfolders = self::getAddSyncFolders() + $userFolder;
+        // if requested, we rewrite the backendids to folderids here
+        if ($backendIdsAsKeys === false && !empty($addfolders)) {
+            SLog::Write(LOGLEVEL_DEBUG, "GSync::GetAdditionalSyncFolders(): Requested AS folderids as keys for additional folders array, converting");
+            $faddfolders = [];
+            foreach ($addfolders as $backendId => $addFolder) {
+                $fid = self::GetDeviceManager()->GetFolderIdForBackendId($backendId);
+                $faddfolders[$fid] = $addFolder;
+            }
+            $addfolders = $faddfolders;
+        }
+
+        return $addfolders;
+    }
+
+    /**
+     * Returns additional folder objects which should be synchronized to the device.
+     *
+     * @param string $backendid
+     * @param bool   $noDebug   (opt) by default, debug message is shown
+     *
+     * @return string
+     */
+    public static function GetAdditionalSyncFolderStore($backendid, $noDebug = false) {
+        if (isset(self::getAddSyncFolders()[$backendid]->Store)) {
+            $val = self::getAddSyncFolders()[$backendid]->Store;
+        }
+        else {
+            $val = self::GetDeviceManager()->GetAdditionalUserSyncFolder($backendid);
+            if (isset($val['store'])) {
+                $val = $val['store'];
+            }
+        }
+
+        if (!$noDebug) {
+            SLog::Write(LOGLEVEL_DEBUG, sprintf("GSync::GetAdditionalSyncFolderStore('%s'): '%s'", $backendid, Utils::PrintAsString($val)));
+        }
+
+        return $val;
+    }
+
+    /**
+     * Returns a SyncObject class name for a folder class.
+     *
+     * @param string $folderclass
+     *
+     * @throws FatalNotImplementedException
+     *
+     * @return string
+     */
+    public static function getSyncObjectFromFolderClass($folderclass) {
+        if (!isset(self::$classes[$folderclass])) {
+            throw new FatalNotImplementedException("Class '{$folderclass}' is not supported");
+        }
+
+        $class = self::$classes[$folderclass][self::CLASS_NAME];
+        if (self::$classes[$folderclass][self::CLASS_REQUIRESPROTOCOLVERSION]) {
+            return new $class(Request::GetProtocolVersion());
+        }
+
+        return new $class();
+    }
+
+    /**
+     * Initializes the SyncObjects for additional folders on demand.
+     * Uses DeviceManager->BuildSyncFolderObject() to do patching required for ZP-907.
+     *
+     * @return array
+     */
+    private static function getAddSyncFolders() {
+        global $additionalFolders;
+        if (!isset(self::$addSyncFolders)) {
+            self::$addSyncFolders = [];
+
+            if (isset($additionalFolders) && !is_array($additionalFolders)) {
+                SLog::Write(LOGLEVEL_ERROR, "GSync::getAddSyncFolders() : The additional folders synchronization not available as array.");
+            }
+            else {
+                foreach ($additionalFolders as $af) {
+                    if (!is_array($af) || !isset($af['store']) || !isset($af['folderid']) || !isset($af['name']) || !isset($af['type'])) {
+                        SLog::Write(LOGLEVEL_ERROR, "GSync::getAddSyncFolders() : the additional folder synchronization is not configured correctly. Missing parameters. Entry will be ignored.");
+
+                        continue;
+                    }
+
+                    if ($af['store'] == "" || $af['folderid'] == "" || $af['name'] == "" || $af['type'] == "") {
+                        SLog::Write(LOGLEVEL_WARN, "GSync::getAddSyncFolders() : the additional folder synchronization is not configured correctly. Empty parameters. Entry will be ignored.");
+
+                        continue;
+                    }
+
+                    if (!in_array($af['type'], [SYNC_FOLDER_TYPE_USER_NOTE, SYNC_FOLDER_TYPE_USER_CONTACT, SYNC_FOLDER_TYPE_USER_APPOINTMENT, SYNC_FOLDER_TYPE_USER_TASK, SYNC_FOLDER_TYPE_USER_MAIL])) {
+                        SLog::Write(LOGLEVEL_ERROR, sprintf("GSync::getAddSyncFolders() : the type of the additional synchronization folder '%s is not permitted.", $af['name']));
+
+                        continue;
+                    }
+
+                    // don't fail hard if no flags are set, but we at least warn about it
+                    if (!isset($af['flags'])) {
+                        SLog::Write(LOGLEVEL_WARN, sprintf("GSync::getAddSyncFolders() : the additional folder '%s' is not configured completely. Missing 'flags' parameter, defaulting to DeviceManager::FLD_FLAGS_NONE.", $af['name']));
+                        $af['flags'] = DeviceManager::FLD_FLAGS_NONE;
+                    }
+
+                    $folder = self::GetDeviceManager()->BuildSyncFolderObject($af['store'], $af['folderid'], '0', $af['name'], $af['type'], $af['flags'], DeviceManager::FLD_ORIGIN_CONFIG);
+                    self::$addSyncFolders[$folder->BackendId] = $folder;
+                }
+            }
+        }
+
+        return self::$addSyncFolders;
+    }
+
+    /**
+     * Returns the default foldertype for a folder class.
+     *
+     * @param string $folderclass folderclass sent by the mobile
+     *
+     * @return string
+     */
+    public static function getDefaultFolderTypeFromFolderClass($folderclass) {
+        SLog::Write(LOGLEVEL_DEBUG, sprintf("GSync::getDefaultFolderTypeFromFolderClass('%s'): '%d'", $folderclass, self::$classes[$folderclass][self::CLASS_DEFAULTTYPE]));
+
+        return self::$classes[$folderclass][self::CLASS_DEFAULTTYPE];
+    }
+
+    /**
+     * Returns the folder class for a foldertype.
+     *
+     * @param string $foldertype
+     *
+     * @return string/false     false if no class for this type is available
+     */
+    public static function GetFolderClassFromFolderType($foldertype) {
+        $class = false;
+        foreach (self::$classes as $aClass => $cprops) {
+            if ($cprops[self::CLASS_DEFAULTTYPE] == $foldertype || in_array($foldertype, $cprops[self::CLASS_OTHERTYPES])) {
+                $class = $aClass;
+
+                break;
+            }
+        }
+        SLog::Write(LOGLEVEL_DEBUG, sprintf("GSync::GetFolderClassFromFolderType('%s'): %s", $foldertype, Utils::PrintAsString($class)));
+
+        return $class;
+    }
+
+    /**
+     * Prints the grommunio-sync legal header to STDOUT
+     * Using this breaks ActiveSync synchronization if wbxml is expected.
+     *
+     * @param string $message           (opt) message to be displayed
+     * @param string $additionalMessage (opt) additional message to be displayed
+     *
+     * @return
+     */
+    public static function PrintGrommunioSyncLegal($message = "", $additionalMessage = "") {
+        SLog::Write(LOGLEVEL_DEBUG, "GSync::PrintGrommunioSyncLegal()");
+
+        if ($message) {
+            $message = "<h3>" . $message . "</h3>";
+        }
+        if ($additionalMessage) {
+            $additionalMessage .= "<br>";
+        }
+
+        header("Content-type: text/html");
+        echo <<<END
         <html>
         <header>
         <title>grommunio-sync ActiveSync</title>
@@ -699,198 +699,198 @@ 
         </body>
         </html>
 END;
-	}
-
-	/**
-	 * Indicates the latest AS version supported by grommunio-sync.
-	 *
-	 * @return string
-	 */
-	public static function GetLatestSupportedASVersion() {
-		return end(self::$supportedASVersions);
-	}
-
-	/**
-	 * Indicates which is the highest AS version supported by the backend.
-	 *
-	 * @throws FatalNotImplementedException if the backend returns an invalid version
-	 *
-	 * @return string
-	 */
-	public static function GetSupportedASVersion() {
-		$version = self::GetBackend()->GetSupportedASVersion();
-		if (!in_array($version, self::$supportedASVersions)) {
-			throw new FatalNotImplementedException(sprintf("AS version '%s' reported by the backend is not supported", $version));
-		}
-
-		return $version;
-	}
-
-	/**
-	 * Returns AS server header.
-	 *
-	 * @return string
-	 */
-	public static function GetServerHeader() {
-		if (self::GetSupportedASVersion() == self::ASV_25) {
-			return "MS-Server-ActiveSync: 6.5.7638.1";
-		}
-
-		return "MS-Server-ActiveSync: " . self::GetSupportedASVersion();
-	}
-
-	/**
-	 * Returns AS protocol versions which are supported.
-	 *
-	 * @param bool $valueOnly (opt) default: false (also returns the header name)
-	 *
-	 * @return string
-	 */
-	public static function GetSupportedProtocolVersions($valueOnly = false) {
-		$versions = implode(',', array_slice(self::$supportedASVersions, 0, (array_search(self::GetSupportedASVersion(), self::$supportedASVersions) + 1)));
-		SLog::Write(LOGLEVEL_DEBUG, "GSync::GetSupportedProtocolVersions(): " . $versions);
-
-		if ($valueOnly === true) {
-			return $versions;
-		}
-
-		return "MS-ASProtocolVersions: " . $versions;
-	}
-
-	/**
-	 * Returns AS commands which are supported.
-	 *
-	 * @return string
-	 */
-	public static function GetSupportedCommands() {
-		$asCommands = [];
-		// filter all non-activesync commands
-		foreach (self::$supportedCommands as $c => $v) {
-			if (!self::checkCommandOptions($c, self::NOACTIVESYNCCOMMAND) &&
-					self::checkCommandOptions($c, self::GetSupportedASVersion())) {
-				$asCommands[] = Utils::GetCommandFromCode($c);
-			}
-		}
-
-		$commands = implode(',', $asCommands);
-		SLog::Write(LOGLEVEL_DEBUG, "GSync::GetSupportedCommands(): " . $commands);
-
-		return "MS-ASProtocolCommands: " . $commands;
-	}
-
-	/**
-	 * Loads and instantiates a request processor for a command.
-	 *
-	 * @param int $commandCode
-	 *
-	 * @return RequestProcessor sub-class
-	 */
-	public static function GetRequestHandlerForCommand($commandCode) {
-		if (!array_key_exists($commandCode, self::$supportedCommands) ||
-				!array_key_exists(self::REQUESTHANDLER, self::$supportedCommands[$commandCode])) {
-			throw new FatalNotImplementedException(sprintf("Command '%s' has no request handler or class", Utils::GetCommandFromCode($commandCode)));
-		}
-
-		$class = self::$supportedCommands[$commandCode][self::REQUESTHANDLER];
-		$handlerclass = REAL_BASE_PATH . "lib/request/" . strtolower($class) . ".php";
-
-		if (is_file($handlerclass)) {
-			include $handlerclass;
-		}
-
-		if (class_exists($class)) {
-			return new $class();
-		}
-
-		throw new FatalNotImplementedException(sprintf("Request handler '%s' can not be loaded", $class));
-	}
-
-	/**
-	 * Indicates if a commands requires authentication or not.
-	 *
-	 * @param int $commandCode
-	 *
-	 * @return bool
-	 */
-	public static function CommandNeedsAuthentication($commandCode) {
-		$stat = !self::checkCommandOptions($commandCode, self::UNAUTHENTICATED);
-		SLog::Write(LOGLEVEL_DEBUG, sprintf("GSync::CommandNeedsAuthentication(%d): %s", $commandCode, Utils::PrintAsString($stat)));
-
-		return $stat;
-	}
-
-	/**
-	 * Indicates if the Provisioning check has to be forced on these commands.
-	 *
-	 * @param string $commandCode
-	 *
-	 * @return bool
-	 */
-	public static function CommandNeedsProvisioning($commandCode) {
-		$stat = !self::checkCommandOptions($commandCode, self::UNPROVISIONED);
-		SLog::Write(LOGLEVEL_DEBUG, sprintf("GSync::CommandNeedsProvisioning(%s): %s", $commandCode, Utils::PrintAsString($stat)));
-
-		return $stat;
-	}
-
-	/**
-	 * Indicates if these commands expect plain text input instead of wbxml.
-	 *
-	 * @param string $commandCode
-	 *
-	 * @return bool
-	 */
-	public static function CommandNeedsPlainInput($commandCode) {
-		$stat = self::checkCommandOptions($commandCode, self::PLAININPUT);
-		SLog::Write(LOGLEVEL_DEBUG, sprintf("GSync::CommandNeedsPlainInput(%d): %s", $commandCode, Utils::PrintAsString($stat)));
-
-		return $stat;
-	}
-
-	/**
-	 * Indicates if the command to be executed operates on the hierarchy.
-	 *
-	 * @param int $commandCode
-	 *
-	 * @return bool
-	 */
-	public static function HierarchyCommand($commandCode) {
-		$stat = self::checkCommandOptions($commandCode, self::HIERARCHYCOMMAND);
-		SLog::Write(LOGLEVEL_DEBUG, sprintf("GSync::HierarchyCommand(%d): %s", $commandCode, Utils::PrintAsString($stat)));
-
-		return $stat;
-	}
-
-	/**
-	 * Checks access types of a command.
-	 *
-	 * @param string $commandCode a commandCode
-	 * @param string $option      e.g. self::UNAUTHENTICATED
-	 *
-	 * @throws FatalNotImplementedException
-	 *
-	 * @return object StateMachine
-	 */
-	private static function checkCommandOptions($commandCode, $option) {
-		if ($commandCode === false) {
-			return false;
-		}
-
-		if (!array_key_exists($commandCode, self::$supportedCommands)) {
-			throw new FatalNotImplementedException(sprintf("Command '%s' is not supported", Utils::GetCommandFromCode($commandCode)));
-		}
-
-		$capa = self::$supportedCommands[$commandCode];
-		$defcapa = in_array($option, $capa, true);
-
-		// if not looking for a default capability, check if the command is supported since a previous AS version
-		if (!$defcapa) {
-			$verkey = array_search($option, self::$supportedASVersions, true);
-			if ($verkey !== false && ($verkey >= array_search($capa[0], self::$supportedASVersions))) {
-				$defcapa = true;
-			}
-		}
-
-		return $defcapa;
-	}
+    }
+
+    /**
+     * Indicates the latest AS version supported by grommunio-sync.
+     *
+     * @return string
+     */
+    public static function GetLatestSupportedASVersion() {
+        return end(self::$supportedASVersions);
+    }
+
+    /**
+     * Indicates which is the highest AS version supported by the backend.
+     *
+     * @throws FatalNotImplementedException if the backend returns an invalid version
+     *
+     * @return string
+     */
+    public static function GetSupportedASVersion() {
+        $version = self::GetBackend()->GetSupportedASVersion();
+        if (!in_array($version, self::$supportedASVersions)) {
+            throw new FatalNotImplementedException(sprintf("AS version '%s' reported by the backend is not supported", $version));
+        }
+
+        return $version;
+    }
+
+    /**
+     * Returns AS server header.
+     *
+     * @return string
+     */
+    public static function GetServerHeader() {
+        if (self::GetSupportedASVersion() == self::ASV_25) {
+            return "MS-Server-ActiveSync: 6.5.7638.1";
+        }
+
+        return "MS-Server-ActiveSync: " . self::GetSupportedASVersion();
+    }
+
+    /**
+     * Returns AS protocol versions which are supported.
+     *
+     * @param bool $valueOnly (opt) default: false (also returns the header name)
+     *
+     * @return string
+     */
+    public static function GetSupportedProtocolVersions($valueOnly = false) {
+        $versions = implode(',', array_slice(self::$supportedASVersions, 0, (array_search(self::GetSupportedASVersion(), self::$supportedASVersions) + 1)));
+        SLog::Write(LOGLEVEL_DEBUG, "GSync::GetSupportedProtocolVersions(): " . $versions);
+
+        if ($valueOnly === true) {
+            return $versions;
+        }
+
+        return "MS-ASProtocolVersions: " . $versions;
+    }
+
+    /**
+     * Returns AS commands which are supported.
+     *
+     * @return string
+     */
+    public static function GetSupportedCommands() {
+        $asCommands = [];
+        // filter all non-activesync commands
+        foreach (self::$supportedCommands as $c => $v) {
+            if (!self::checkCommandOptions($c, self::NOACTIVESYNCCOMMAND) &&
+                    self::checkCommandOptions($c, self::GetSupportedASVersion())) {
+                $asCommands[] = Utils::GetCommandFromCode($c);
+            }
+        }
+
+        $commands = implode(',', $asCommands);
+        SLog::Write(LOGLEVEL_DEBUG, "GSync::GetSupportedCommands(): " . $commands);
+
+        return "MS-ASProtocolCommands: " . $commands;
+    }
+
+    /**
+     * Loads and instantiates a request processor for a command.
+     *
+     * @param int $commandCode
+     *
+     * @return RequestProcessor sub-class
+     */
+    public static function GetRequestHandlerForCommand($commandCode) {
+        if (!array_key_exists($commandCode, self::$supportedCommands) ||
+                !array_key_exists(self::REQUESTHANDLER, self::$supportedCommands[$commandCode])) {
+            throw new FatalNotImplementedException(sprintf("Command '%s' has no request handler or class", Utils::GetCommandFromCode($commandCode)));
+        }
+
+        $class = self::$supportedCommands[$commandCode][self::REQUESTHANDLER];
+        $handlerclass = REAL_BASE_PATH . "lib/request/" . strtolower($class) . ".php";
+
+        if (is_file($handlerclass)) {
+            include $handlerclass;
+        }
+
+        if (class_exists($class)) {
+            return new $class();
+        }
+
+        throw new FatalNotImplementedException(sprintf("Request handler '%s' can not be loaded", $class));
+    }
+
+    /**
+     * Indicates if a commands requires authentication or not.
+     *
+     * @param int $commandCode
+     *
+     * @return bool
+     */
+    public static function CommandNeedsAuthentication($commandCode) {
+        $stat = !self::checkCommandOptions($commandCode, self::UNAUTHENTICATED);
+        SLog::Write(LOGLEVEL_DEBUG, sprintf("GSync::CommandNeedsAuthentication(%d): %s", $commandCode, Utils::PrintAsString($stat)));
+
+        return $stat;
+    }
+
+    /**
+     * Indicates if the Provisioning check has to be forced on these commands.
+     *
+     * @param string $commandCode
+     *
+     * @return bool
+     */
+    public static function CommandNeedsProvisioning($commandCode) {
+        $stat = !self::checkCommandOptions($commandCode, self::UNPROVISIONED);
+        SLog::Write(LOGLEVEL_DEBUG, sprintf("GSync::CommandNeedsProvisioning(%s): %s", $commandCode, Utils::PrintAsString($stat)));
+
+        return $stat;
+    }
+
+    /**
+     * Indicates if these commands expect plain text input instead of wbxml.
+     *
+     * @param string $commandCode
+     *
+     * @return bool
+     */
+    public static function CommandNeedsPlainInput($commandCode) {
+        $stat = self::checkCommandOptions($commandCode, self::PLAININPUT);
+        SLog::Write(LOGLEVEL_DEBUG, sprintf("GSync::CommandNeedsPlainInput(%d): %s", $commandCode, Utils::PrintAsString($stat)));
+
+        return $stat;
+    }
+
+    /**
+     * Indicates if the command to be executed operates on the hierarchy.
+     *
+     * @param int $commandCode
+     *
+     * @return bool
+     */
+    public static function HierarchyCommand($commandCode) {
+        $stat = self::checkCommandOptions($commandCode, self::HIERARCHYCOMMAND);
+        SLog::Write(LOGLEVEL_DEBUG, sprintf("GSync::HierarchyCommand(%d): %s", $commandCode, Utils::PrintAsString($stat)));
+
+        return $stat;
+    }
+
+    /**
+     * Checks access types of a command.
+     *
+     * @param string $commandCode a commandCode
+     * @param string $option      e.g. self::UNAUTHENTICATED
+     *
+     * @throws FatalNotImplementedException
+     *
+     * @return object StateMachine
+     */
+    private static function checkCommandOptions($commandCode, $option) {
+        if ($commandCode === false) {
+            return false;
+        }
+
+        if (!array_key_exists($commandCode, self::$supportedCommands)) {
+            throw new FatalNotImplementedException(sprintf("Command '%s' is not supported", Utils::GetCommandFromCode($commandCode)));
+        }
+
+        $capa = self::$supportedCommands[$commandCode];
+        $defcapa = in_array($option, $capa, true);
+
+        // if not looking for a default capability, check if the command is supported since a previous AS version
+        if (!$defcapa) {
+            $verkey = array_search($option, self::$supportedASVersions, true);
+            if ($verkey !== false && ($verkey >= array_search($capa[0], self::$supportedASVersions))) {
+                $defcapa = true;
+            }
+        }
+
+        return $defcapa;
+    }
 }

Spacing +10 added lines, -10 removed lines

@@ -11,7 +11,7 @@ 
 	public const UNAUTHENTICATED = 1;
 	public const UNPROVISIONED = 2;
 	public const NOACTIVESYNCCOMMAND = 3;
-	public const WEBSERVICECOMMAND = 4;    // DEPRECATED
+	public const WEBSERVICECOMMAND = 4; // DEPRECATED
 	public const HIERARCHYCOMMAND = 5;
 	public const PLAININPUT = 6;
 	public const REQUESTHANDLER = 7;
@@ -473,8 +473,8 @@ 
 
 		$rbn = substr($backendname, 7);
 
-		$subdirbackend = REAL_BASE_PATH . "backend/" . $rbn . "/" . $rbn . ".php";
-		$stdbackend = REAL_BASE_PATH . "backend/" . $rbn . ".php";
+		$subdirbackend = REAL_BASE_PATH."backend/".$rbn."/".$rbn.".php";
+		$stdbackend = REAL_BASE_PATH."backend/".$rbn.".php";
 
 		if (is_file($subdirbackend)) {
 			$toLoad = $subdirbackend;
@@ -676,7 +676,7 @@ 
 		SLog::Write(LOGLEVEL_DEBUG, "GSync::PrintGrommunioSyncLegal()");
 
 		if ($message) {
-			$message = "<h3>" . $message . "</h3>";
+			$message = "<h3>".$message."</h3>";
 		}
 		if ($additionalMessage) {
 			$additionalMessage .= "<br>";
@@ -736,7 +736,7 @@ 
 			return "MS-Server-ActiveSync: 6.5.7638.1";
 		}
 
-		return "MS-Server-ActiveSync: " . self::GetSupportedASVersion();
+		return "MS-Server-ActiveSync: ".self::GetSupportedASVersion();
 	}
 
 	/**
@@ -748,13 +748,13 @@ 
 	 */
 	public static function GetSupportedProtocolVersions($valueOnly = false) {
 		$versions = implode(',', array_slice(self::$supportedASVersions, 0, (array_search(self::GetSupportedASVersion(), self::$supportedASVersions) + 1)));
-		SLog::Write(LOGLEVEL_DEBUG, "GSync::GetSupportedProtocolVersions(): " . $versions);
+		SLog::Write(LOGLEVEL_DEBUG, "GSync::GetSupportedProtocolVersions(): ".$versions);
 
 		if ($valueOnly === true) {
 			return $versions;
 		}
 
-		return "MS-ASProtocolVersions: " . $versions;
+		return "MS-ASProtocolVersions: ".$versions;
 	}
 
 	/**
@@ -773,9 +773,9 @@ 
 		}
 
 		$commands = implode(',', $asCommands);
-		SLog::Write(LOGLEVEL_DEBUG, "GSync::GetSupportedCommands(): " . $commands);
+		SLog::Write(LOGLEVEL_DEBUG, "GSync::GetSupportedCommands(): ".$commands);
 
-		return "MS-ASProtocolCommands: " . $commands;
+		return "MS-ASProtocolCommands: ".$commands;
 	}
 
 	/**
@@ -792,7 +792,7 @@ 
 		}
 
 		$class = self::$supportedCommands[$commandCode][self::REQUESTHANDLER];
-		$handlerclass = REAL_BASE_PATH . "lib/request/" . strtolower($class) . ".php";
+		$handlerclass = REAL_BASE_PATH."lib/request/".strtolower($class).".php";
 
 		if (is_file($handlerclass)) {
 			include $handlerclass;

Braces +13 added lines, -26 removed lines

@@ -178,8 +178,7 @@ 
 
 		if (defined('BASE_PATH_CLI') && file_exists(BASE_PATH_CLI)) {
 			define('REAL_BASE_PATH', BASE_PATH_CLI);
-		}
-		else {
+		} else {
 			define('REAL_BASE_PATH', BASE_PATH);
 		}
 
@@ -212,8 +211,7 @@ 
 			if (LOG_SYSLOG_HOST && LOG_SYSLOG_PORT <= 0) {
 				throw new FatalMisconfigurationException("LOG_SYSLOG_HOST is defined but the LOG_SYSLOG_PORT does not seem to be valid.");
 			}
-		}
-		elseif (strtolower(LOGBACKEND) == 'filelog') {
+		} elseif (strtolower(LOGBACKEND) == 'filelog') {
 			define('LOGBACKEND_CLASS', 'FileLog');
 			if (!defined('LOGFILEDIR')) {
 				throw new FatalMisconfigurationException("The LOGFILEDIR is not configured. Check if the config.php file is in place.");
@@ -238,8 +236,7 @@ 
 			// check ownership on the (eventually) just created files
 			Utils::FixFileOwner(LOGFILE);
 			Utils::FixFileOwner(LOGERRORFILE);
-		}
-		else {
+		} else {
 			define('LOGBACKEND_CLASS', LOGBACKEND);
 		}
 
@@ -249,8 +246,7 @@ 
 			if (!@date_default_timezone_set(TIMEZONE)) {
 				throw new FatalMisconfigurationException(sprintf("The configured TIMEZONE '%s' is not valid. Please check supported timezones at http://www.php.net/manual/en/timezones.php", constant('TIMEZONE')));
 			}
-		}
-		elseif (!ini_get('date.timezone')) {
+		} elseif (!ini_get('date.timezone')) {
 			date_default_timezone_set('Europe/Vienna');
 		}
 
@@ -287,8 +283,7 @@ 
 
 		if (!defined('SYNC_CONTACTS_MAXPICTURESIZE')) {
 			define('SYNC_CONTACTS_MAXPICTURESIZE', 49152);
-		}
-		elseif ((!is_int(SYNC_CONTACTS_MAXPICTURESIZE) || SYNC_CONTACTS_MAXPICTURESIZE < 1)) {
+		} elseif ((!is_int(SYNC_CONTACTS_MAXPICTURESIZE) || SYNC_CONTACTS_MAXPICTURESIZE < 1)) {
 			throw new FatalMisconfigurationException("The SYNC_CONTACTS_MAXPICTURESIZE value must be a number higher than 0.");
 		}
 
@@ -298,14 +293,12 @@ 
 
 		if (!defined('PING_LOWER_BOUND_LIFETIME')) {
 			define('PING_LOWER_BOUND_LIFETIME', false);
-		}
-		elseif (PING_LOWER_BOUND_LIFETIME !== false && (!is_int(PING_LOWER_BOUND_LIFETIME) || PING_LOWER_BOUND_LIFETIME < 1 || PING_LOWER_BOUND_LIFETIME > 3540)) {
+		} elseif (PING_LOWER_BOUND_LIFETIME !== false && (!is_int(PING_LOWER_BOUND_LIFETIME) || PING_LOWER_BOUND_LIFETIME < 1 || PING_LOWER_BOUND_LIFETIME > 3540)) {
 			throw new FatalMisconfigurationException("The PING_LOWER_BOUND_LIFETIME value must be 'false' or a number between 1 and 3540 inclusively.");
 		}
 		if (!defined('PING_HIGHER_BOUND_LIFETIME')) {
 			define('PING_HIGHER_BOUND_LIFETIME', false);
-		}
-		elseif (PING_HIGHER_BOUND_LIFETIME !== false && (!is_int(PING_HIGHER_BOUND_LIFETIME) || PING_HIGHER_BOUND_LIFETIME < 1 || PING_HIGHER_BOUND_LIFETIME > 3540)) {
+		} elseif (PING_HIGHER_BOUND_LIFETIME !== false && (!is_int(PING_HIGHER_BOUND_LIFETIME) || PING_HIGHER_BOUND_LIFETIME < 1 || PING_HIGHER_BOUND_LIFETIME > 3540)) {
 			throw new FatalMisconfigurationException("The PING_HIGHER_BOUND_LIFETIME value must be 'false' or a number between 1 and 3540 inclusively.");
 		}
 		if (PING_HIGHER_BOUND_LIFETIME !== false && PING_LOWER_BOUND_LIFETIME !== false && PING_HIGHER_BOUND_LIFETIME < PING_LOWER_BOUND_LIFETIME) {
@@ -314,8 +307,7 @@ 
 
 		if (!defined('RETRY_AFTER_DELAY')) {
 			define('RETRY_AFTER_DELAY', 300);
-		}
-		elseif (RETRY_AFTER_DELAY !== false && (!is_int(RETRY_AFTER_DELAY) || RETRY_AFTER_DELAY < 1)) {
+		} elseif (RETRY_AFTER_DELAY !== false && (!is_int(RETRY_AFTER_DELAY) || RETRY_AFTER_DELAY < 1)) {
 			throw new FatalMisconfigurationException("The RETRY_AFTER_DELAY value must be 'false' or a number greater than 0.");
 		}
 
@@ -330,8 +322,7 @@ 
 		// the check on additional folders will not throw hard errors, as this is probably changed on live systems
 		if (isset($additionalFolders) && !is_array($additionalFolders)) {
 			SLog::Write(LOGLEVEL_ERROR, "GSync::CheckConfig(): The additional folders synchronization not available as array.");
-		}
-		else {
+		} else {
 			// check configured data
 			foreach ($additionalFolders as $af) {
 				if (!is_array($af) || !isset($af['store']) || !isset($af['folderid']) || !isset($af['name']) || !isset($af['type'])) {
@@ -478,11 +469,9 @@ 
 
 		if (is_file($subdirbackend)) {
 			$toLoad = $subdirbackend;
-		}
-		elseif (is_file($stdbackend)) {
+		} elseif (is_file($stdbackend)) {
 			$toLoad = $stdbackend;
-		}
-		else {
+		} else {
 			return false;
 		}
 
@@ -543,8 +532,7 @@ 
 	public static function GetAdditionalSyncFolderStore($backendid, $noDebug = false) {
 		if (isset(self::getAddSyncFolders()[$backendid]->Store)) {
 			$val = self::getAddSyncFolders()[$backendid]->Store;
-		}
-		else {
+		} else {
 			$val = self::GetDeviceManager()->GetAdditionalUserSyncFolder($backendid);
 			if (isset($val['store'])) {
 				$val = $val['store'];
@@ -593,8 +581,7 @@ 
 
 			if (isset($additionalFolders) && !is_array($additionalFolders)) {
 				SLog::Write(LOGLEVEL_ERROR, "GSync::getAddSyncFolders() : The additional folders synchronization not available as array.");
-			}
-			else {
+			} else {
 				foreach ($additionalFolders as $af) {
 					if (!is_array($af) || !isset($af['store']) || !isset($af['folderid']) || !isset($af['name']) || !isset($af['type'])) {
 						SLog::Write(LOGLEVEL_ERROR, "GSync::getAddSyncFolders() : the additional folder synchronization is not configured correctly. Missing parameters. Entry will be ignored.");

lib/core/stateobject.php

Indentation +228 added lines, -228 removed lines

@@ -8,232 +8,232 @@
  */
 
 class StateObject implements JsonSerializable {
-	private $SO_internalid;
-	protected $data = [];
-	protected $unsetdata = [];
-	protected $changed = false;
-
-	/**
-	 * Returns the unique id of that data object.
-	 *
-	 * @return array
-	 */
-	public function GetID() {
-		if (!isset($this->SO_internalid)) {
-			$this->SO_internalid = sprintf('%04x%04x%04x', mt_rand(0, 0xFFFF), mt_rand(0, 0xFFFF), mt_rand(0, 0xFFFF));
-		}
-
-		return $this->SO_internalid;
-	}
-
-	/**
-	 * Indicates if the data contained in this object was modified.
-	 *
-	 * @return array
-	 */
-	public function IsDataChanged() {
-		return $this->changed;
-	}
-
-	/**
-	 * PHP magic to set an instance variable.
-	 *
-	 * @param mixed $name
-	 * @param mixed $value
-	 *
-	 * @return
-	 */
-	public function __set($name, $value) {
-		$lname = strtolower($name);
-		if (isset($this->data[$lname]) &&
-				(
-					(is_scalar($value) && !is_array($value) && $this->data[$lname] === $value) ||
-				  (is_array($value) && is_array($this->data[$lname]) && $this->data[$lname] === $value)
-				)) {
-			return false;
-		}
-
-		$this->data[$lname] = $value;
-		$this->changed = true;
-	}
-
-	/**
-	 * PHP magic to get an instance variable
-	 * if the variable was not set previously, the value of the
-	 * Unsetdata array is returned.
-	 *
-	 * @param mixed $name
-	 *
-	 * @return
-	 */
-	public function __get($name) {
-		$lname = strtolower($name);
-
-		if (array_key_exists($lname, $this->data)) {
-			return $this->data[$lname];
-		}
-
-		if (isset($this->unsetdata) && is_array($this->unsetdata) && array_key_exists($lname, $this->unsetdata)) {
-			return $this->unsetdata[$lname];
-		}
-
-		return null;
-	}
-
-	/**
-	 * PHP magic to check if an instance variable is set.
-	 *
-	 * @param mixed $name
-	 *
-	 * @return
-	 */
-	public function __isset($name) {
-		return isset($this->data[strtolower($name)]);
-	}
-
-	/**
-	 * PHP magic to remove an instance variable.
-	 *
-	 * @param mixed $name
-	 *
-	 * @return
-	 */
-	public function __unset($name) {
-		if (isset($this->{$name})) {
-			unset($this->data[strtolower($name)]);
-			$this->changed = true;
-		}
-	}
-
-	/**
-	 * PHP magic to implement any getter, setter, has and delete operations
-	 * on an instance variable.
-	 * Methods like e.g. "SetVariableName($x)" and "GetVariableName()" are supported.
-	 *
-	 * @param mixed $name
-	 * @param mixed $arguments
-	 *
-	 * @return mixed
-	 */
-	public function __call($name, $arguments) {
-		$name = strtolower($name);
-		$operator = substr($name, 0, 3);
-		$var = substr($name, 3);
-
-		if ($name == "postunserialize") {
-			return $this->postUnserialize();
-		}
-
-		if ($operator == "set" && count($arguments) == 1) {
-			$this->{$var} = $arguments[0];
-
-			return true;
-		}
-
-		if ($operator == "set" && count($arguments) == 2 && $arguments[1] === false) {
-			$this->data[$var] = $arguments[0];
-
-			return true;
-		}
-
-		// getter without argument = return variable, null if not set
-		if ($operator == "get" && count($arguments) == 0) {
-			return $this->{$var};
-		}
-
-		// getter with one argument = return variable if set, else the argument
-		if ($operator == "get" && count($arguments) == 1) {
-			if (isset($this->{$var})) {
-				return $this->{$var};
-			}
-
-			return $arguments[0];
-		}
-
-		if ($operator == "has" && count($arguments) == 0) {
-			return isset($this->{$var});
-		}
-
-		if ($operator == "del" && count($arguments) == 0) {
-			unset($this->{$var});
-
-			return true;
-		}
-
-		throw new FatalNotImplementedException(sprintf("StateObject->__call('%s'): not implemented. op: {%s} args: %d", $name, $operator, count($arguments)));
-	}
-
-	/**
-	 * Called after the StateObject was unserialized.
-	 *
-	 * @return bool
-	 */
-	protected function postUnserialize() {
-		$this->changed = false;
-
-		return true;
-	}
-
-	/**
-	 * Callback function for failed unserialize.
-	 *
-	 * @throws StateInvalidException
-	 */
-	public static function ThrowStateInvalidException() {
-		throw new StateInvalidException("Unserialization failed as class was not found or not compatible");
-	}
-
-	/**
-	 * JsonSerializable interface method.
-	 *
-	 * Serializes the object to a value that can be serialized natively by json_encode()
-	 *
-	 * @return array
-	 */
-	public function jsonSerialize() {
-		return [
-			'gsSyncStateClass' => get_class($this),
-			'data' => $this->data,
-		];
-	}
-
-	/**
-	 * Restores the object from a value provided by json_decode.
-	 *
-	 * @param $stdObj   stdClass Object
-	 */
-	public function jsonDeserialize($stdObj) {
-		foreach ($stdObj->data as $prop => $val) {
-			if (is_object($val) && isset($val->gsSyncStateClass)) {
-				SLog::Write(LOGLEVEL_DEBUG, sprintf("StateObject->jsonDeserialize(): top class '%s'", $val->gsSyncStateClass));
-				$this->data[$prop] = new $val->gsSyncStateClass();
-				$this->data[$prop]->jsonDeserialize($val);
-				$this->data[$prop]->postUnserialize();
-			}
-			elseif (is_object($val)) {
-				// json_decode converts arrays into objects, convert them back to arrays
-				$this->data[$prop] = [];
-				foreach ($val as $k => $v) {
-					if (is_object($v) && isset($v->gsSyncStateClass)) {
-						SLog::Write(LOGLEVEL_DEBUG, sprintf("StateObject->jsonDeserialize(): sub class '%s'", $v->gsSyncStateClass));
-						// TODO: case should be removed when removing ASDevice backwards compatibility
-						if (strcasecmp($v->gsSyncStateClass, "ASDevice") == 0) {
-							$this->data[$prop][$k] = new ASDevice(Request::GetDeviceID(), Request::GetDeviceType(), Request::GetGETUser(), Request::GetUserAgent());
-						}
-						else {
-							$this->data[$prop][$k] = new $v->gsSyncStateClass();
-						}
-						$this->data[$prop][$k]->jsonDeserialize($v);
-						$this->data[$prop][$k]->postUnserialize();
-					}
-					else {
-						$this->data[$prop][$k] = $v;
-					}
-				}
-			}
-			else {
-				$this->data[$prop] = $val;
-			}
-		}
-	}
+    private $SO_internalid;
+    protected $data = [];
+    protected $unsetdata = [];
+    protected $changed = false;
+
+    /**
+     * Returns the unique id of that data object.
+     *
+     * @return array
+     */
+    public function GetID() {
+        if (!isset($this->SO_internalid)) {
+            $this->SO_internalid = sprintf('%04x%04x%04x', mt_rand(0, 0xFFFF), mt_rand(0, 0xFFFF), mt_rand(0, 0xFFFF));
+        }
+
+        return $this->SO_internalid;
+    }
+
+    /**
+     * Indicates if the data contained in this object was modified.
+     *
+     * @return array
+     */
+    public function IsDataChanged() {
+        return $this->changed;
+    }
+
+    /**
+     * PHP magic to set an instance variable.
+     *
+     * @param mixed $name
+     * @param mixed $value
+     *
+     * @return
+     */
+    public function __set($name, $value) {
+        $lname = strtolower($name);
+        if (isset($this->data[$lname]) &&
+                (
+                    (is_scalar($value) && !is_array($value) && $this->data[$lname] === $value) ||
+                  (is_array($value) && is_array($this->data[$lname]) && $this->data[$lname] === $value)
+                )) {
+            return false;
+        }
+
+        $this->data[$lname] = $value;
+        $this->changed = true;
+    }
+
+    /**
+     * PHP magic to get an instance variable
+     * if the variable was not set previously, the value of the
+     * Unsetdata array is returned.
+     *
+     * @param mixed $name
+     *
+     * @return
+     */
+    public function __get($name) {
+        $lname = strtolower($name);
+
+        if (array_key_exists($lname, $this->data)) {
+            return $this->data[$lname];
+        }
+
+        if (isset($this->unsetdata) && is_array($this->unsetdata) && array_key_exists($lname, $this->unsetdata)) {
+            return $this->unsetdata[$lname];
+        }
+
+        return null;
+    }
+
+    /**
+     * PHP magic to check if an instance variable is set.
+     *
+     * @param mixed $name
+     *
+     * @return
+     */
+    public function __isset($name) {
+        return isset($this->data[strtolower($name)]);
+    }
+
+    /**
+     * PHP magic to remove an instance variable.
+     *
+     * @param mixed $name
+     *
+     * @return
+     */
+    public function __unset($name) {
+        if (isset($this->{$name})) {
+            unset($this->data[strtolower($name)]);
+            $this->changed = true;
+        }
+    }
+
+    /**
+     * PHP magic to implement any getter, setter, has and delete operations
+     * on an instance variable.
+     * Methods like e.g. "SetVariableName($x)" and "GetVariableName()" are supported.
+     *
+     * @param mixed $name
+     * @param mixed $arguments
+     *
+     * @return mixed
+     */
+    public function __call($name, $arguments) {
+        $name = strtolower($name);
+        $operator = substr($name, 0, 3);
+        $var = substr($name, 3);
+
+        if ($name == "postunserialize") {
+            return $this->postUnserialize();
+        }
+
+        if ($operator == "set" && count($arguments) == 1) {
+            $this->{$var} = $arguments[0];
+
+            return true;
+        }
+
+        if ($operator == "set" && count($arguments) == 2 && $arguments[1] === false) {
+            $this->data[$var] = $arguments[0];
+
+            return true;
+        }
+
+        // getter without argument = return variable, null if not set
+        if ($operator == "get" && count($arguments) == 0) {
+            return $this->{$var};
+        }
+
+        // getter with one argument = return variable if set, else the argument
+        if ($operator == "get" && count($arguments) == 1) {
+            if (isset($this->{$var})) {
+                return $this->{$var};
+            }
+
+            return $arguments[0];
+        }
+
+        if ($operator == "has" && count($arguments) == 0) {
+            return isset($this->{$var});
+        }
+
+        if ($operator == "del" && count($arguments) == 0) {
+            unset($this->{$var});
+
+            return true;
+        }
+
+        throw new FatalNotImplementedException(sprintf("StateObject->__call('%s'): not implemented. op: {%s} args: %d", $name, $operator, count($arguments)));
+    }
+
+    /**
+     * Called after the StateObject was unserialized.
+     *
+     * @return bool
+     */
+    protected function postUnserialize() {
+        $this->changed = false;
+
+        return true;
+    }
+
+    /**
+     * Callback function for failed unserialize.
+     *
+     * @throws StateInvalidException
+     */
+    public static function ThrowStateInvalidException() {
+        throw new StateInvalidException("Unserialization failed as class was not found or not compatible");
+    }
+
+    /**
+     * JsonSerializable interface method.
+     *
+     * Serializes the object to a value that can be serialized natively by json_encode()
+     *
+     * @return array
+     */
+    public function jsonSerialize() {
+        return [
+            'gsSyncStateClass' => get_class($this),
+            'data' => $this->data,
+        ];
+    }
+
+    /**
+     * Restores the object from a value provided by json_decode.
+     *
+     * @param $stdObj   stdClass Object
+     */
+    public function jsonDeserialize($stdObj) {
+        foreach ($stdObj->data as $prop => $val) {
+            if (is_object($val) && isset($val->gsSyncStateClass)) {
+                SLog::Write(LOGLEVEL_DEBUG, sprintf("StateObject->jsonDeserialize(): top class '%s'", $val->gsSyncStateClass));
+                $this->data[$prop] = new $val->gsSyncStateClass();
+                $this->data[$prop]->jsonDeserialize($val);
+                $this->data[$prop]->postUnserialize();
+            }
+            elseif (is_object($val)) {
+                // json_decode converts arrays into objects, convert them back to arrays
+                $this->data[$prop] = [];
+                foreach ($val as $k => $v) {
+                    if (is_object($v) && isset($v->gsSyncStateClass)) {
+                        SLog::Write(LOGLEVEL_DEBUG, sprintf("StateObject->jsonDeserialize(): sub class '%s'", $v->gsSyncStateClass));
+                        // TODO: case should be removed when removing ASDevice backwards compatibility
+                        if (strcasecmp($v->gsSyncStateClass, "ASDevice") == 0) {
+                            $this->data[$prop][$k] = new ASDevice(Request::GetDeviceID(), Request::GetDeviceType(), Request::GetGETUser(), Request::GetUserAgent());
+                        }
+                        else {
+                            $this->data[$prop][$k] = new $v->gsSyncStateClass();
+                        }
+                        $this->data[$prop][$k]->jsonDeserialize($v);
+                        $this->data[$prop][$k]->postUnserialize();
+                    }
+                    else {
+                        $this->data[$prop][$k] = $v;
+                    }
+                }
+            }
+            else {
+                $this->data[$prop] = $val;
+            }
+        }
+    }
 }

Braces +4 added lines, -8 removed lines

@@ -209,8 +209,7 @@ 
 				$this->data[$prop] = new $val->gsSyncStateClass();
 				$this->data[$prop]->jsonDeserialize($val);
 				$this->data[$prop]->postUnserialize();
-			}
-			elseif (is_object($val)) {
+			} elseif (is_object($val)) {
 				// json_decode converts arrays into objects, convert them back to arrays
 				$this->data[$prop] = [];
 				foreach ($val as $k => $v) {
@@ -219,19 +218,16 @@ 
 						// TODO: case should be removed when removing ASDevice backwards compatibility
 						if (strcasecmp($v->gsSyncStateClass, "ASDevice") == 0) {
 							$this->data[$prop][$k] = new ASDevice(Request::GetDeviceID(), Request::GetDeviceType(), Request::GetGETUser(), Request::GetUserAgent());
-						}
-						else {
+						} else {
 							$this->data[$prop][$k] = new $v->gsSyncStateClass();
 						}
 						$this->data[$prop][$k]->jsonDeserialize($v);
 						$this->data[$prop][$k]->postUnserialize();
-					}
-					else {
+					} else {
 						$this->data[$prop][$k] = $v;
 					}
 				}
-			}
-			else {
+			} else {
 				$this->data[$prop] = $val;
 			}
 		}

lib/core/contentparameters.php

Indentation +126 added lines, -126 removed lines

@@ -8,130 +8,130 @@
  */
 
 class ContentParameters extends StateObject {
-	protected $unsetdata = [
-		'contentclass' => false,
-		'foldertype' => '',
-		'conflict' => false,
-		'deletesasmoves' => true,
-		'filtertype' => false,
-		'truncation' => false,
-		'rtftruncation' => false,
-		'mimesupport' => false,
-		'conversationmode' => false,
-	];
-
-	private $synckeyChanged = false;
-
-	/**
-	 * Expected magic getters and setters.
-	 *
-	 * GetContentClass() + SetContentClass()
-	 * GetConflict() + SetConflict()
-	 * GetDeletesAsMoves() + SetDeletesAsMoves()
-	 * GetFilterType() + SetFilterType()
-	 * GetTruncation() + SetTruncation
-	 * GetRTFTruncation() + SetRTFTruncation()
-	 * GetMimeSupport () + SetMimeSupport()
-	 * GetMimeTruncation() + SetMimeTruncation()
-	 * GetConversationMode() + SetConversationMode()
-	 *
-	 * @param mixed $name
-	 * @param mixed $arguments
-	 */
-
-	/**
-	 * Overwrite StateObject->__call so we are able to handle ContentParameters->BodyPreference()
-	 * and ContentParameters->BodyPartPreference().
-	 *
-	 * @return mixed
-	 */
-	public function __call($name, $arguments) {
-		if ($name === "BodyPreference") {
-			return $this->BodyPreference($arguments[0]);
-		}
-
-		if ($name === "BodyPartPreference") {
-			return $this->BodyPartPreference($arguments[0]);
-		}
-
-		return parent::__call($name, $arguments);
-	}
-
-	/**
-	 * Instantiates/returns the bodypreference object for a type.
-	 *
-	 * @param int $type
-	 *
-	 * @return int/boolean          returns false if value is not defined
-	 */
-	public function BodyPreference($type) {
-		if (!isset($this->bodypref)) {
-			$this->bodypref = [];
-		}
-
-		if (isset($this->bodypref[$type])) {
-			return $this->bodypref[$type];
-		}
-
-		$asb = new BodyPreference();
-		$arr = (array) $this->bodypref;
-		$arr[$type] = $asb;
-		$this->bodypref = $arr;
-
-		return $asb;
-	}
-
-	/**
-	 * Instantiates/returns the bodypartpreference object for a type.
-	 *
-	 * @param int $type
-	 *
-	 * @return int/boolean          returns false if value is not defined
-	 */
-	public function BodyPartPreference($type) {
-		if (!isset($this->bodypartpref)) {
-			$this->bodypartpref = [];
-		}
-
-		if (isset($this->bodypartpref[$type])) {
-			return $this->bodypartpref[$type];
-		}
-
-		$asb = new BodyPartPreference();
-		$arr = (array) $this->bodypartpref;
-		$arr[$type] = $asb;
-		$this->bodypartpref = $arr;
-
-		return $asb;
-	}
-
-	/**
-	 * Returns available body preference objects.
-	 *
-	 *  @return array/boolean       returns false if the client's body preference is not available
-	 */
-	public function GetBodyPreference() {
-		if (!isset($this->bodypref) || !(is_array($this->bodypref) || empty($this->bodypref))) {
-			SLog::Write(LOGLEVEL_DEBUG, sprintf("ContentParameters->GetBodyPreference(): bodypref is empty or not set"));
-
-			return false;
-		}
-
-		return array_keys($this->bodypref);
-	}
-
-	/**
-	 * Returns available body part preference objects.
-	 *
-	 *  @return array/boolean       returns false if the client's body preference is not available
-	 */
-	public function GetBodyPartPreference() {
-		if (!isset($this->bodypartpref) || !(is_array($this->bodypartpref) || empty($this->bodypartpref))) {
-			SLog::Write(LOGLEVEL_DEBUG, sprintf("ContentParameters->GetBodyPartPreference(): bodypartpref is empty or not set"));
-
-			return false;
-		}
-
-		return array_keys($this->bodypartpref);
-	}
+    protected $unsetdata = [
+        'contentclass' => false,
+        'foldertype' => '',
+        'conflict' => false,
+        'deletesasmoves' => true,
+        'filtertype' => false,
+        'truncation' => false,
+        'rtftruncation' => false,
+        'mimesupport' => false,
+        'conversationmode' => false,
+    ];
+
+    private $synckeyChanged = false;
+
+    /**
+     * Expected magic getters and setters.
+     *
+     * GetContentClass() + SetContentClass()
+     * GetConflict() + SetConflict()
+     * GetDeletesAsMoves() + SetDeletesAsMoves()
+     * GetFilterType() + SetFilterType()
+     * GetTruncation() + SetTruncation
+     * GetRTFTruncation() + SetRTFTruncation()
+     * GetMimeSupport () + SetMimeSupport()
+     * GetMimeTruncation() + SetMimeTruncation()
+     * GetConversationMode() + SetConversationMode()
+     *
+     * @param mixed $name
+     * @param mixed $arguments
+     */
+
+    /**
+     * Overwrite StateObject->__call so we are able to handle ContentParameters->BodyPreference()
+     * and ContentParameters->BodyPartPreference().
+     *
+     * @return mixed
+     */
+    public function __call($name, $arguments) {
+        if ($name === "BodyPreference") {
+            return $this->BodyPreference($arguments[0]);
+        }
+
+        if ($name === "BodyPartPreference") {
+            return $this->BodyPartPreference($arguments[0]);
+        }
+
+        return parent::__call($name, $arguments);
+    }
+
+    /**
+     * Instantiates/returns the bodypreference object for a type.
+     *
+     * @param int $type
+     *
+     * @return int/boolean          returns false if value is not defined
+     */
+    public function BodyPreference($type) {
+        if (!isset($this->bodypref)) {
+            $this->bodypref = [];
+        }
+
+        if (isset($this->bodypref[$type])) {
+            return $this->bodypref[$type];
+        }
+
+        $asb = new BodyPreference();
+        $arr = (array) $this->bodypref;
+        $arr[$type] = $asb;
+        $this->bodypref = $arr;
+
+        return $asb;
+    }
+
+    /**
+     * Instantiates/returns the bodypartpreference object for a type.
+     *
+     * @param int $type
+     *
+     * @return int/boolean          returns false if value is not defined
+     */
+    public function BodyPartPreference($type) {
+        if (!isset($this->bodypartpref)) {
+            $this->bodypartpref = [];
+        }
+
+        if (isset($this->bodypartpref[$type])) {
+            return $this->bodypartpref[$type];
+        }
+
+        $asb = new BodyPartPreference();
+        $arr = (array) $this->bodypartpref;
+        $arr[$type] = $asb;
+        $this->bodypartpref = $arr;
+
+        return $asb;
+    }
+
+    /**
+     * Returns available body preference objects.
+     *
+     *  @return array/boolean       returns false if the client's body preference is not available
+     */
+    public function GetBodyPreference() {
+        if (!isset($this->bodypref) || !(is_array($this->bodypref) || empty($this->bodypref))) {
+            SLog::Write(LOGLEVEL_DEBUG, sprintf("ContentParameters->GetBodyPreference(): bodypref is empty or not set"));
+
+            return false;
+        }
+
+        return array_keys($this->bodypref);
+    }
+
+    /**
+     * Returns available body part preference objects.
+     *
+     *  @return array/boolean       returns false if the client's body preference is not available
+     */
+    public function GetBodyPartPreference() {
+        if (!isset($this->bodypartpref) || !(is_array($this->bodypartpref) || empty($this->bodypartpref))) {
+            SLog::Write(LOGLEVEL_DEBUG, sprintf("ContentParameters->GetBodyPartPreference(): bodypartpref is empty or not set"));
+
+            return false;
+        }
+
+        return array_keys($this->bodypartpref);
+    }
 }

Spacing +2 added lines, -2 removed lines

@@ -74,7 +74,7 @@ 
 		}
 
 		$asb = new BodyPreference();
-		$arr = (array) $this->bodypref;
+		$arr = (array)$this->bodypref;
 		$arr[$type] = $asb;
 		$this->bodypref = $arr;
 
@@ -98,7 +98,7 @@ 
 		}
 
 		$asb = new BodyPartPreference();
-		$arr = (array) $this->bodypartpref;
+		$arr = (array)$this->bodypartpref;
 		$arr[$type] = $asb;
 		$this->bodypartpref = $arr;
 

lib/core/devicemanager.php

Indentation +1093 added lines, -1093 removed lines

@@ -13,1106 +13,1106 @@
  */
 
 class DeviceManager extends InterProcessData {
-	// broken message indicators
-	public const MSG_BROKEN_UNKNOWN = 1;
-	public const MSG_BROKEN_CAUSINGLOOP = 2;
-	public const MSG_BROKEN_SEMANTICERR = 4;
-
-	public const FLD_SYNC_INITIALIZED = 1;
-	public const FLD_SYNC_INPROGRESS = 2;
-	public const FLD_SYNC_COMPLETED = 4;
-
-	// new types need to be added to Request::HEX_EXTENDED2 filter
-	public const FLD_ORIGIN_USER = "U";
-	public const FLD_ORIGIN_CONFIG = "C";
-	public const FLD_ORIGIN_SHARED = "S";
-	public const FLD_ORIGIN_GAB = "G";
-	public const FLD_ORIGIN_IMPERSONATED = "I";
-
-	public const FLD_FLAGS_NONE = 0;
-	public const FLD_FLAGS_SENDASOWNER = 1;
-	public const FLD_FLAGS_TRACKSHARENAME = 2;
-	public const FLD_FLAGS_CALENDARREMINDERS = 4;
-
-	private $device;
-	private $deviceHash;
-	private $saveDevice;
-	private $statemachine;
-	private $stateManager;
-	private $incomingData = 0;
-	private $outgoingData = 0;
-
-	private $windowSize;
-	private $latestFolder;
-
-	private $loopdetection;
-	private $hierarchySyncRequired;
-	private $additionalFoldersHash;
-
-	/**
-	 * Constructor.
-	 */
-	public function __construct() {
-		$this->statemachine = GSync::GetStateMachine();
-		$this->deviceHash = false;
-		$this->saveDevice = true;
-		$this->windowSize = [];
-		$this->latestFolder = false;
-		$this->hierarchySyncRequired = false;
-
-		// initialize InterProcess parameters
-		$this->allocate = 0;
-		$this->type = "grommunio-sync:devicesuser";
-		parent::__construct();
-		parent::initializeParams();
-		$this->stateManager = new StateManager();
-
-		// only continue if deviceid is set
-		if (self::$devid) {
-			$this->device = new ASDevice();
-			$this->device->Initialize(self::$devid, Request::GetDeviceType(), Request::GetGETUser(), Request::GetUserAgent());
-			$this->loadDeviceData();
-
-			GSync::GetTopCollector()->SetUserAgent($this->device->GetDeviceUserAgent());
-		}
-		else {
-			throw new FatalNotImplementedException("Can not proceed without a device id.");
-		}
-
-		$this->loopdetection = new LoopDetection();
-		$this->loopdetection->ProcessLoopDetectionInit();
-		$this->loopdetection->ProcessLoopDetectionPreviousConnectionFailed();
-
-		$this->additionalFoldersHash = $this->getAdditionalFoldersHash();
-	}
-
-	/**
-	 * Load another different device.
-	 *
-	 * @param ASDevice $asDevice
-	 */
-	public function SetDevice($asDevice) {
-		// TODO: this is broken and callers should be removed/updated. ASDevice is now always overwritten.
-		$this->device = $asDevice;
-		$this->loadDeviceData();
-		// $this->stateManager->SetDevice($this->device);
-	}
-
-	/**
-	 * Returns the StateManager for the current device.
-	 *
-	 * @return StateManager
-	 */
-	public function GetStateManager() {
-		return $this->stateManager;
-	}
-
-	/*----------------------------------------------------------------------------------------------------------
+    // broken message indicators
+    public const MSG_BROKEN_UNKNOWN = 1;
+    public const MSG_BROKEN_CAUSINGLOOP = 2;
+    public const MSG_BROKEN_SEMANTICERR = 4;
+
+    public const FLD_SYNC_INITIALIZED = 1;
+    public const FLD_SYNC_INPROGRESS = 2;
+    public const FLD_SYNC_COMPLETED = 4;
+
+    // new types need to be added to Request::HEX_EXTENDED2 filter
+    public const FLD_ORIGIN_USER = "U";
+    public const FLD_ORIGIN_CONFIG = "C";
+    public const FLD_ORIGIN_SHARED = "S";
+    public const FLD_ORIGIN_GAB = "G";
+    public const FLD_ORIGIN_IMPERSONATED = "I";
+
+    public const FLD_FLAGS_NONE = 0;
+    public const FLD_FLAGS_SENDASOWNER = 1;
+    public const FLD_FLAGS_TRACKSHARENAME = 2;
+    public const FLD_FLAGS_CALENDARREMINDERS = 4;
+
+    private $device;
+    private $deviceHash;
+    private $saveDevice;
+    private $statemachine;
+    private $stateManager;
+    private $incomingData = 0;
+    private $outgoingData = 0;
+
+    private $windowSize;
+    private $latestFolder;
+
+    private $loopdetection;
+    private $hierarchySyncRequired;
+    private $additionalFoldersHash;
+
+    /**
+     * Constructor.
+     */
+    public function __construct() {
+        $this->statemachine = GSync::GetStateMachine();
+        $this->deviceHash = false;
+        $this->saveDevice = true;
+        $this->windowSize = [];
+        $this->latestFolder = false;
+        $this->hierarchySyncRequired = false;
+
+        // initialize InterProcess parameters
+        $this->allocate = 0;
+        $this->type = "grommunio-sync:devicesuser";
+        parent::__construct();
+        parent::initializeParams();
+        $this->stateManager = new StateManager();
+
+        // only continue if deviceid is set
+        if (self::$devid) {
+            $this->device = new ASDevice();
+            $this->device->Initialize(self::$devid, Request::GetDeviceType(), Request::GetGETUser(), Request::GetUserAgent());
+            $this->loadDeviceData();
+
+            GSync::GetTopCollector()->SetUserAgent($this->device->GetDeviceUserAgent());
+        }
+        else {
+            throw new FatalNotImplementedException("Can not proceed without a device id.");
+        }
+
+        $this->loopdetection = new LoopDetection();
+        $this->loopdetection->ProcessLoopDetectionInit();
+        $this->loopdetection->ProcessLoopDetectionPreviousConnectionFailed();
+
+        $this->additionalFoldersHash = $this->getAdditionalFoldersHash();
+    }
+
+    /**
+     * Load another different device.
+     *
+     * @param ASDevice $asDevice
+     */
+    public function SetDevice($asDevice) {
+        // TODO: this is broken and callers should be removed/updated. ASDevice is now always overwritten.
+        $this->device = $asDevice;
+        $this->loadDeviceData();
+        // $this->stateManager->SetDevice($this->device);
+    }
+
+    /**
+     * Returns the StateManager for the current device.
+     *
+     * @return StateManager
+     */
+    public function GetStateManager() {
+        return $this->stateManager;
+    }
+
+    /*----------------------------------------------------------------------------------------------------------
 	 * Device operations
 	 */
 
-	/**
-	 * Announces amount of transmitted data to the DeviceManager.
-	 *
-	 * @param int $datacounter
-	 *
-	 * @return bool
-	 */
-	public function SentData($datacounter) {
-		// TODO save this somewhere
-		$this->incomingData = Request::GetContentLength();
-		$this->outgoingData = $datacounter;
-
-		return true;
-	}
-
-	/**
-	 * Called at the end of the request
-	 * Statistics about received/sent data is saved here.
-	 *
-	 * @return bool
-	 */
-	public function Save() {
-		// TODO save other stuff
-
-		// check if previousily ignored messages were synchronized for the current folder
-		// on multifolder operations of AS14 this is done by setLatestFolder()
-		if ($this->latestFolder !== false) {
-			$this->checkBrokenMessages($this->latestFolder);
-		}
-
-		// update the user agent and AS version on the device
-		$this->device->SetUserAgent(Request::GetUserAgent());
-		$this->device->SetASVersion(Request::GetProtocolVersion());
-
-		// data to be saved
-		if ($this->device->IsDataChanged() && Request::IsValidDeviceID() && $this->saveDevice) {
-			SLog::Write(LOGLEVEL_DEBUG, "DeviceManager->Save(): Device data changed");
-
-			try {
-				// check if this is the first time the device data is saved and it is authenticated. If so, link the user to the device id
-				if ($this->device->IsNewDevice() && RequestProcessor::isUserAuthenticated()) {
-					SLog::Write(LOGLEVEL_INFO, sprintf("Linking device ID '%s' to user '%s'", self::$devid, $this->device->GetDeviceUser()));
-					$this->statemachine->LinkUserDevice($this->device->GetDeviceUser(), self::$devid);
-				}
-
-				if (RequestProcessor::isUserAuthenticated() || $this->device->GetForceSave()) {
-					$this->device->lastupdatetime = time();
-					$this->device->StripData();
-					$this->statemachine->SetState($this->device, self::$devid, IStateMachine::DEVICEDATA);
-
-					// update deviceuser stat in redis as well
-					$this->setDeviceUserData($this->type, [self::$user => $this->device], self::$devid, -1, $doCas = "merge");
-					SLog::Write(LOGLEVEL_DEBUG, "DeviceManager->Save(): Device data saved");
-				}
-			}
-			catch (StateNotFoundException $snfex) {
-				SLog::Write(LOGLEVEL_ERROR, "DeviceManager->Save(): Exception: " . $snfex->getMessage());
-			}
-		}
-
-		// remove old search data
-		$oldpid = $this->loopdetection->ProcessLoopDetectionGetOutdatedSearchPID();
-		if ($oldpid) {
-			GSync::GetBackend()->GetSearchProvider()->TerminateSearch($oldpid);
-		}
-
-		// we terminated this process
-		if ($this->loopdetection) {
-			$this->loopdetection->ProcessLoopDetectionTerminate();
-		}
-
-		return true;
-	}
-
-	/**
-	 * Sets if the AS Device should automatically be saved when terminating the request.
-	 *
-	 * @param bool $doSave
-	 */
-	public function DoAutomaticASDeviceSaving($doSave) {
-		SLog::Write(LOGLEVEL_DEBUG, "DeviceManager->DoAutomaticASDeviceSaving(): save automatically: " . Utils::PrintAsString($doSave));
-		$this->saveDevice = $doSave;
-	}
-
-	/**
-	 * Newer mobiles send extensive device information with the Settings command
-	 * These information are saved in the ASDevice.
-	 *
-	 * @param SyncDeviceInformation $deviceinformation
-	 *
-	 * @return bool
-	 */
-	public function SaveDeviceInformation($deviceinformation) {
-		SLog::Write(LOGLEVEL_DEBUG, "Saving submitted device information");
-
-		// set the user agent
-		if (isset($deviceinformation->useragent)) {
-			$this->device->SetUserAgent($deviceinformation->useragent);
-		}
-
-		// save other information
-		foreach (["model", "imei", "friendlyname", "os", "oslanguage", "phonenumber", "mobileoperator", "enableoutboundsms"] as $info) {
-			if (isset($deviceinformation->{$info}) && $deviceinformation->{$info} != "") {
-				$this->device->__set("device" . $info, $deviceinformation->{$info});
-			}
-		}
-
-		return true;
-	}
-
-	/*----------------------------------------------------------------------------------------------------------
+    /**
+     * Announces amount of transmitted data to the DeviceManager.
+     *
+     * @param int $datacounter
+     *
+     * @return bool
+     */
+    public function SentData($datacounter) {
+        // TODO save this somewhere
+        $this->incomingData = Request::GetContentLength();
+        $this->outgoingData = $datacounter;
+
+        return true;
+    }
+
+    /**
+     * Called at the end of the request
+     * Statistics about received/sent data is saved here.
+     *
+     * @return bool
+     */
+    public function Save() {
+        // TODO save other stuff
+
+        // check if previousily ignored messages were synchronized for the current folder
+        // on multifolder operations of AS14 this is done by setLatestFolder()
+        if ($this->latestFolder !== false) {
+            $this->checkBrokenMessages($this->latestFolder);
+        }
+
+        // update the user agent and AS version on the device
+        $this->device->SetUserAgent(Request::GetUserAgent());
+        $this->device->SetASVersion(Request::GetProtocolVersion());
+
+        // data to be saved
+        if ($this->device->IsDataChanged() && Request::IsValidDeviceID() && $this->saveDevice) {
+            SLog::Write(LOGLEVEL_DEBUG, "DeviceManager->Save(): Device data changed");
+
+            try {
+                // check if this is the first time the device data is saved and it is authenticated. If so, link the user to the device id
+                if ($this->device->IsNewDevice() && RequestProcessor::isUserAuthenticated()) {
+                    SLog::Write(LOGLEVEL_INFO, sprintf("Linking device ID '%s' to user '%s'", self::$devid, $this->device->GetDeviceUser()));
+                    $this->statemachine->LinkUserDevice($this->device->GetDeviceUser(), self::$devid);
+                }
+
+                if (RequestProcessor::isUserAuthenticated() || $this->device->GetForceSave()) {
+                    $this->device->lastupdatetime = time();
+                    $this->device->StripData();
+                    $this->statemachine->SetState($this->device, self::$devid, IStateMachine::DEVICEDATA);
+
+                    // update deviceuser stat in redis as well
+                    $this->setDeviceUserData($this->type, [self::$user => $this->device], self::$devid, -1, $doCas = "merge");
+                    SLog::Write(LOGLEVEL_DEBUG, "DeviceManager->Save(): Device data saved");
+                }
+            }
+            catch (StateNotFoundException $snfex) {
+                SLog::Write(LOGLEVEL_ERROR, "DeviceManager->Save(): Exception: " . $snfex->getMessage());
+            }
+        }
+
+        // remove old search data
+        $oldpid = $this->loopdetection->ProcessLoopDetectionGetOutdatedSearchPID();
+        if ($oldpid) {
+            GSync::GetBackend()->GetSearchProvider()->TerminateSearch($oldpid);
+        }
+
+        // we terminated this process
+        if ($this->loopdetection) {
+            $this->loopdetection->ProcessLoopDetectionTerminate();
+        }
+
+        return true;
+    }
+
+    /**
+     * Sets if the AS Device should automatically be saved when terminating the request.
+     *
+     * @param bool $doSave
+     */
+    public function DoAutomaticASDeviceSaving($doSave) {
+        SLog::Write(LOGLEVEL_DEBUG, "DeviceManager->DoAutomaticASDeviceSaving(): save automatically: " . Utils::PrintAsString($doSave));
+        $this->saveDevice = $doSave;
+    }
+
+    /**
+     * Newer mobiles send extensive device information with the Settings command
+     * These information are saved in the ASDevice.
+     *
+     * @param SyncDeviceInformation $deviceinformation
+     *
+     * @return bool
+     */
+    public function SaveDeviceInformation($deviceinformation) {
+        SLog::Write(LOGLEVEL_DEBUG, "Saving submitted device information");
+
+        // set the user agent
+        if (isset($deviceinformation->useragent)) {
+            $this->device->SetUserAgent($deviceinformation->useragent);
+        }
+
+        // save other information
+        foreach (["model", "imei", "friendlyname", "os", "oslanguage", "phonenumber", "mobileoperator", "enableoutboundsms"] as $info) {
+            if (isset($deviceinformation->{$info}) && $deviceinformation->{$info} != "") {
+                $this->device->__set("device" . $info, $deviceinformation->{$info});
+            }
+        }
+
+        return true;
+    }
+
+    /*----------------------------------------------------------------------------------------------------------
 	 * LEGACY AS 1.0 and WRAPPER operations
 	 */
 
-	/**
-	 * Returns a wrapped Importer & Exporter to use the
-	 * HierarchyChache.
-	 *
-	 * @see ChangesMemoryWrapper
-	 *
-	 * @return object HierarchyCache
-	 */
-	public function GetHierarchyChangesWrapper() {
-		return $this->device->GetHierarchyCache();
-	}
-
-	/**
-	 * Initializes the HierarchyCache for legacy syncs
-	 * this is for AS 1.0 compatibility:
-	 *      save folder information synched with GetHierarchy().
-	 *
-	 * @param string $folders Array with folder information
-	 *
-	 * @return bool
-	 */
-	public function InitializeFolderCache($folders) {
-		$this->stateManager->SetDevice($this->device);
-
-		return $this->stateManager->InitializeFolderCache($folders);
-	}
-
-	/**
-	 * Returns the ActiveSync folder type for a FolderID.
-	 *
-	 * @param string $folderid
-	 *
-	 * @return int/boolean        boolean if no type is found
-	 */
-	public function GetFolderTypeFromCacheById($folderid) {
-		return $this->device->GetFolderType($folderid);
-	}
-
-	/**
-	 * Returns a FolderID of default classes
-	 * this is for AS 1.0 compatibility:
-	 *      this information was made available during GetHierarchy().
-	 *
-	 * @param string $class The class requested
-	 *
-	 * @throws NoHierarchyCacheAvailableException
-	 *
-	 * @return string
-	 */
-	public function GetFolderIdFromCacheByClass($class) {
-		$folderidforClass = false;
-		// look at the default foldertype for this class
-		$type = GSync::getDefaultFolderTypeFromFolderClass($class);
-
-		if ($type && $type > SYNC_FOLDER_TYPE_OTHER && $type < SYNC_FOLDER_TYPE_USER_MAIL) {
-			$folderids = $this->device->GetAllFolderIds();
-			foreach ($folderids as $folderid) {
-				if ($type == $this->device->GetFolderType($folderid)) {
-					$folderidforClass = $folderid;
-
-					break;
-				}
-			}
-
-			// Old Palm Treos always do initial sync for calendar and contacts, even if they are not made available by the backend.
-			// We need to fake these folderids, allowing a fake sync/ping, even if they are not supported by the backend
-			// if the folderid would be available, they would already be returned in the above statement
-			if ($folderidforClass == false && ($type == SYNC_FOLDER_TYPE_APPOINTMENT || $type == SYNC_FOLDER_TYPE_CONTACT)) {
-				$folderidforClass = SYNC_FOLDER_TYPE_DUMMY;
-			}
-		}
-
-		SLog::Write(LOGLEVEL_DEBUG, sprintf("DeviceManager->GetFolderIdFromCacheByClass('%s'): '%s' => '%s'", $class, $type, $folderidforClass));
-
-		return $folderidforClass;
-	}
-
-	/**
-	 * Returns a FolderClass for a FolderID which is known to the mobile.
-	 *
-	 * @param string $folderid
-	 *
-	 * @throws NoHierarchyCacheAvailableException, NotImplementedException
-	 *
-	 * @return int
-	 */
-	public function GetFolderClassFromCacheByID($folderid) {
-		// TODO check if the parent folder exists and is also being synchronized
-		$typeFromCache = $this->device->GetFolderType($folderid);
-		if ($typeFromCache === false) {
-			throw new NoHierarchyCacheAvailableException(sprintf("Folderid '%s' is not fully synchronized on the device", $folderid));
-		}
-
-		$class = GSync::GetFolderClassFromFolderType($typeFromCache);
-		if ($class === false) {
-			throw new NotImplementedException(sprintf("Folderid '%s' is saved to be of type '%d' but this type is not implemented", $folderid, $typeFromCache));
-		}
-
-		return $class;
-	}
-
-	/**
-	 * Returns the additional folders as SyncFolder objects.
-	 *
-	 * @return array of SyncFolder with backendids as keys
-	 */
-	public function GetAdditionalUserSyncFolders() {
-		$folders = [];
-
-		// In impersonated stores, no additional folders will be synchronized
-		if (Request::GetImpersonatedUser()) {
-			return $folders;
-		}
-
-		foreach ($this->device->GetAdditionalFolders() as $df) {
-			if (!isset($df['flags'])) {
-				$df['flags'] = 0;
-				SLog::Write(LOGLEVEL_WARN, sprintf("DeviceManager->GetAdditionalUserSyncFolders(): Additional folder '%s' has no flags.", $df['name']));
-			}
-			if (!isset($df['parentid'])) {
-				$df['parentid'] = '0';
-				SLog::Write(LOGLEVEL_WARN, sprintf("DeviceManager->GetAdditionalUserSyncFolders(): Additional folder '%s' has no parentid.", $df['name']));
-			}
-
-			$folder = $this->BuildSyncFolderObject($df['store'], $df['folderid'], $df['parentid'], $df['name'], $df['type'], $df['flags'], DeviceManager::FLD_ORIGIN_SHARED);
-			$folders[$folder->BackendId] = $folder;
-		}
-
-		return $folders;
-	}
-
-	/**
-	 * Get the store of an additional folder.
-	 *
-	 * @param string $folderid
-	 *
-	 * @return bool|string
-	 */
-	public function GetAdditionalUserSyncFolder($folderid) {
-		$f = $this->device->GetAdditionalFolder($folderid);
-		if ($f) {
-			return $f;
-		}
-
-		return false;
-	}
-
-	/**
-	 * Checks if the message should be streamed to a mobile
-	 * Should always be called before a message is sent to the mobile
-	 * Returns true if there is something wrong and the content could break the
-	 * synchronization.
-	 *
-	 * @param string     $id       message id
-	 * @param SyncObject &$message the method could edit the message to change the flags
-	 *
-	 * @return bool returns true if the message should NOT be send!
-	 */
-	public function DoNotStreamMessage($id, &$message) {
-		$folderid = $this->getLatestFolder();
-
-		if (isset($message->parentid)) {
-			$folder = $message->parentid;
-		}
-
-		// message was identified to be causing a loop
-		if ($this->loopdetection->IgnoreNextMessage(true, $id, $folderid)) {
-			$this->AnnounceIgnoredMessage($folderid, $id, $message, self::MSG_BROKEN_CAUSINGLOOP);
-
-			return true;
-		}
-
-		// message is semantically incorrect
-		if (!$message->Check(true)) {
-			$this->AnnounceIgnoredMessage($folderid, $id, $message, self::MSG_BROKEN_SEMANTICERR);
-
-			return true;
-		}
-
-		// check if this message is broken
-		if ($this->device->HasIgnoredMessage($folderid, $id)) {
-			// reset the flags so the message is always streamed with <Add>
-			$message->flags = false;
-
-			// track the broken message in the loop detection
-			$this->loopdetection->SetBrokenMessage($folderid, $id);
-		}
-
-		return false;
-	}
-
-	/**
-	 * Removes device information about a broken message as it is been removed from the mobile.
-	 *
-	 * @param string $id message id
-	 *
-	 * @return bool
-	 */
-	public function RemoveBrokenMessage($id) {
-		$folderid = $this->getLatestFolder();
-		if ($this->device->RemoveIgnoredMessage($folderid, $id)) {
-			SLog::Write(LOGLEVEL_INFO, sprintf("DeviceManager->RemoveBrokenMessage('%s', '%s'): cleared data about previously ignored message", $folderid, $id));
-
-			return true;
-		}
-
-		return false;
-	}
-
-	/**
-	 * Amount of items to me synchronized.
-	 *
-	 * @param string $folderid
-	 * @param string $type
-	 * @param int    $queuedmessages;
-	 * @param mixed  $uuid
-	 * @param mixed  $statecounter
-	 *
-	 * @return int
-	 */
-	public function GetWindowSize($folderid, $uuid, $statecounter, $queuedmessages) {
-		if (isset($this->windowSize[$folderid])) {
-			$items = $this->windowSize[$folderid];
-		}
-		else {
-			$items = WINDOW_SIZE_MAX;
-		} // 512 by default
-
-		$this->setLatestFolder($folderid);
-
-		// detect if this is a loop condition
-		$loop = $this->loopdetection->Detect($folderid, $uuid, $statecounter, $items, $queuedmessages);
-		if ($loop !== false) {
-			if ($loop === true) {
-				$items = ($items == 0) ? 0 : 1 + ($this->loopdetection->IgnoreNextMessage(false) ? 1 : 0);
-			}
-			else {
-				// we got a new suggested window size
-				$items = $loop;
-				SLog::Write(LOGLEVEL_DEBUG, sprintf("Mobile loop pre stage detected! Forcing smaller window size of %d before entering loop detection mode", $items));
-			}
-		}
-
-		if ($items >= 0 && $items <= 2) {
-			SLog::Write(LOGLEVEL_WARN, sprintf("Mobile loop detected! Messages sent to the mobile will be restricted to %d items in order to identify the conflict", $items));
-		}
-
-		return $items;
-	}
-
-	/**
-	 * Sets the amount of items the device is requesting.
-	 *
-	 * @param string $folderid
-	 * @param int    $maxItems
-	 *
-	 * @return bool
-	 */
-	public function SetWindowSize($folderid, $maxItems) {
-		$this->windowSize[$folderid] = $maxItems;
-
-		return true;
-	}
-
-	/**
-	 * Sets the supported fields transmitted by the device for a certain folder.
-	 *
-	 * @param string $folderid
-	 * @param array  $fieldlist supported fields
-	 *
-	 * @return bool
-	 */
-	public function SetSupportedFields($folderid, $fieldlist) {
-		return $this->device->SetSupportedFields($folderid, $fieldlist);
-	}
-
-	/**
-	 * Gets the supported fields transmitted previously by the device
-	 * for a certain folder.
-	 *
-	 * @param string $folderid
-	 *
-	 * @return array/boolean
-	 */
-	public function GetSupportedFields($folderid) {
-		return $this->device->GetSupportedFields($folderid);
-	}
-
-	/**
-	 * Returns the maximum filter type for a folder.
-	 * This might be limited globally, per device or per folder.
-	 *
-	 * @param string $folderid
-	 * @param mixed  $backendFolderId
-	 *
-	 * @return int
-	 */
-	public function GetFilterType($folderid, $backendFolderId) {
-		global $specialSyncFilter;
-		// either globally configured SYNC_FILTERTIME_MAX or ALL (no limit)
-		$maxAllowed = (defined('SYNC_FILTERTIME_MAX') && SYNC_FILTERTIME_MAX > SYNC_FILTERTYPE_ALL) ? SYNC_FILTERTIME_MAX : SYNC_FILTERTYPE_ALL;
-
-		// TODO we could/should check for a specific value for the folder, if it's available
-		$maxDevice = $this->device->GetSyncFilterType();
-
-		// ALL has a value of 0, all limitations have higher integer values, see SYNC_FILTERTYPE_ALL definition
-		if ($maxDevice !== false && $maxDevice > SYNC_FILTERTYPE_ALL && ($maxAllowed == SYNC_FILTERTYPE_ALL || $maxDevice < $maxAllowed)) {
-			$maxAllowed = $maxDevice;
-		}
-
-		if (is_array($specialSyncFilter)) {
-			$store = GSync::GetAdditionalSyncFolderStore($backendFolderId);
-			// the store is only available when this is a shared folder (but might also be statically configured)
-			if ($store) {
-				$origin = Utils::GetFolderOriginFromId($folderid);
-				// do not limit when the owner or impersonated user is syncing!
-				if ($origin == DeviceManager::FLD_ORIGIN_USER || $origin == DeviceManager::FLD_ORIGIN_IMPERSONATED) {
-					SLog::Write(LOGLEVEL_DEBUG, "Not checking for specific sync limit as this is the owner/impersonated user.");
-				}
-				else {
-					$spKey = false;
-					$spFilter = false;
-					// 1. step: check if there is a general limitation for the store
-					if (array_key_exists($store, $specialSyncFilter)) {
-						$spFilter = $specialSyncFilter[$store];
-						SLog::Write(LOGLEVEL_DEBUG, sprintf("Limit sync due to configured limitation on the store: '%s': %s", $store, $spFilter));
-					}
-
-					// 2. step: check if there is a limitation for the hashed ID (for shared/configured stores)
-					$spKey = $store . '/' . $folderid;
-					if (array_key_exists($spKey, $specialSyncFilter)) {
-						$spFilter = $specialSyncFilter[$spKey];
-						SLog::Write(LOGLEVEL_DEBUG, sprintf("Limit sync due to configured limitation on the folder: '%s': %s", $spKey, $spFilter));
-					}
-
-					// 3. step: check if there is a limitation for the backendId
-					$spKey = $store . '/' . $backendFolderId;
-					if (array_key_exists($spKey, $specialSyncFilter)) {
-						$spFilter = $specialSyncFilter[$spKey];
-						SLog::Write(LOGLEVEL_DEBUG, sprintf("Limit sync due to configured limitation on the folder: '%s': %s", $spKey, $spFilter));
-					}
-					if ($spFilter) {
-						$maxAllowed = $spFilter;
-					}
-				}
-			}
-		}
-
-		return $maxAllowed;
-	}
-
-	/**
-	 * Removes all linked states of a specific folder.
-	 * During next request the folder is resynchronized.
-	 *
-	 * @param string $folderid
-	 *
-	 * @return bool
-	 */
-	public function ForceFolderResync($folderid) {
-		SLog::Write(LOGLEVEL_INFO, sprintf("DeviceManager->ForceFolderResync('%s'): folder resync", $folderid));
-
-		// delete folder states
-		StateManager::UnLinkState($this->device, $folderid);
-
-		return true;
-	}
-
-	/**
-	 * Removes all linked states from a device.
-	 * During next requests a full resync is triggered.
-	 *
-	 * @return bool
-	 */
-	public function ForceFullResync() {
-		SLog::Write(LOGLEVEL_INFO, "Full device resync requested");
-
-		// delete all other uuids
-		foreach ($this->device->GetAllFolderIds() as $folderid) {
-			$uuid = StateManager::UnLinkState($this->device, $folderid);
-		}
-
-		// delete hierarchy states
-		StateManager::UnLinkState($this->device, false);
-
-		return true;
-	}
-
-	/**
-	 * Indicates if the hierarchy should be resynchronized based on the general folder state and
-	 * if additional folders changed.
-	 *
-	 * @return bool
-	 */
-	public function IsHierarchySyncRequired() {
-		$this->loadDeviceData();
-
-		if ($this->loopdetection->ProcessLoopDetectionIsHierarchySyncAdvised()) {
-			return true;
-		}
-
-		// if the hash of the additional folders changed, we have to sync the hierarchy
-		if ($this->additionalFoldersHash != $this->getAdditionalFoldersHash()) {
-			$this->hierarchySyncRequired = true;
-		}
-
-		// check if a hierarchy sync might be necessary
-		if ($this->device->GetFolderUUID(false) === false) {
-			$this->hierarchySyncRequired = true;
-		}
-
-		return $this->hierarchySyncRequired;
-	}
-
-	private function getAdditionalFoldersHash() {
-		return md5(serialize($this->device->GetAdditionalFolders()));
-	}
-
-	/**
-	 * Indicates if a full hierarchy resync should be triggered due to loops.
-	 *
-	 * @return bool
-	 */
-	public function IsHierarchyFullResyncRequired() {
-		// do not check for loop detection, if the foldersync is not yet complete
-		if ($this->GetFolderSyncComplete() === false) {
-			SLog::Write(LOGLEVEL_INFO, "DeviceManager->IsHierarchyFullResyncRequired(): aborted, as exporting of folders has not yet completed");
-
-			return false;
-		}
-		// check for potential process loops like described in ZP-5
-		return $this->loopdetection->ProcessLoopDetectionIsHierarchyResyncRequired();
-	}
-
-	/**
-	 * Adds an Exceptions to the process tracking.
-	 *
-	 * @param Exception $exception
-	 *
-	 * @return bool
-	 */
-	public function AnnounceProcessException($exception) {
-		return $this->loopdetection->ProcessLoopDetectionAddException($exception);
-	}
-
-	/**
-	 * Adds a non-ok status for a folderid to the process tracking.
-	 * On 'false' a hierarchy status is assumed.
-	 *
-	 * @param mixed $folderid
-	 * @param mixed $status
-	 *
-	 * @return bool
-	 */
-	public function AnnounceProcessStatus($folderid, $status) {
-		return $this->loopdetection->ProcessLoopDetectionAddStatus($folderid, $status);
-	}
-
-	/**
-	 * Announces that the current process is a push connection to the process loop
-	 * detection and to the Top collector.
-	 *
-	 * @return bool
-	 */
-	public function AnnounceProcessAsPush() {
-		SLog::Write(LOGLEVEL_DEBUG, "Announce process as PUSH connection");
-
-		return $this->loopdetection->ProcessLoopDetectionSetAsPush() && GSync::GetTopCollector()->SetAsPushConnection();
-	}
-
-	/**
-	 * Checks if the given counter for a certain uuid+folderid was already exported or modified.
-	 * This is called when a heartbeat request found changes to make sure that the same
-	 * changes are not exported twice, as during the heartbeat there could have been a normal
-	 * sync request.
-	 *
-	 * @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 CheckHearbeatStateIntegrity($folderid, $uuid, $counter) {
-		return $this->loopdetection->IsSyncStateObsolete($folderid, $uuid, $counter);
-	}
-
-	/**
-	 * Marks a syncstate as obsolete for Heartbeat, as e.g. an import was started using it.
-	 *
-	 * @param string $folderid folder id
-	 * @param string $uuid     synkkey
-	 * @param string $counter  synckey counter
-	 *
-	 * @return
-	 */
-	public function SetHeartbeatStateIntegrity($folderid, $uuid, $counter) {
-		return $this->loopdetection->SetSyncStateUsage($folderid, $uuid, $counter);
-	}
-
-	/**
-	 * Checks the data integrity of the data in the hierarchy cache and the data of the content data (synchronized folders).
-	 * If a folder is deleted, the sync states could still be on the server (and being loaded by PING) while
-	 * the folder is not being synchronized anymore. See also https://jira.z-hub.io/browse/ZP-1077.
-	 *
-	 * @return bool
-	 */
-	public function CheckFolderData() {
-		SLog::Write(LOGLEVEL_DEBUG, "DeviceManager->CheckFolderData() checking integrity of hierarchy cache with synchronized folders");
-
-		$hc = $this->device->GetHierarchyCache();
-		$notInCache = [];
-		foreach ($this->device->GetAllFolderIds() as $folderid) {
-			$uuid = $this->device->GetFolderUUID($folderid);
-			if ($uuid) {
-				// has a UUID but is not in the cache?! This is deleted, remove the states.
-				if (!$hc->GetFolder($folderid)) {
-					SLog::Write(LOGLEVEL_WARN, sprintf("DeviceManager->CheckFolderData(): Folder '%s' has sync states but is not in the hierarchy cache. Removing states.", $folderid));
-					StateManager::UnLinkState($this->device, $folderid);
-				}
-			}
-		}
-
-		return true;
-	}
-
-	/**
-	 * Sets the current status of the folder.
-	 *
-	 * @param string $folderid   folder id
-	 * @param int    $statusflag current status: DeviceManager::FLD_SYNC_INITIALIZED, DeviceManager::FLD_SYNC_INPROGRESS, DeviceManager::FLD_SYNC_COMPLETED
-	 *
-	 * @return
-	 */
-	public function SetFolderSyncStatus($folderid, $statusflag) {
-		$currentStatus = $this->device->GetFolderSyncStatus($folderid);
-
-		// status available or just initialized
-		if (isset($currentStatus->{ASDevice::FOLDERSYNCSTATUS}) || $statusflag == self::FLD_SYNC_INITIALIZED) {
-			// only update if there is a change
-			if ((!$currentStatus || (isset($currentStatus->{ASDevice::FOLDERSYNCSTATUS}) && $statusflag !== $currentStatus->{ASDevice::FOLDERSYNCSTATUS})) &&
-					$statusflag != self::FLD_SYNC_COMPLETED) {
-				$this->device->SetFolderSyncStatus($folderid, $statusflag);
-				SLog::Write(LOGLEVEL_DEBUG, sprintf("SetFolderSyncStatus(): set %s for %s", $statusflag, $folderid));
-			}
-			// if completed, remove the status
-			elseif ($statusflag == self::FLD_SYNC_COMPLETED) {
-				$this->device->SetFolderSyncStatus($folderid, false);
-				SLog::Write(LOGLEVEL_DEBUG, sprintf("SetFolderSyncStatus(): completed for %s", $folderid));
-			}
-		}
-
-		return true;
-	}
-
-	/**
-	 * Indicates if a folder is synchronizing by the saved status.
-	 *
-	 * @param string $folderid folder id
-	 *
-	 * @return bool
-	 */
-	public function HasFolderSyncStatus($folderid) {
-		$currentStatus = $this->device->GetFolderSyncStatus($folderid);
-
-		// status available ?
-		$hasStatus = isset($currentStatus->{ASDevice::FOLDERSYNCSTATUS});
-		if ($hasStatus) {
-			SLog::Write(LOGLEVEL_DEBUG, sprintf("HasFolderSyncStatus(): saved folder status for %s: %s", $folderid, $currentStatus->{ASDevice::FOLDERSYNCSTATUS}));
-		}
-
-		return $hasStatus;
-	}
-
-	/**
-	 * Returns the indicator if the FolderSync was completed successfully  (all folders synchronized).
-	 *
-	 * @return bool
-	 */
-	public function GetFolderSyncComplete() {
-		return $this->device->GetFolderSyncComplete();
-	}
-
-	/**
-	 * Sets if the FolderSync was completed successfully (all folders synchronized).
-	 *
-	 * @param bool  $complete indicating if all folders were sent
-	 * @param mixed $user
-	 * @param mixed $devid
-	 *
-	 * @return bool
-	 */
-	public function SetFolderSyncComplete($complete, $user = false, $devid = false) {
-		$this->device->SetFolderSyncComplete($complete);
-
-		return true;
-	}
-
-	/**
-	 * Removes the Loop detection data for a user & device.
-	 *
-	 * @param string $user
-	 * @param string $devid
-	 *
-	 * @return bool
-	 */
-	public function ClearLoopDetectionData($user, $devid) {
-		if ($user == false || $devid == false) {
-			return false;
-		}
-		SLog::Write(LOGLEVEL_DEBUG, sprintf("DeviceManager->ClearLoopDetectionData(): clearing data for user '%s' and device '%s'", $user, $devid));
-
-		return $this->loopdetection->ClearData($user, $devid);
-	}
-
-	/**
-	 * Indicates if the device needs an AS version update.
-	 *
-	 * @return bool
-	 */
-	public function AnnounceASVersion() {
-		$latest = GSync::GetSupportedASVersion();
-		$announced = $this->device->GetAnnouncedASversion();
-		$this->device->SetAnnouncedASversion($latest);
-
-		return $announced != $latest;
-	}
-
-	/**
-	 * Returns the User Agent. This data is consolidated with data from Request::GetUserAgent()
-	 * and the data saved in the ASDevice.
-	 *
-	 * @return string
-	 */
-	public function GetUserAgent() {
-		return $this->device->GetDeviceUserAgent();
-	}
-
-	/**
-	 * Returns the backend folder id from the AS folderid known to the mobile.
-	 * If the id is not known, it's returned as is.
-	 *
-	 * @param mixed $folderid
-	 *
-	 * @return int/boolean  returns false if the type is not set
-	 */
-	public function GetBackendIdForFolderId($folderid) {
-		$backendId = $this->device->GetFolderBackendId($folderid);
-		if (!$backendId) {
-			SLog::Write(LOGLEVEL_DEBUG, sprintf("DeviceManager->GetBackendIdForFolderId(): no backend-folderid available for '%s', returning as is.", $folderid));
-
-			return $folderid;
-		}
-		SLog::Write(LOGLEVEL_DEBUG, sprintf("DeviceManager->GetBackendIdForFolderId(): folderid %s => %s", $folderid, $backendId));
-
-		return $backendId;
-	}
-
-	/**
-	 * Gets the AS folderid for a backendFolderId.
-	 * If there is no known AS folderId a new one is being created.
-	 *
-	 * @param string $backendid          Backend folder id
-	 * @param bool   $generateNewIdIfNew generates a new AS folderid for the case the backend folder is not known yet, default: false
-	 * @param string $folderOrigin       Folder type is one of   'U' (user)
-	 *                                   'C' (configured)
-	 *                                   'S' (shared)
-	 *                                   'G' (global address book)
-	 *                                   'I' (impersonated)
-	 * @param string $folderName         Folder name of the backend folder
-	 *
-	 * @return string/boolean  returns false if there is folderid known for this backendid and $generateNewIdIfNew is not set or false
-	 */
-	public function GetFolderIdForBackendId($backendid, $generateNewIdIfNew = false, $folderOrigin = self::FLD_ORIGIN_USER, $folderName = null) {
-		if (!in_array($folderOrigin, [DeviceManager::FLD_ORIGIN_CONFIG, DeviceManager::FLD_ORIGIN_GAB, DeviceManager::FLD_ORIGIN_SHARED, DeviceManager::FLD_ORIGIN_USER, DeviceManager::FLD_ORIGIN_IMPERSONATED])) {
-			SLog::Write(LOGLEVEL_WARN, sprintf("ASDevice->GetFolderIdForBackendId(): folder type '%s' is unknown in DeviceManager", $folderOrigin));
-		}
-
-		return $this->device->GetFolderIdForBackendId($backendid, $generateNewIdIfNew, $folderOrigin, $folderName);
-	}
-
-	/*----------------------------------------------------------------------------------------------------------
+    /**
+     * Returns a wrapped Importer & Exporter to use the
+     * HierarchyChache.
+     *
+     * @see ChangesMemoryWrapper
+     *
+     * @return object HierarchyCache
+     */
+    public function GetHierarchyChangesWrapper() {
+        return $this->device->GetHierarchyCache();
+    }
+
+    /**
+     * Initializes the HierarchyCache for legacy syncs
+     * this is for AS 1.0 compatibility:
+     *      save folder information synched with GetHierarchy().
+     *
+     * @param string $folders Array with folder information
+     *
+     * @return bool
+     */
+    public function InitializeFolderCache($folders) {
+        $this->stateManager->SetDevice($this->device);
+
+        return $this->stateManager->InitializeFolderCache($folders);
+    }
+
+    /**
+     * Returns the ActiveSync folder type for a FolderID.
+     *
+     * @param string $folderid
+     *
+     * @return int/boolean        boolean if no type is found
+     */
+    public function GetFolderTypeFromCacheById($folderid) {
+        return $this->device->GetFolderType($folderid);
+    }
+
+    /**
+     * Returns a FolderID of default classes
+     * this is for AS 1.0 compatibility:
+     *      this information was made available during GetHierarchy().
+     *
+     * @param string $class The class requested
+     *
+     * @throws NoHierarchyCacheAvailableException
+     *
+     * @return string
+     */
+    public function GetFolderIdFromCacheByClass($class) {
+        $folderidforClass = false;
+        // look at the default foldertype for this class
+        $type = GSync::getDefaultFolderTypeFromFolderClass($class);
+
+        if ($type && $type > SYNC_FOLDER_TYPE_OTHER && $type < SYNC_FOLDER_TYPE_USER_MAIL) {
+            $folderids = $this->device->GetAllFolderIds();
+            foreach ($folderids as $folderid) {
+                if ($type == $this->device->GetFolderType($folderid)) {
+                    $folderidforClass = $folderid;
+
+                    break;
+                }
+            }
+
+            // Old Palm Treos always do initial sync for calendar and contacts, even if they are not made available by the backend.
+            // We need to fake these folderids, allowing a fake sync/ping, even if they are not supported by the backend
+            // if the folderid would be available, they would already be returned in the above statement
+            if ($folderidforClass == false && ($type == SYNC_FOLDER_TYPE_APPOINTMENT || $type == SYNC_FOLDER_TYPE_CONTACT)) {
+                $folderidforClass = SYNC_FOLDER_TYPE_DUMMY;
+            }
+        }
+
+        SLog::Write(LOGLEVEL_DEBUG, sprintf("DeviceManager->GetFolderIdFromCacheByClass('%s'): '%s' => '%s'", $class, $type, $folderidforClass));
+
+        return $folderidforClass;
+    }
+
+    /**
+     * Returns a FolderClass for a FolderID which is known to the mobile.
+     *
+     * @param string $folderid
+     *
+     * @throws NoHierarchyCacheAvailableException, NotImplementedException
+     *
+     * @return int
+     */
+    public function GetFolderClassFromCacheByID($folderid) {
+        // TODO check if the parent folder exists and is also being synchronized
+        $typeFromCache = $this->device->GetFolderType($folderid);
+        if ($typeFromCache === false) {
+            throw new NoHierarchyCacheAvailableException(sprintf("Folderid '%s' is not fully synchronized on the device", $folderid));
+        }
+
+        $class = GSync::GetFolderClassFromFolderType($typeFromCache);
+        if ($class === false) {
+            throw new NotImplementedException(sprintf("Folderid '%s' is saved to be of type '%d' but this type is not implemented", $folderid, $typeFromCache));
+        }
+
+        return $class;
+    }
+
+    /**
+     * Returns the additional folders as SyncFolder objects.
+     *
+     * @return array of SyncFolder with backendids as keys
+     */
+    public function GetAdditionalUserSyncFolders() {
+        $folders = [];
+
+        // In impersonated stores, no additional folders will be synchronized
+        if (Request::GetImpersonatedUser()) {
+            return $folders;
+        }
+
+        foreach ($this->device->GetAdditionalFolders() as $df) {
+            if (!isset($df['flags'])) {
+                $df['flags'] = 0;
+                SLog::Write(LOGLEVEL_WARN, sprintf("DeviceManager->GetAdditionalUserSyncFolders(): Additional folder '%s' has no flags.", $df['name']));
+            }
+            if (!isset($df['parentid'])) {
+                $df['parentid'] = '0';
+                SLog::Write(LOGLEVEL_WARN, sprintf("DeviceManager->GetAdditionalUserSyncFolders(): Additional folder '%s' has no parentid.", $df['name']));
+            }
+
+            $folder = $this->BuildSyncFolderObject($df['store'], $df['folderid'], $df['parentid'], $df['name'], $df['type'], $df['flags'], DeviceManager::FLD_ORIGIN_SHARED);
+            $folders[$folder->BackendId] = $folder;
+        }
+
+        return $folders;
+    }
+
+    /**
+     * Get the store of an additional folder.
+     *
+     * @param string $folderid
+     *
+     * @return bool|string
+     */
+    public function GetAdditionalUserSyncFolder($folderid) {
+        $f = $this->device->GetAdditionalFolder($folderid);
+        if ($f) {
+            return $f;
+        }
+
+        return false;
+    }
+
+    /**
+     * Checks if the message should be streamed to a mobile
+     * Should always be called before a message is sent to the mobile
+     * Returns true if there is something wrong and the content could break the
+     * synchronization.
+     *
+     * @param string     $id       message id
+     * @param SyncObject &$message the method could edit the message to change the flags
+     *
+     * @return bool returns true if the message should NOT be send!
+     */
+    public function DoNotStreamMessage($id, &$message) {
+        $folderid = $this->getLatestFolder();
+
+        if (isset($message->parentid)) {
+            $folder = $message->parentid;
+        }
+
+        // message was identified to be causing a loop
+        if ($this->loopdetection->IgnoreNextMessage(true, $id, $folderid)) {
+            $this->AnnounceIgnoredMessage($folderid, $id, $message, self::MSG_BROKEN_CAUSINGLOOP);
+
+            return true;
+        }
+
+        // message is semantically incorrect
+        if (!$message->Check(true)) {
+            $this->AnnounceIgnoredMessage($folderid, $id, $message, self::MSG_BROKEN_SEMANTICERR);
+
+            return true;
+        }
+
+        // check if this message is broken
+        if ($this->device->HasIgnoredMessage($folderid, $id)) {
+            // reset the flags so the message is always streamed with <Add>
+            $message->flags = false;
+
+            // track the broken message in the loop detection
+            $this->loopdetection->SetBrokenMessage($folderid, $id);
+        }
+
+        return false;
+    }
+
+    /**
+     * Removes device information about a broken message as it is been removed from the mobile.
+     *
+     * @param string $id message id
+     *
+     * @return bool
+     */
+    public function RemoveBrokenMessage($id) {
+        $folderid = $this->getLatestFolder();
+        if ($this->device->RemoveIgnoredMessage($folderid, $id)) {
+            SLog::Write(LOGLEVEL_INFO, sprintf("DeviceManager->RemoveBrokenMessage('%s', '%s'): cleared data about previously ignored message", $folderid, $id));
+
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * Amount of items to me synchronized.
+     *
+     * @param string $folderid
+     * @param string $type
+     * @param int    $queuedmessages;
+     * @param mixed  $uuid
+     * @param mixed  $statecounter
+     *
+     * @return int
+     */
+    public function GetWindowSize($folderid, $uuid, $statecounter, $queuedmessages) {
+        if (isset($this->windowSize[$folderid])) {
+            $items = $this->windowSize[$folderid];
+        }
+        else {
+            $items = WINDOW_SIZE_MAX;
+        } // 512 by default
+
+        $this->setLatestFolder($folderid);
+
+        // detect if this is a loop condition
+        $loop = $this->loopdetection->Detect($folderid, $uuid, $statecounter, $items, $queuedmessages);
+        if ($loop !== false) {
+            if ($loop === true) {
+                $items = ($items == 0) ? 0 : 1 + ($this->loopdetection->IgnoreNextMessage(false) ? 1 : 0);
+            }
+            else {
+                // we got a new suggested window size
+                $items = $loop;
+                SLog::Write(LOGLEVEL_DEBUG, sprintf("Mobile loop pre stage detected! Forcing smaller window size of %d before entering loop detection mode", $items));
+            }
+        }
+
+        if ($items >= 0 && $items <= 2) {
+            SLog::Write(LOGLEVEL_WARN, sprintf("Mobile loop detected! Messages sent to the mobile will be restricted to %d items in order to identify the conflict", $items));
+        }
+
+        return $items;
+    }
+
+    /**
+     * Sets the amount of items the device is requesting.
+     *
+     * @param string $folderid
+     * @param int    $maxItems
+     *
+     * @return bool
+     */
+    public function SetWindowSize($folderid, $maxItems) {
+        $this->windowSize[$folderid] = $maxItems;
+
+        return true;
+    }
+
+    /**
+     * Sets the supported fields transmitted by the device for a certain folder.
+     *
+     * @param string $folderid
+     * @param array  $fieldlist supported fields
+     *
+     * @return bool
+     */
+    public function SetSupportedFields($folderid, $fieldlist) {
+        return $this->device->SetSupportedFields($folderid, $fieldlist);
+    }
+
+    /**
+     * Gets the supported fields transmitted previously by the device
+     * for a certain folder.
+     *
+     * @param string $folderid
+     *
+     * @return array/boolean
+     */
+    public function GetSupportedFields($folderid) {
+        return $this->device->GetSupportedFields($folderid);
+    }
+
+    /**
+     * Returns the maximum filter type for a folder.
+     * This might be limited globally, per device or per folder.
+     *
+     * @param string $folderid
+     * @param mixed  $backendFolderId
+     *
+     * @return int
+     */
+    public function GetFilterType($folderid, $backendFolderId) {
+        global $specialSyncFilter;
+        // either globally configured SYNC_FILTERTIME_MAX or ALL (no limit)
+        $maxAllowed = (defined('SYNC_FILTERTIME_MAX') && SYNC_FILTERTIME_MAX > SYNC_FILTERTYPE_ALL) ? SYNC_FILTERTIME_MAX : SYNC_FILTERTYPE_ALL;
+
+        // TODO we could/should check for a specific value for the folder, if it's available
+        $maxDevice = $this->device->GetSyncFilterType();
+
+        // ALL has a value of 0, all limitations have higher integer values, see SYNC_FILTERTYPE_ALL definition
+        if ($maxDevice !== false && $maxDevice > SYNC_FILTERTYPE_ALL && ($maxAllowed == SYNC_FILTERTYPE_ALL || $maxDevice < $maxAllowed)) {
+            $maxAllowed = $maxDevice;
+        }
+
+        if (is_array($specialSyncFilter)) {
+            $store = GSync::GetAdditionalSyncFolderStore($backendFolderId);
+            // the store is only available when this is a shared folder (but might also be statically configured)
+            if ($store) {
+                $origin = Utils::GetFolderOriginFromId($folderid);
+                // do not limit when the owner or impersonated user is syncing!
+                if ($origin == DeviceManager::FLD_ORIGIN_USER || $origin == DeviceManager::FLD_ORIGIN_IMPERSONATED) {
+                    SLog::Write(LOGLEVEL_DEBUG, "Not checking for specific sync limit as this is the owner/impersonated user.");
+                }
+                else {
+                    $spKey = false;
+                    $spFilter = false;
+                    // 1. step: check if there is a general limitation for the store
+                    if (array_key_exists($store, $specialSyncFilter)) {
+                        $spFilter = $specialSyncFilter[$store];
+                        SLog::Write(LOGLEVEL_DEBUG, sprintf("Limit sync due to configured limitation on the store: '%s': %s", $store, $spFilter));
+                    }
+
+                    // 2. step: check if there is a limitation for the hashed ID (for shared/configured stores)
+                    $spKey = $store . '/' . $folderid;
+                    if (array_key_exists($spKey, $specialSyncFilter)) {
+                        $spFilter = $specialSyncFilter[$spKey];
+                        SLog::Write(LOGLEVEL_DEBUG, sprintf("Limit sync due to configured limitation on the folder: '%s': %s", $spKey, $spFilter));
+                    }
+
+                    // 3. step: check if there is a limitation for the backendId
+                    $spKey = $store . '/' . $backendFolderId;
+                    if (array_key_exists($spKey, $specialSyncFilter)) {
+                        $spFilter = $specialSyncFilter[$spKey];
+                        SLog::Write(LOGLEVEL_DEBUG, sprintf("Limit sync due to configured limitation on the folder: '%s': %s", $spKey, $spFilter));
+                    }
+                    if ($spFilter) {
+                        $maxAllowed = $spFilter;
+                    }
+                }
+            }
+        }
+
+        return $maxAllowed;
+    }
+
+    /**
+     * Removes all linked states of a specific folder.
+     * During next request the folder is resynchronized.
+     *
+     * @param string $folderid
+     *
+     * @return bool
+     */
+    public function ForceFolderResync($folderid) {
+        SLog::Write(LOGLEVEL_INFO, sprintf("DeviceManager->ForceFolderResync('%s'): folder resync", $folderid));
+
+        // delete folder states
+        StateManager::UnLinkState($this->device, $folderid);
+
+        return true;
+    }
+
+    /**
+     * Removes all linked states from a device.
+     * During next requests a full resync is triggered.
+     *
+     * @return bool
+     */
+    public function ForceFullResync() {
+        SLog::Write(LOGLEVEL_INFO, "Full device resync requested");
+
+        // delete all other uuids
+        foreach ($this->device->GetAllFolderIds() as $folderid) {
+            $uuid = StateManager::UnLinkState($this->device, $folderid);
+        }
+
+        // delete hierarchy states
+        StateManager::UnLinkState($this->device, false);
+
+        return true;
+    }
+
+    /**
+     * Indicates if the hierarchy should be resynchronized based on the general folder state and
+     * if additional folders changed.
+     *
+     * @return bool
+     */
+    public function IsHierarchySyncRequired() {
+        $this->loadDeviceData();
+
+        if ($this->loopdetection->ProcessLoopDetectionIsHierarchySyncAdvised()) {
+            return true;
+        }
+
+        // if the hash of the additional folders changed, we have to sync the hierarchy
+        if ($this->additionalFoldersHash != $this->getAdditionalFoldersHash()) {
+            $this->hierarchySyncRequired = true;
+        }
+
+        // check if a hierarchy sync might be necessary
+        if ($this->device->GetFolderUUID(false) === false) {
+            $this->hierarchySyncRequired = true;
+        }
+
+        return $this->hierarchySyncRequired;
+    }
+
+    private function getAdditionalFoldersHash() {
+        return md5(serialize($this->device->GetAdditionalFolders()));
+    }
+
+    /**
+     * Indicates if a full hierarchy resync should be triggered due to loops.
+     *
+     * @return bool
+     */
+    public function IsHierarchyFullResyncRequired() {
+        // do not check for loop detection, if the foldersync is not yet complete
+        if ($this->GetFolderSyncComplete() === false) {
+            SLog::Write(LOGLEVEL_INFO, "DeviceManager->IsHierarchyFullResyncRequired(): aborted, as exporting of folders has not yet completed");
+
+            return false;
+        }
+        // check for potential process loops like described in ZP-5
+        return $this->loopdetection->ProcessLoopDetectionIsHierarchyResyncRequired();
+    }
+
+    /**
+     * Adds an Exceptions to the process tracking.
+     *
+     * @param Exception $exception
+     *
+     * @return bool
+     */
+    public function AnnounceProcessException($exception) {
+        return $this->loopdetection->ProcessLoopDetectionAddException($exception);
+    }
+
+    /**
+     * Adds a non-ok status for a folderid to the process tracking.
+     * On 'false' a hierarchy status is assumed.
+     *
+     * @param mixed $folderid
+     * @param mixed $status
+     *
+     * @return bool
+     */
+    public function AnnounceProcessStatus($folderid, $status) {
+        return $this->loopdetection->ProcessLoopDetectionAddStatus($folderid, $status);
+    }
+
+    /**
+     * Announces that the current process is a push connection to the process loop
+     * detection and to the Top collector.
+     *
+     * @return bool
+     */
+    public function AnnounceProcessAsPush() {
+        SLog::Write(LOGLEVEL_DEBUG, "Announce process as PUSH connection");
+
+        return $this->loopdetection->ProcessLoopDetectionSetAsPush() && GSync::GetTopCollector()->SetAsPushConnection();
+    }
+
+    /**
+     * Checks if the given counter for a certain uuid+folderid was already exported or modified.
+     * This is called when a heartbeat request found changes to make sure that the same
+     * changes are not exported twice, as during the heartbeat there could have been a normal
+     * sync request.
+     *
+     * @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 CheckHearbeatStateIntegrity($folderid, $uuid, $counter) {
+        return $this->loopdetection->IsSyncStateObsolete($folderid, $uuid, $counter);
+    }
+
+    /**
+     * Marks a syncstate as obsolete for Heartbeat, as e.g. an import was started using it.
+     *
+     * @param string $folderid folder id
+     * @param string $uuid     synkkey
+     * @param string $counter  synckey counter
+     *
+     * @return
+     */
+    public function SetHeartbeatStateIntegrity($folderid, $uuid, $counter) {
+        return $this->loopdetection->SetSyncStateUsage($folderid, $uuid, $counter);
+    }
+
+    /**
+     * Checks the data integrity of the data in the hierarchy cache and the data of the content data (synchronized folders).
+     * If a folder is deleted, the sync states could still be on the server (and being loaded by PING) while
+     * the folder is not being synchronized anymore. See also https://jira.z-hub.io/browse/ZP-1077.
+     *
+     * @return bool
+     */
+    public function CheckFolderData() {
+        SLog::Write(LOGLEVEL_DEBUG, "DeviceManager->CheckFolderData() checking integrity of hierarchy cache with synchronized folders");
+
+        $hc = $this->device->GetHierarchyCache();
+        $notInCache = [];
+        foreach ($this->device->GetAllFolderIds() as $folderid) {
+            $uuid = $this->device->GetFolderUUID($folderid);
+            if ($uuid) {
+                // has a UUID but is not in the cache?! This is deleted, remove the states.
+                if (!$hc->GetFolder($folderid)) {
+                    SLog::Write(LOGLEVEL_WARN, sprintf("DeviceManager->CheckFolderData(): Folder '%s' has sync states but is not in the hierarchy cache. Removing states.", $folderid));
+                    StateManager::UnLinkState($this->device, $folderid);
+                }
+            }
+        }
+
+        return true;
+    }
+
+    /**
+     * Sets the current status of the folder.
+     *
+     * @param string $folderid   folder id
+     * @param int    $statusflag current status: DeviceManager::FLD_SYNC_INITIALIZED, DeviceManager::FLD_SYNC_INPROGRESS, DeviceManager::FLD_SYNC_COMPLETED
+     *
+     * @return
+     */
+    public function SetFolderSyncStatus($folderid, $statusflag) {
+        $currentStatus = $this->device->GetFolderSyncStatus($folderid);
+
+        // status available or just initialized
+        if (isset($currentStatus->{ASDevice::FOLDERSYNCSTATUS}) || $statusflag == self::FLD_SYNC_INITIALIZED) {
+            // only update if there is a change
+            if ((!$currentStatus || (isset($currentStatus->{ASDevice::FOLDERSYNCSTATUS}) && $statusflag !== $currentStatus->{ASDevice::FOLDERSYNCSTATUS})) &&
+                    $statusflag != self::FLD_SYNC_COMPLETED) {
+                $this->device->SetFolderSyncStatus($folderid, $statusflag);
+                SLog::Write(LOGLEVEL_DEBUG, sprintf("SetFolderSyncStatus(): set %s for %s", $statusflag, $folderid));
+            }
+            // if completed, remove the status
+            elseif ($statusflag == self::FLD_SYNC_COMPLETED) {
+                $this->device->SetFolderSyncStatus($folderid, false);
+                SLog::Write(LOGLEVEL_DEBUG, sprintf("SetFolderSyncStatus(): completed for %s", $folderid));
+            }
+        }
+
+        return true;
+    }
+
+    /**
+     * Indicates if a folder is synchronizing by the saved status.
+     *
+     * @param string $folderid folder id
+     *
+     * @return bool
+     */
+    public function HasFolderSyncStatus($folderid) {
+        $currentStatus = $this->device->GetFolderSyncStatus($folderid);
+
+        // status available ?
+        $hasStatus = isset($currentStatus->{ASDevice::FOLDERSYNCSTATUS});
+        if ($hasStatus) {
+            SLog::Write(LOGLEVEL_DEBUG, sprintf("HasFolderSyncStatus(): saved folder status for %s: %s", $folderid, $currentStatus->{ASDevice::FOLDERSYNCSTATUS}));
+        }
+
+        return $hasStatus;
+    }
+
+    /**
+     * Returns the indicator if the FolderSync was completed successfully  (all folders synchronized).
+     *
+     * @return bool
+     */
+    public function GetFolderSyncComplete() {
+        return $this->device->GetFolderSyncComplete();
+    }
+
+    /**
+     * Sets if the FolderSync was completed successfully (all folders synchronized).
+     *
+     * @param bool  $complete indicating if all folders were sent
+     * @param mixed $user
+     * @param mixed $devid
+     *
+     * @return bool
+     */
+    public function SetFolderSyncComplete($complete, $user = false, $devid = false) {
+        $this->device->SetFolderSyncComplete($complete);
+
+        return true;
+    }
+
+    /**
+     * Removes the Loop detection data for a user & device.
+     *
+     * @param string $user
+     * @param string $devid
+     *
+     * @return bool
+     */
+    public function ClearLoopDetectionData($user, $devid) {
+        if ($user == false || $devid == false) {
+            return false;
+        }
+        SLog::Write(LOGLEVEL_DEBUG, sprintf("DeviceManager->ClearLoopDetectionData(): clearing data for user '%s' and device '%s'", $user, $devid));
+
+        return $this->loopdetection->ClearData($user, $devid);
+    }
+
+    /**
+     * Indicates if the device needs an AS version update.
+     *
+     * @return bool
+     */
+    public function AnnounceASVersion() {
+        $latest = GSync::GetSupportedASVersion();
+        $announced = $this->device->GetAnnouncedASversion();
+        $this->device->SetAnnouncedASversion($latest);
+
+        return $announced != $latest;
+    }
+
+    /**
+     * Returns the User Agent. This data is consolidated with data from Request::GetUserAgent()
+     * and the data saved in the ASDevice.
+     *
+     * @return string
+     */
+    public function GetUserAgent() {
+        return $this->device->GetDeviceUserAgent();
+    }
+
+    /**
+     * Returns the backend folder id from the AS folderid known to the mobile.
+     * If the id is not known, it's returned as is.
+     *
+     * @param mixed $folderid
+     *
+     * @return int/boolean  returns false if the type is not set
+     */
+    public function GetBackendIdForFolderId($folderid) {
+        $backendId = $this->device->GetFolderBackendId($folderid);
+        if (!$backendId) {
+            SLog::Write(LOGLEVEL_DEBUG, sprintf("DeviceManager->GetBackendIdForFolderId(): no backend-folderid available for '%s', returning as is.", $folderid));
+
+            return $folderid;
+        }
+        SLog::Write(LOGLEVEL_DEBUG, sprintf("DeviceManager->GetBackendIdForFolderId(): folderid %s => %s", $folderid, $backendId));
+
+        return $backendId;
+    }
+
+    /**
+     * Gets the AS folderid for a backendFolderId.
+     * If there is no known AS folderId a new one is being created.
+     *
+     * @param string $backendid          Backend folder id
+     * @param bool   $generateNewIdIfNew generates a new AS folderid for the case the backend folder is not known yet, default: false
+     * @param string $folderOrigin       Folder type is one of   'U' (user)
+     *                                   'C' (configured)
+     *                                   'S' (shared)
+     *                                   'G' (global address book)
+     *                                   'I' (impersonated)
+     * @param string $folderName         Folder name of the backend folder
+     *
+     * @return string/boolean  returns false if there is folderid known for this backendid and $generateNewIdIfNew is not set or false
+     */
+    public function GetFolderIdForBackendId($backendid, $generateNewIdIfNew = false, $folderOrigin = self::FLD_ORIGIN_USER, $folderName = null) {
+        if (!in_array($folderOrigin, [DeviceManager::FLD_ORIGIN_CONFIG, DeviceManager::FLD_ORIGIN_GAB, DeviceManager::FLD_ORIGIN_SHARED, DeviceManager::FLD_ORIGIN_USER, DeviceManager::FLD_ORIGIN_IMPERSONATED])) {
+            SLog::Write(LOGLEVEL_WARN, sprintf("ASDevice->GetFolderIdForBackendId(): folder type '%s' is unknown in DeviceManager", $folderOrigin));
+        }
+
+        return $this->device->GetFolderIdForBackendId($backendid, $generateNewIdIfNew, $folderOrigin, $folderName);
+    }
+
+    /*----------------------------------------------------------------------------------------------------------
 	 * private DeviceManager methods
 	 */
 
-	/**
-	 * Loads devicedata from the StateMachine and loads it into the device.
-	 *
-	 * @return bool
-	 */
-	private function loadDeviceData() {
-		if (!Request::IsValidDeviceID()) {
-			return false;
-		}
-
-		try {
-			$deviceHash = $this->statemachine->GetStateHash(self::$devid, IStateMachine::DEVICEDATA);
-			if ($deviceHash != $this->deviceHash) {
-				if ($this->deviceHash) {
-					SLog::Write(LOGLEVEL_DEBUG, "DeviceManager->loadDeviceData(): Device data was changed, reloading");
-				}
-				$device = $this->statemachine->GetState(self::$devid, IStateMachine::DEVICEDATA);
-				// TODO: case should be removed when removing ASDevice backwards compatibility
-				// fallback for old grosync like devicedata
-				if (($device instanceof StateObject) && isset($device->devices) && is_array($device->devices)) {
-					SLog::Write(LOGLEVEL_INFO, "Found old style device, converting...");
-					list($_deviceuser, $_domain) = Utils::SplitDomainUser(Request::GetGETUser());
-					if (!isset($device->data->devices[$_deviceuser])) {
-						SLog::Write(LOGLEVEL_INFO, "Using old style device for this request and updating when concluding");
-						$device = $device->devices[$_deviceuser];
-						$device->lastupdatetime = time();
-					}
-					else {
-						SLog::Write(LOGLEVEL_WARN, sprintf("Could not find '%s' in device state. Dropping previous device state!", $_deviceuser));
-					}
-				}
-				if (method_exists($device, 'LoadedDevice')) {
-					$this->device = $device;
-					$this->device->LoadedDevice();
-					$this->deviceHash = $deviceHash;
-				}
-				else {
-					SLog::Write(LOGLEVEL_WARN, "Loaded device is not a device object. Dropping new loaded state and keeping initialized object!");
-				}
-				$this->stateManager->SetDevice($this->device);
-			}
-		}
-		catch (StateNotFoundException $snfex) {
-			$this->hierarchySyncRequired = true;
-		}
-		catch (UnavailableException $uaex) {
-			// This is temporary and can be ignored e.g. in PING - see https://jira.z-hub.io/browse/ZP-1054
-			// If the hash was not available before we treat it like a StateNotFoundException.
-			if ($this->deviceHash === false) {
-				$this->hierarchySyncRequired = true;
-			}
-		}
-
-		return true;
-	}
-
-	/**
-	 * Called when a SyncObject is not being streamed to the mobile.
-	 * The user can be informed so he knows about this issue.
-	 *
-	 * @param string     $folderid id of the parent folder (may be false if unknown)
-	 * @param string     $id       message id
-	 * @param SyncObject $message  the broken message
-	 * @param string     $reason   (self::MSG_BROKEN_UNKNOWN, self::MSG_BROKEN_CAUSINGLOOP, self::MSG_BROKEN_SEMANTICERR)
-	 *
-	 * @return bool
-	 */
-	public function AnnounceIgnoredMessage($folderid, $id, SyncObject $message, $reason = self::MSG_BROKEN_UNKNOWN) {
-		if ($folderid === false) {
-			$folderid = $this->getLatestFolder();
-		}
-
-		$class = get_class($message);
-
-		$brokenMessage = new StateObject();
-		$brokenMessage->id = $id;
-		$brokenMessage->folderid = $folderid;
-		$brokenMessage->ASClass = $class;
-		$brokenMessage->folderid = $folderid;
-		$brokenMessage->reasonCode = $reason;
-		$brokenMessage->reasonString = 'unknown cause';
-		$brokenMessage->timestamp = time();
-		$info = "";
-		if (isset($message->subject)) {
-			$info .= sprintf("Subject: '%s'", $message->subject);
-		}
-		if (isset($message->fileas)) {
-			$info .= sprintf("FileAs: '%s'", $message->fileas);
-		}
-		if (isset($message->from)) {
-			$info .= sprintf(" - From: '%s'", $message->from);
-		}
-		if (isset($message->starttime)) {
-			$info .= sprintf(" - On: '%s'", strftime("%Y-%m-%d %H:%M", $message->starttime));
-		}
-		$brokenMessage->info = $info;
-		$brokenMessage->reasonString = SLog::GetLastMessage(LOGLEVEL_WARN);
-
-		$this->device->AddIgnoredMessage($brokenMessage);
-
-		SLog::Write(LOGLEVEL_ERROR, sprintf("Ignored broken message (%s). Reason: '%s' Folderid: '%s' message id '%s'", $class, $reason, $folderid, $id));
-
-		return true;
-	}
-
-	/**
-	 * Called when a SyncObject was streamed to the mobile.
-	 * If the message could not be sent before this data is obsolete.
-	 *
-	 * @param string $folderid id of the parent folder
-	 * @param string $id       message id
-	 *
-	 * @return bool returns true if the message was ignored before
-	 */
-	private function announceAcceptedMessage($folderid, $id) {
-		if ($this->device->RemoveIgnoredMessage($folderid, $id)) {
-			SLog::Write(LOGLEVEL_INFO, sprintf("DeviceManager->announceAcceptedMessage('%s', '%s'): cleared previously ignored message as message is successfully streamed", $folderid, $id));
-
-			return true;
-		}
-
-		return false;
-	}
-
-	/**
-	 * Checks if there were broken messages streamed to the mobile.
-	 * If the sync completes/continues without further errors they are marked as accepted.
-	 *
-	 * @param string $folderid folderid which is to be checked
-	 *
-	 * @return bool
-	 */
-	private function checkBrokenMessages($folderid) {
-		// check for correctly synchronized messages of the folder
-		foreach ($this->loopdetection->GetSyncedButBeforeIgnoredMessages($folderid) as $okID) {
-			$this->announceAcceptedMessage($folderid, $okID);
-		}
-
-		return true;
-	}
-
-	/**
-	 * Setter for the latest folder id
-	 * on multi-folder operations of AS 14 this is used to set the new current folder id.
-	 *
-	 * @param string $folderid the current folder
-	 *
-	 * @return bool
-	 */
-	private function setLatestFolder($folderid) {
-		// this is a multi folder operation
-		// check on ignoredmessages before discaring the folderid
-		if ($this->latestFolder !== false) {
-			$this->checkBrokenMessages($this->latestFolder);
-		}
-
-		$this->latestFolder = $folderid;
-
-		return true;
-	}
-
-	/**
-	 * Getter for the latest folder id.
-	 *
-	 * @return string $folderid       the current folder
-	 */
-	private function getLatestFolder() {
-		return $this->latestFolder;
-	}
-
-	/**
-	 * Generates and SyncFolder object and returns it.
-	 *
-	 * @param string $store
-	 * @param string $folderid
-	 * @param string $name
-	 * @param int    $type
-	 * @param int    $flags
-	 * @param string $folderOrigin
-	 * @param mixed  $parentid
-	 *
-	 * @returns SyncFolder
-	 */
-	public function BuildSyncFolderObject($store, $folderid, $parentid, $name, $type, $flags, $folderOrigin) {
-		$folder = new SyncFolder();
-		$folder->BackendId = $folderid;
-		$folder->serverid = $this->GetFolderIdForBackendId($folder->BackendId, true, $folderOrigin, $name);
-		$folder->parentid = $this->GetFolderIdForBackendId($parentid);
-		$folder->displayname = $name;
-		$folder->type = $type;
-		// save store as custom property which is not streamed directly to the device
-		$folder->NoBackendFolder = true;
-		$folder->Store = $store;
-		$folder->Flags = $flags;
-
-		return $folder;
-	}
-
-	/**
-	 * Returns the device id.
-	 *
-	 * @return string
-	 */
-	public function GetDevid() {
-		return self::$devid;
-	}
+    /**
+     * Loads devicedata from the StateMachine and loads it into the device.
+     *
+     * @return bool
+     */
+    private function loadDeviceData() {
+        if (!Request::IsValidDeviceID()) {
+            return false;
+        }
+
+        try {
+            $deviceHash = $this->statemachine->GetStateHash(self::$devid, IStateMachine::DEVICEDATA);
+            if ($deviceHash != $this->deviceHash) {
+                if ($this->deviceHash) {
+                    SLog::Write(LOGLEVEL_DEBUG, "DeviceManager->loadDeviceData(): Device data was changed, reloading");
+                }
+                $device = $this->statemachine->GetState(self::$devid, IStateMachine::DEVICEDATA);
+                // TODO: case should be removed when removing ASDevice backwards compatibility
+                // fallback for old grosync like devicedata
+                if (($device instanceof StateObject) && isset($device->devices) && is_array($device->devices)) {
+                    SLog::Write(LOGLEVEL_INFO, "Found old style device, converting...");
+                    list($_deviceuser, $_domain) = Utils::SplitDomainUser(Request::GetGETUser());
+                    if (!isset($device->data->devices[$_deviceuser])) {
+                        SLog::Write(LOGLEVEL_INFO, "Using old style device for this request and updating when concluding");
+                        $device = $device->devices[$_deviceuser];
+                        $device->lastupdatetime = time();
+                    }
+                    else {
+                        SLog::Write(LOGLEVEL_WARN, sprintf("Could not find '%s' in device state. Dropping previous device state!", $_deviceuser));
+                    }
+                }
+                if (method_exists($device, 'LoadedDevice')) {
+                    $this->device = $device;
+                    $this->device->LoadedDevice();
+                    $this->deviceHash = $deviceHash;
+                }
+                else {
+                    SLog::Write(LOGLEVEL_WARN, "Loaded device is not a device object. Dropping new loaded state and keeping initialized object!");
+                }
+                $this->stateManager->SetDevice($this->device);
+            }
+        }
+        catch (StateNotFoundException $snfex) {
+            $this->hierarchySyncRequired = true;
+        }
+        catch (UnavailableException $uaex) {
+            // This is temporary and can be ignored e.g. in PING - see https://jira.z-hub.io/browse/ZP-1054
+            // If the hash was not available before we treat it like a StateNotFoundException.
+            if ($this->deviceHash === false) {
+                $this->hierarchySyncRequired = true;
+            }
+        }
+
+        return true;
+    }
+
+    /**
+     * Called when a SyncObject is not being streamed to the mobile.
+     * The user can be informed so he knows about this issue.
+     *
+     * @param string     $folderid id of the parent folder (may be false if unknown)
+     * @param string     $id       message id
+     * @param SyncObject $message  the broken message
+     * @param string     $reason   (self::MSG_BROKEN_UNKNOWN, self::MSG_BROKEN_CAUSINGLOOP, self::MSG_BROKEN_SEMANTICERR)
+     *
+     * @return bool
+     */
+    public function AnnounceIgnoredMessage($folderid, $id, SyncObject $message, $reason = self::MSG_BROKEN_UNKNOWN) {
+        if ($folderid === false) {
+            $folderid = $this->getLatestFolder();
+        }
+
+        $class = get_class($message);
+
+        $brokenMessage = new StateObject();
+        $brokenMessage->id = $id;
+        $brokenMessage->folderid = $folderid;
+        $brokenMessage->ASClass = $class;
+        $brokenMessage->folderid = $folderid;
+        $brokenMessage->reasonCode = $reason;
+        $brokenMessage->reasonString = 'unknown cause';
+        $brokenMessage->timestamp = time();
+        $info = "";
+        if (isset($message->subject)) {
+            $info .= sprintf("Subject: '%s'", $message->subject);
+        }
+        if (isset($message->fileas)) {
+            $info .= sprintf("FileAs: '%s'", $message->fileas);
+        }
+        if (isset($message->from)) {
+            $info .= sprintf(" - From: '%s'", $message->from);
+        }
+        if (isset($message->starttime)) {
+            $info .= sprintf(" - On: '%s'", strftime("%Y-%m-%d %H:%M", $message->starttime));
+        }
+        $brokenMessage->info = $info;
+        $brokenMessage->reasonString = SLog::GetLastMessage(LOGLEVEL_WARN);
+
+        $this->device->AddIgnoredMessage($brokenMessage);
+
+        SLog::Write(LOGLEVEL_ERROR, sprintf("Ignored broken message (%s). Reason: '%s' Folderid: '%s' message id '%s'", $class, $reason, $folderid, $id));
+
+        return true;
+    }
+
+    /**
+     * Called when a SyncObject was streamed to the mobile.
+     * If the message could not be sent before this data is obsolete.
+     *
+     * @param string $folderid id of the parent folder
+     * @param string $id       message id
+     *
+     * @return bool returns true if the message was ignored before
+     */
+    private function announceAcceptedMessage($folderid, $id) {
+        if ($this->device->RemoveIgnoredMessage($folderid, $id)) {
+            SLog::Write(LOGLEVEL_INFO, sprintf("DeviceManager->announceAcceptedMessage('%s', '%s'): cleared previously ignored message as message is successfully streamed", $folderid, $id));
+
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * Checks if there were broken messages streamed to the mobile.
+     * If the sync completes/continues without further errors they are marked as accepted.
+     *
+     * @param string $folderid folderid which is to be checked
+     *
+     * @return bool
+     */
+    private function checkBrokenMessages($folderid) {
+        // check for correctly synchronized messages of the folder
+        foreach ($this->loopdetection->GetSyncedButBeforeIgnoredMessages($folderid) as $okID) {
+            $this->announceAcceptedMessage($folderid, $okID);
+        }
+
+        return true;
+    }
+
+    /**
+     * Setter for the latest folder id
+     * on multi-folder operations of AS 14 this is used to set the new current folder id.
+     *
+     * @param string $folderid the current folder
+     *
+     * @return bool
+     */
+    private function setLatestFolder($folderid) {
+        // this is a multi folder operation
+        // check on ignoredmessages before discaring the folderid
+        if ($this->latestFolder !== false) {
+            $this->checkBrokenMessages($this->latestFolder);
+        }
+
+        $this->latestFolder = $folderid;
+
+        return true;
+    }
+
+    /**
+     * Getter for the latest folder id.
+     *
+     * @return string $folderid       the current folder
+     */
+    private function getLatestFolder() {
+        return $this->latestFolder;
+    }
+
+    /**
+     * Generates and SyncFolder object and returns it.
+     *
+     * @param string $store
+     * @param string $folderid
+     * @param string $name
+     * @param int    $type
+     * @param int    $flags
+     * @param string $folderOrigin
+     * @param mixed  $parentid
+     *
+     * @returns SyncFolder
+     */
+    public function BuildSyncFolderObject($store, $folderid, $parentid, $name, $type, $flags, $folderOrigin) {
+        $folder = new SyncFolder();
+        $folder->BackendId = $folderid;
+        $folder->serverid = $this->GetFolderIdForBackendId($folder->BackendId, true, $folderOrigin, $name);
+        $folder->parentid = $this->GetFolderIdForBackendId($parentid);
+        $folder->displayname = $name;
+        $folder->type = $type;
+        // save store as custom property which is not streamed directly to the device
+        $folder->NoBackendFolder = true;
+        $folder->Store = $store;
+        $folder->Flags = $flags;
+
+        return $folder;
+    }
+
+    /**
+     * Returns the device id.
+     *
+     * @return string
+     */
+    public function GetDevid() {
+        return self::$devid;
+    }
 }

Spacing +5 added lines, -5 removed lines

@@ -167,7 +167,7 @@ 
 				}
 			}
 			catch (StateNotFoundException $snfex) {
-				SLog::Write(LOGLEVEL_ERROR, "DeviceManager->Save(): Exception: " . $snfex->getMessage());
+				SLog::Write(LOGLEVEL_ERROR, "DeviceManager->Save(): Exception: ".$snfex->getMessage());
 			}
 		}
 
@@ -191,7 +191,7 @@ 
 	 * @param bool $doSave
 	 */
 	public function DoAutomaticASDeviceSaving($doSave) {
-		SLog::Write(LOGLEVEL_DEBUG, "DeviceManager->DoAutomaticASDeviceSaving(): save automatically: " . Utils::PrintAsString($doSave));
+		SLog::Write(LOGLEVEL_DEBUG, "DeviceManager->DoAutomaticASDeviceSaving(): save automatically: ".Utils::PrintAsString($doSave));
 		$this->saveDevice = $doSave;
 	}
 
@@ -214,7 +214,7 @@ 
 		// save other information
 		foreach (["model", "imei", "friendlyname", "os", "oslanguage", "phonenumber", "mobileoperator", "enableoutboundsms"] as $info) {
 			if (isset($deviceinformation->{$info}) && $deviceinformation->{$info} != "") {
-				$this->device->__set("device" . $info, $deviceinformation->{$info});
+				$this->device->__set("device".$info, $deviceinformation->{$info});
 			}
 		}
 
@@ -554,14 +554,14 @@ 
 					}
 
 					// 2. step: check if there is a limitation for the hashed ID (for shared/configured stores)
-					$spKey = $store . '/' . $folderid;
+					$spKey = $store.'/'.$folderid;
 					if (array_key_exists($spKey, $specialSyncFilter)) {
 						$spFilter = $specialSyncFilter[$spKey];
 						SLog::Write(LOGLEVEL_DEBUG, sprintf("Limit sync due to configured limitation on the folder: '%s': %s", $spKey, $spFilter));
 					}
 
 					// 3. step: check if there is a limitation for the backendId
-					$spKey = $store . '/' . $backendFolderId;
+					$spKey = $store.'/'.$backendFolderId;
 					if (array_key_exists($spKey, $specialSyncFilter)) {
 						$spFilter = $specialSyncFilter[$spKey];
 						SLog::Write(LOGLEVEL_DEBUG, sprintf("Limit sync due to configured limitation on the folder: '%s': %s", $spKey, $spFilter));

Braces +9 added lines, -18 removed lines

@@ -74,8 +74,7 @@ 
 			$this->loadDeviceData();
 
 			GSync::GetTopCollector()->SetUserAgent($this->device->GetDeviceUserAgent());
-		}
-		else {
+		} else {
 			throw new FatalNotImplementedException("Can not proceed without a device id.");
 		}
 
@@ -165,8 +164,7 @@ 
 					$this->setDeviceUserData($this->type, [self::$user => $this->device], self::$devid, -1, $doCas = "merge");
 					SLog::Write(LOGLEVEL_DEBUG, "DeviceManager->Save(): Device data saved");
 				}
-			}
-			catch (StateNotFoundException $snfex) {
+			} catch (StateNotFoundException $snfex) {
 				SLog::Write(LOGLEVEL_ERROR, "DeviceManager->Save(): Exception: " . $snfex->getMessage());
 			}
 		}
@@ -448,8 +446,7 @@ 
 	public function GetWindowSize($folderid, $uuid, $statecounter, $queuedmessages) {
 		if (isset($this->windowSize[$folderid])) {
 			$items = $this->windowSize[$folderid];
-		}
-		else {
+		} else {
 			$items = WINDOW_SIZE_MAX;
 		} // 512 by default
 
@@ -460,8 +457,7 @@ 
 		if ($loop !== false) {
 			if ($loop === true) {
 				$items = ($items == 0) ? 0 : 1 + ($this->loopdetection->IgnoreNextMessage(false) ? 1 : 0);
-			}
-			else {
+			} else {
 				// we got a new suggested window size
 				$items = $loop;
 				SLog::Write(LOGLEVEL_DEBUG, sprintf("Mobile loop pre stage detected! Forcing smaller window size of %d before entering loop detection mode", $items));
@@ -543,8 +539,7 @@ 
 				// do not limit when the owner or impersonated user is syncing!
 				if ($origin == DeviceManager::FLD_ORIGIN_USER || $origin == DeviceManager::FLD_ORIGIN_IMPERSONATED) {
 					SLog::Write(LOGLEVEL_DEBUG, "Not checking for specific sync limit as this is the owner/impersonated user.");
-				}
-				else {
+				} else {
 					$spKey = false;
 					$spFilter = false;
 					// 1. step: check if there is a general limitation for the store
@@ -935,8 +930,7 @@ 
 						SLog::Write(LOGLEVEL_INFO, "Using old style device for this request and updating when concluding");
 						$device = $device->devices[$_deviceuser];
 						$device->lastupdatetime = time();
-					}
-					else {
+					} else {
 						SLog::Write(LOGLEVEL_WARN, sprintf("Could not find '%s' in device state. Dropping previous device state!", $_deviceuser));
 					}
 				}
@@ -944,17 +938,14 @@ 
 					$this->device = $device;
 					$this->device->LoadedDevice();
 					$this->deviceHash = $deviceHash;
-				}
-				else {
+				} else {
 					SLog::Write(LOGLEVEL_WARN, "Loaded device is not a device object. Dropping new loaded state and keeping initialized object!");
 				}
 				$this->stateManager->SetDevice($this->device);
 			}
-		}
-		catch (StateNotFoundException $snfex) {
+		} catch (StateNotFoundException $snfex) {
 			$this->hierarchySyncRequired = true;
-		}
-		catch (UnavailableException $uaex) {
+		} catch (UnavailableException $uaex) {
 			// This is temporary and can be ignored e.g. in PING - see https://jira.z-hub.io/browse/ZP-1054
 			// If the hash was not available before we treat it like a StateNotFoundException.
 			if ($this->deviceHash === false) {

lib/core/statemanager.php

Indentation +505 added lines, -505 removed lines

@@ -16,515 +16,515 @@
  */
 
 class StateManager {
-	public const FIXEDHIERARCHYCOUNTER = 99999;
-
-	// backend storage types
-	public const BACKENDSTORAGE_PERMANENT = 1;
-	public const BACKENDSTORAGE_STATE = 2;
-
-	private $statemachine;
-	private $device;
-	private $hierarchyOperation = false;
-	private $deleteOldStates = false;
-
-	private $foldertype;
-	private $uuid;
-	private $oldStateCounter;
-	private $newStateCounter;
-	private $synchedFolders;
-
-	/**
-	 * Constructor.
-	 */
-	public function __construct() {
-		$this->statemachine = GSync::GetStateMachine();
-		$this->hierarchyOperation = GSync::HierarchyCommand(Request::GetCommandCode());
-		$this->deleteOldStates = (Request::GetCommandCode() === GSync::COMMAND_SYNC || $this->hierarchyOperation);
-		$this->synchedFolders = [];
-	}
-
-	/**
-	 * Prevents the StateMachine from removing old states.
-	 */
-	public function DoNotDeleteOldStates() {
-		$this->deleteOldStates = false;
-	}
-
-	/**
-	 * Sets an ASDevice for the Statemanager to work with.
-	 *
-	 * @param ASDevice $device
-	 *
-	 * @return bool
-	 */
-	public function SetDevice(&$device) {
-		$this->device = $device;
-
-		return true;
-	}
-
-	/**
-	 * Returns an array will all synchronized folderids.
-	 *
-	 * @return array
-	 */
-	public function GetSynchedFolders() {
-		$synched = [];
-		foreach ($this->device->GetAllFolderIds() as $folderid) {
-			$uuid = $this->device->GetFolderUUID($folderid);
-			if ($uuid) {
-				$synched[] = $folderid;
-			}
-		}
-
-		return $synched;
-	}
-
-	/**
-	 * Returns a folder state (SyncParameters) for a folder id.
-	 *
-	 * @param string $folderid
-	 * @param bool   $fromCacheIfAvailable if set to false, the folderdata is always reloaded, default: true
-	 *
-	 * @return SyncParameters
-	 */
-	public function GetSynchedFolderState($folderid, $fromCacheIfAvailable = true) {
-		// new SyncParameters are cached
-		if ($fromCacheIfAvailable && isset($this->synchedFolders[$folderid])) {
-			return $this->synchedFolders[$folderid];
-		}
-
-		$uuid = $this->device->GetFolderUUID($folderid);
-		if ($uuid) {
-			try {
-				$data = $this->statemachine->GetState($this->device->GetDeviceId(), IStateMachine::FOLDERDATA, $uuid);
-				if ($data !== false) {
-					$this->synchedFolders[$folderid] = $data;
-				}
-			}
-			catch (StateNotFoundException $ex) {
-			}
-		}
-
-		if (!isset($this->synchedFolders[$folderid])) {
-			$this->synchedFolders[$folderid] = new SyncParameters();
-		}
-
-		return $this->synchedFolders[$folderid];
-	}
-
-	/**
-	 * Saves a folder state - SyncParameters object.
-	 *
-	 * @param SyncParamerters $spa
-	 *
-	 * @return bool
-	 */
-	public function SetSynchedFolderState($spa) {
-		// make sure the current uuid is linked on the device for the folder.
-		// if not, old states will be automatically removed and the new ones linked
-		self::LinkState($this->device, $spa->GetUuid(), $spa->GetFolderId());
-
-		$spa->SetReferencePolicyKey($this->device->GetPolicyKey());
-
-		return $this->statemachine->SetState($spa, $this->device->GetDeviceId(), IStateMachine::FOLDERDATA, $spa->GetUuid());
-	}
-
-	/**
-	 * Gets the new sync key for a specified sync key. The new sync state must be
-	 * associated to this sync key when calling SetSyncState().
-	 *
-	 * @param string $synckey
-	 *
-	 * @return string
-	 */
-	public function GetNewSyncKey($synckey) {
-		if (!isset($synckey) || $synckey == "0" || $synckey == false) {
-			$this->uuid = $this->getNewUuid();
-			$this->newStateCounter = 1;
-		}
-		else {
-			list($uuid, $counter) = self::ParseStateKey($synckey);
-			$this->uuid = $uuid;
-			$this->newStateCounter = $counter + 1;
-		}
-
-		return self::BuildStateKey($this->uuid, $this->newStateCounter);
-	}
-
-	/**
-	 * Returns a counter zero SyncKey.
-	 *
-	 * @return string
-	 */
-	public function GetZeroSyncKey() {
-		return self::BuildStateKey($this->getNewUuid(), 0);
-	}
-
-	/**
-	 * Gets the state for a specified synckey (uuid + counter).
-	 *
-	 * @param string $synckey
-	 * @param bool   $forceHierarchyLoading, default: false
-	 *
-	 * @throws StateInvalidException, StateNotFoundException
-	 *
-	 * @return string
-	 */
-	public function GetSyncState($synckey, $forceHierarchyLoading = false) {
-		// No sync state for sync key '0'
-		if ($synckey == "0") {
-			$this->oldStateCounter = 0;
-
-			return "";
-		}
-
-		// Check if synckey is allowed and set uuid and counter
-		list($this->uuid, $this->oldStateCounter) = self::ParseStateKey($synckey);
-
-		// make sure the hierarchy cache is in place
-		if ($this->hierarchyOperation || $forceHierarchyLoading) {
-			$this->loadHierarchyCache($forceHierarchyLoading);
-		}
-
-		// the state machine will discard any sync states before this one, as they are no longer required
-		return $this->statemachine->GetState($this->device->GetDeviceId(), IStateMachine::DEFTYPE, $this->uuid, $this->oldStateCounter, $this->deleteOldStates);
-	}
-
-	/**
-	 * Writes the sync state to a new synckey.
-	 *
-	 * @param string $synckey
-	 * @param string $syncstate
-	 * @param string $folderid  (opt) the synckey is associated with the folder - should always be set when performing CONTENT operations
-	 *
-	 * @throws StateInvalidException
-	 *
-	 * @return bool
-	 */
-	public function SetSyncState($synckey, $syncstate, $folderid = false) {
-		$internalkey = self::BuildStateKey($this->uuid, $this->newStateCounter);
-		if ($this->oldStateCounter != 0 && $synckey != $internalkey) {
-			throw new StateInvalidException(sprintf("Unexpected synckey value oldcounter: '%s' synckey: '%s' internal key: '%s'", $this->oldStateCounter, $synckey, $internalkey));
-		}
-
-		// make sure the hierarchy cache is also saved
-		if ($this->hierarchyOperation) {
-			$this->saveHierarchyCache();
-		}
-
-		// announce this uuid to the device, while old uuid/states should be deleted
-		self::LinkState($this->device, $this->uuid, $folderid);
-
-		return $this->statemachine->SetState($syncstate, $this->device->GetDeviceId(), IStateMachine::DEFTYPE, $this->uuid, $this->newStateCounter);
-	}
-
-	/**
-	 * Gets the failsave sync state for the current synckey.
-	 *
-	 * @return array/boolean    false if not available
-	 */
-	public function GetSyncFailState() {
-		if (!$this->uuid) {
-			return false;
-		}
-
-		try {
-			return $this->statemachine->GetState($this->device->GetDeviceId(), IStateMachine::FAILSAVE, $this->uuid, $this->oldStateCounter, $this->deleteOldStates);
-		}
-		catch (StateNotFoundException $snfex) {
-			return false;
-		}
-	}
-
-	/**
-	 * Writes the failsave sync state for the current (old) synckey.
-	 *
-	 * @param mixed $syncstate
-	 *
-	 * @return bool
-	 */
-	public function SetSyncFailState($syncstate) {
-		if ($this->oldStateCounter == 0) {
-			return false;
-		}
-
-		return $this->statemachine->SetState($syncstate, $this->device->GetDeviceId(), IStateMachine::FAILSAVE, $this->uuid, $this->oldStateCounter);
-	}
-
-	/**
-	 * Gets the backendstorage data.
-	 *
-	 * @param int $type permanent or state related storage
-	 *
-	 * @throws StateNotYetAvailableException, StateNotFoundException
-	 *
-	 * @return mixed
-	 */
-	public function GetBackendStorage($type = self::BACKENDSTORAGE_PERMANENT) {
-		if ($type == self::BACKENDSTORAGE_STATE) {
-			if (!$this->uuid) {
-				throw new StateNotYetAvailableException();
-			}
-
-			return $this->statemachine->GetState($this->device->GetDeviceId(), IStateMachine::BACKENDSTORAGE, $this->uuid, $this->oldStateCounter, $this->deleteOldStates);
-		}
-
-		return $this->statemachine->GetState($this->device->GetDeviceId(), IStateMachine::BACKENDSTORAGE, false, $this->device->GetFirstSyncTime(), false);
-	}
-
-	/**
-	 * Writes the backendstorage data.
-	 *
-	 * @param mixed $data
-	 * @param int   $type permanent or state related storage
-	 *
-	 * @throws StateNotYetAvailableException, StateNotFoundException
-	 *
-	 * @return int amount of bytes saved
-	 */
-	public function SetBackendStorage($data, $type = self::BACKENDSTORAGE_PERMANENT) {
-		if ($type == self::BACKENDSTORAGE_STATE) {
-			if (!$this->uuid) {
-				throw new StateNotYetAvailableException();
-			}
-
-			// TODO serialization should be done in the StateMachine
-			return $this->statemachine->SetState($data, $this->device->GetDeviceId(), IStateMachine::BACKENDSTORAGE, $this->uuid, $this->newStateCounter);
-		}
-
-		return $this->statemachine->SetState($data, $this->device->GetDeviceId(), IStateMachine::BACKENDSTORAGE, false, $this->device->GetFirstSyncTime());
-	}
-
-	/**
-	 * Initializes the HierarchyCache for legacy syncs
-	 * this is for AS 1.0 compatibility:
-	 * save folder information synched with GetHierarchy()
-	 * handled by StateManager.
-	 *
-	 * @param string $folders Array with folder information
-	 *
-	 * @return bool
-	 */
-	public function InitializeFolderCache($folders) {
-		if (!is_array($folders)) {
-			return false;
-		}
-
-		if (!isset($this->device)) {
-			throw new FatalException("ASDevice not initialized");
-		}
-
-		// redeclare this operation as hierarchyOperation
-		$this->hierarchyOperation = true;
-
-		// as there is no hierarchy uuid, we have to create one
-		$this->uuid = $this->getNewUuid();
-		$this->newStateCounter = self::FIXEDHIERARCHYCOUNTER;
-
-		// initialize legacy HierarchCache
-		$this->device->SetHierarchyCache($folders);
-
-		// force saving the hierarchy cache!
-		return $this->saveHierarchyCache(true);
-	}
-
-	/*----------------------------------------------------------------------------------------------------------
+    public const FIXEDHIERARCHYCOUNTER = 99999;
+
+    // backend storage types
+    public const BACKENDSTORAGE_PERMANENT = 1;
+    public const BACKENDSTORAGE_STATE = 2;
+
+    private $statemachine;
+    private $device;
+    private $hierarchyOperation = false;
+    private $deleteOldStates = false;
+
+    private $foldertype;
+    private $uuid;
+    private $oldStateCounter;
+    private $newStateCounter;
+    private $synchedFolders;
+
+    /**
+     * Constructor.
+     */
+    public function __construct() {
+        $this->statemachine = GSync::GetStateMachine();
+        $this->hierarchyOperation = GSync::HierarchyCommand(Request::GetCommandCode());
+        $this->deleteOldStates = (Request::GetCommandCode() === GSync::COMMAND_SYNC || $this->hierarchyOperation);
+        $this->synchedFolders = [];
+    }
+
+    /**
+     * Prevents the StateMachine from removing old states.
+     */
+    public function DoNotDeleteOldStates() {
+        $this->deleteOldStates = false;
+    }
+
+    /**
+     * Sets an ASDevice for the Statemanager to work with.
+     *
+     * @param ASDevice $device
+     *
+     * @return bool
+     */
+    public function SetDevice(&$device) {
+        $this->device = $device;
+
+        return true;
+    }
+
+    /**
+     * Returns an array will all synchronized folderids.
+     *
+     * @return array
+     */
+    public function GetSynchedFolders() {
+        $synched = [];
+        foreach ($this->device->GetAllFolderIds() as $folderid) {
+            $uuid = $this->device->GetFolderUUID($folderid);
+            if ($uuid) {
+                $synched[] = $folderid;
+            }
+        }
+
+        return $synched;
+    }
+
+    /**
+     * Returns a folder state (SyncParameters) for a folder id.
+     *
+     * @param string $folderid
+     * @param bool   $fromCacheIfAvailable if set to false, the folderdata is always reloaded, default: true
+     *
+     * @return SyncParameters
+     */
+    public function GetSynchedFolderState($folderid, $fromCacheIfAvailable = true) {
+        // new SyncParameters are cached
+        if ($fromCacheIfAvailable && isset($this->synchedFolders[$folderid])) {
+            return $this->synchedFolders[$folderid];
+        }
+
+        $uuid = $this->device->GetFolderUUID($folderid);
+        if ($uuid) {
+            try {
+                $data = $this->statemachine->GetState($this->device->GetDeviceId(), IStateMachine::FOLDERDATA, $uuid);
+                if ($data !== false) {
+                    $this->synchedFolders[$folderid] = $data;
+                }
+            }
+            catch (StateNotFoundException $ex) {
+            }
+        }
+
+        if (!isset($this->synchedFolders[$folderid])) {
+            $this->synchedFolders[$folderid] = new SyncParameters();
+        }
+
+        return $this->synchedFolders[$folderid];
+    }
+
+    /**
+     * Saves a folder state - SyncParameters object.
+     *
+     * @param SyncParamerters $spa
+     *
+     * @return bool
+     */
+    public function SetSynchedFolderState($spa) {
+        // make sure the current uuid is linked on the device for the folder.
+        // if not, old states will be automatically removed and the new ones linked
+        self::LinkState($this->device, $spa->GetUuid(), $spa->GetFolderId());
+
+        $spa->SetReferencePolicyKey($this->device->GetPolicyKey());
+
+        return $this->statemachine->SetState($spa, $this->device->GetDeviceId(), IStateMachine::FOLDERDATA, $spa->GetUuid());
+    }
+
+    /**
+     * Gets the new sync key for a specified sync key. The new sync state must be
+     * associated to this sync key when calling SetSyncState().
+     *
+     * @param string $synckey
+     *
+     * @return string
+     */
+    public function GetNewSyncKey($synckey) {
+        if (!isset($synckey) || $synckey == "0" || $synckey == false) {
+            $this->uuid = $this->getNewUuid();
+            $this->newStateCounter = 1;
+        }
+        else {
+            list($uuid, $counter) = self::ParseStateKey($synckey);
+            $this->uuid = $uuid;
+            $this->newStateCounter = $counter + 1;
+        }
+
+        return self::BuildStateKey($this->uuid, $this->newStateCounter);
+    }
+
+    /**
+     * Returns a counter zero SyncKey.
+     *
+     * @return string
+     */
+    public function GetZeroSyncKey() {
+        return self::BuildStateKey($this->getNewUuid(), 0);
+    }
+
+    /**
+     * Gets the state for a specified synckey (uuid + counter).
+     *
+     * @param string $synckey
+     * @param bool   $forceHierarchyLoading, default: false
+     *
+     * @throws StateInvalidException, StateNotFoundException
+     *
+     * @return string
+     */
+    public function GetSyncState($synckey, $forceHierarchyLoading = false) {
+        // No sync state for sync key '0'
+        if ($synckey == "0") {
+            $this->oldStateCounter = 0;
+
+            return "";
+        }
+
+        // Check if synckey is allowed and set uuid and counter
+        list($this->uuid, $this->oldStateCounter) = self::ParseStateKey($synckey);
+
+        // make sure the hierarchy cache is in place
+        if ($this->hierarchyOperation || $forceHierarchyLoading) {
+            $this->loadHierarchyCache($forceHierarchyLoading);
+        }
+
+        // the state machine will discard any sync states before this one, as they are no longer required
+        return $this->statemachine->GetState($this->device->GetDeviceId(), IStateMachine::DEFTYPE, $this->uuid, $this->oldStateCounter, $this->deleteOldStates);
+    }
+
+    /**
+     * Writes the sync state to a new synckey.
+     *
+     * @param string $synckey
+     * @param string $syncstate
+     * @param string $folderid  (opt) the synckey is associated with the folder - should always be set when performing CONTENT operations
+     *
+     * @throws StateInvalidException
+     *
+     * @return bool
+     */
+    public function SetSyncState($synckey, $syncstate, $folderid = false) {
+        $internalkey = self::BuildStateKey($this->uuid, $this->newStateCounter);
+        if ($this->oldStateCounter != 0 && $synckey != $internalkey) {
+            throw new StateInvalidException(sprintf("Unexpected synckey value oldcounter: '%s' synckey: '%s' internal key: '%s'", $this->oldStateCounter, $synckey, $internalkey));
+        }
+
+        // make sure the hierarchy cache is also saved
+        if ($this->hierarchyOperation) {
+            $this->saveHierarchyCache();
+        }
+
+        // announce this uuid to the device, while old uuid/states should be deleted
+        self::LinkState($this->device, $this->uuid, $folderid);
+
+        return $this->statemachine->SetState($syncstate, $this->device->GetDeviceId(), IStateMachine::DEFTYPE, $this->uuid, $this->newStateCounter);
+    }
+
+    /**
+     * Gets the failsave sync state for the current synckey.
+     *
+     * @return array/boolean    false if not available
+     */
+    public function GetSyncFailState() {
+        if (!$this->uuid) {
+            return false;
+        }
+
+        try {
+            return $this->statemachine->GetState($this->device->GetDeviceId(), IStateMachine::FAILSAVE, $this->uuid, $this->oldStateCounter, $this->deleteOldStates);
+        }
+        catch (StateNotFoundException $snfex) {
+            return false;
+        }
+    }
+
+    /**
+     * Writes the failsave sync state for the current (old) synckey.
+     *
+     * @param mixed $syncstate
+     *
+     * @return bool
+     */
+    public function SetSyncFailState($syncstate) {
+        if ($this->oldStateCounter == 0) {
+            return false;
+        }
+
+        return $this->statemachine->SetState($syncstate, $this->device->GetDeviceId(), IStateMachine::FAILSAVE, $this->uuid, $this->oldStateCounter);
+    }
+
+    /**
+     * Gets the backendstorage data.
+     *
+     * @param int $type permanent or state related storage
+     *
+     * @throws StateNotYetAvailableException, StateNotFoundException
+     *
+     * @return mixed
+     */
+    public function GetBackendStorage($type = self::BACKENDSTORAGE_PERMANENT) {
+        if ($type == self::BACKENDSTORAGE_STATE) {
+            if (!$this->uuid) {
+                throw new StateNotYetAvailableException();
+            }
+
+            return $this->statemachine->GetState($this->device->GetDeviceId(), IStateMachine::BACKENDSTORAGE, $this->uuid, $this->oldStateCounter, $this->deleteOldStates);
+        }
+
+        return $this->statemachine->GetState($this->device->GetDeviceId(), IStateMachine::BACKENDSTORAGE, false, $this->device->GetFirstSyncTime(), false);
+    }
+
+    /**
+     * Writes the backendstorage data.
+     *
+     * @param mixed $data
+     * @param int   $type permanent or state related storage
+     *
+     * @throws StateNotYetAvailableException, StateNotFoundException
+     *
+     * @return int amount of bytes saved
+     */
+    public function SetBackendStorage($data, $type = self::BACKENDSTORAGE_PERMANENT) {
+        if ($type == self::BACKENDSTORAGE_STATE) {
+            if (!$this->uuid) {
+                throw new StateNotYetAvailableException();
+            }
+
+            // TODO serialization should be done in the StateMachine
+            return $this->statemachine->SetState($data, $this->device->GetDeviceId(), IStateMachine::BACKENDSTORAGE, $this->uuid, $this->newStateCounter);
+        }
+
+        return $this->statemachine->SetState($data, $this->device->GetDeviceId(), IStateMachine::BACKENDSTORAGE, false, $this->device->GetFirstSyncTime());
+    }
+
+    /**
+     * Initializes the HierarchyCache for legacy syncs
+     * this is for AS 1.0 compatibility:
+     * save folder information synched with GetHierarchy()
+     * handled by StateManager.
+     *
+     * @param string $folders Array with folder information
+     *
+     * @return bool
+     */
+    public function InitializeFolderCache($folders) {
+        if (!is_array($folders)) {
+            return false;
+        }
+
+        if (!isset($this->device)) {
+            throw new FatalException("ASDevice not initialized");
+        }
+
+        // redeclare this operation as hierarchyOperation
+        $this->hierarchyOperation = true;
+
+        // as there is no hierarchy uuid, we have to create one
+        $this->uuid = $this->getNewUuid();
+        $this->newStateCounter = self::FIXEDHIERARCHYCOUNTER;
+
+        // initialize legacy HierarchCache
+        $this->device->SetHierarchyCache($folders);
+
+        // force saving the hierarchy cache!
+        return $this->saveHierarchyCache(true);
+    }
+
+    /*----------------------------------------------------------------------------------------------------------
 	 * static StateManager methods
 	 */
 
-	/**
-	 * Links a folderid to the a UUID
-	 * Old states are removed if an folderid is linked to a new UUID
-	 * assisting the StateMachine to get rid of old data.
-	 *
-	 * @param ASDevice $device
-	 * @param string   $uuid     the uuid to link to
-	 * @param string   $folderid (opt) if not set, hierarchy state is linked
-	 * @param mixed    $newUuid
-	 *
-	 * @return bool
-	 */
-	public static function LinkState(&$device, $newUuid, $folderid = false) {
-		$savedUuid = $device->GetFolderUUID($folderid);
-		// delete 'old' states!
-		if ($savedUuid != $newUuid) {
-			// remove states but no need to notify device
-			self::UnLinkState($device, $folderid, false);
-
-			SLog::Write(LOGLEVEL_DEBUG, sprintf("StateManager::linkState(#ASDevice, '%s','%s'): linked to uuid '%s'.", $newUuid, (($folderid === false) ? 'HierarchyCache' : $folderid), $newUuid));
-
-			return $device->SetFolderUUID($newUuid, $folderid);
-		}
-
-		return true;
-	}
-
-	/**
-	 * UnLinks all states from a folder id
-	 * Old states are removed assisting the StateMachine to get rid of old data.
-	 * The UUID is then removed from the device.
-	 *
-	 * @param ASDevice $device
-	 * @param string   $folderid
-	 * @param bool     $removeFromDevice       indicates if the device should be
-	 *                                         notified that the state was removed
-	 * @param bool     $retrieveUUIDFromDevice indicates if the UUID should be retrieved from
-	 *                                         device. If not true this parameter will be used as UUID.
-	 *
-	 * @return bool
-	 */
-	public static function UnLinkState(&$device, $folderid, $removeFromDevice = true, $retrieveUUIDFromDevice = true) {
-		if ($retrieveUUIDFromDevice === true) {
-			$savedUuid = $device->GetFolderUUID($folderid);
-		}
-		else {
-			$savedUuid = $retrieveUUIDFromDevice;
-		}
-
-		if ($savedUuid) {
-			SLog::Write(LOGLEVEL_DEBUG, sprintf("StateManager::UnLinkState('%s'): saved state '%s' will be deleted.", $folderid, $savedUuid));
-			GSync::GetStateMachine()->CleanStates($device->GetDeviceId(), IStateMachine::DEFTYPE, $savedUuid, self::FIXEDHIERARCHYCOUNTER * 2);
-			GSync::GetStateMachine()->CleanStates($device->GetDeviceId(), IStateMachine::FOLDERDATA, $savedUuid, false, true); // CPO
-			GSync::GetStateMachine()->CleanStates($device->GetDeviceId(), IStateMachine::FAILSAVE, $savedUuid, self::FIXEDHIERARCHYCOUNTER * 2);
-			GSync::GetStateMachine()->CleanStates($device->GetDeviceId(), IStateMachine::BACKENDSTORAGE, $savedUuid, self::FIXEDHIERARCHYCOUNTER * 2);
-
-			// remove all messages which could not be synched before
-			$device->RemoveIgnoredMessage($folderid, false);
-
-			if ($folderid === false && $savedUuid !== false) {
-				GSync::GetStateMachine()->CleanStates($device->GetDeviceId(), IStateMachine::HIERARCHY, $savedUuid, self::FIXEDHIERARCHYCOUNTER * 2);
-			}
-		}
-		// delete this id from the uuid cache
-		if ($removeFromDevice) {
-			return $device->SetFolderUUID(false, $folderid);
-		}
-
-		return true;
-	}
-
-	/**
-	 * Parses a SyncKey and returns UUID and counter.
-	 *
-	 * @param string $synckey
-	 *
-	 * @throws StateInvalidException
-	 *
-	 * @return array uuid, counter
-	 */
-	public static function ParseStateKey($synckey) {
-		$matches = [];
-		if (!preg_match('/^\{([0-9A-Za-z-]+)\}([0-9]+)$/', $synckey, $matches)) {
-			throw new StateInvalidException(sprintf("SyncKey '%s' is invalid", $synckey));
-		}
-
-		return [$matches[1], (int) $matches[2]];
-	}
-
-	/**
-	 * Builds a SyncKey from a UUID and counter.
-	 *
-	 * @param string $uuid
-	 * @param int    $counter
-	 *
-	 * @throws StateInvalidException
-	 *
-	 * @return string syncKey
-	 */
-	public static function BuildStateKey($uuid, $counter) {
-		if (!preg_match('/^([0-9A-Za-z-]+)$/', $uuid, $matches)) {
-			throw new StateInvalidException(sprintf("UUID '%s' is invalid", $uuid));
-		}
-
-		return "{" . $uuid . "}" . $counter;
-	}
-
-	/*----------------------------------------------------------------------------------------------------------
+    /**
+     * Links a folderid to the a UUID
+     * Old states are removed if an folderid is linked to a new UUID
+     * assisting the StateMachine to get rid of old data.
+     *
+     * @param ASDevice $device
+     * @param string   $uuid     the uuid to link to
+     * @param string   $folderid (opt) if not set, hierarchy state is linked
+     * @param mixed    $newUuid
+     *
+     * @return bool
+     */
+    public static function LinkState(&$device, $newUuid, $folderid = false) {
+        $savedUuid = $device->GetFolderUUID($folderid);
+        // delete 'old' states!
+        if ($savedUuid != $newUuid) {
+            // remove states but no need to notify device
+            self::UnLinkState($device, $folderid, false);
+
+            SLog::Write(LOGLEVEL_DEBUG, sprintf("StateManager::linkState(#ASDevice, '%s','%s'): linked to uuid '%s'.", $newUuid, (($folderid === false) ? 'HierarchyCache' : $folderid), $newUuid));
+
+            return $device->SetFolderUUID($newUuid, $folderid);
+        }
+
+        return true;
+    }
+
+    /**
+     * UnLinks all states from a folder id
+     * Old states are removed assisting the StateMachine to get rid of old data.
+     * The UUID is then removed from the device.
+     *
+     * @param ASDevice $device
+     * @param string   $folderid
+     * @param bool     $removeFromDevice       indicates if the device should be
+     *                                         notified that the state was removed
+     * @param bool     $retrieveUUIDFromDevice indicates if the UUID should be retrieved from
+     *                                         device. If not true this parameter will be used as UUID.
+     *
+     * @return bool
+     */
+    public static function UnLinkState(&$device, $folderid, $removeFromDevice = true, $retrieveUUIDFromDevice = true) {
+        if ($retrieveUUIDFromDevice === true) {
+            $savedUuid = $device->GetFolderUUID($folderid);
+        }
+        else {
+            $savedUuid = $retrieveUUIDFromDevice;
+        }
+
+        if ($savedUuid) {
+            SLog::Write(LOGLEVEL_DEBUG, sprintf("StateManager::UnLinkState('%s'): saved state '%s' will be deleted.", $folderid, $savedUuid));
+            GSync::GetStateMachine()->CleanStates($device->GetDeviceId(), IStateMachine::DEFTYPE, $savedUuid, self::FIXEDHIERARCHYCOUNTER * 2);
+            GSync::GetStateMachine()->CleanStates($device->GetDeviceId(), IStateMachine::FOLDERDATA, $savedUuid, false, true); // CPO
+            GSync::GetStateMachine()->CleanStates($device->GetDeviceId(), IStateMachine::FAILSAVE, $savedUuid, self::FIXEDHIERARCHYCOUNTER * 2);
+            GSync::GetStateMachine()->CleanStates($device->GetDeviceId(), IStateMachine::BACKENDSTORAGE, $savedUuid, self::FIXEDHIERARCHYCOUNTER * 2);
+
+            // remove all messages which could not be synched before
+            $device->RemoveIgnoredMessage($folderid, false);
+
+            if ($folderid === false && $savedUuid !== false) {
+                GSync::GetStateMachine()->CleanStates($device->GetDeviceId(), IStateMachine::HIERARCHY, $savedUuid, self::FIXEDHIERARCHYCOUNTER * 2);
+            }
+        }
+        // delete this id from the uuid cache
+        if ($removeFromDevice) {
+            return $device->SetFolderUUID(false, $folderid);
+        }
+
+        return true;
+    }
+
+    /**
+     * Parses a SyncKey and returns UUID and counter.
+     *
+     * @param string $synckey
+     *
+     * @throws StateInvalidException
+     *
+     * @return array uuid, counter
+     */
+    public static function ParseStateKey($synckey) {
+        $matches = [];
+        if (!preg_match('/^\{([0-9A-Za-z-]+)\}([0-9]+)$/', $synckey, $matches)) {
+            throw new StateInvalidException(sprintf("SyncKey '%s' is invalid", $synckey));
+        }
+
+        return [$matches[1], (int) $matches[2]];
+    }
+
+    /**
+     * Builds a SyncKey from a UUID and counter.
+     *
+     * @param string $uuid
+     * @param int    $counter
+     *
+     * @throws StateInvalidException
+     *
+     * @return string syncKey
+     */
+    public static function BuildStateKey($uuid, $counter) {
+        if (!preg_match('/^([0-9A-Za-z-]+)$/', $uuid, $matches)) {
+            throw new StateInvalidException(sprintf("UUID '%s' is invalid", $uuid));
+        }
+
+        return "{" . $uuid . "}" . $counter;
+    }
+
+    /*----------------------------------------------------------------------------------------------------------
 	 * private StateManager methods
 	 */
 
-	/**
-	 * Loads the HierarchyCacheState and initializes the HierarchyChache
-	 * if this is an hierarchy operation.
-	 *
-	 * @param bool $forceLoading, default: false
-	 *
-	 * @throws StateNotFoundException
-	 *
-	 * @return bool
-	 */
-	private function loadHierarchyCache($forceLoading = false) {
-		if (!$this->hierarchyOperation && $forceLoading == false) {
-			return false;
-		}
-
-		SLog::Write(LOGLEVEL_DEBUG, sprintf("StateManager->loadHierarchyCache(): '%s-%s-%s-%d'", $this->device->GetDeviceId(), $this->uuid, IStateMachine::HIERARCHY, $this->oldStateCounter));
-
-		// check if a full hierarchy sync might be necessary
-		if ($this->device->GetFolderUUID(false) === false) {
-			self::UnLinkState($this->device, false, false, $this->uuid);
-
-			throw new StateNotFoundException("No hierarchy UUID linked to device. Requesting folder resync.");
-		}
-
-		$hierarchydata = $this->statemachine->GetState($this->device->GetDeviceId(), IStateMachine::HIERARCHY, $this->uuid, $this->oldStateCounter, $this->deleteOldStates);
-		$this->device->SetHierarchyCache($hierarchydata);
-
-		return true;
-	}
-
-	/**
-	 * Saves the HierarchyCacheState of the HierarchyChache
-	 * if this is an hierarchy operation.
-	 *
-	 * @param bool  $forceLoad   indicates if the cache should be saved also if not a hierary operation
-	 * @param mixed $forceSaving
-	 *
-	 * @throws StateInvalidException
-	 *
-	 * @return bool
-	 */
-	private function saveHierarchyCache($forceSaving = false) {
-		if (!$this->hierarchyOperation && !$forceSaving) {
-			return false;
-		}
-
-		// link the hierarchy cache again, if the UUID does not match the UUID saved in the devicedata
-		if (($this->uuid != $this->device->GetFolderUUID() || $forceSaving)) {
-			self::LinkState($this->device, $this->uuid);
-		}
-
-		// check all folders and deleted folders to update data of ASDevice and delete old states
-		$hc = $this->device->getHierarchyCache();
-		foreach ($hc->GetDeletedFolders() as $delfolder) {
-			self::UnLinkState($this->device, $delfolder->serverid);
-		}
-
-		foreach ($hc->ExportFolders() as $folder) {
-			$this->device->SetFolderType($folder->serverid, $folder->type);
-			$this->device->SetFolderBackendId($folder->serverid, $folder->BackendId);
-		}
-
-		return $this->statemachine->SetState($this->device->GetHierarchyCacheData(), $this->device->GetDeviceId(), IStateMachine::HIERARCHY, $this->uuid, $this->newStateCounter);
-	}
-
-	/**
-	 * Generates a new UUID.
-	 *
-	 * @return string
-	 */
-	private function getNewUuid() {
-		return sprintf(
-			'%04x%04x-%04x-%04x-%04x-%04x%04x%04x',
-			mt_rand(0, 0xFFFF),
-			mt_rand(0, 0xFFFF),
-			mt_rand(0, 0xFFFF),
-			mt_rand(0, 0x0FFF) | 0x4000,
-			mt_rand(0, 0x3FFF) | 0x8000,
-			mt_rand(0, 0xFFFF),
-			mt_rand(0, 0xFFFF),
-			mt_rand(0, 0xFFFF)
-		);
-	}
+    /**
+     * Loads the HierarchyCacheState and initializes the HierarchyChache
+     * if this is an hierarchy operation.
+     *
+     * @param bool $forceLoading, default: false
+     *
+     * @throws StateNotFoundException
+     *
+     * @return bool
+     */
+    private function loadHierarchyCache($forceLoading = false) {
+        if (!$this->hierarchyOperation && $forceLoading == false) {
+            return false;
+        }
+
+        SLog::Write(LOGLEVEL_DEBUG, sprintf("StateManager->loadHierarchyCache(): '%s-%s-%s-%d'", $this->device->GetDeviceId(), $this->uuid, IStateMachine::HIERARCHY, $this->oldStateCounter));
+
+        // check if a full hierarchy sync might be necessary
+        if ($this->device->GetFolderUUID(false) === false) {
+            self::UnLinkState($this->device, false, false, $this->uuid);
+
+            throw new StateNotFoundException("No hierarchy UUID linked to device. Requesting folder resync.");
+        }
+
+        $hierarchydata = $this->statemachine->GetState($this->device->GetDeviceId(), IStateMachine::HIERARCHY, $this->uuid, $this->oldStateCounter, $this->deleteOldStates);
+        $this->device->SetHierarchyCache($hierarchydata);
+
+        return true;
+    }
+
+    /**
+     * Saves the HierarchyCacheState of the HierarchyChache
+     * if this is an hierarchy operation.
+     *
+     * @param bool  $forceLoad   indicates if the cache should be saved also if not a hierary operation
+     * @param mixed $forceSaving
+     *
+     * @throws StateInvalidException
+     *
+     * @return bool
+     */
+    private function saveHierarchyCache($forceSaving = false) {
+        if (!$this->hierarchyOperation && !$forceSaving) {
+            return false;
+        }
+
+        // link the hierarchy cache again, if the UUID does not match the UUID saved in the devicedata
+        if (($this->uuid != $this->device->GetFolderUUID() || $forceSaving)) {
+            self::LinkState($this->device, $this->uuid);
+        }
+
+        // check all folders and deleted folders to update data of ASDevice and delete old states
+        $hc = $this->device->getHierarchyCache();
+        foreach ($hc->GetDeletedFolders() as $delfolder) {
+            self::UnLinkState($this->device, $delfolder->serverid);
+        }
+
+        foreach ($hc->ExportFolders() as $folder) {
+            $this->device->SetFolderType($folder->serverid, $folder->type);
+            $this->device->SetFolderBackendId($folder->serverid, $folder->BackendId);
+        }
+
+        return $this->statemachine->SetState($this->device->GetHierarchyCacheData(), $this->device->GetDeviceId(), IStateMachine::HIERARCHY, $this->uuid, $this->newStateCounter);
+    }
+
+    /**
+     * Generates a new UUID.
+     *
+     * @return string
+     */
+    private function getNewUuid() {
+        return sprintf(
+            '%04x%04x-%04x-%04x-%04x-%04x%04x%04x',
+            mt_rand(0, 0xFFFF),
+            mt_rand(0, 0xFFFF),
+            mt_rand(0, 0xFFFF),
+            mt_rand(0, 0x0FFF) | 0x4000,
+            mt_rand(0, 0x3FFF) | 0x8000,
+            mt_rand(0, 0xFFFF),
+            mt_rand(0, 0xFFFF),
+            mt_rand(0, 0xFFFF)
+        );
+    }
 }

Spacing +4 added lines, -4 removed lines

@@ -419,7 +419,7 @@ 
 			throw new StateInvalidException(sprintf("SyncKey '%s' is invalid", $synckey));
 		}
 
-		return [$matches[1], (int) $matches[2]];
+		return [$matches[1], (int)$matches[2]];
 	}
 
 	/**
@@ -437,7 +437,7 @@ 
 			throw new StateInvalidException(sprintf("UUID '%s' is invalid", $uuid));
 		}
 
-		return "{" . $uuid . "}" . $counter;
+		return "{".$uuid."}".$counter;
 	}
 
 	/*----------------------------------------------------------------------------------------------------------
@@ -520,8 +520,8 @@ 
 			mt_rand(0, 0xFFFF),
 			mt_rand(0, 0xFFFF),
 			mt_rand(0, 0xFFFF),
-			mt_rand(0, 0x0FFF) | 0x4000,
-			mt_rand(0, 0x3FFF) | 0x8000,
+			mt_rand(0, 0x0FFF)|0x4000,
+			mt_rand(0, 0x3FFF)|0x8000,
 			mt_rand(0, 0xFFFF),
 			mt_rand(0, 0xFFFF),
 			mt_rand(0, 0xFFFF)

Braces +4 added lines, -8 removed lines

@@ -101,8 +101,7 @@ 
 				if ($data !== false) {
 					$this->synchedFolders[$folderid] = $data;
 				}
-			}
-			catch (StateNotFoundException $ex) {
+			} catch (StateNotFoundException $ex) {
 			}
 		}
 
@@ -142,8 +141,7 @@ 
 		if (!isset($synckey) || $synckey == "0" || $synckey == false) {
 			$this->uuid = $this->getNewUuid();
 			$this->newStateCounter = 1;
-		}
-		else {
+		} else {
 			list($uuid, $counter) = self::ParseStateKey($synckey);
 			$this->uuid = $uuid;
 			$this->newStateCounter = $counter + 1;
@@ -231,8 +229,7 @@ 
 
 		try {
 			return $this->statemachine->GetState($this->device->GetDeviceId(), IStateMachine::FAILSAVE, $this->uuid, $this->oldStateCounter, $this->deleteOldStates);
-		}
-		catch (StateNotFoundException $snfex) {
+		} catch (StateNotFoundException $snfex) {
 			return false;
 		}
 	}
@@ -377,8 +374,7 @@ 
 	public static function UnLinkState(&$device, $folderid, $removeFromDevice = true, $retrieveUUIDFromDevice = true) {
 		if ($retrieveUUIDFromDevice === true) {
 			$savedUuid = $device->GetFolderUUID($folderid);
-		}
-		else {
+		} else {
 			$savedUuid = $retrieveUUIDFromDevice;
 		}
 

lib/core/pingtracking.php

Indentation +48 added lines, -48 removed lines

@@ -6,58 +6,58 @@
  */
 
 class PingTracking extends InterProcessData {
-	/**
-	 * Constructor.
-	 */
-	public function __construct() {
-		// initialize super parameters
-		$this->allocate = 0;
-		$this->type = "grommunio-sync:pingtracking";
-		parent::__construct();
+    /**
+     * Constructor.
+     */
+    public function __construct() {
+        // initialize super parameters
+        $this->allocate = 0;
+        $this->type = "grommunio-sync:pingtracking";
+        parent::__construct();
 
-		$this->initPing();
-	}
+        $this->initPing();
+    }
 
-	/**
-	 * Destructor
-	 * Used to remove the current ping data from shared memory.
-	 */
-	public function __destruct() {
-		return $this->setDeviceUserData($this->type, ["pid:" . self::$pid], self::$devid, self::$user, $subkey = -1, $doCas = "deletekeys");
-	}
+    /**
+     * Destructor
+     * Used to remove the current ping data from shared memory.
+     */
+    public function __destruct() {
+        return $this->setDeviceUserData($this->type, ["pid:" . self::$pid], self::$devid, self::$user, $subkey = -1, $doCas = "deletekeys");
+    }
 
-	/**
-	 * Initialized the current request.
-	 *
-	 * @return bool
-	 */
-	protected function initPing() {
-		// initialize params
-		$this->initializeParams();
-		// need microtime as connections sometimes start at the same second
-		self::$start = microtime(true);
-		$pingtracking = ["pid:" . self::$pid => self::$start];
+    /**
+     * Initialized the current request.
+     *
+     * @return bool
+     */
+    protected function initPing() {
+        // initialize params
+        $this->initializeParams();
+        // need microtime as connections sometimes start at the same second
+        self::$start = microtime(true);
+        $pingtracking = ["pid:" . self::$pid => self::$start];
 
-		return $this->setDeviceUserData($this->type, $pingtracking, self::$devid, self::$user, $subkey = -1, $doCas = "merge");
-	}
+        return $this->setDeviceUserData($this->type, $pingtracking, self::$devid, self::$user, $subkey = -1, $doCas = "merge");
+    }
 
-	/**
-	 * Checks if there are newer ping requests for the same device & user so
-	 * the current process could be terminated.
-	 *
-	 * @return bool true if the current process is obsolete
-	 */
-	public function DoForcePingTimeout() {
-		$pings = $this->getDeviceUserData($this->type, self::$devid, self::$user);
-		// check if there is another (and newer) active ping connection
-		if (count($pings) > 1) {
-			foreach ($pings as $pid => $starttime) {
-				if ($starttime > self::$start) {
-					return true;
-				}
-			}
-		}
+    /**
+     * Checks if there are newer ping requests for the same device & user so
+     * the current process could be terminated.
+     *
+     * @return bool true if the current process is obsolete
+     */
+    public function DoForcePingTimeout() {
+        $pings = $this->getDeviceUserData($this->type, self::$devid, self::$user);
+        // check if there is another (and newer) active ping connection
+        if (count($pings) > 1) {
+            foreach ($pings as $pid => $starttime) {
+                if ($starttime > self::$start) {
+                    return true;
+                }
+            }
+        }
 
-		return false;
-	}
+        return false;
+    }
 }

Spacing +2 added lines, -2 removed lines

@@ -23,7 +23,7 @@ 
 	 * Used to remove the current ping data from shared memory.
 	 */
 	public function __destruct() {
-		return $this->setDeviceUserData($this->type, ["pid:" . self::$pid], self::$devid, self::$user, $subkey = -1, $doCas = "deletekeys");
+		return $this->setDeviceUserData($this->type, ["pid:".self::$pid], self::$devid, self::$user, $subkey = -1, $doCas = "deletekeys");
 	}
 
 	/**
@@ -36,7 +36,7 @@ 
 		$this->initializeParams();
 		// need microtime as connections sometimes start at the same second
 		self::$start = microtime(true);
-		$pingtracking = ["pid:" . self::$pid => self::$start];
+		$pingtracking = ["pid:".self::$pid => self::$start];
 
 		return $this->setDeviceUserData($this->type, $pingtracking, self::$devid, self::$user, $subkey = -1, $doCas = "merge");
 	}

lib/core/provisioningmanager.php

Indentation +227 added lines, -227 removed lines

@@ -8,231 +8,231 @@
  */
 
 class ProvisioningManager extends InterProcessData {
-	public const KEY_POLICYKEY = "policykey";
-	public const KEY_POLICYHASH = "policyhash";
-	public const KEY_UPDATETIME = "updatetime";
-
-	private $policies = [];
-	private $policyKey = ASDevice::UNDEFINED;
-	private $policyHash = ASDevice::UNDEFINED;
-	private $updatetime = 0;
-	private $loadtime = 0;
-	private $typePolicyCacheId = false;
-
-	/**
-	 * Constructor.
-	 */
-	public function __construct() {
-		// initialize super parameters
-		$this->allocate = 0;
-		$this->type = "grommunio-sync:provisioningcache";
-		parent::__construct();
-		// initialize params
-		$this->initializeParams();
-
-		$this->typePolicyCacheId = sprintf("grommunio-sync:policycache-%s", self::$user);
-
-		// Remote wipe requested ?
-		// If there is an entry in the provisioningcache for this user+device we assume that there is **NO** remote wipe requested.
-		// If a device is to be remotewipe'd, the entry from the provisioningcache will be removed by the admin api.
-		// This will trigger a provisioning operation and retrieve the status via GetProvisioningWipeStatus().
-
-		// get provisioning data from redis
-		$p = $this->getData($this->typePolicyCacheId);
-		if (!empty($p)) {
-			$this->policies = $p;
-		}
-		// no policies cached in redis, get policies from admin API
-		else {
-			$policies = false;
-			$api_response = file_get_contents(ADMIN_API_POLICY_ENDPOINT . self::$user);
-			if ($api_response) {
-				$data = json_decode($api_response);
-				if (isset($data->data)) {
-					$policies = $data->data;
-				}
-			}
-
-			// failed to retrieve: use default "empty" policy
-			if (!$policies) {
-				// failed to retrieve: use default "empty" policy
-				$policies = [];
-			}
-			$this->policies = $policies;
-			// cache policies for 24h
-			$this->setData($this->policies, $this->typePolicyCacheId, 3600 * 24);
-		}
-
-		// get policykey and hash
-		$this->loadPolicyCache();
-	}
-
-	private function loadPolicyCache() {
-		if ($this->loadtime + 29 > time()) {
-			return;
-		}
-		// get provisioning data from redis
-		$d = $this->getDeviceUserData($this->type, self::$devid, self::$user);
-		if (!empty($d)) {
-			$this->policyKey = $d[self::KEY_POLICYKEY];
-			$this->policyHash = $d[self::KEY_POLICYHASH];
-			$this->updatetime = $d[self::KEY_UPDATETIME];
-			$this->loadtime = time();
-		}
-		else {
-			$this->policyKey = ASDevice::UNDEFINED;
-			$this->policyHash = ASDevice::UNDEFINED;
-			$this->updatetime = 0;
-			$this->loadtime = time();
-		}
-	}
-
-	private function updatePolicyCache() {
-		$p = [];
-		$p[self::KEY_POLICYKEY] = $this->policyKey;
-		$p[self::KEY_POLICYHASH] = $this->policyHash;
-		$p[self::KEY_UPDATETIME] = time();
-
-		return $this->setDeviceUserData($this->type, $p, self::$devid, self::$user);
-	}
-
-	/**
-	 * Checks if the sent policykey matches the latest policykey
-	 * saved for the device.
-	 *
-	 * @param string $policykey
-	 * @param bool   $noDebug       (opt) by default, debug message is shown
-	 * @param bool   $checkPolicies (opt) by default check if the provisioning policies changed
-	 *
-	 * @return bool
-	 */
-	public function ProvisioningRequired($policykey, $noDebug = false, $checkPolicies = true) {
-		// get latest policykey and hash
-		$this->loadPolicyCache();
-
-		// check if policiykey matches
-		$p = (($policykey !== ASDevice::UNDEFINED && $policykey != $this->policyKey) || $this->policyKey == ASDevice::UNDEFINED);
-
-		if (!$noDebug || $p) {
-			SLog::Write(LOGLEVEL_DEBUG, sprintf("ProvisioningManager->ProvisioningRequired('%s') saved device key '%s': %s", $policykey, $this->policyKey, Utils::PrintAsString($p)));
-		}
-
-		if ($checkPolicies) {
-			$policyHash = $this->GetProvisioningObject()->GetPolicyHash();
-			if ($this->policyHash !== ASDevice::UNDEFINED && $this->policyHash != $policyHash) {
-				$p = true;
-				SLog::Write(LOGLEVEL_INFO, sprintf("ProvisioningManager->ProvisioningRequired(): saved policy hash '%s' changed to '%s'. Provisioning required.", $this->policyHash, $policyHash));
-			}
-			elseif (!$noDebug) {
-				SLog::Write(LOGLEVEL_DEBUG, sprintf("ProvisioningManager->ProvisioningRequired() saved policy hash '%s' matches", $policyHash));
-			}
-		}
-
-		return $p;
-	}
-
-	/**
-	 * Generates a new Policykey.
-	 *
-	 * @return int
-	 */
-	public function GenerateProvisioningPolicyKey() {
-		return mt_rand(100000000, 999999999);
-	}
-
-	/**
-	 * Attributes a provisioned policykey to a device.
-	 *
-	 * @param int $policykey
-	 *
-	 * @return bool status
-	 */
-	public function SetProvisioningPolicyKey($policykey) {
-		SLog::Write(LOGLEVEL_DEBUG, sprintf("ProvisioningManager->SetPolicyKey('%s')", $policykey));
-		$this->policyKey = $policykey;
-		$this->updatePolicyCache();
-
-		// tell the Admin API that the policies were successfully deployed
-		return $this->SetProvisioningWipeStatus(SYNC_PROVISION_RWSTATUS_OK);
-	}
-
-	/**
-	 * Builds a Provisioning SyncObject with policies.
-	 *
-	 * @param bool $logPolicies optional, determines if the policies and values should be logged. Default: false
-	 *
-	 * @return SyncProvisioning
-	 */
-	public function GetProvisioningObject($logPolicies = false) {
-		return SyncProvisioning::GetObjectWithPolicies($this->policies, $logPolicies);
-	}
-
-	/**
-	 * Returns the status of the remote wipe policy.
-	 *
-	 * @return int returns the current status of the device - SYNC_PROVISION_RWSTATUS_*
-	 */
-	public function GetProvisioningWipeStatus() {
-		$status = SYNC_PROVISION_RWSTATUS_NA;
-
-		// retrieve the WIPE STATUS from the Admin API
-		$api_response = file_get_contents(ADMIN_API_WIPE_ENDPOINT . self::$user . "?devices=" . self::$devid);
-		if ($api_response) {
-			$data = json_decode($api_response, true);
-			if (isset($data['data'][self::$devid]["status"])) {
-				$status = $data['data'][self::$devid]["status"];
-				// reset status to pending if it was already executed
-				if ($status >= SYNC_PROVISION_RWSTATUS_PENDING) {
-					SLog::Write(LOGLEVEL_INFO, sprintf("ProvisioningManager->GetProvisioningWipeStatus(): REMOTE WIPE due for user '%s' on device '%s' - status: '%s'", self::$user, self::$devid, $status));
-					$status = SYNC_PROVISION_RWSTATUS_PENDING;
-				}
-				else {
-					SLog::Write(LOGLEVEL_INFO, sprintf("ProvisioningManager->GetProvisioningWipeStatus(): no remote wipe pending - status: '%s'", $status));
-				}
-			}
-		}
-
-		return $status;
-	}
-
-	/**
-	 * Updates the status of the remote wipe.
-	 *
-	 * @param int $status - SYNC_PROVISION_RWSTATUS_*
-	 *
-	 * @return bool could fail if trying to update status to a wipe status which was not requested before
-	 */
-	public function SetProvisioningWipeStatus($status) {
-		SLog::Write(LOGLEVEL_DEBUG, sprintf("ProvisioningManager->SetProvisioningWipeStatus() set to '%d'", $status));
-		$opts = ['http' => [
-			'method' => 'POST',
-			'header' => 'Content-Type: application/json',
-			'ignore_errors' => true,
-			'content' => json_encode(
-				[
-					'remoteIP' => Request::GetRemoteAddr(),
-					'status' => $status,
-					'time' => time(),
-				]
-			),
-		],
-		];
-		$ret = file_get_contents(ADMIN_API_WIPE_ENDPOINT . self::$user . "?devices=" . self::$devid, false, stream_context_create($opts));
-		SLog::Write(LOGLEVEL_DEBUG, sprintf("ProvisioningManager->SetProvisioningWipeStatus() admin API response: %s", trim(Utils::PrintAsString($ret))));
-
-		return strpos($http_response_header[0], "201") !== false;
-	}
-
-	/**
-	 * Saves the policy hash and name in device's state.
-	 *
-	 * @param SyncProvisioning $provisioning
-	 */
-	public function SavePolicyHash($provisioning) {
-		// save policies' hash
-		$this->policyHash = $provisioning->GetPolicyHash();
-		$this->updatePolicyCache();
-
-		SLog::Write(LOGLEVEL_DEBUG, sprintf("ProvisioningManager->SavePolicyHash(): Set policy with hash: %s", $this->policyHash));
-	}
+    public const KEY_POLICYKEY = "policykey";
+    public const KEY_POLICYHASH = "policyhash";
+    public const KEY_UPDATETIME = "updatetime";
+
+    private $policies = [];
+    private $policyKey = ASDevice::UNDEFINED;
+    private $policyHash = ASDevice::UNDEFINED;
+    private $updatetime = 0;
+    private $loadtime = 0;
+    private $typePolicyCacheId = false;
+
+    /**
+     * Constructor.
+     */
+    public function __construct() {
+        // initialize super parameters
+        $this->allocate = 0;
+        $this->type = "grommunio-sync:provisioningcache";
+        parent::__construct();
+        // initialize params
+        $this->initializeParams();
+
+        $this->typePolicyCacheId = sprintf("grommunio-sync:policycache-%s", self::$user);
+
+        // Remote wipe requested ?
+        // If there is an entry in the provisioningcache for this user+device we assume that there is **NO** remote wipe requested.
+        // If a device is to be remotewipe'd, the entry from the provisioningcache will be removed by the admin api.
+        // This will trigger a provisioning operation and retrieve the status via GetProvisioningWipeStatus().
+
+        // get provisioning data from redis
+        $p = $this->getData($this->typePolicyCacheId);
+        if (!empty($p)) {
+            $this->policies = $p;
+        }
+        // no policies cached in redis, get policies from admin API
+        else {
+            $policies = false;
+            $api_response = file_get_contents(ADMIN_API_POLICY_ENDPOINT . self::$user);
+            if ($api_response) {
+                $data = json_decode($api_response);
+                if (isset($data->data)) {
+                    $policies = $data->data;
+                }
+            }
+
+            // failed to retrieve: use default "empty" policy
+            if (!$policies) {
+                // failed to retrieve: use default "empty" policy
+                $policies = [];
+            }
+            $this->policies = $policies;
+            // cache policies for 24h
+            $this->setData($this->policies, $this->typePolicyCacheId, 3600 * 24);
+        }
+
+        // get policykey and hash
+        $this->loadPolicyCache();
+    }
+
+    private function loadPolicyCache() {
+        if ($this->loadtime + 29 > time()) {
+            return;
+        }
+        // get provisioning data from redis
+        $d = $this->getDeviceUserData($this->type, self::$devid, self::$user);
+        if (!empty($d)) {
+            $this->policyKey = $d[self::KEY_POLICYKEY];
+            $this->policyHash = $d[self::KEY_POLICYHASH];
+            $this->updatetime = $d[self::KEY_UPDATETIME];
+            $this->loadtime = time();
+        }
+        else {
+            $this->policyKey = ASDevice::UNDEFINED;
+            $this->policyHash = ASDevice::UNDEFINED;
+            $this->updatetime = 0;
+            $this->loadtime = time();
+        }
+    }
+
+    private function updatePolicyCache() {
+        $p = [];
+        $p[self::KEY_POLICYKEY] = $this->policyKey;
+        $p[self::KEY_POLICYHASH] = $this->policyHash;
+        $p[self::KEY_UPDATETIME] = time();
+
+        return $this->setDeviceUserData($this->type, $p, self::$devid, self::$user);
+    }
+
+    /**
+     * Checks if the sent policykey matches the latest policykey
+     * saved for the device.
+     *
+     * @param string $policykey
+     * @param bool   $noDebug       (opt) by default, debug message is shown
+     * @param bool   $checkPolicies (opt) by default check if the provisioning policies changed
+     *
+     * @return bool
+     */
+    public function ProvisioningRequired($policykey, $noDebug = false, $checkPolicies = true) {
+        // get latest policykey and hash
+        $this->loadPolicyCache();
+
+        // check if policiykey matches
+        $p = (($policykey !== ASDevice::UNDEFINED && $policykey != $this->policyKey) || $this->policyKey == ASDevice::UNDEFINED);
+
+        if (!$noDebug || $p) {
+            SLog::Write(LOGLEVEL_DEBUG, sprintf("ProvisioningManager->ProvisioningRequired('%s') saved device key '%s': %s", $policykey, $this->policyKey, Utils::PrintAsString($p)));
+        }
+
+        if ($checkPolicies) {
+            $policyHash = $this->GetProvisioningObject()->GetPolicyHash();
+            if ($this->policyHash !== ASDevice::UNDEFINED && $this->policyHash != $policyHash) {
+                $p = true;
+                SLog::Write(LOGLEVEL_INFO, sprintf("ProvisioningManager->ProvisioningRequired(): saved policy hash '%s' changed to '%s'. Provisioning required.", $this->policyHash, $policyHash));
+            }
+            elseif (!$noDebug) {
+                SLog::Write(LOGLEVEL_DEBUG, sprintf("ProvisioningManager->ProvisioningRequired() saved policy hash '%s' matches", $policyHash));
+            }
+        }
+
+        return $p;
+    }
+
+    /**
+     * Generates a new Policykey.
+     *
+     * @return int
+     */
+    public function GenerateProvisioningPolicyKey() {
+        return mt_rand(100000000, 999999999);
+    }
+
+    /**
+     * Attributes a provisioned policykey to a device.
+     *
+     * @param int $policykey
+     *
+     * @return bool status
+     */
+    public function SetProvisioningPolicyKey($policykey) {
+        SLog::Write(LOGLEVEL_DEBUG, sprintf("ProvisioningManager->SetPolicyKey('%s')", $policykey));
+        $this->policyKey = $policykey;
+        $this->updatePolicyCache();
+
+        // tell the Admin API that the policies were successfully deployed
+        return $this->SetProvisioningWipeStatus(SYNC_PROVISION_RWSTATUS_OK);
+    }
+
+    /**
+     * Builds a Provisioning SyncObject with policies.
+     *
+     * @param bool $logPolicies optional, determines if the policies and values should be logged. Default: false
+     *
+     * @return SyncProvisioning
+     */
+    public function GetProvisioningObject($logPolicies = false) {
+        return SyncProvisioning::GetObjectWithPolicies($this->policies, $logPolicies);
+    }
+
+    /**
+     * Returns the status of the remote wipe policy.
+     *
+     * @return int returns the current status of the device - SYNC_PROVISION_RWSTATUS_*
+     */
+    public function GetProvisioningWipeStatus() {
+        $status = SYNC_PROVISION_RWSTATUS_NA;
+
+        // retrieve the WIPE STATUS from the Admin API
+        $api_response = file_get_contents(ADMIN_API_WIPE_ENDPOINT . self::$user . "?devices=" . self::$devid);
+        if ($api_response) {
+            $data = json_decode($api_response, true);
+            if (isset($data['data'][self::$devid]["status"])) {
+                $status = $data['data'][self::$devid]["status"];
+                // reset status to pending if it was already executed
+                if ($status >= SYNC_PROVISION_RWSTATUS_PENDING) {
+                    SLog::Write(LOGLEVEL_INFO, sprintf("ProvisioningManager->GetProvisioningWipeStatus(): REMOTE WIPE due for user '%s' on device '%s' - status: '%s'", self::$user, self::$devid, $status));
+                    $status = SYNC_PROVISION_RWSTATUS_PENDING;
+                }
+                else {
+                    SLog::Write(LOGLEVEL_INFO, sprintf("ProvisioningManager->GetProvisioningWipeStatus(): no remote wipe pending - status: '%s'", $status));
+                }
+            }
+        }
+
+        return $status;
+    }
+
+    /**
+     * Updates the status of the remote wipe.
+     *
+     * @param int $status - SYNC_PROVISION_RWSTATUS_*
+     *
+     * @return bool could fail if trying to update status to a wipe status which was not requested before
+     */
+    public function SetProvisioningWipeStatus($status) {
+        SLog::Write(LOGLEVEL_DEBUG, sprintf("ProvisioningManager->SetProvisioningWipeStatus() set to '%d'", $status));
+        $opts = ['http' => [
+            'method' => 'POST',
+            'header' => 'Content-Type: application/json',
+            'ignore_errors' => true,
+            'content' => json_encode(
+                [
+                    'remoteIP' => Request::GetRemoteAddr(),
+                    'status' => $status,
+                    'time' => time(),
+                ]
+            ),
+        ],
+        ];
+        $ret = file_get_contents(ADMIN_API_WIPE_ENDPOINT . self::$user . "?devices=" . self::$devid, false, stream_context_create($opts));
+        SLog::Write(LOGLEVEL_DEBUG, sprintf("ProvisioningManager->SetProvisioningWipeStatus() admin API response: %s", trim(Utils::PrintAsString($ret))));
+
+        return strpos($http_response_header[0], "201") !== false;
+    }
+
+    /**
+     * Saves the policy hash and name in device's state.
+     *
+     * @param SyncProvisioning $provisioning
+     */
+    public function SavePolicyHash($provisioning) {
+        // save policies' hash
+        $this->policyHash = $provisioning->GetPolicyHash();
+        $this->updatePolicyCache();
+
+        SLog::Write(LOGLEVEL_DEBUG, sprintf("ProvisioningManager->SavePolicyHash(): Set policy with hash: %s", $this->policyHash));
+    }
 }

Spacing +3 added lines, -3 removed lines

@@ -45,7 +45,7 @@ 
 		// no policies cached in redis, get policies from admin API
 		else {
 			$policies = false;
-			$api_response = file_get_contents(ADMIN_API_POLICY_ENDPOINT . self::$user);
+			$api_response = file_get_contents(ADMIN_API_POLICY_ENDPOINT.self::$user);
 			if ($api_response) {
 				$data = json_decode($api_response);
 				if (isset($data->data)) {
@@ -176,7 +176,7 @@ 
 		$status = SYNC_PROVISION_RWSTATUS_NA;
 
 		// retrieve the WIPE STATUS from the Admin API
-		$api_response = file_get_contents(ADMIN_API_WIPE_ENDPOINT . self::$user . "?devices=" . self::$devid);
+		$api_response = file_get_contents(ADMIN_API_WIPE_ENDPOINT.self::$user."?devices=".self::$devid);
 		if ($api_response) {
 			$data = json_decode($api_response, true);
 			if (isset($data['data'][self::$devid]["status"])) {
@@ -217,7 +217,7 @@ 
 			),
 		],
 		];
-		$ret = file_get_contents(ADMIN_API_WIPE_ENDPOINT . self::$user . "?devices=" . self::$devid, false, stream_context_create($opts));
+		$ret = file_get_contents(ADMIN_API_WIPE_ENDPOINT.self::$user."?devices=".self::$devid, false, stream_context_create($opts));
 		SLog::Write(LOGLEVEL_DEBUG, sprintf("ProvisioningManager->SetProvisioningWipeStatus() admin API response: %s", trim(Utils::PrintAsString($ret))));
 
 		return strpos($http_response_header[0], "201") !== false;

Braces +3 added lines, -6 removed lines

@@ -78,8 +78,7 @@ 
 			$this->policyHash = $d[self::KEY_POLICYHASH];
 			$this->updatetime = $d[self::KEY_UPDATETIME];
 			$this->loadtime = time();
-		}
-		else {
+		} else {
 			$this->policyKey = ASDevice::UNDEFINED;
 			$this->policyHash = ASDevice::UNDEFINED;
 			$this->updatetime = 0;
@@ -122,8 +121,7 @@ 
 			if ($this->policyHash !== ASDevice::UNDEFINED && $this->policyHash != $policyHash) {
 				$p = true;
 				SLog::Write(LOGLEVEL_INFO, sprintf("ProvisioningManager->ProvisioningRequired(): saved policy hash '%s' changed to '%s'. Provisioning required.", $this->policyHash, $policyHash));
-			}
-			elseif (!$noDebug) {
+			} elseif (!$noDebug) {
 				SLog::Write(LOGLEVEL_DEBUG, sprintf("ProvisioningManager->ProvisioningRequired() saved policy hash '%s' matches", $policyHash));
 			}
 		}
@@ -185,8 +183,7 @@ 
 				if ($status >= SYNC_PROVISION_RWSTATUS_PENDING) {
 					SLog::Write(LOGLEVEL_INFO, sprintf("ProvisioningManager->GetProvisioningWipeStatus(): REMOTE WIPE due for user '%s' on device '%s' - status: '%s'", self::$user, self::$devid, $status));
 					$status = SYNC_PROVISION_RWSTATUS_PENDING;
-				}
-				else {
+				} else {
 					SLog::Write(LOGLEVEL_INFO, sprintf("ProvisioningManager->GetProvisioningWipeStatus(): no remote wipe pending - status: '%s'", $status));
 				}
 			}