grommunio / grommunio-sync

lib/core/synccollections.php

Indentation +903 added lines, -903 removed lines

@@ -19,907 +19,907 @@
  */
 
 class SyncCollections implements Iterator {
-	public const ERROR_NO_COLLECTIONS = 1;
-	public const ERROR_WRONG_HIERARCHY = 2;
-	public const OBSOLETE_CONNECTION = 3;
-	public const HIERARCHY_CHANGED = 4;
-
-	private $stateManager;
-
-	private $collections = [];
-	private $addparms = [];
-	private $changes = [];
-	private $saveData = true;
-
-	private $refPolicyKey = false;
-	private $refLifetime = false;
-
-	private $globalWindowSize;
-	private $lastSyncTime;
-
-	private $waitingTime = 0;
-	private $hierarchyExporterChecked = false;
-	private $loggedGlobalWindowSizeOverwrite = false;
-
-	/**
-	 * Invalidates all pingable flags for all folders.
-	 *
-	 * @return bool
-	 */
-	public static function InvalidatePingableFlags() {
-		SLog::Write(LOGLEVEL_DEBUG, "SyncCollections::InvalidatePingableFlags(): Invalidating now");
-
-		try {
-			$sc = new SyncCollections();
-			$sc->LoadAllCollections();
-			foreach ($sc as $folderid => $spa) {
-				if ($spa->GetPingableFlag() == true) {
-					$spa->DelPingableFlag();
-					$sc->SaveCollection($spa);
-				}
-			}
-
-			return true;
-		}
-		catch (GSyncException $e) {
-		}
-
-		return false;
-	}
-
-	/**
-	 * Constructor.
-	 */
-	public function __construct() {
-	}
-
-	/**
-	 * Sets the StateManager for this object
-	 * If this is not done and a method needs it, the StateManager will be
-	 * requested from the DeviceManager.
-	 *
-	 * @param StateManager $statemanager
-	 *
-	 * @return
-	 */
-	public function SetStateManager($statemanager) {
-		$this->stateManager = $statemanager;
-	}
-
-	/**
-	 * Loads all collections known for the current device.
-	 *
-	 * @param bool $overwriteLoaded  (opt) overwrites Collection with saved state if set to true
-	 * @param bool $loadState        (opt) indicates if the collection sync state should be loaded, default false
-	 * @param bool $checkPermissions (opt) if set to true each folder will pass
-	 *                               through a backend->Setup() to check permissions.
-	 *                               If this fails a StatusException will be thrown.
-	 * @param bool $loadHierarchy    (opt) if the hierarchy sync states should be loaded, default false
-	 * @param bool $confirmedOnly    (opt) indicates if only confirmed states should be loaded, default: false
-	 *
-	 * @throws StatusException       with SyncCollections::ERROR_WRONG_HIERARCHY if permission check fails
-	 * @throws StateInvalidException if the sync state can not be found or relation between states is invalid ($loadState = true)
-	 *
-	 * @return bool
-	 */
-	public function LoadAllCollections($overwriteLoaded = false, $loadState = false, $checkPermissions = false, $loadHierarchy = false, $confirmedOnly = false) {
-		$this->loadStateManager();
-
-		// this operation should not remove old state counters
-		$this->stateManager->DoNotDeleteOldStates();
-
-		$invalidStates = false;
-		foreach ($this->stateManager->GetSynchedFolders() as $folderid) {
-			if ($overwriteLoaded === false && isset($this->collections[$folderid])) {
-				continue;
-			}
-
-			// Load Collection!
-			if (!$this->LoadCollection($folderid, $loadState, $checkPermissions, $confirmedOnly)) {
-				$invalidStates = true;
-			}
-		}
-
-		// load the hierarchy data - there are no permissions to verify so we just set it to false
-		if ($loadHierarchy && !$this->LoadCollection(false, $loadState, false, false)) {
-			throw new StatusException("Invalid states found while loading hierarchy data. Forcing hierarchy sync");
-		}
-
-		if ($invalidStates) {
-			throw new StateInvalidException("Invalid states found while loading collections. Forcing sync");
-		}
-
-		return true;
-	}
-
-	/**
-	 * Loads all collections known for the current device.
-	 *
-	 * @param string $folderid         folder id to be loaded
-	 * @param bool   $loadState        (opt) indicates if the collection sync state should be loaded, default true
-	 * @param bool   $checkPermissions (opt) if set to true each folder will pass
-	 *                                 through a backend->Setup() to check permissions.
-	 *                                 If this fails a StatusException will be thrown.
-	 * @param bool   $confirmedOnly    (opt) indicates if only confirmed states should be loaded, default: false
-	 *
-	 * @throws StatusException       with SyncCollections::ERROR_WRONG_HIERARCHY if permission check fails
-	 * @throws StateInvalidException if the sync state can not be found or relation between states is invalid ($loadState = true)
-	 *
-	 * @return bool
-	 */
-	public function LoadCollection($folderid, $loadState = false, $checkPermissions = false, $confirmedOnly = false) {
-		$this->loadStateManager();
-
-		try {
-			// Get SyncParameters for the folder from the state
-			$spa = $this->stateManager->GetSynchedFolderState($folderid, !$loadState);
-
-			// TODO remove resync of folders
-			// this forces a resync of all states
-			if (!$spa instanceof SyncParameters) {
-				throw new StateInvalidException("Saved state are not of type SyncParameters");
-			}
-
-			if ($spa->GetUuidCounter() == 0) {
-				SLog::Write(LOGLEVEL_DEBUG, "SyncCollections->LoadCollection(): Found collection with move state only, ignoring.");
-
-				return true;
-			}
-		}
-		catch (StateInvalidException $sive) {
-			// in case there is something wrong with the state, just stop here
-			// later when trying to retrieve the SyncParameters nothing will be found
-
-			if ($folderid === false) {
-				throw new StatusException(sprintf("SyncCollections->LoadCollection(): could not get FOLDERDATA state of the hierarchy uuid: %s", $spa->GetUuid()), self::ERROR_WRONG_HIERARCHY);
-			}
-
-			// we also generate a fake change, so a sync on this folder is triggered
-			$this->changes[$folderid] = 1;
-
-			return false;
-		}
-
-		// if this is an additional folder the backend has to be setup correctly
-		if ($checkPermissions === true && !GSync::GetBackend()->Setup(GSync::GetAdditionalSyncFolderStore($spa->GetBackendFolderId()))) {
-			throw new StatusException(sprintf("SyncCollections->LoadCollection(): could not Setup() the backend for folder id %s/%s", $spa->GetFolderId(), $spa->GetBackendFolderId()), self::ERROR_WRONG_HIERARCHY);
-		}
-
-		// add collection to object
-		$addStatus = $this->AddCollection($spa);
-
-		// load the latest known syncstate if requested
-		if ($addStatus && $loadState === true) {
-			try {
-				// make sure the hierarchy cache is loaded when we are loading hierarchy states
-				$this->addparms[$folderid]["state"] = $this->stateManager->GetSyncState($spa->GetLatestSyncKey($confirmedOnly), ($folderid === false));
-			}
-			catch (StateNotFoundException $snfe) {
-				// if we can't find the state, first we should try a sync of that folder, so
-				// we generate a fake change, so a sync on this folder is triggered
-				$this->changes[$folderid] = 1;
-
-				// make sure this folder is fully synched on next Sync request
-				$this->invalidateFolderStat($spa);
-
-				return false;
-			}
-		}
-
-		return $addStatus;
-	}
-
-	/**
-	 * Saves a SyncParameters Object.
-	 *
-	 * @param SyncParamerts $spa
-	 *
-	 * @return bool
-	 */
-	public function SaveCollection($spa) {
-		if (!$this->saveData || !$spa->HasFolderId()) {
-			return false;
-		}
-
-		if ($spa->IsDataChanged()) {
-			$this->loadStateManager();
-			SLog::Write(LOGLEVEL_DEBUG, sprintf("SyncCollections->SaveCollection(): Data of folder '%s' changed", $spa->GetFolderId()));
-
-			// save new windowsize
-			if (isset($this->globalWindowSize)) {
-				$spa->SetWindowSize($this->globalWindowSize);
-			}
-
-			// update latest lifetime
-			if (isset($this->refLifetime)) {
-				$spa->SetReferenceLifetime($this->refLifetime);
-			}
-
-			return $this->stateManager->SetSynchedFolderState($spa);
-		}
-
-		return false;
-	}
-
-	/**
-	 * Adds a SyncParameters object to the current list of collections.
-	 *
-	 * @param SyncParameters $spa
-	 *
-	 * @return bool
-	 */
-	public function AddCollection($spa) {
-		if (!$spa->HasFolderId()) {
-			return false;
-		}
-
-		$this->collections[$spa->GetFolderId()] = $spa;
-
-		SLog::Write(LOGLEVEL_DEBUG, sprintf("SyncCollections->AddCollection(): Folder id '%s' : ref. Lifetime '%s', last sync at '%s'", $spa->GetFolderId(), $spa->GetReferenceLifetime(), $spa->GetLastSyncTime()));
-		if ($spa->HasLastSyncTime() && $spa->GetLastSyncTime() > $this->lastSyncTime) {
-			$this->lastSyncTime = $spa->GetLastSyncTime();
-
-			// use SyncParameters PolicyKey as reference if available
-			if ($spa->HasReferencePolicyKey()) {
-				$this->refPolicyKey = $spa->GetReferencePolicyKey();
-			}
-
-			// use SyncParameters LifeTime as reference if available
-			if ($spa->HasReferenceLifetime()) {
-				$this->refLifetime = $spa->GetReferenceLifetime();
-			}
-
-			SLog::Write(LOGLEVEL_DEBUG, sprintf("SyncCollections->AddCollection(): Updated reference PolicyKey '%s', reference Lifetime '%s', Last sync at '%s'", $this->refPolicyKey, $this->refLifetime, $this->lastSyncTime));
-		}
-
-		return true;
-	}
-
-	/**
-	 * Returns a previousily added or loaded SyncParameters object for a folderid.
-	 *
-	 * @param SyncParameters $spa
-	 * @param mixed          $folderid
-	 *
-	 * @return SyncParameters / boolean      false if no SyncParameters object is found for folderid
-	 */
-	public function GetCollection($folderid) {
-		if (isset($this->collections[$folderid])) {
-			return $this->collections[$folderid];
-		}
-
-		return false;
-	}
-
-	/**
-	 * Indicates if there are any loaded CPOs.
-	 *
-	 * @return bool
-	 */
-	public function HasCollections() {
-		return !empty($this->collections);
-	}
-
-	/**
-	 * Indicates the amount of collections loaded.
-	 *
-	 * @return int
-	 */
-	public function GetCollectionCount() {
-		return count($this->collections);
-	}
-
-	/**
-	 * Add a non-permanent key/value pair for a SyncParameters object.
-	 *
-	 * @param SyncParameters $spa   target SyncParameters
-	 * @param string         $key
-	 * @param mixed          $value
-	 *
-	 * @return bool
-	 */
-	public function AddParameter($spa, $key, $value) {
-		if (!$spa->HasFolderId()) {
-			return false;
-		}
-
-		$folderid = $spa->GetFolderId();
-		if (!isset($this->addparms[$folderid])) {
-			$this->addparms[$folderid] = [];
-		}
-
-		$this->addparms[$folderid][$key] = $value;
-
-		return true;
-	}
-
-	/**
-	 * Returns a previousily set non-permanent value for a SyncParameters object.
-	 *
-	 * @param SyncParameters $spa target SyncParameters
-	 * @param string         $key
-	 *
-	 * @return mixed returns 'null' if nothing set
-	 */
-	public function GetParameter($spa, $key) {
-		if (!$spa->HasFolderId()) {
-			return null;
-		}
-
-		if (isset($this->addparms[$spa->GetFolderId()], $this->addparms[$spa->GetFolderId()][$key])) {
-			return $this->addparms[$spa->GetFolderId()][$key];
-		}
-
-		return null;
-	}
-
-	/**
-	 * Returns the latest known PolicyKey to be used as reference.
-	 *
-	 * @return int/boolean       returns false if nothing found in collections
-	 */
-	public function GetReferencePolicyKey() {
-		return $this->refPolicyKey;
-	}
-
-	/**
-	 * Sets a global window size which should be used for all collections
-	 * in a case of a heartbeat and/or partial sync.
-	 *
-	 * @param int $windowsize
-	 *
-	 * @return bool
-	 */
-	public function SetGlobalWindowSize($windowsize) {
-		$this->globalWindowSize = $windowsize;
-
-		return true;
-	}
-
-	/**
-	 * Returns the global window size of items to be exported in total over all
-	 * requested collections.
-	 *
-	 * @return int/boolean          returns requested windows size, 512 (max) or the
-	 *                              value of config SYNC_MAX_ITEMS if it is lower
-	 */
-	public function GetGlobalWindowSize() {
-		// take the requested global windowsize or the max 512 if not defined
-		if (isset($this->globalWindowSize)) {
-			$globalWindowSize = $this->globalWindowSize;
-		}
-		else {
-			$globalWindowSize = WINDOW_SIZE_MAX; // 512 by default
-		}
-
-		if (defined("SYNC_MAX_ITEMS") && $globalWindowSize > SYNC_MAX_ITEMS) {
-			if (!$this->loggedGlobalWindowSizeOverwrite) {
-				SLog::Write(LOGLEVEL_DEBUG, sprintf("SyncCollections->GetGlobalWindowSize() overwriting requested global window size of %d by %d forced in configuration.", $globalWindowSize, SYNC_MAX_ITEMS));
-				$this->loggedGlobalWindowSizeOverwrite = true;
-			}
-			$globalWindowSize = SYNC_MAX_ITEMS;
-		}
-
-		return $globalWindowSize;
-	}
-
-	/**
-	 * Sets the lifetime for heartbeat or ping connections.
-	 *
-	 * @param int $lifetime time in seconds
-	 *
-	 * @return bool
-	 */
-	public function SetLifetime($lifetime) {
-		$this->refLifetime = $lifetime;
-
-		return true;
-	}
-
-	/**
-	 * Sets the lifetime for heartbeat or ping connections
-	 * previousily set or saved in a collection.
-	 *
-	 * @return int returns PING_HIGHER_BOUND_LIFETIME as default if nothing set or not available.
-	 *             If PING_HIGHER_BOUND_LIFETIME is not set, returns 600.
-	 */
-	public function GetLifetime() {
-		if (!isset($this->refLifetime) || $this->refLifetime === false) {
-			if (PING_HIGHER_BOUND_LIFETIME !== false) {
-				return PING_HIGHER_BOUND_LIFETIME;
-			}
-
-			return 600;
-		}
-
-		return $this->refLifetime;
-	}
-
-	/**
-	 * Returns the timestamp of the last synchronization for all
-	 * loaded collections.
-	 *
-	 * @return int timestamp
-	 */
-	public function GetLastSyncTime() {
-		return $this->lastSyncTime;
-	}
-
-	/**
-	 * Checks if the currently known collections for changes for $lifetime seconds.
-	 * If the backend provides a ChangesSink the sink will be used.
-	 * If not every $interval seconds an exporter will be configured for each
-	 * folder to perform GetChangeCount().
-	 *
-	 * @param int  $lifetime     (opt) total lifetime to wait for changes / default 600s
-	 * @param int  $interval     (opt) time between blocking operations of sink or polling / default 30s
-	 * @param bool $onlyPingable (opt) only check for folders which have the PingableFlag
-	 *
-	 * @throws StatusException with code SyncCollections::ERROR_NO_COLLECTIONS if no collections available
-	 *                         with code SyncCollections::ERROR_WRONG_HIERARCHY if there were errors getting changes
-	 *
-	 * @return bool indicating if changes were found
-	 */
-	public function CheckForChanges($lifetime = 600, $interval = 30, $onlyPingable = false) {
-		$classes = [];
-		foreach ($this->collections as $folderid => $spa) {
-			if ($onlyPingable && $spa->GetPingableFlag() !== true || !$folderid) {
-				continue;
-			}
-
-			$class = $this->getPingClass($spa);
-
-			if (!isset($classes[$class])) {
-				$classes[$class] = 0;
-			}
-			++$classes[$class];
-		}
-		if (empty($classes)) {
-			$checkClasses = "policies only";
-		}
-		elseif (array_sum($classes) > 4) {
-			$checkClasses = "";
-			foreach ($classes as $class => $count) {
-				if ($count == 1) {
-					$checkClasses .= sprintf("%s ", $class);
-				}
-				else {
-					$checkClasses .= sprintf("%s(%d) ", $class, $count);
-				}
-			}
-		}
-		else {
-			$checkClasses = implode(" ", array_keys($classes));
-		}
-
-		$pingTracking = new PingTracking();
-		$this->changes = [];
-
-		GSync::GetDeviceManager()->AnnounceProcessAsPush();
-		GSync::GetTopCollector()->AnnounceInformation(sprintf("lifetime %ds", $lifetime), true);
-		SLog::Write(LOGLEVEL_INFO, sprintf("SyncCollections->CheckForChanges(): Waiting for %s changes... (lifetime %d seconds)", (empty($classes)) ? 'policy' : 'store', $lifetime));
-
-		// use changes sink where available
-		$changesSink = GSync::GetBackend()->HasChangesSink();
-
-		// create changessink and check folder stats if there are folders to Ping
-		if (!empty($classes)) {
-			// initialize all possible folders
-			foreach ($this->collections as $folderid => $spa) {
-				if (($onlyPingable && $spa->GetPingableFlag() !== true) || !$folderid) {
-					continue;
-				}
-
-				$backendFolderId = $spa->GetBackendFolderId();
-
-				// get the user store if this is a additional folder
-				$store = GSync::GetAdditionalSyncFolderStore($backendFolderId);
-
-				// initialize sink if no immediate changes were found so far
-				if ($changesSink && empty($this->changes)) {
-					GSync::GetBackend()->Setup($store);
-					if (!GSync::GetBackend()->ChangesSinkInitialize($backendFolderId)) {
-						throw new StatusException(sprintf("Error initializing ChangesSink for folder id %s/%s", $folderid, $backendFolderId), self::ERROR_WRONG_HIERARCHY);
-					}
-				}
-
-				// check if the folder stat changed since the last sync, if so generate a change for it (only on first run)
-				$currentFolderStat = GSync::GetBackend()->GetFolderStat($store, $backendFolderId);
-				if ($this->waitingTime == 0 && GSync::GetBackend()->HasFolderStats() && $currentFolderStat !== false && $spa->IsExporterRunRequired($currentFolderStat, true)) {
-					$this->changes[$spa->GetFolderId()] = 1;
-				}
-			}
-		}
-
-		if (!empty($this->changes)) {
-			SLog::Write(LOGLEVEL_DEBUG, "SyncCollections->CheckForChanges(): Using ChangesSink but found changes verifying the folder stats");
-
-			return true;
-		}
-
-		// wait for changes
-		$started = time();
-		$endat = time() + $lifetime;
-
-		// always use policy key from the request if it was sent
-		$policyKey = $this->GetReferencePolicyKey();
-		if (Request::WasPolicyKeySent() && Request::GetPolicyKey() != 0) {
-			SLog::Write(LOGLEVEL_DEBUG, sprintf("refpolkey:'%s', sent polkey:'%s'", $policyKey, Request::GetPolicyKey()));
-			$policyKey = Request::GetPolicyKey();
-		}
-		while (($now = time()) < $endat) {
-			// how long are we waiting for changes
-			$this->waitingTime = $now - $started;
-
-			$nextInterval = $interval;
-			// we should not block longer than the lifetime
-			if ($endat - $now < $nextInterval) {
-				$nextInterval = $endat - $now;
-			}
-
-			// Check if provisioning is necessary
-			// if a PolicyKey was sent use it. If not, compare with the ReferencePolicyKey
-			if (PROVISIONING === true && $policyKey !== false && GSync::GetProvisioningManager()->ProvisioningRequired($policyKey, true, false)) {
-				// the hierarchysync forces provisioning
-				throw new StatusException("SyncCollections->CheckForChanges(): Policies or PolicyKey changed. Provisioning required.", self::ERROR_WRONG_HIERARCHY);
-			}
-
-			// Check if a hierarchy sync is necessary
-			if ($this->countHierarchyChange()) {
-				throw new StatusException("SyncCollections->CheckForChanges(): HierarchySync required.", self::HIERARCHY_CHANGED);
-			}
-
-			// Check if there are newer requests
-			// If so, this process should be terminated if more than 60 secs to go
-			if ($pingTracking->DoForcePingTimeout()) {
-				// do not update CPOs because another process has already read them!
-				$this->saveData = false;
-
-				// more than 60 secs to go?
-				if (($now + 60) < $endat) {
-					GSync::GetTopCollector()->AnnounceInformation(sprintf("Forced timeout after %ds", ($now - $started)), true);
-
-					throw new StatusException(sprintf("SyncCollections->CheckForChanges(): Timeout forced after %ss from %ss due to other process", ($now - $started), $lifetime), self::OBSOLETE_CONNECTION);
-				}
-			}
-
-			// Use changes sink if available
-			if ($changesSink) {
-				GSync::GetTopCollector()->AnnounceInformation(sprintf("Sink %d/%ds on %s", ($now - $started), $lifetime, $checkClasses));
-				$notifications = GSync::GetBackend()->ChangesSink($nextInterval);
-
-				// how long are we waiting for changes
-				$this->waitingTime = time() - $started;
-
-				$validNotifications = false;
-				foreach ($notifications as $backendFolderId) {
-					// Check hierarchy notifications
-					if ($backendFolderId === IBackend::HIERARCHYNOTIFICATION) {
-						// wait two seconds before validating this notification, because it could potentially be made by the mobile and we need some time to update the states.
-						sleep(2);
-						// check received hierarchy notifications by exporting
-						if ($this->countHierarchyChange(true)) {
-							throw new StatusException("SyncCollections->CheckForChanges(): HierarchySync required.", self::HIERARCHY_CHANGED);
-						}
-					}
-					else {
-						// the backend will notify on the backend folderid
-						$folderid = GSync::GetDeviceManager()->GetFolderIdForBackendId($backendFolderId);
-
-						// check if the notification on the folder is within our filter
-						if ($this->CountChange($folderid)) {
-							SLog::Write(LOGLEVEL_DEBUG, sprintf("SyncCollections->CheckForChanges(): Notification received on folder '%s'", $folderid));
-							$validNotifications = true;
-							$this->waitingTime = time() - $started;
-						}
-						else {
-							SLog::Write(LOGLEVEL_DEBUG, sprintf("SyncCollections->CheckForChanges(): Notification received on folder '%s', but it is not relevant", $folderid));
-						}
-					}
-				}
-				if ($validNotifications) {
-					return true;
-				}
-			}
-			// use polling mechanism
-			else {
-				GSync::GetTopCollector()->AnnounceInformation(sprintf("Polling %d/%ds on %s", ($now - $started), $lifetime, $checkClasses));
-				if ($this->CountChanges($onlyPingable)) {
-					SLog::Write(LOGLEVEL_DEBUG, sprintf("SyncCollections->CheckForChanges(): Found changes polling"));
-
-					return true;
-				}
-
-				sleep($nextInterval);
-			} // end polling
-		} // end wait for changes
-		SLog::Write(LOGLEVEL_DEBUG, sprintf("SyncCollections->CheckForChanges(): no changes found after %ds", time() - $started));
-
-		return false;
-	}
-
-	/**
-	 * Checks if the currently known collections for
-	 * changes performing Exporter->GetChangeCount().
-	 *
-	 * @param bool $onlyPingable (opt) only check for folders which have the PingableFlag
-	 *
-	 * @return bool indicating if changes were found or not
-	 */
-	public function CountChanges($onlyPingable = false) {
-		$changesAvailable = false;
-		foreach ($this->collections as $folderid => $spa) {
-			if ($onlyPingable && $spa->GetPingableFlag() !== true) {
-				continue;
-			}
-
-			if (isset($this->addparms[$spa->GetFolderId()]["status"]) && $this->addparms[$spa->GetFolderId()]["status"] != SYNC_STATUS_SUCCESS) {
-				continue;
-			}
-
-			if ($this->CountChange($folderid)) {
-				$changesAvailable = true;
-			}
-		}
-
-		return $changesAvailable;
-	}
-
-	/**
-	 * Checks a folder for changes performing Exporter->GetChangeCount().
-	 *
-	 * @param string $folderid counts changes for a folder
-	 *
-	 * @return bool indicating if changes were found or not
-	 */
-	private function CountChange($folderid) {
-		$spa = $this->GetCollection($folderid);
-
-		if (!$spa) {
-			SLog::Write(LOGLEVEL_DEBUG, sprintf("SyncCollections->CountChange(): Could not get SyncParameters object from cache for folderid '%s' to verify notification. Ignoring.", $folderid));
-
-			return false;
-		}
-
-		$backendFolderId = GSync::GetDeviceManager()->GetBackendIdForFolderId($folderid);
-		// switch user store if this is a additional folder (additional true -> do not debug)
-		GSync::GetBackend()->Setup(GSync::GetAdditionalSyncFolderStore($backendFolderId, true));
-		$changecount = false;
-
-		try {
-			$exporter = GSync::GetBackend()->GetExporter($backendFolderId);
-			if ($exporter !== false && isset($this->addparms[$folderid]["state"])) {
-				$importer = false;
-				$exporter->Config($this->addparms[$folderid]["state"], BACKEND_DISCARD_DATA);
-				$exporter->ConfigContentParameters($spa->GetCPO());
-				$ret = $exporter->InitializeExporter($importer);
-
-				if ($ret !== false) {
-					$changecount = $exporter->GetChangeCount();
-				}
-			}
-		}
-		catch (StatusException $ste) {
-			if ($ste->getCode() == SYNC_STATUS_FOLDERHIERARCHYCHANGED) {
-				SLog::Write(LOGLEVEL_WARN, "SyncCollections->CountChange(): exporter can not be re-configured due to state error, emulating change in folder to force Sync.");
-				$this->changes[$folderid] = 1;
-				// make sure this folder is fully synched on next Sync request
-				$this->invalidateFolderStat($spa);
-
-				return true;
-			}
-
-			throw new StatusException("SyncCollections->CountChange(): exporter can not be re-configured.", self::ERROR_WRONG_HIERARCHY, null, LOGLEVEL_WARN);
-		}
-
-		// start over if exporter can not be configured atm
-		if ($changecount === false) {
-			SLog::Write(LOGLEVEL_WARN, "SyncCollections->CountChange(): no changes received from Exporter.");
-		}
-
-		$this->changes[$folderid] = $changecount;
-
-		return $changecount > 0;
-	}
-
-	/**
-	 * Checks the hierarchy for changes.
-	 *
-	 * @param bool       export changes, default: false
-	 * @param mixed $exportChanges
-	 *
-	 * @return bool indicating if changes were found or not
-	 */
-	private function countHierarchyChange($exportChanges = false) {
-		$folderid = false;
-
-		// Check with device manager if the hierarchy should be reloaded.
-		// New additional folders are loaded here.
-		if (GSync::GetDeviceManager()->IsHierarchySyncRequired()) {
-			SLog::Write(LOGLEVEL_DEBUG, "SyncCollections->countHierarchyChange(): DeviceManager says HierarchySync is required.");
-
-			return true;
-		}
-
-		$changecount = false;
-		if ($exportChanges || $this->hierarchyExporterChecked === false) {
-			try {
-				// if this is a validation (not first run), make sure to load the hierarchy data again
-				if ($this->hierarchyExporterChecked === true && !$this->LoadCollection(false, true, false)) {
-					throw new StatusException("Invalid states found while re-loading hierarchy data.");
-				}
-
-				$changesMem = GSync::GetDeviceManager()->GetHierarchyChangesWrapper();
-				// the hierarchyCache should now fully be initialized - check for changes in the additional folders
-				$changesMem->Config(GSync::GetAdditionalSyncFolders(false));
-
-				// reset backend to the main store
-				GSync::GetBackend()->Setup(false);
-				$exporter = GSync::GetBackend()->GetExporter();
-				if ($exporter !== false && isset($this->addparms[$folderid]["state"])) {
-					$exporter->Config($this->addparms[$folderid]["state"]);
-					$ret = $exporter->InitializeExporter($changesMem);
-					while (is_array($exporter->Synchronize()));
-
-					if ($ret !== false) {
-						$changecount = $changesMem->GetChangeCount();
-					}
-
-					$this->hierarchyExporterChecked = true;
-				}
-			}
-			catch (StatusException $ste) {
-				throw new StatusException("SyncCollections->countHierarchyChange(): exporter can not be re-configured.", self::ERROR_WRONG_HIERARCHY, null, LOGLEVEL_WARN);
-			}
-
-			// start over if exporter can not be configured atm
-			if ($changecount === false) {
-				SLog::Write(LOGLEVEL_WARN, "SyncCollections->countHierarchyChange(): no changes received from Exporter.");
-			}
-		}
-
-		return $changecount > 0;
-	}
-
-	/**
-	 * Returns an array with all folderid and the amount of changes found.
-	 *
-	 * @return array
-	 */
-	public function GetChangedFolderIds() {
-		return $this->changes;
-	}
-
-	/**
-	 * Indicates if there are folders which are pingable.
-	 *
-	 * @return bool
-	 */
-	public function PingableFolders() {
-		foreach ($this->collections as $folderid => $spa) {
-			if ($spa->GetPingableFlag() == true) {
-				return true;
-			}
-		}
-
-		return false;
-	}
-
-	/**
-	 * Indicates if the process did wait in a sink, polling or before running a
-	 * regular export to find changes.
-	 *
-	 * @return bool
-	 */
-	public function WaitedForChanges() {
-		SLog::Write(LOGLEVEL_DEBUG, sprintf("SyncCollections->WaitedForChanges: waited for %d seconds", $this->waitingTime));
-
-		return $this->waitingTime > 0;
-	}
-
-	/**
-	 * Indicates how many seconds the process did wait in a sink, polling or before running a
-	 * regular export to find changes.
-	 *
-	 * @return int
-	 */
-	public function GetWaitedSeconds() {
-		return $this->waitingTime;
-	}
-
-	/**
-	 * Returns how the current folder should be called in the PING comment.
-	 *
-	 * @param SyncParameters $spa
-	 *
-	 * @return string
-	 */
-	private function getPingClass($spa) {
-		$class = $spa->GetContentClass();
-		if ($class == "Calendar" && strpos($spa->GetFolderId(), DeviceManager::FLD_ORIGIN_GAB) === 0) {
-			$class = "GAB";
-		}
-
-		return $class;
-	}
-
-	/**
-	 * Simple Iterator Interface implementation to traverse through collections.
-	 */
-
-	/**
-	 * Rewind the Iterator to the first element.
-	 *
-	 * @return
-	 */
-	public function rewind() {
-		return reset($this->collections);
-	}
-
-	/**
-	 * Returns the current element.
-	 *
-	 * @return mixed
-	 */
-	public function current() {
-		return current($this->collections);
-	}
-
-	/**
-	 * Return the key of the current element.
-	 *
-	 * @return scalar on success, or NULL on failure
-	 */
-	public function key() {
-		return key($this->collections);
-	}
-
-	/**
-	 * Move forward to next element.
-	 *
-	 * @return
-	 */
-	public function next() {
-		return next($this->collections);
-	}
-
-	/**
-	 * Checks if current position is valid.
-	 *
-	 * @return bool
-	 */
-	public function valid() {
-		return key($this->collections) != null && key($this->collections) != false;
-	}
-
-	/**
-	 * Gets the StateManager from the DeviceManager
-	 * if it's not available.
-	 *
-	 * @return
-	 */
-	private function loadStateManager() {
-		if (!isset($this->stateManager)) {
-			$this->stateManager = GSync::GetDeviceManager()->GetStateManager();
-		}
-	}
-
-	/**
-	 * Remove folder statistics from a SyncParameter object.
-	 *
-	 * @param SyncParameters $spa
-	 *
-	 * @return
-	 */
-	private function invalidateFolderStat($spa) {
-		if ($spa->HasFolderStat()) {
-			SLog::Write(LOGLEVEL_DEBUG, sprintf("SyncCollections->invalidateFolderStat(): removing folder stat '%s' for folderid '%s'", $spa->GetFolderStat(), $spa->GetFolderId()));
-			$spa->DelFolderStat();
-			$this->SaveCollection($spa);
-
-			return true;
-		}
-
-		return false;
-	}
+    public const ERROR_NO_COLLECTIONS = 1;
+    public const ERROR_WRONG_HIERARCHY = 2;
+    public const OBSOLETE_CONNECTION = 3;
+    public const HIERARCHY_CHANGED = 4;
+
+    private $stateManager;
+
+    private $collections = [];
+    private $addparms = [];
+    private $changes = [];
+    private $saveData = true;
+
+    private $refPolicyKey = false;
+    private $refLifetime = false;
+
+    private $globalWindowSize;
+    private $lastSyncTime;
+
+    private $waitingTime = 0;
+    private $hierarchyExporterChecked = false;
+    private $loggedGlobalWindowSizeOverwrite = false;
+
+    /**
+     * Invalidates all pingable flags for all folders.
+     *
+     * @return bool
+     */
+    public static function InvalidatePingableFlags() {
+        SLog::Write(LOGLEVEL_DEBUG, "SyncCollections::InvalidatePingableFlags(): Invalidating now");
+
+        try {
+            $sc = new SyncCollections();
+            $sc->LoadAllCollections();
+            foreach ($sc as $folderid => $spa) {
+                if ($spa->GetPingableFlag() == true) {
+                    $spa->DelPingableFlag();
+                    $sc->SaveCollection($spa);
+                }
+            }
+
+            return true;
+        }
+        catch (GSyncException $e) {
+        }
+
+        return false;
+    }
+
+    /**
+     * Constructor.
+     */
+    public function __construct() {
+    }
+
+    /**
+     * Sets the StateManager for this object
+     * If this is not done and a method needs it, the StateManager will be
+     * requested from the DeviceManager.
+     *
+     * @param StateManager $statemanager
+     *
+     * @return
+     */
+    public function SetStateManager($statemanager) {
+        $this->stateManager = $statemanager;
+    }
+
+    /**
+     * Loads all collections known for the current device.
+     *
+     * @param bool $overwriteLoaded  (opt) overwrites Collection with saved state if set to true
+     * @param bool $loadState        (opt) indicates if the collection sync state should be loaded, default false
+     * @param bool $checkPermissions (opt) if set to true each folder will pass
+     *                               through a backend->Setup() to check permissions.
+     *                               If this fails a StatusException will be thrown.
+     * @param bool $loadHierarchy    (opt) if the hierarchy sync states should be loaded, default false
+     * @param bool $confirmedOnly    (opt) indicates if only confirmed states should be loaded, default: false
+     *
+     * @throws StatusException       with SyncCollections::ERROR_WRONG_HIERARCHY if permission check fails
+     * @throws StateInvalidException if the sync state can not be found or relation between states is invalid ($loadState = true)
+     *
+     * @return bool
+     */
+    public function LoadAllCollections($overwriteLoaded = false, $loadState = false, $checkPermissions = false, $loadHierarchy = false, $confirmedOnly = false) {
+        $this->loadStateManager();
+
+        // this operation should not remove old state counters
+        $this->stateManager->DoNotDeleteOldStates();
+
+        $invalidStates = false;
+        foreach ($this->stateManager->GetSynchedFolders() as $folderid) {
+            if ($overwriteLoaded === false && isset($this->collections[$folderid])) {
+                continue;
+            }
+
+            // Load Collection!
+            if (!$this->LoadCollection($folderid, $loadState, $checkPermissions, $confirmedOnly)) {
+                $invalidStates = true;
+            }
+        }
+
+        // load the hierarchy data - there are no permissions to verify so we just set it to false
+        if ($loadHierarchy && !$this->LoadCollection(false, $loadState, false, false)) {
+            throw new StatusException("Invalid states found while loading hierarchy data. Forcing hierarchy sync");
+        }
+
+        if ($invalidStates) {
+            throw new StateInvalidException("Invalid states found while loading collections. Forcing sync");
+        }
+
+        return true;
+    }
+
+    /**
+     * Loads all collections known for the current device.
+     *
+     * @param string $folderid         folder id to be loaded
+     * @param bool   $loadState        (opt) indicates if the collection sync state should be loaded, default true
+     * @param bool   $checkPermissions (opt) if set to true each folder will pass
+     *                                 through a backend->Setup() to check permissions.
+     *                                 If this fails a StatusException will be thrown.
+     * @param bool   $confirmedOnly    (opt) indicates if only confirmed states should be loaded, default: false
+     *
+     * @throws StatusException       with SyncCollections::ERROR_WRONG_HIERARCHY if permission check fails
+     * @throws StateInvalidException if the sync state can not be found or relation between states is invalid ($loadState = true)
+     *
+     * @return bool
+     */
+    public function LoadCollection($folderid, $loadState = false, $checkPermissions = false, $confirmedOnly = false) {
+        $this->loadStateManager();
+
+        try {
+            // Get SyncParameters for the folder from the state
+            $spa = $this->stateManager->GetSynchedFolderState($folderid, !$loadState);
+
+            // TODO remove resync of folders
+            // this forces a resync of all states
+            if (!$spa instanceof SyncParameters) {
+                throw new StateInvalidException("Saved state are not of type SyncParameters");
+            }
+
+            if ($spa->GetUuidCounter() == 0) {
+                SLog::Write(LOGLEVEL_DEBUG, "SyncCollections->LoadCollection(): Found collection with move state only, ignoring.");
+
+                return true;
+            }
+        }
+        catch (StateInvalidException $sive) {
+            // in case there is something wrong with the state, just stop here
+            // later when trying to retrieve the SyncParameters nothing will be found
+
+            if ($folderid === false) {
+                throw new StatusException(sprintf("SyncCollections->LoadCollection(): could not get FOLDERDATA state of the hierarchy uuid: %s", $spa->GetUuid()), self::ERROR_WRONG_HIERARCHY);
+            }
+
+            // we also generate a fake change, so a sync on this folder is triggered
+            $this->changes[$folderid] = 1;
+
+            return false;
+        }
+
+        // if this is an additional folder the backend has to be setup correctly
+        if ($checkPermissions === true && !GSync::GetBackend()->Setup(GSync::GetAdditionalSyncFolderStore($spa->GetBackendFolderId()))) {
+            throw new StatusException(sprintf("SyncCollections->LoadCollection(): could not Setup() the backend for folder id %s/%s", $spa->GetFolderId(), $spa->GetBackendFolderId()), self::ERROR_WRONG_HIERARCHY);
+        }
+
+        // add collection to object
+        $addStatus = $this->AddCollection($spa);
+
+        // load the latest known syncstate if requested
+        if ($addStatus && $loadState === true) {
+            try {
+                // make sure the hierarchy cache is loaded when we are loading hierarchy states
+                $this->addparms[$folderid]["state"] = $this->stateManager->GetSyncState($spa->GetLatestSyncKey($confirmedOnly), ($folderid === false));
+            }
+            catch (StateNotFoundException $snfe) {
+                // if we can't find the state, first we should try a sync of that folder, so
+                // we generate a fake change, so a sync on this folder is triggered
+                $this->changes[$folderid] = 1;
+
+                // make sure this folder is fully synched on next Sync request
+                $this->invalidateFolderStat($spa);
+
+                return false;
+            }
+        }
+
+        return $addStatus;
+    }
+
+    /**
+     * Saves a SyncParameters Object.
+     *
+     * @param SyncParamerts $spa
+     *
+     * @return bool
+     */
+    public function SaveCollection($spa) {
+        if (!$this->saveData || !$spa->HasFolderId()) {
+            return false;
+        }
+
+        if ($spa->IsDataChanged()) {
+            $this->loadStateManager();
+            SLog::Write(LOGLEVEL_DEBUG, sprintf("SyncCollections->SaveCollection(): Data of folder '%s' changed", $spa->GetFolderId()));
+
+            // save new windowsize
+            if (isset($this->globalWindowSize)) {
+                $spa->SetWindowSize($this->globalWindowSize);
+            }
+
+            // update latest lifetime
+            if (isset($this->refLifetime)) {
+                $spa->SetReferenceLifetime($this->refLifetime);
+            }
+
+            return $this->stateManager->SetSynchedFolderState($spa);
+        }
+
+        return false;
+    }
+
+    /**
+     * Adds a SyncParameters object to the current list of collections.
+     *
+     * @param SyncParameters $spa
+     *
+     * @return bool
+     */
+    public function AddCollection($spa) {
+        if (!$spa->HasFolderId()) {
+            return false;
+        }
+
+        $this->collections[$spa->GetFolderId()] = $spa;
+
+        SLog::Write(LOGLEVEL_DEBUG, sprintf("SyncCollections->AddCollection(): Folder id '%s' : ref. Lifetime '%s', last sync at '%s'", $spa->GetFolderId(), $spa->GetReferenceLifetime(), $spa->GetLastSyncTime()));
+        if ($spa->HasLastSyncTime() && $spa->GetLastSyncTime() > $this->lastSyncTime) {
+            $this->lastSyncTime = $spa->GetLastSyncTime();
+
+            // use SyncParameters PolicyKey as reference if available
+            if ($spa->HasReferencePolicyKey()) {
+                $this->refPolicyKey = $spa->GetReferencePolicyKey();
+            }
+
+            // use SyncParameters LifeTime as reference if available
+            if ($spa->HasReferenceLifetime()) {
+                $this->refLifetime = $spa->GetReferenceLifetime();
+            }
+
+            SLog::Write(LOGLEVEL_DEBUG, sprintf("SyncCollections->AddCollection(): Updated reference PolicyKey '%s', reference Lifetime '%s', Last sync at '%s'", $this->refPolicyKey, $this->refLifetime, $this->lastSyncTime));
+        }
+
+        return true;
+    }
+
+    /**
+     * Returns a previousily added or loaded SyncParameters object for a folderid.
+     *
+     * @param SyncParameters $spa
+     * @param mixed          $folderid
+     *
+     * @return SyncParameters / boolean      false if no SyncParameters object is found for folderid
+     */
+    public function GetCollection($folderid) {
+        if (isset($this->collections[$folderid])) {
+            return $this->collections[$folderid];
+        }
+
+        return false;
+    }
+
+    /**
+     * Indicates if there are any loaded CPOs.
+     *
+     * @return bool
+     */
+    public function HasCollections() {
+        return !empty($this->collections);
+    }
+
+    /**
+     * Indicates the amount of collections loaded.
+     *
+     * @return int
+     */
+    public function GetCollectionCount() {
+        return count($this->collections);
+    }
+
+    /**
+     * Add a non-permanent key/value pair for a SyncParameters object.
+     *
+     * @param SyncParameters $spa   target SyncParameters
+     * @param string         $key
+     * @param mixed          $value
+     *
+     * @return bool
+     */
+    public function AddParameter($spa, $key, $value) {
+        if (!$spa->HasFolderId()) {
+            return false;
+        }
+
+        $folderid = $spa->GetFolderId();
+        if (!isset($this->addparms[$folderid])) {
+            $this->addparms[$folderid] = [];
+        }
+
+        $this->addparms[$folderid][$key] = $value;
+
+        return true;
+    }
+
+    /**
+     * Returns a previousily set non-permanent value for a SyncParameters object.
+     *
+     * @param SyncParameters $spa target SyncParameters
+     * @param string         $key
+     *
+     * @return mixed returns 'null' if nothing set
+     */
+    public function GetParameter($spa, $key) {
+        if (!$spa->HasFolderId()) {
+            return null;
+        }
+
+        if (isset($this->addparms[$spa->GetFolderId()], $this->addparms[$spa->GetFolderId()][$key])) {
+            return $this->addparms[$spa->GetFolderId()][$key];
+        }
+
+        return null;
+    }
+
+    /**
+     * Returns the latest known PolicyKey to be used as reference.
+     *
+     * @return int/boolean       returns false if nothing found in collections
+     */
+    public function GetReferencePolicyKey() {
+        return $this->refPolicyKey;
+    }
+
+    /**
+     * Sets a global window size which should be used for all collections
+     * in a case of a heartbeat and/or partial sync.
+     *
+     * @param int $windowsize
+     *
+     * @return bool
+     */
+    public function SetGlobalWindowSize($windowsize) {
+        $this->globalWindowSize = $windowsize;
+
+        return true;
+    }
+
+    /**
+     * Returns the global window size of items to be exported in total over all
+     * requested collections.
+     *
+     * @return int/boolean          returns requested windows size, 512 (max) or the
+     *                              value of config SYNC_MAX_ITEMS if it is lower
+     */
+    public function GetGlobalWindowSize() {
+        // take the requested global windowsize or the max 512 if not defined
+        if (isset($this->globalWindowSize)) {
+            $globalWindowSize = $this->globalWindowSize;
+        }
+        else {
+            $globalWindowSize = WINDOW_SIZE_MAX; // 512 by default
+        }
+
+        if (defined("SYNC_MAX_ITEMS") && $globalWindowSize > SYNC_MAX_ITEMS) {
+            if (!$this->loggedGlobalWindowSizeOverwrite) {
+                SLog::Write(LOGLEVEL_DEBUG, sprintf("SyncCollections->GetGlobalWindowSize() overwriting requested global window size of %d by %d forced in configuration.", $globalWindowSize, SYNC_MAX_ITEMS));
+                $this->loggedGlobalWindowSizeOverwrite = true;
+            }
+            $globalWindowSize = SYNC_MAX_ITEMS;
+        }
+
+        return $globalWindowSize;
+    }
+
+    /**
+     * Sets the lifetime for heartbeat or ping connections.
+     *
+     * @param int $lifetime time in seconds
+     *
+     * @return bool
+     */
+    public function SetLifetime($lifetime) {
+        $this->refLifetime = $lifetime;
+
+        return true;
+    }
+
+    /**
+     * Sets the lifetime for heartbeat or ping connections
+     * previousily set or saved in a collection.
+     *
+     * @return int returns PING_HIGHER_BOUND_LIFETIME as default if nothing set or not available.
+     *             If PING_HIGHER_BOUND_LIFETIME is not set, returns 600.
+     */
+    public function GetLifetime() {
+        if (!isset($this->refLifetime) || $this->refLifetime === false) {
+            if (PING_HIGHER_BOUND_LIFETIME !== false) {
+                return PING_HIGHER_BOUND_LIFETIME;
+            }
+
+            return 600;
+        }
+
+        return $this->refLifetime;
+    }
+
+    /**
+     * Returns the timestamp of the last synchronization for all
+     * loaded collections.
+     *
+     * @return int timestamp
+     */
+    public function GetLastSyncTime() {
+        return $this->lastSyncTime;
+    }
+
+    /**
+     * Checks if the currently known collections for changes for $lifetime seconds.
+     * If the backend provides a ChangesSink the sink will be used.
+     * If not every $interval seconds an exporter will be configured for each
+     * folder to perform GetChangeCount().
+     *
+     * @param int  $lifetime     (opt) total lifetime to wait for changes / default 600s
+     * @param int  $interval     (opt) time between blocking operations of sink or polling / default 30s
+     * @param bool $onlyPingable (opt) only check for folders which have the PingableFlag
+     *
+     * @throws StatusException with code SyncCollections::ERROR_NO_COLLECTIONS if no collections available
+     *                         with code SyncCollections::ERROR_WRONG_HIERARCHY if there were errors getting changes
+     *
+     * @return bool indicating if changes were found
+     */
+    public function CheckForChanges($lifetime = 600, $interval = 30, $onlyPingable = false) {
+        $classes = [];
+        foreach ($this->collections as $folderid => $spa) {
+            if ($onlyPingable && $spa->GetPingableFlag() !== true || !$folderid) {
+                continue;
+            }
+
+            $class = $this->getPingClass($spa);
+
+            if (!isset($classes[$class])) {
+                $classes[$class] = 0;
+            }
+            ++$classes[$class];
+        }
+        if (empty($classes)) {
+            $checkClasses = "policies only";
+        }
+        elseif (array_sum($classes) > 4) {
+            $checkClasses = "";
+            foreach ($classes as $class => $count) {
+                if ($count == 1) {
+                    $checkClasses .= sprintf("%s ", $class);
+                }
+                else {
+                    $checkClasses .= sprintf("%s(%d) ", $class, $count);
+                }
+            }
+        }
+        else {
+            $checkClasses = implode(" ", array_keys($classes));
+        }
+
+        $pingTracking = new PingTracking();
+        $this->changes = [];
+
+        GSync::GetDeviceManager()->AnnounceProcessAsPush();
+        GSync::GetTopCollector()->AnnounceInformation(sprintf("lifetime %ds", $lifetime), true);
+        SLog::Write(LOGLEVEL_INFO, sprintf("SyncCollections->CheckForChanges(): Waiting for %s changes... (lifetime %d seconds)", (empty($classes)) ? 'policy' : 'store', $lifetime));
+
+        // use changes sink where available
+        $changesSink = GSync::GetBackend()->HasChangesSink();
+
+        // create changessink and check folder stats if there are folders to Ping
+        if (!empty($classes)) {
+            // initialize all possible folders
+            foreach ($this->collections as $folderid => $spa) {
+                if (($onlyPingable && $spa->GetPingableFlag() !== true) || !$folderid) {
+                    continue;
+                }
+
+                $backendFolderId = $spa->GetBackendFolderId();
+
+                // get the user store if this is a additional folder
+                $store = GSync::GetAdditionalSyncFolderStore($backendFolderId);
+
+                // initialize sink if no immediate changes were found so far
+                if ($changesSink && empty($this->changes)) {
+                    GSync::GetBackend()->Setup($store);
+                    if (!GSync::GetBackend()->ChangesSinkInitialize($backendFolderId)) {
+                        throw new StatusException(sprintf("Error initializing ChangesSink for folder id %s/%s", $folderid, $backendFolderId), self::ERROR_WRONG_HIERARCHY);
+                    }
+                }
+
+                // check if the folder stat changed since the last sync, if so generate a change for it (only on first run)
+                $currentFolderStat = GSync::GetBackend()->GetFolderStat($store, $backendFolderId);
+                if ($this->waitingTime == 0 && GSync::GetBackend()->HasFolderStats() && $currentFolderStat !== false && $spa->IsExporterRunRequired($currentFolderStat, true)) {
+                    $this->changes[$spa->GetFolderId()] = 1;
+                }
+            }
+        }
+
+        if (!empty($this->changes)) {
+            SLog::Write(LOGLEVEL_DEBUG, "SyncCollections->CheckForChanges(): Using ChangesSink but found changes verifying the folder stats");
+
+            return true;
+        }
+
+        // wait for changes
+        $started = time();
+        $endat = time() + $lifetime;
+
+        // always use policy key from the request if it was sent
+        $policyKey = $this->GetReferencePolicyKey();
+        if (Request::WasPolicyKeySent() && Request::GetPolicyKey() != 0) {
+            SLog::Write(LOGLEVEL_DEBUG, sprintf("refpolkey:'%s', sent polkey:'%s'", $policyKey, Request::GetPolicyKey()));
+            $policyKey = Request::GetPolicyKey();
+        }
+        while (($now = time()) < $endat) {
+            // how long are we waiting for changes
+            $this->waitingTime = $now - $started;
+
+            $nextInterval = $interval;
+            // we should not block longer than the lifetime
+            if ($endat - $now < $nextInterval) {
+                $nextInterval = $endat - $now;
+            }
+
+            // Check if provisioning is necessary
+            // if a PolicyKey was sent use it. If not, compare with the ReferencePolicyKey
+            if (PROVISIONING === true && $policyKey !== false && GSync::GetProvisioningManager()->ProvisioningRequired($policyKey, true, false)) {
+                // the hierarchysync forces provisioning
+                throw new StatusException("SyncCollections->CheckForChanges(): Policies or PolicyKey changed. Provisioning required.", self::ERROR_WRONG_HIERARCHY);
+            }
+
+            // Check if a hierarchy sync is necessary
+            if ($this->countHierarchyChange()) {
+                throw new StatusException("SyncCollections->CheckForChanges(): HierarchySync required.", self::HIERARCHY_CHANGED);
+            }
+
+            // Check if there are newer requests
+            // If so, this process should be terminated if more than 60 secs to go
+            if ($pingTracking->DoForcePingTimeout()) {
+                // do not update CPOs because another process has already read them!
+                $this->saveData = false;
+
+                // more than 60 secs to go?
+                if (($now + 60) < $endat) {
+                    GSync::GetTopCollector()->AnnounceInformation(sprintf("Forced timeout after %ds", ($now - $started)), true);
+
+                    throw new StatusException(sprintf("SyncCollections->CheckForChanges(): Timeout forced after %ss from %ss due to other process", ($now - $started), $lifetime), self::OBSOLETE_CONNECTION);
+                }
+            }
+
+            // Use changes sink if available
+            if ($changesSink) {
+                GSync::GetTopCollector()->AnnounceInformation(sprintf("Sink %d/%ds on %s", ($now - $started), $lifetime, $checkClasses));
+                $notifications = GSync::GetBackend()->ChangesSink($nextInterval);
+
+                // how long are we waiting for changes
+                $this->waitingTime = time() - $started;
+
+                $validNotifications = false;
+                foreach ($notifications as $backendFolderId) {
+                    // Check hierarchy notifications
+                    if ($backendFolderId === IBackend::HIERARCHYNOTIFICATION) {
+                        // wait two seconds before validating this notification, because it could potentially be made by the mobile and we need some time to update the states.
+                        sleep(2);
+                        // check received hierarchy notifications by exporting
+                        if ($this->countHierarchyChange(true)) {
+                            throw new StatusException("SyncCollections->CheckForChanges(): HierarchySync required.", self::HIERARCHY_CHANGED);
+                        }
+                    }
+                    else {
+                        // the backend will notify on the backend folderid
+                        $folderid = GSync::GetDeviceManager()->GetFolderIdForBackendId($backendFolderId);
+
+                        // check if the notification on the folder is within our filter
+                        if ($this->CountChange($folderid)) {
+                            SLog::Write(LOGLEVEL_DEBUG, sprintf("SyncCollections->CheckForChanges(): Notification received on folder '%s'", $folderid));
+                            $validNotifications = true;
+                            $this->waitingTime = time() - $started;
+                        }
+                        else {
+                            SLog::Write(LOGLEVEL_DEBUG, sprintf("SyncCollections->CheckForChanges(): Notification received on folder '%s', but it is not relevant", $folderid));
+                        }
+                    }
+                }
+                if ($validNotifications) {
+                    return true;
+                }
+            }
+            // use polling mechanism
+            else {
+                GSync::GetTopCollector()->AnnounceInformation(sprintf("Polling %d/%ds on %s", ($now - $started), $lifetime, $checkClasses));
+                if ($this->CountChanges($onlyPingable)) {
+                    SLog::Write(LOGLEVEL_DEBUG, sprintf("SyncCollections->CheckForChanges(): Found changes polling"));
+
+                    return true;
+                }
+
+                sleep($nextInterval);
+            } // end polling
+        } // end wait for changes
+        SLog::Write(LOGLEVEL_DEBUG, sprintf("SyncCollections->CheckForChanges(): no changes found after %ds", time() - $started));
+
+        return false;
+    }
+
+    /**
+     * Checks if the currently known collections for
+     * changes performing Exporter->GetChangeCount().
+     *
+     * @param bool $onlyPingable (opt) only check for folders which have the PingableFlag
+     *
+     * @return bool indicating if changes were found or not
+     */
+    public function CountChanges($onlyPingable = false) {
+        $changesAvailable = false;
+        foreach ($this->collections as $folderid => $spa) {
+            if ($onlyPingable && $spa->GetPingableFlag() !== true) {
+                continue;
+            }
+
+            if (isset($this->addparms[$spa->GetFolderId()]["status"]) && $this->addparms[$spa->GetFolderId()]["status"] != SYNC_STATUS_SUCCESS) {
+                continue;
+            }
+
+            if ($this->CountChange($folderid)) {
+                $changesAvailable = true;
+            }
+        }
+
+        return $changesAvailable;
+    }
+
+    /**
+     * Checks a folder for changes performing Exporter->GetChangeCount().
+     *
+     * @param string $folderid counts changes for a folder
+     *
+     * @return bool indicating if changes were found or not
+     */
+    private function CountChange($folderid) {
+        $spa = $this->GetCollection($folderid);
+
+        if (!$spa) {
+            SLog::Write(LOGLEVEL_DEBUG, sprintf("SyncCollections->CountChange(): Could not get SyncParameters object from cache for folderid '%s' to verify notification. Ignoring.", $folderid));
+
+            return false;
+        }
+
+        $backendFolderId = GSync::GetDeviceManager()->GetBackendIdForFolderId($folderid);
+        // switch user store if this is a additional folder (additional true -> do not debug)
+        GSync::GetBackend()->Setup(GSync::GetAdditionalSyncFolderStore($backendFolderId, true));
+        $changecount = false;
+
+        try {
+            $exporter = GSync::GetBackend()->GetExporter($backendFolderId);
+            if ($exporter !== false && isset($this->addparms[$folderid]["state"])) {
+                $importer = false;
+                $exporter->Config($this->addparms[$folderid]["state"], BACKEND_DISCARD_DATA);
+                $exporter->ConfigContentParameters($spa->GetCPO());
+                $ret = $exporter->InitializeExporter($importer);
+
+                if ($ret !== false) {
+                    $changecount = $exporter->GetChangeCount();
+                }
+            }
+        }
+        catch (StatusException $ste) {
+            if ($ste->getCode() == SYNC_STATUS_FOLDERHIERARCHYCHANGED) {
+                SLog::Write(LOGLEVEL_WARN, "SyncCollections->CountChange(): exporter can not be re-configured due to state error, emulating change in folder to force Sync.");
+                $this->changes[$folderid] = 1;
+                // make sure this folder is fully synched on next Sync request
+                $this->invalidateFolderStat($spa);
+
+                return true;
+            }
+
+            throw new StatusException("SyncCollections->CountChange(): exporter can not be re-configured.", self::ERROR_WRONG_HIERARCHY, null, LOGLEVEL_WARN);
+        }
+
+        // start over if exporter can not be configured atm
+        if ($changecount === false) {
+            SLog::Write(LOGLEVEL_WARN, "SyncCollections->CountChange(): no changes received from Exporter.");
+        }
+
+        $this->changes[$folderid] = $changecount;
+
+        return $changecount > 0;
+    }
+
+    /**
+     * Checks the hierarchy for changes.
+     *
+     * @param bool       export changes, default: false
+     * @param mixed $exportChanges
+     *
+     * @return bool indicating if changes were found or not
+     */
+    private function countHierarchyChange($exportChanges = false) {
+        $folderid = false;
+
+        // Check with device manager if the hierarchy should be reloaded.
+        // New additional folders are loaded here.
+        if (GSync::GetDeviceManager()->IsHierarchySyncRequired()) {
+            SLog::Write(LOGLEVEL_DEBUG, "SyncCollections->countHierarchyChange(): DeviceManager says HierarchySync is required.");
+
+            return true;
+        }
+
+        $changecount = false;
+        if ($exportChanges || $this->hierarchyExporterChecked === false) {
+            try {
+                // if this is a validation (not first run), make sure to load the hierarchy data again
+                if ($this->hierarchyExporterChecked === true && !$this->LoadCollection(false, true, false)) {
+                    throw new StatusException("Invalid states found while re-loading hierarchy data.");
+                }
+
+                $changesMem = GSync::GetDeviceManager()->GetHierarchyChangesWrapper();
+                // the hierarchyCache should now fully be initialized - check for changes in the additional folders
+                $changesMem->Config(GSync::GetAdditionalSyncFolders(false));
+
+                // reset backend to the main store
+                GSync::GetBackend()->Setup(false);
+                $exporter = GSync::GetBackend()->GetExporter();
+                if ($exporter !== false && isset($this->addparms[$folderid]["state"])) {
+                    $exporter->Config($this->addparms[$folderid]["state"]);
+                    $ret = $exporter->InitializeExporter($changesMem);
+                    while (is_array($exporter->Synchronize()));
+
+                    if ($ret !== false) {
+                        $changecount = $changesMem->GetChangeCount();
+                    }
+
+                    $this->hierarchyExporterChecked = true;
+                }
+            }
+            catch (StatusException $ste) {
+                throw new StatusException("SyncCollections->countHierarchyChange(): exporter can not be re-configured.", self::ERROR_WRONG_HIERARCHY, null, LOGLEVEL_WARN);
+            }
+
+            // start over if exporter can not be configured atm
+            if ($changecount === false) {
+                SLog::Write(LOGLEVEL_WARN, "SyncCollections->countHierarchyChange(): no changes received from Exporter.");
+            }
+        }
+
+        return $changecount > 0;
+    }
+
+    /**
+     * Returns an array with all folderid and the amount of changes found.
+     *
+     * @return array
+     */
+    public function GetChangedFolderIds() {
+        return $this->changes;
+    }
+
+    /**
+     * Indicates if there are folders which are pingable.
+     *
+     * @return bool
+     */
+    public function PingableFolders() {
+        foreach ($this->collections as $folderid => $spa) {
+            if ($spa->GetPingableFlag() == true) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
+    /**
+     * Indicates if the process did wait in a sink, polling or before running a
+     * regular export to find changes.
+     *
+     * @return bool
+     */
+    public function WaitedForChanges() {
+        SLog::Write(LOGLEVEL_DEBUG, sprintf("SyncCollections->WaitedForChanges: waited for %d seconds", $this->waitingTime));
+
+        return $this->waitingTime > 0;
+    }
+
+    /**
+     * Indicates how many seconds the process did wait in a sink, polling or before running a
+     * regular export to find changes.
+     *
+     * @return int
+     */
+    public function GetWaitedSeconds() {
+        return $this->waitingTime;
+    }
+
+    /**
+     * Returns how the current folder should be called in the PING comment.
+     *
+     * @param SyncParameters $spa
+     *
+     * @return string
+     */
+    private function getPingClass($spa) {
+        $class = $spa->GetContentClass();
+        if ($class == "Calendar" && strpos($spa->GetFolderId(), DeviceManager::FLD_ORIGIN_GAB) === 0) {
+            $class = "GAB";
+        }
+
+        return $class;
+    }
+
+    /**
+     * Simple Iterator Interface implementation to traverse through collections.
+     */
+
+    /**
+     * Rewind the Iterator to the first element.
+     *
+     * @return
+     */
+    public function rewind() {
+        return reset($this->collections);
+    }
+
+    /**
+     * Returns the current element.
+     *
+     * @return mixed
+     */
+    public function current() {
+        return current($this->collections);
+    }
+
+    /**
+     * Return the key of the current element.
+     *
+     * @return scalar on success, or NULL on failure
+     */
+    public function key() {
+        return key($this->collections);
+    }
+
+    /**
+     * Move forward to next element.
+     *
+     * @return
+     */
+    public function next() {
+        return next($this->collections);
+    }
+
+    /**
+     * Checks if current position is valid.
+     *
+     * @return bool
+     */
+    public function valid() {
+        return key($this->collections) != null && key($this->collections) != false;
+    }
+
+    /**
+     * Gets the StateManager from the DeviceManager
+     * if it's not available.
+     *
+     * @return
+     */
+    private function loadStateManager() {
+        if (!isset($this->stateManager)) {
+            $this->stateManager = GSync::GetDeviceManager()->GetStateManager();
+        }
+    }
+
+    /**
+     * Remove folder statistics from a SyncParameter object.
+     *
+     * @param SyncParameters $spa
+     *
+     * @return
+     */
+    private function invalidateFolderStat($spa) {
+        if ($spa->HasFolderStat()) {
+            SLog::Write(LOGLEVEL_DEBUG, sprintf("SyncCollections->invalidateFolderStat(): removing folder stat '%s' for folderid '%s'", $spa->GetFolderStat(), $spa->GetFolderId()));
+            $spa->DelFolderStat();
+            $this->SaveCollection($spa);
+
+            return true;
+        }
+
+        return false;
+    }
 }

Braces +11 added lines, -22 removed lines

@@ -60,8 +60,7 @@ 
 			}
 
 			return true;
-		}
-		catch (GSyncException $e) {
+		} catch (GSyncException $e) {
 		}
 
 		return false;
@@ -165,8 +164,7 @@ 
 
 				return true;
 			}
-		}
-		catch (StateInvalidException $sive) {
+		} catch (StateInvalidException $sive) {
 			// in case there is something wrong with the state, just stop here
 			// later when trying to retrieve the SyncParameters nothing will be found
 
@@ -193,8 +191,7 @@ 
 			try {
 				// make sure the hierarchy cache is loaded when we are loading hierarchy states
 				$this->addparms[$folderid]["state"] = $this->stateManager->GetSyncState($spa->GetLatestSyncKey($confirmedOnly), ($folderid === false));
-			}
-			catch (StateNotFoundException $snfe) {
+			} catch (StateNotFoundException $snfe) {
 				// if we can't find the state, first we should try a sync of that folder, so
 				// we generate a fake change, so a sync on this folder is triggered
 				$this->changes[$folderid] = 1;
@@ -387,8 +384,7 @@ 
 		// take the requested global windowsize or the max 512 if not defined
 		if (isset($this->globalWindowSize)) {
 			$globalWindowSize = $this->globalWindowSize;
-		}
-		else {
+		} else {
 			$globalWindowSize = WINDOW_SIZE_MAX; // 512 by default
 		}
 
@@ -476,19 +472,16 @@ 
 		}
 		if (empty($classes)) {
 			$checkClasses = "policies only";
-		}
-		elseif (array_sum($classes) > 4) {
+		} elseif (array_sum($classes) > 4) {
 			$checkClasses = "";
 			foreach ($classes as $class => $count) {
 				if ($count == 1) {
 					$checkClasses .= sprintf("%s ", $class);
-				}
-				else {
+				} else {
 					$checkClasses .= sprintf("%s(%d) ", $class, $count);
 				}
 			}
-		}
-		else {
+		} else {
 			$checkClasses = implode(" ", array_keys($classes));
 		}
 
@@ -601,8 +594,7 @@ 
 						if ($this->countHierarchyChange(true)) {
 							throw new StatusException("SyncCollections->CheckForChanges(): HierarchySync required.", self::HIERARCHY_CHANGED);
 						}
-					}
-					else {
+					} else {
 						// the backend will notify on the backend folderid
 						$folderid = GSync::GetDeviceManager()->GetFolderIdForBackendId($backendFolderId);
 
@@ -611,8 +603,7 @@ 
 							SLog::Write(LOGLEVEL_DEBUG, sprintf("SyncCollections->CheckForChanges(): Notification received on folder '%s'", $folderid));
 							$validNotifications = true;
 							$this->waitingTime = time() - $started;
-						}
-						else {
+						} else {
 							SLog::Write(LOGLEVEL_DEBUG, sprintf("SyncCollections->CheckForChanges(): Notification received on folder '%s', but it is not relevant", $folderid));
 						}
 					}
@@ -698,8 +689,7 @@ 
 					$changecount = $exporter->GetChangeCount();
 				}
 			}
-		}
-		catch (StatusException $ste) {
+		} catch (StatusException $ste) {
 			if ($ste->getCode() == SYNC_STATUS_FOLDERHIERARCHYCHANGED) {
 				SLog::Write(LOGLEVEL_WARN, "SyncCollections->CountChange(): exporter can not be re-configured due to state error, emulating change in folder to force Sync.");
 				$this->changes[$folderid] = 1;
@@ -767,8 +757,7 @@ 
 
 					$this->hierarchyExporterChecked = true;
 				}
-			}
-			catch (StatusException $ste) {
+			} catch (StatusException $ste) {
 				throw new StatusException("SyncCollections->countHierarchyChange(): exporter can not be re-configured.", self::ERROR_WRONG_HIERARCHY, null, LOGLEVEL_WARN);
 			}
 

lib/core/streamimporter.php

Indentation +255 added lines, -255 removed lines

@@ -8,259 +8,259 @@
  */
 
 class ImportChangesStream implements IImportChanges {
-	private $encoder;
-	private $objclass;
-	private $seenObjects;
-	private $importedMsgs;
-	private $checkForIgnoredMessages;
-	private $classAsString;
-
-	/**
-	 * Constructor of the StreamImporter.
-	 *
-	 * @param WBXMLEncoder $encoder Objects are streamed to this encoder
-	 * @param SyncObject   $class   SyncObject class (only these are accepted when streaming content messages)
-	 */
-	public function __construct(&$encoder, $class) {
-		$this->encoder = &$encoder;
-		$this->objclass = $class;
-		$this->classAsString = (is_object($class)) ? get_class($class) : '';
-		$this->seenObjects = [];
-		$this->importedMsgs = 0;
-		$this->checkForIgnoredMessages = true;
-	}
-
-	/**
-	 * Implement interface - never used.
-	 *
-	 * @param mixed $state
-	 * @param mixed $flags
-	 */
-	public function Config($state, $flags = 0) {
-		return true;
-	}
-
-	public function ConfigContentParameters($contentparameters) {
-		return true;
-	}
-
-	public function GetState() {
-		return false;
-	}
-
-	public function LoadConflicts($contentparameters, $state) {
-		return true;
-	}
-
-	/**
-	 * Imports a single message.
-	 *
-	 * @param string     $id
-	 * @param SyncObject $message
-	 *
-	 * @return bool
-	 */
-	public function ImportMessageChange($id, $message) {
-		// ignore other SyncObjects
-		if (!($message instanceof $this->classAsString)) {
-			return false;
-		}
-
-		// prevent sending the same object twice in one request
-		if (in_array($id, $this->seenObjects)) {
-			SLog::Write(LOGLEVEL_DEBUG, sprintf("Object '%s' discarded! Object already sent in this request.", $id));
-
-			return true;
-		}
-
-		++$this->importedMsgs;
-		$this->seenObjects[] = $id;
-
-		// checks if the next message may cause a loop or is broken
-		if (GSync::GetDeviceManager()->DoNotStreamMessage($id, $message)) {
-			SLog::Write(LOGLEVEL_DEBUG, sprintf("ImportChangesStream->ImportMessageChange('%s'): message ignored and requested to be removed from mobile", $id));
-
-			// this is an internal operation & should not trigger an update in the device manager
-			$this->checkForIgnoredMessages = false;
-			$stat = $this->ImportMessageDeletion($id);
-			$this->checkForIgnoredMessages = true;
-
-			return $stat;
-		}
-
-		if ($message->flags === false || $message->flags === SYNC_NEWMESSAGE) {
-			$this->encoder->startTag(SYNC_ADD);
-		}
-		else {
-			// on update of an SyncEmail we only export the flags and categories
-			if ($message instanceof SyncMail && ((isset($message->flag) && $message->flag instanceof SyncMailFlags) || isset($message->categories))) {
-				$newmessage = new SyncMail();
-				$newmessage->read = $message->read;
-				if (isset($message->flag)) {
-					$newmessage->flag = $message->flag;
-				}
-				if (isset($message->lastverbexectime)) {
-					$newmessage->lastverbexectime = $message->lastverbexectime;
-				}
-				if (isset($message->lastverbexecuted)) {
-					$newmessage->lastverbexecuted = $message->lastverbexecuted;
-				}
-				if (isset($message->categories)) {
-					$newmessage->categories = $message->categories;
-				}
-				$message = $newmessage;
-				unset($newmessage);
-				SLog::Write(LOGLEVEL_DEBUG, sprintf("ImportChangesStream->ImportMessageChange('%s'): SyncMail message updated. Message content is striped, only flags/categories are streamed.", $id));
-			}
-
-			$this->encoder->startTag(SYNC_MODIFY);
-		}
-
-		// TAG: SYNC_ADD / SYNC_MODIFY
-		$this->encoder->startTag(SYNC_SERVERENTRYID);
-		$this->encoder->content($id);
-		$this->encoder->endTag();
-		$this->encoder->startTag(SYNC_DATA);
-		$message->Encode($this->encoder);
-		$this->encoder->endTag();
-		$this->encoder->endTag();
-
-		return true;
-	}
-
-	/**
-	 * Imports a deletion.
-	 *
-	 * @param string $id
-	 * @param bool   $asSoftDelete (opt) if true, the deletion is exported as "SoftDelete", else as "Remove" - default: false
-	 *
-	 * @return bool
-	 */
-	public function ImportMessageDeletion($id, $asSoftDelete = false) {
-		if ($this->checkForIgnoredMessages) {
-			GSync::GetDeviceManager()->RemoveBrokenMessage($id);
-		}
-
-		++$this->importedMsgs;
-		if ($asSoftDelete) {
-			$this->encoder->startTag(SYNC_SOFTDELETE);
-		}
-		else {
-			$this->encoder->startTag(SYNC_REMOVE);
-		}
-		$this->encoder->startTag(SYNC_SERVERENTRYID);
-		$this->encoder->content($id);
-		$this->encoder->endTag();
-		$this->encoder->endTag();
-
-		return true;
-	}
-
-	/**
-	 * Imports a change in 'read' flag
-	 * Can only be applied to SyncMail (Email) requests.
-	 *
-	 * @param string $id
-	 * @param int    $flags      - read/unread
-	 * @param array  $categories
-	 *
-	 * @return bool
-	 */
-	public function ImportMessageReadFlag($id, $flags, $categories = []) {
-		if (!($this->objclass instanceof SyncMail)) {
-			return false;
-		}
-
-		++$this->importedMsgs;
-
-		$this->encoder->startTag(SYNC_MODIFY);
-		$this->encoder->startTag(SYNC_SERVERENTRYID);
-		$this->encoder->content($id);
-		$this->encoder->endTag();
-		$this->encoder->startTag(SYNC_DATA);
-		$this->encoder->startTag(SYNC_POOMMAIL_READ);
-		$this->encoder->content($flags);
-		$this->encoder->endTag();
-		if (!empty($categories) && is_array($categories)) {
-			$this->encoder->startTag(SYNC_POOMMAIL_CATEGORIES);
-			foreach ($categories as $category) {
-				$this->encoder->startTag(SYNC_POOMMAIL_CATEGORY);
-				$this->encoder->content($category);
-				$this->encoder->endTag();
-			}
-			$this->encoder->endTag();
-		}
-		$this->encoder->endTag();
-		$this->encoder->endTag();
-
-		return true;
-	}
-
-	/**
-	 * ImportMessageMove is not implemented, as this operation can not be streamed to a WBXMLEncoder.
-	 *
-	 * @param string $id
-	 * @param int    $flags     read/unread
-	 * @param mixed  $newfolder
-	 *
-	 * @return bool
-	 */
-	public function ImportMessageMove($id, $newfolder) {
-		return true;
-	}
-
-	/**
-	 * Imports a change on a folder.
-	 *
-	 * @param object $folder SyncFolder
-	 *
-	 * @return boolean/SyncObject           status/object with the ath least the serverid of the folder set
-	 */
-	public function ImportFolderChange($folder) {
-		// checks if the next message may cause a loop or is broken
-		if (GSync::GetDeviceManager(false) && GSync::GetDeviceManager()->DoNotStreamMessage($folder->serverid, $folder)) {
-			SLog::Write(LOGLEVEL_DEBUG, sprintf("ImportChangesStream->ImportFolderChange('%s'): folder ignored as requested by DeviceManager.", $folder->serverid));
-
-			return true;
-		}
-
-		// send a modify flag if the folder is already known on the device
-		if (isset($folder->flags) && $folder->flags === SYNC_NEWMESSAGE) {
-			$this->encoder->startTag(SYNC_FOLDERHIERARCHY_ADD);
-		}
-		else {
-			$this->encoder->startTag(SYNC_FOLDERHIERARCHY_UPDATE);
-		}
-
-		$folder->Encode($this->encoder);
-		$this->encoder->endTag();
-
-		return true;
-	}
-
-	/**
-	 * Imports a folder deletion.
-	 *
-	 * @param SyncFolder $folder at least "serverid" needs to be set
-	 *
-	 * @return bool
-	 */
-	public function ImportFolderDeletion($folder) {
-		$this->encoder->startTag(SYNC_FOLDERHIERARCHY_REMOVE);
-		$this->encoder->startTag(SYNC_FOLDERHIERARCHY_SERVERENTRYID);
-		$this->encoder->content($folder->serverid);
-		$this->encoder->endTag();
-		$this->encoder->endTag();
-
-		return true;
-	}
-
-	/**
-	 * Returns the number of messages which were changed, deleted and had changed read status.
-	 *
-	 * @return int
-	 */
-	public function GetImportedMessages() {
-		return $this->importedMsgs;
-	}
+    private $encoder;
+    private $objclass;
+    private $seenObjects;
+    private $importedMsgs;
+    private $checkForIgnoredMessages;
+    private $classAsString;
+
+    /**
+     * Constructor of the StreamImporter.
+     *
+     * @param WBXMLEncoder $encoder Objects are streamed to this encoder
+     * @param SyncObject   $class   SyncObject class (only these are accepted when streaming content messages)
+     */
+    public function __construct(&$encoder, $class) {
+        $this->encoder = &$encoder;
+        $this->objclass = $class;
+        $this->classAsString = (is_object($class)) ? get_class($class) : '';
+        $this->seenObjects = [];
+        $this->importedMsgs = 0;
+        $this->checkForIgnoredMessages = true;
+    }
+
+    /**
+     * Implement interface - never used.
+     *
+     * @param mixed $state
+     * @param mixed $flags
+     */
+    public function Config($state, $flags = 0) {
+        return true;
+    }
+
+    public function ConfigContentParameters($contentparameters) {
+        return true;
+    }
+
+    public function GetState() {
+        return false;
+    }
+
+    public function LoadConflicts($contentparameters, $state) {
+        return true;
+    }
+
+    /**
+     * Imports a single message.
+     *
+     * @param string     $id
+     * @param SyncObject $message
+     *
+     * @return bool
+     */
+    public function ImportMessageChange($id, $message) {
+        // ignore other SyncObjects
+        if (!($message instanceof $this->classAsString)) {
+            return false;
+        }
+
+        // prevent sending the same object twice in one request
+        if (in_array($id, $this->seenObjects)) {
+            SLog::Write(LOGLEVEL_DEBUG, sprintf("Object '%s' discarded! Object already sent in this request.", $id));
+
+            return true;
+        }
+
+        ++$this->importedMsgs;
+        $this->seenObjects[] = $id;
+
+        // checks if the next message may cause a loop or is broken
+        if (GSync::GetDeviceManager()->DoNotStreamMessage($id, $message)) {
+            SLog::Write(LOGLEVEL_DEBUG, sprintf("ImportChangesStream->ImportMessageChange('%s'): message ignored and requested to be removed from mobile", $id));
+
+            // this is an internal operation & should not trigger an update in the device manager
+            $this->checkForIgnoredMessages = false;
+            $stat = $this->ImportMessageDeletion($id);
+            $this->checkForIgnoredMessages = true;
+
+            return $stat;
+        }
+
+        if ($message->flags === false || $message->flags === SYNC_NEWMESSAGE) {
+            $this->encoder->startTag(SYNC_ADD);
+        }
+        else {
+            // on update of an SyncEmail we only export the flags and categories
+            if ($message instanceof SyncMail && ((isset($message->flag) && $message->flag instanceof SyncMailFlags) || isset($message->categories))) {
+                $newmessage = new SyncMail();
+                $newmessage->read = $message->read;
+                if (isset($message->flag)) {
+                    $newmessage->flag = $message->flag;
+                }
+                if (isset($message->lastverbexectime)) {
+                    $newmessage->lastverbexectime = $message->lastverbexectime;
+                }
+                if (isset($message->lastverbexecuted)) {
+                    $newmessage->lastverbexecuted = $message->lastverbexecuted;
+                }
+                if (isset($message->categories)) {
+                    $newmessage->categories = $message->categories;
+                }
+                $message = $newmessage;
+                unset($newmessage);
+                SLog::Write(LOGLEVEL_DEBUG, sprintf("ImportChangesStream->ImportMessageChange('%s'): SyncMail message updated. Message content is striped, only flags/categories are streamed.", $id));
+            }
+
+            $this->encoder->startTag(SYNC_MODIFY);
+        }
+
+        // TAG: SYNC_ADD / SYNC_MODIFY
+        $this->encoder->startTag(SYNC_SERVERENTRYID);
+        $this->encoder->content($id);
+        $this->encoder->endTag();
+        $this->encoder->startTag(SYNC_DATA);
+        $message->Encode($this->encoder);
+        $this->encoder->endTag();
+        $this->encoder->endTag();
+
+        return true;
+    }
+
+    /**
+     * Imports a deletion.
+     *
+     * @param string $id
+     * @param bool   $asSoftDelete (opt) if true, the deletion is exported as "SoftDelete", else as "Remove" - default: false
+     *
+     * @return bool
+     */
+    public function ImportMessageDeletion($id, $asSoftDelete = false) {
+        if ($this->checkForIgnoredMessages) {
+            GSync::GetDeviceManager()->RemoveBrokenMessage($id);
+        }
+
+        ++$this->importedMsgs;
+        if ($asSoftDelete) {
+            $this->encoder->startTag(SYNC_SOFTDELETE);
+        }
+        else {
+            $this->encoder->startTag(SYNC_REMOVE);
+        }
+        $this->encoder->startTag(SYNC_SERVERENTRYID);
+        $this->encoder->content($id);
+        $this->encoder->endTag();
+        $this->encoder->endTag();
+
+        return true;
+    }
+
+    /**
+     * Imports a change in 'read' flag
+     * Can only be applied to SyncMail (Email) requests.
+     *
+     * @param string $id
+     * @param int    $flags      - read/unread
+     * @param array  $categories
+     *
+     * @return bool
+     */
+    public function ImportMessageReadFlag($id, $flags, $categories = []) {
+        if (!($this->objclass instanceof SyncMail)) {
+            return false;
+        }
+
+        ++$this->importedMsgs;
+
+        $this->encoder->startTag(SYNC_MODIFY);
+        $this->encoder->startTag(SYNC_SERVERENTRYID);
+        $this->encoder->content($id);
+        $this->encoder->endTag();
+        $this->encoder->startTag(SYNC_DATA);
+        $this->encoder->startTag(SYNC_POOMMAIL_READ);
+        $this->encoder->content($flags);
+        $this->encoder->endTag();
+        if (!empty($categories) && is_array($categories)) {
+            $this->encoder->startTag(SYNC_POOMMAIL_CATEGORIES);
+            foreach ($categories as $category) {
+                $this->encoder->startTag(SYNC_POOMMAIL_CATEGORY);
+                $this->encoder->content($category);
+                $this->encoder->endTag();
+            }
+            $this->encoder->endTag();
+        }
+        $this->encoder->endTag();
+        $this->encoder->endTag();
+
+        return true;
+    }
+
+    /**
+     * ImportMessageMove is not implemented, as this operation can not be streamed to a WBXMLEncoder.
+     *
+     * @param string $id
+     * @param int    $flags     read/unread
+     * @param mixed  $newfolder
+     *
+     * @return bool
+     */
+    public function ImportMessageMove($id, $newfolder) {
+        return true;
+    }
+
+    /**
+     * Imports a change on a folder.
+     *
+     * @param object $folder SyncFolder
+     *
+     * @return boolean/SyncObject           status/object with the ath least the serverid of the folder set
+     */
+    public function ImportFolderChange($folder) {
+        // checks if the next message may cause a loop or is broken
+        if (GSync::GetDeviceManager(false) && GSync::GetDeviceManager()->DoNotStreamMessage($folder->serverid, $folder)) {
+            SLog::Write(LOGLEVEL_DEBUG, sprintf("ImportChangesStream->ImportFolderChange('%s'): folder ignored as requested by DeviceManager.", $folder->serverid));
+
+            return true;
+        }
+
+        // send a modify flag if the folder is already known on the device
+        if (isset($folder->flags) && $folder->flags === SYNC_NEWMESSAGE) {
+            $this->encoder->startTag(SYNC_FOLDERHIERARCHY_ADD);
+        }
+        else {
+            $this->encoder->startTag(SYNC_FOLDERHIERARCHY_UPDATE);
+        }
+
+        $folder->Encode($this->encoder);
+        $this->encoder->endTag();
+
+        return true;
+    }
+
+    /**
+     * Imports a folder deletion.
+     *
+     * @param SyncFolder $folder at least "serverid" needs to be set
+     *
+     * @return bool
+     */
+    public function ImportFolderDeletion($folder) {
+        $this->encoder->startTag(SYNC_FOLDERHIERARCHY_REMOVE);
+        $this->encoder->startTag(SYNC_FOLDERHIERARCHY_SERVERENTRYID);
+        $this->encoder->content($folder->serverid);
+        $this->encoder->endTag();
+        $this->encoder->endTag();
+
+        return true;
+    }
+
+    /**
+     * Returns the number of messages which were changed, deleted and had changed read status.
+     *
+     * @return int
+     */
+    public function GetImportedMessages() {
+        return $this->importedMsgs;
+    }
 }

Braces +3 added lines, -6 removed lines

@@ -90,8 +90,7 @@ 
 
 		if ($message->flags === false || $message->flags === SYNC_NEWMESSAGE) {
 			$this->encoder->startTag(SYNC_ADD);
-		}
-		else {
+		} else {
 			// on update of an SyncEmail we only export the flags and categories
 			if ($message instanceof SyncMail && ((isset($message->flag) && $message->flag instanceof SyncMailFlags) || isset($message->categories))) {
 				$newmessage = new SyncMail();
@@ -144,8 +143,7 @@ 
 		++$this->importedMsgs;
 		if ($asSoftDelete) {
 			$this->encoder->startTag(SYNC_SOFTDELETE);
-		}
-		else {
+		} else {
 			$this->encoder->startTag(SYNC_REMOVE);
 		}
 		$this->encoder->startTag(SYNC_SERVERENTRYID);
@@ -227,8 +225,7 @@ 
 		// send a modify flag if the folder is already known on the device
 		if (isset($folder->flags) && $folder->flags === SYNC_NEWMESSAGE) {
 			$this->encoder->startTag(SYNC_FOLDERHIERARCHY_ADD);
-		}
-		else {
+		} else {
 			$this->encoder->startTag(SYNC_FOLDERHIERARCHY_UPDATE);
 		}
 

lib/core/streamer.php

Indentation +488 added lines, -488 removed lines

@@ -10,495 +10,495 @@
  */
 
 class Streamer implements JsonSerializable {
-	public const STREAMER_VAR = 1;
-	public const STREAMER_ARRAY = 2;
-	public const STREAMER_TYPE = 3;
-	public const STREAMER_PROP = 4;
-	public const STREAMER_RONOTIFY = 5;
-	public const STREAMER_VALUEMAP = 20;
-	public const STREAMER_TYPE_DATE = 1;
-	public const STREAMER_TYPE_HEX = 2;
-	public const STREAMER_TYPE_DATE_DASHES = 3;
-	public const STREAMER_TYPE_STREAM = 4; // deprecated
-	public const STREAMER_TYPE_IGNORE = 5;
-	public const STREAMER_TYPE_SEND_EMPTY = 6;
-	public const STREAMER_TYPE_NO_CONTAINER = 7;
-	public const STREAMER_TYPE_COMMA_SEPARATED = 8;
-	public const STREAMER_TYPE_SEMICOLON_SEPARATED = 9;
-	public const STREAMER_TYPE_MULTIPART = 10;
-	public const STREAMER_TYPE_STREAM_ASBASE64 = 11;
-	public const STREAMER_TYPE_STREAM_ASPLAIN = 12;
-	public const STREAMER_PRIVATE = 13;
-	public const STRIP_PRIVATE_DATA = 1;
-	public const STRIP_PRIVATE_SUBSTITUTE = 'Private';
-
-	protected $mapping;
-	public $flags;
-	public $content;
-
-	/**
-	 * Constructor.
-	 *
-	 * @param array $mapping internal mapping of variables
-	 */
-	public function __construct($mapping) {
-		$this->mapping = $mapping;
-		$this->flags = false;
-	}
-
-	/**
-	 * Return the streamer mapping for this object.
-	 */
-	public function GetMapping() {
-		return $this->mapping;
-	}
-
-	/**
-	 * Decodes the WBXML from a WBXMLdecoder until we reach the same depth level of WBXML.
-	 * This means that if there are multiple objects at this level, then only the first is
-	 * decoded SubOjects are auto-instantiated and decoded using the same functionality.
-	 *
-	 * @param WBXMLDecoder $decoder
-	 */
-	public function Decode(&$decoder) {
-		WBXMLDecoder::ResetInWhile("decodeMain");
-		while (WBXMLDecoder::InWhile("decodeMain")) {
-			$entity = $decoder->getElement();
-
-			if ($entity[EN_TYPE] == EN_TYPE_STARTTAG) {
-				if (!($entity[EN_FLAGS] & EN_FLAGS_CONTENT)) {
-					$map = $this->mapping[$entity[EN_TAG]];
-					if (isset($map[self::STREAMER_ARRAY])) {
-						$this->{$map[self::STREAMER_VAR]} = [];
-					}
-					elseif (isset($map[self::STREAMER_PROP]) && $map[self::STREAMER_PROP] == self::STREAMER_TYPE_SEND_EMPTY) {
-						$this->{$map[self::STREAMER_VAR]} = "1";
-					}
-					elseif (!isset($map[self::STREAMER_TYPE])) {
-						$this->{$map[self::STREAMER_VAR]} = "";
-					}
-					elseif ($map[self::STREAMER_TYPE] == self::STREAMER_TYPE_DATE || $map[self::STREAMER_TYPE] == self::STREAMER_TYPE_DATE_DASHES) {
-						$this->{$map[self::STREAMER_VAR]} = "";
-					}
-
-					continue;
-				}
-				// Found a start tag
-				if (!isset($this->mapping[$entity[EN_TAG]])) {
-					// This tag shouldn't be here, abort
-					SLog::Write(LOGLEVEL_WBXMLSTACK, sprintf("Tag '%s' unexpected in type XML type '%s'", $entity[EN_TAG], get_class($this)));
-
-					return false;
-				}
-
-				$map = $this->mapping[$entity[EN_TAG]];
-
-				// Handle an array
-				if (isset($map[self::STREAMER_ARRAY])) {
-					WBXMLDecoder::ResetInWhile("decodeArray");
-					while (WBXMLDecoder::InWhile("decodeArray")) {
-						// do not get start tag for an array without a container
-						if (!(isset($map[self::STREAMER_PROP]) && $map[self::STREAMER_PROP] == self::STREAMER_TYPE_NO_CONTAINER)) {
-							if (!$decoder->getElementStartTag($map[self::STREAMER_ARRAY])) {
-								break;
-							}
-						}
-						if (isset($map[self::STREAMER_TYPE])) {
-							$decoded = new $map[self::STREAMER_TYPE]();
-
-							$decoded->Decode($decoder);
-						}
-						else {
-							$decoded = $decoder->getElementContent();
-						}
-
-						if (!isset($this->{$map[self::STREAMER_VAR]})) {
-							$this->{$map[self::STREAMER_VAR]} = [$decoded];
-						}
-						else {
-							array_push($this->{$map[self::STREAMER_VAR]}, $decoded);
-						}
-
-						if (!$decoder->getElementEndTag()) { // end tag of a container element
-							return false;
-						}
-
-						if (isset($map[self::STREAMER_PROP]) && $map[self::STREAMER_PROP] == self::STREAMER_TYPE_NO_CONTAINER) {
-							$e = $decoder->peek();
-							// go back to the initial while if another block of no container elements is found
-							if ($e[EN_TYPE] == EN_TYPE_STARTTAG) {
-								continue 2;
-							}
-							// break on end tag because no container elements block end is reached
-							if ($e[EN_TYPE] == EN_TYPE_ENDTAG) {
-								break;
-							}
-							if (empty($e)) {
-								break;
-							}
-						}
-					}
-					// do not get end tag for an array without a container
-					if (!(isset($map[self::STREAMER_PROP]) && $map[self::STREAMER_PROP] == self::STREAMER_TYPE_NO_CONTAINER)) {
-						if (!$decoder->getElementEndTag()) { // end tag of container
-							return false;
-						}
-					}
-				}
-				else { // Handle single value
-					if (isset($map[self::STREAMER_TYPE])) {
-						// Complex type, decode recursively
-						if ($map[self::STREAMER_TYPE] == self::STREAMER_TYPE_DATE || $map[self::STREAMER_TYPE] == self::STREAMER_TYPE_DATE_DASHES) {
-							$decoded = $this->parseDate($decoder->getElementContent());
-							if (!$decoder->getElementEndTag()) {
-								return false;
-							}
-						}
-						elseif ($map[self::STREAMER_TYPE] == self::STREAMER_TYPE_HEX) {
-							$decoded = hex2bin($decoder->getElementContent());
-							if (!$decoder->getElementEndTag()) {
-								return false;
-							}
-						}
-						// explode comma or semicolon strings into arrays
-						elseif ($map[self::STREAMER_TYPE] == self::STREAMER_TYPE_COMMA_SEPARATED || $map[self::STREAMER_TYPE] == self::STREAMER_TYPE_SEMICOLON_SEPARATED) {
-							$glue = ($map[self::STREAMER_TYPE] == self::STREAMER_TYPE_COMMA_SEPARATED) ? ", " : "; ";
-							$decoded = explode($glue, $decoder->getElementContent());
-							if (!$decoder->getElementEndTag()) {
-								return false;
-							}
-						}
-						elseif ($map[self::STREAMER_TYPE] == self::STREAMER_TYPE_STREAM_ASPLAIN) {
-							$decoded = StringStreamWrapper::Open($decoder->getElementContent());
-							if (!$decoder->getElementEndTag()) {
-								return false;
-							}
-						}
-						else {
-							$subdecoder = new $map[self::STREAMER_TYPE]();
-							if ($subdecoder->Decode($decoder) === false) {
-								return false;
-							}
-
-							$decoded = $subdecoder;
-
-							if (!$decoder->getElementEndTag()) {
-								SLog::Write(LOGLEVEL_WBXMLSTACK, sprintf("No end tag for '%s'", $entity[EN_TAG]));
-
-								return false;
-							}
-						}
-					}
-					else {
-						// Simple type, just get content
-						$decoded = $decoder->getElementContent();
-
-						if ($decoded === false) {
-							// the tag is declared to have content, but no content is available.
-							// set an empty content
-							$decoded = "";
-						}
-
-						if (!$decoder->getElementEndTag()) {
-							SLog::Write(LOGLEVEL_WBXMLSTACK, sprintf("Unable to get end tag for '%s'", $entity[EN_TAG]));
-
-							return false;
-						}
-					}
-					// $decoded now contains data object (or string)
-					$this->{$map[self::STREAMER_VAR]} = $decoded;
-				}
-			}
-			elseif ($entity[EN_TYPE] == EN_TYPE_ENDTAG) {
-				$decoder->ungetElement($entity);
-
-				break;
-			}
-			else {
-				SLog::Write(LOGLEVEL_WBXMLSTACK, "Unexpected content in type");
-
-				break;
-			}
-		}
-	}
-
-	/**
-	 * Encodes this object and any subobjects - output is ordered according to mapping.
-	 *
-	 * @param WBXMLEncoder $encoder
-	 */
-	public function Encode(&$encoder) {
-		// A return value if anything was streamed. We need for empty tags.
-		$streamed = false;
-		foreach ($this->mapping as $tag => $map) {
-			if (isset($this->{$map[self::STREAMER_VAR]})) {
-				// Variable is available
-				if (is_object($this->{$map[self::STREAMER_VAR]})) {
-					// Subobjects can do their own encoding
-					if ($this->{$map[self::STREAMER_VAR]} instanceof Streamer) {
-						$encoder->startTag($tag);
-						$res = $this->{$map[self::STREAMER_VAR]}->Encode($encoder);
-						$encoder->endTag();
-						// nothing was streamed in previous encode but it should be streamed empty anyway
-						if (!$res && isset($map[self::STREAMER_PROP]) && $map[self::STREAMER_PROP] == self::STREAMER_TYPE_SEND_EMPTY) {
-							$encoder->startTag($tag, false, true);
-						}
-					}
-					else {
-						SLog::Write(LOGLEVEL_ERROR, sprintf("Streamer->Encode(): parameter '%s' of object %s is not of type Streamer", $map[self::STREAMER_VAR], get_class($this)));
-					}
-				}
-				// Array of objects
-				elseif (isset($map[self::STREAMER_ARRAY])) {
-					if (empty($this->{$map[self::STREAMER_VAR]}) && isset($map[self::STREAMER_PROP]) && $map[self::STREAMER_PROP] == self::STREAMER_TYPE_SEND_EMPTY) {
-						$encoder->startTag($tag, false, true);
-					}
-					else {
-						// Outputs array container (eg Attachments)
-						// Do not output start and end tag when type is STREAMER_TYPE_NO_CONTAINER
-						if (!isset($map[self::STREAMER_PROP]) || $map[self::STREAMER_PROP] != self::STREAMER_TYPE_NO_CONTAINER) {
-							$encoder->startTag($tag);
-						}
-
-						foreach ($this->{$map[self::STREAMER_VAR]} as $element) {
-							if (is_object($element)) {
-								$encoder->startTag($map[self::STREAMER_ARRAY]); // Outputs object container (eg Attachment)
-								$element->Encode($encoder);
-								$encoder->endTag();
-							}
-							else {
-								if (strlen($element) == 0)
-									  // Do not output empty items. Not sure if we should output an empty tag with $encoder->startTag($map[self::STREAMER_ARRAY], false, true);
-									  ; else {
-									  	$encoder->startTag($map[self::STREAMER_ARRAY]);
-									  	$encoder->content($element);
-									  	$encoder->endTag();
-									  	$streamed = true;
-									  }
-							}
-						}
-
-						if (!isset($map[self::STREAMER_PROP]) || $map[self::STREAMER_PROP] != self::STREAMER_TYPE_NO_CONTAINER) {
-							$encoder->endTag();
-						}
-					}
-				}
-				else {
-					if (isset($map[self::STREAMER_TYPE]) && $map[self::STREAMER_TYPE] == self::STREAMER_TYPE_IGNORE) {
-						continue;
-					}
-
-					if ($encoder->getMultipart() && isset($map[self::STREAMER_PROP]) && $map[self::STREAMER_PROP] == self::STREAMER_TYPE_MULTIPART) {
-						$encoder->addBodypartStream($this->{$map[self::STREAMER_VAR]});
-						$encoder->startTag(SYNC_ITEMOPERATIONS_PART);
-						$encoder->content($encoder->getBodypartsCount());
-						$encoder->endTag();
-
-						continue;
-					}
-
-					// Simple type
-					if (!isset($map[self::STREAMER_TYPE]) && strlen($this->{$map[self::STREAMER_VAR]}) == 0) {
-						// send empty tags
-						if (isset($map[self::STREAMER_PROP]) && $map[self::STREAMER_PROP] == self::STREAMER_TYPE_SEND_EMPTY) {
-							$encoder->startTag($tag, false, true);
-						}
-
-						// Do not output empty items. See above: $encoder->startTag($tag, false, true);
-						continue;
-					}
-					$encoder->startTag($tag);
-
-					if (isset($map[self::STREAMER_TYPE]) && ($map[self::STREAMER_TYPE] == self::STREAMER_TYPE_DATE || $map[self::STREAMER_TYPE] == self::STREAMER_TYPE_DATE_DASHES)) {
-						if ($this->{$map[self::STREAMER_VAR]} != 0) { // don't output 1-1-1970
-							$encoder->content($this->formatDate($this->{$map[self::STREAMER_VAR]}, $map[self::STREAMER_TYPE]));
-						}
-					}
-					elseif (isset($map[self::STREAMER_TYPE]) && $map[self::STREAMER_TYPE] == self::STREAMER_TYPE_HEX) {
-						$encoder->content(strtoupper(bin2hex($this->{$map[self::STREAMER_VAR]})));
-					}
-					elseif (isset($map[self::STREAMER_TYPE]) && $map[self::STREAMER_TYPE] == self::STREAMER_TYPE_STREAM_ASPLAIN) {
-						$encoder->contentStream($this->{$map[self::STREAMER_VAR]}, false);
-					}
-					elseif (isset($map[self::STREAMER_TYPE]) && ($map[self::STREAMER_TYPE] == self::STREAMER_TYPE_STREAM_ASBASE64 || $map[self::STREAMER_TYPE] == self::STREAMER_TYPE_STREAM)) {
-						$encoder->contentStream($this->{$map[self::STREAMER_VAR]}, true);
-					}
-					// implode comma or semicolon arrays into a string
-					elseif (isset($map[self::STREAMER_TYPE]) && is_array($this->{$map[self::STREAMER_VAR]}) &&
-						($map[self::STREAMER_TYPE] == self::STREAMER_TYPE_COMMA_SEPARATED || $map[self::STREAMER_TYPE] == self::STREAMER_TYPE_SEMICOLON_SEPARATED)) {
-						$glue = ($map[self::STREAMER_TYPE] == self::STREAMER_TYPE_COMMA_SEPARATED) ? ", " : "; ";
-						$encoder->content(implode($glue, $this->{$map[self::STREAMER_VAR]}));
-					}
-					else {
-						$encoder->content($this->{$map[self::STREAMER_VAR]});
-					}
-					$encoder->endTag();
-					$streamed = true;
-				}
-			}
-		}
-		// Output our own content
-		if (isset($this->content)) {
-			$encoder->content($this->content);
-		}
-
-		return $streamed;
-	}
-
-	/**
-	 * Removes not necessary data from the object.
-	 *
-	 * @param mixed $flags
-	 *
-	 * @return bool
-	 */
-	public function StripData($flags = 0) {
-		foreach ($this->mapping as $k => $v) {
-			if (isset($this->{$v[self::STREAMER_VAR]})) {
-				if (is_object($this->{$v[self::STREAMER_VAR]}) && method_exists($this->{$v[self::STREAMER_VAR]}, "StripData")) {
-					$this->{$v[self::STREAMER_VAR]}->StripData($flags);
-				}
-				elseif (isset($v[self::STREAMER_ARRAY]) && !empty($this->{$v[self::STREAMER_VAR]})) {
-					foreach ($this->{$v[self::STREAMER_VAR]} as $element) {
-						if (is_object($element) && method_exists($element, "StripData")) {
-							$element->StripData($flags);
-						}
-						elseif ($flags === Streamer::STRIP_PRIVATE_DATA && isset($v[self::STREAMER_PRIVATE])) {
-							if ($v[self::STREAMER_PRIVATE] !== true) {
-								$this->{$v[self::STREAMER_VAR]} = $v[self::STREAMER_PRIVATE];
-							}
-							else {
-								unset($this->{$v[self::STREAMER_VAR]});
-							}
-						}
-					}
-				}
-				elseif ($flags === Streamer::STRIP_PRIVATE_DATA && isset($v[self::STREAMER_PRIVATE])) {
-					if ($v[self::STREAMER_PRIVATE] !== true) {
-						$this->{$v[self::STREAMER_VAR]} = $v[self::STREAMER_PRIVATE];
-					}
-					else {
-						unset($this->{$v[self::STREAMER_VAR]});
-					}
-				}
-			}
-		}
-		if ($flags === 0) {
-			unset($this->mapping);
-		}
-
-		return true;
-	}
-
-	/**
-	 * Returns SyncObject's streamer variable names.
-	 *
-	 * @return array
-	 */
-	public function GetStreamerVars() {
-		$streamerVars = [];
-		foreach ($this->mapping as $v) {
-			$streamerVars[] = $v[self::STREAMER_VAR];
-		}
-
-		return $streamerVars;
-	}
-
-	/**
-	 * JsonSerializable interface method.
-	 *
-	 * Serializes the object to a value that can be serialized natively by json_encode()
-	 *
-	 * @return array
-	 */
-	public function jsonSerialize() {
-		$data = [];
-		foreach ($this->mapping as $k => $v) {
-			if (isset($this->{$v[self::STREAMER_VAR]})) {
-				$data[$v[self::STREAMER_VAR]] = $this->{$v[self::STREAMER_VAR]};
-			}
-		}
-
-		return [
-			'gsSyncStateClass' => get_class($this),
-			'data' => $data,
-		];
-	}
-
-	/**
-	 * Restores the object from a value provided by json_decode.
-	 *
-	 * @param $stdObj   stdClass Object
-	 */
-	public function jsonDeserialize($stdObj) {
-		foreach ($stdObj->data as $k => $v) {
-			if (is_object($v) && isset($v->gsSyncStateClass)) {
-				SLog::Write(LOGLEVEL_DEBUG, sprintf("Streamer->jsonDeserialize(): top class '%s'", $v->gsSyncStateClass));
-				$this->{$k} = new $v->gsSyncStateClass();
-				$this->{$k}->jsonDeserialize($v);
-			}
-			else {
-				$this->{$k} = $v;
-			}
-		}
-	}
-
-	/*----------------------------------------------------------------------------------------------------------
+    public const STREAMER_VAR = 1;
+    public const STREAMER_ARRAY = 2;
+    public const STREAMER_TYPE = 3;
+    public const STREAMER_PROP = 4;
+    public const STREAMER_RONOTIFY = 5;
+    public const STREAMER_VALUEMAP = 20;
+    public const STREAMER_TYPE_DATE = 1;
+    public const STREAMER_TYPE_HEX = 2;
+    public const STREAMER_TYPE_DATE_DASHES = 3;
+    public const STREAMER_TYPE_STREAM = 4; // deprecated
+    public const STREAMER_TYPE_IGNORE = 5;
+    public const STREAMER_TYPE_SEND_EMPTY = 6;
+    public const STREAMER_TYPE_NO_CONTAINER = 7;
+    public const STREAMER_TYPE_COMMA_SEPARATED = 8;
+    public const STREAMER_TYPE_SEMICOLON_SEPARATED = 9;
+    public const STREAMER_TYPE_MULTIPART = 10;
+    public const STREAMER_TYPE_STREAM_ASBASE64 = 11;
+    public const STREAMER_TYPE_STREAM_ASPLAIN = 12;
+    public const STREAMER_PRIVATE = 13;
+    public const STRIP_PRIVATE_DATA = 1;
+    public const STRIP_PRIVATE_SUBSTITUTE = 'Private';
+
+    protected $mapping;
+    public $flags;
+    public $content;
+
+    /**
+     * Constructor.
+     *
+     * @param array $mapping internal mapping of variables
+     */
+    public function __construct($mapping) {
+        $this->mapping = $mapping;
+        $this->flags = false;
+    }
+
+    /**
+     * Return the streamer mapping for this object.
+     */
+    public function GetMapping() {
+        return $this->mapping;
+    }
+
+    /**
+     * Decodes the WBXML from a WBXMLdecoder until we reach the same depth level of WBXML.
+     * This means that if there are multiple objects at this level, then only the first is
+     * decoded SubOjects are auto-instantiated and decoded using the same functionality.
+     *
+     * @param WBXMLDecoder $decoder
+     */
+    public function Decode(&$decoder) {
+        WBXMLDecoder::ResetInWhile("decodeMain");
+        while (WBXMLDecoder::InWhile("decodeMain")) {
+            $entity = $decoder->getElement();
+
+            if ($entity[EN_TYPE] == EN_TYPE_STARTTAG) {
+                if (!($entity[EN_FLAGS] & EN_FLAGS_CONTENT)) {
+                    $map = $this->mapping[$entity[EN_TAG]];
+                    if (isset($map[self::STREAMER_ARRAY])) {
+                        $this->{$map[self::STREAMER_VAR]} = [];
+                    }
+                    elseif (isset($map[self::STREAMER_PROP]) && $map[self::STREAMER_PROP] == self::STREAMER_TYPE_SEND_EMPTY) {
+                        $this->{$map[self::STREAMER_VAR]} = "1";
+                    }
+                    elseif (!isset($map[self::STREAMER_TYPE])) {
+                        $this->{$map[self::STREAMER_VAR]} = "";
+                    }
+                    elseif ($map[self::STREAMER_TYPE] == self::STREAMER_TYPE_DATE || $map[self::STREAMER_TYPE] == self::STREAMER_TYPE_DATE_DASHES) {
+                        $this->{$map[self::STREAMER_VAR]} = "";
+                    }
+
+                    continue;
+                }
+                // Found a start tag
+                if (!isset($this->mapping[$entity[EN_TAG]])) {
+                    // This tag shouldn't be here, abort
+                    SLog::Write(LOGLEVEL_WBXMLSTACK, sprintf("Tag '%s' unexpected in type XML type '%s'", $entity[EN_TAG], get_class($this)));
+
+                    return false;
+                }
+
+                $map = $this->mapping[$entity[EN_TAG]];
+
+                // Handle an array
+                if (isset($map[self::STREAMER_ARRAY])) {
+                    WBXMLDecoder::ResetInWhile("decodeArray");
+                    while (WBXMLDecoder::InWhile("decodeArray")) {
+                        // do not get start tag for an array without a container
+                        if (!(isset($map[self::STREAMER_PROP]) && $map[self::STREAMER_PROP] == self::STREAMER_TYPE_NO_CONTAINER)) {
+                            if (!$decoder->getElementStartTag($map[self::STREAMER_ARRAY])) {
+                                break;
+                            }
+                        }
+                        if (isset($map[self::STREAMER_TYPE])) {
+                            $decoded = new $map[self::STREAMER_TYPE]();
+
+                            $decoded->Decode($decoder);
+                        }
+                        else {
+                            $decoded = $decoder->getElementContent();
+                        }
+
+                        if (!isset($this->{$map[self::STREAMER_VAR]})) {
+                            $this->{$map[self::STREAMER_VAR]} = [$decoded];
+                        }
+                        else {
+                            array_push($this->{$map[self::STREAMER_VAR]}, $decoded);
+                        }
+
+                        if (!$decoder->getElementEndTag()) { // end tag of a container element
+                            return false;
+                        }
+
+                        if (isset($map[self::STREAMER_PROP]) && $map[self::STREAMER_PROP] == self::STREAMER_TYPE_NO_CONTAINER) {
+                            $e = $decoder->peek();
+                            // go back to the initial while if another block of no container elements is found
+                            if ($e[EN_TYPE] == EN_TYPE_STARTTAG) {
+                                continue 2;
+                            }
+                            // break on end tag because no container elements block end is reached
+                            if ($e[EN_TYPE] == EN_TYPE_ENDTAG) {
+                                break;
+                            }
+                            if (empty($e)) {
+                                break;
+                            }
+                        }
+                    }
+                    // do not get end tag for an array without a container
+                    if (!(isset($map[self::STREAMER_PROP]) && $map[self::STREAMER_PROP] == self::STREAMER_TYPE_NO_CONTAINER)) {
+                        if (!$decoder->getElementEndTag()) { // end tag of container
+                            return false;
+                        }
+                    }
+                }
+                else { // Handle single value
+                    if (isset($map[self::STREAMER_TYPE])) {
+                        // Complex type, decode recursively
+                        if ($map[self::STREAMER_TYPE] == self::STREAMER_TYPE_DATE || $map[self::STREAMER_TYPE] == self::STREAMER_TYPE_DATE_DASHES) {
+                            $decoded = $this->parseDate($decoder->getElementContent());
+                            if (!$decoder->getElementEndTag()) {
+                                return false;
+                            }
+                        }
+                        elseif ($map[self::STREAMER_TYPE] == self::STREAMER_TYPE_HEX) {
+                            $decoded = hex2bin($decoder->getElementContent());
+                            if (!$decoder->getElementEndTag()) {
+                                return false;
+                            }
+                        }
+                        // explode comma or semicolon strings into arrays
+                        elseif ($map[self::STREAMER_TYPE] == self::STREAMER_TYPE_COMMA_SEPARATED || $map[self::STREAMER_TYPE] == self::STREAMER_TYPE_SEMICOLON_SEPARATED) {
+                            $glue = ($map[self::STREAMER_TYPE] == self::STREAMER_TYPE_COMMA_SEPARATED) ? ", " : "; ";
+                            $decoded = explode($glue, $decoder->getElementContent());
+                            if (!$decoder->getElementEndTag()) {
+                                return false;
+                            }
+                        }
+                        elseif ($map[self::STREAMER_TYPE] == self::STREAMER_TYPE_STREAM_ASPLAIN) {
+                            $decoded = StringStreamWrapper::Open($decoder->getElementContent());
+                            if (!$decoder->getElementEndTag()) {
+                                return false;
+                            }
+                        }
+                        else {
+                            $subdecoder = new $map[self::STREAMER_TYPE]();
+                            if ($subdecoder->Decode($decoder) === false) {
+                                return false;
+                            }
+
+                            $decoded = $subdecoder;
+
+                            if (!$decoder->getElementEndTag()) {
+                                SLog::Write(LOGLEVEL_WBXMLSTACK, sprintf("No end tag for '%s'", $entity[EN_TAG]));
+
+                                return false;
+                            }
+                        }
+                    }
+                    else {
+                        // Simple type, just get content
+                        $decoded = $decoder->getElementContent();
+
+                        if ($decoded === false) {
+                            // the tag is declared to have content, but no content is available.
+                            // set an empty content
+                            $decoded = "";
+                        }
+
+                        if (!$decoder->getElementEndTag()) {
+                            SLog::Write(LOGLEVEL_WBXMLSTACK, sprintf("Unable to get end tag for '%s'", $entity[EN_TAG]));
+
+                            return false;
+                        }
+                    }
+                    // $decoded now contains data object (or string)
+                    $this->{$map[self::STREAMER_VAR]} = $decoded;
+                }
+            }
+            elseif ($entity[EN_TYPE] == EN_TYPE_ENDTAG) {
+                $decoder->ungetElement($entity);
+
+                break;
+            }
+            else {
+                SLog::Write(LOGLEVEL_WBXMLSTACK, "Unexpected content in type");
+
+                break;
+            }
+        }
+    }
+
+    /**
+     * Encodes this object and any subobjects - output is ordered according to mapping.
+     *
+     * @param WBXMLEncoder $encoder
+     */
+    public function Encode(&$encoder) {
+        // A return value if anything was streamed. We need for empty tags.
+        $streamed = false;
+        foreach ($this->mapping as $tag => $map) {
+            if (isset($this->{$map[self::STREAMER_VAR]})) {
+                // Variable is available
+                if (is_object($this->{$map[self::STREAMER_VAR]})) {
+                    // Subobjects can do their own encoding
+                    if ($this->{$map[self::STREAMER_VAR]} instanceof Streamer) {
+                        $encoder->startTag($tag);
+                        $res = $this->{$map[self::STREAMER_VAR]}->Encode($encoder);
+                        $encoder->endTag();
+                        // nothing was streamed in previous encode but it should be streamed empty anyway
+                        if (!$res && isset($map[self::STREAMER_PROP]) && $map[self::STREAMER_PROP] == self::STREAMER_TYPE_SEND_EMPTY) {
+                            $encoder->startTag($tag, false, true);
+                        }
+                    }
+                    else {
+                        SLog::Write(LOGLEVEL_ERROR, sprintf("Streamer->Encode(): parameter '%s' of object %s is not of type Streamer", $map[self::STREAMER_VAR], get_class($this)));
+                    }
+                }
+                // Array of objects
+                elseif (isset($map[self::STREAMER_ARRAY])) {
+                    if (empty($this->{$map[self::STREAMER_VAR]}) && isset($map[self::STREAMER_PROP]) && $map[self::STREAMER_PROP] == self::STREAMER_TYPE_SEND_EMPTY) {
+                        $encoder->startTag($tag, false, true);
+                    }
+                    else {
+                        // Outputs array container (eg Attachments)
+                        // Do not output start and end tag when type is STREAMER_TYPE_NO_CONTAINER
+                        if (!isset($map[self::STREAMER_PROP]) || $map[self::STREAMER_PROP] != self::STREAMER_TYPE_NO_CONTAINER) {
+                            $encoder->startTag($tag);
+                        }
+
+                        foreach ($this->{$map[self::STREAMER_VAR]} as $element) {
+                            if (is_object($element)) {
+                                $encoder->startTag($map[self::STREAMER_ARRAY]); // Outputs object container (eg Attachment)
+                                $element->Encode($encoder);
+                                $encoder->endTag();
+                            }
+                            else {
+                                if (strlen($element) == 0)
+                                        // Do not output empty items. Not sure if we should output an empty tag with $encoder->startTag($map[self::STREAMER_ARRAY], false, true);
+                                        ; else {
+                                            $encoder->startTag($map[self::STREAMER_ARRAY]);
+                                            $encoder->content($element);
+                                            $encoder->endTag();
+                                            $streamed = true;
+                                        }
+                            }
+                        }
+
+                        if (!isset($map[self::STREAMER_PROP]) || $map[self::STREAMER_PROP] != self::STREAMER_TYPE_NO_CONTAINER) {
+                            $encoder->endTag();
+                        }
+                    }
+                }
+                else {
+                    if (isset($map[self::STREAMER_TYPE]) && $map[self::STREAMER_TYPE] == self::STREAMER_TYPE_IGNORE) {
+                        continue;
+                    }
+
+                    if ($encoder->getMultipart() && isset($map[self::STREAMER_PROP]) && $map[self::STREAMER_PROP] == self::STREAMER_TYPE_MULTIPART) {
+                        $encoder->addBodypartStream($this->{$map[self::STREAMER_VAR]});
+                        $encoder->startTag(SYNC_ITEMOPERATIONS_PART);
+                        $encoder->content($encoder->getBodypartsCount());
+                        $encoder->endTag();
+
+                        continue;
+                    }
+
+                    // Simple type
+                    if (!isset($map[self::STREAMER_TYPE]) && strlen($this->{$map[self::STREAMER_VAR]}) == 0) {
+                        // send empty tags
+                        if (isset($map[self::STREAMER_PROP]) && $map[self::STREAMER_PROP] == self::STREAMER_TYPE_SEND_EMPTY) {
+                            $encoder->startTag($tag, false, true);
+                        }
+
+                        // Do not output empty items. See above: $encoder->startTag($tag, false, true);
+                        continue;
+                    }
+                    $encoder->startTag($tag);
+
+                    if (isset($map[self::STREAMER_TYPE]) && ($map[self::STREAMER_TYPE] == self::STREAMER_TYPE_DATE || $map[self::STREAMER_TYPE] == self::STREAMER_TYPE_DATE_DASHES)) {
+                        if ($this->{$map[self::STREAMER_VAR]} != 0) { // don't output 1-1-1970
+                            $encoder->content($this->formatDate($this->{$map[self::STREAMER_VAR]}, $map[self::STREAMER_TYPE]));
+                        }
+                    }
+                    elseif (isset($map[self::STREAMER_TYPE]) && $map[self::STREAMER_TYPE] == self::STREAMER_TYPE_HEX) {
+                        $encoder->content(strtoupper(bin2hex($this->{$map[self::STREAMER_VAR]})));
+                    }
+                    elseif (isset($map[self::STREAMER_TYPE]) && $map[self::STREAMER_TYPE] == self::STREAMER_TYPE_STREAM_ASPLAIN) {
+                        $encoder->contentStream($this->{$map[self::STREAMER_VAR]}, false);
+                    }
+                    elseif (isset($map[self::STREAMER_TYPE]) && ($map[self::STREAMER_TYPE] == self::STREAMER_TYPE_STREAM_ASBASE64 || $map[self::STREAMER_TYPE] == self::STREAMER_TYPE_STREAM)) {
+                        $encoder->contentStream($this->{$map[self::STREAMER_VAR]}, true);
+                    }
+                    // implode comma or semicolon arrays into a string
+                    elseif (isset($map[self::STREAMER_TYPE]) && is_array($this->{$map[self::STREAMER_VAR]}) &&
+                        ($map[self::STREAMER_TYPE] == self::STREAMER_TYPE_COMMA_SEPARATED || $map[self::STREAMER_TYPE] == self::STREAMER_TYPE_SEMICOLON_SEPARATED)) {
+                        $glue = ($map[self::STREAMER_TYPE] == self::STREAMER_TYPE_COMMA_SEPARATED) ? ", " : "; ";
+                        $encoder->content(implode($glue, $this->{$map[self::STREAMER_VAR]}));
+                    }
+                    else {
+                        $encoder->content($this->{$map[self::STREAMER_VAR]});
+                    }
+                    $encoder->endTag();
+                    $streamed = true;
+                }
+            }
+        }
+        // Output our own content
+        if (isset($this->content)) {
+            $encoder->content($this->content);
+        }
+
+        return $streamed;
+    }
+
+    /**
+     * Removes not necessary data from the object.
+     *
+     * @param mixed $flags
+     *
+     * @return bool
+     */
+    public function StripData($flags = 0) {
+        foreach ($this->mapping as $k => $v) {
+            if (isset($this->{$v[self::STREAMER_VAR]})) {
+                if (is_object($this->{$v[self::STREAMER_VAR]}) && method_exists($this->{$v[self::STREAMER_VAR]}, "StripData")) {
+                    $this->{$v[self::STREAMER_VAR]}->StripData($flags);
+                }
+                elseif (isset($v[self::STREAMER_ARRAY]) && !empty($this->{$v[self::STREAMER_VAR]})) {
+                    foreach ($this->{$v[self::STREAMER_VAR]} as $element) {
+                        if (is_object($element) && method_exists($element, "StripData")) {
+                            $element->StripData($flags);
+                        }
+                        elseif ($flags === Streamer::STRIP_PRIVATE_DATA && isset($v[self::STREAMER_PRIVATE])) {
+                            if ($v[self::STREAMER_PRIVATE] !== true) {
+                                $this->{$v[self::STREAMER_VAR]} = $v[self::STREAMER_PRIVATE];
+                            }
+                            else {
+                                unset($this->{$v[self::STREAMER_VAR]});
+                            }
+                        }
+                    }
+                }
+                elseif ($flags === Streamer::STRIP_PRIVATE_DATA && isset($v[self::STREAMER_PRIVATE])) {
+                    if ($v[self::STREAMER_PRIVATE] !== true) {
+                        $this->{$v[self::STREAMER_VAR]} = $v[self::STREAMER_PRIVATE];
+                    }
+                    else {
+                        unset($this->{$v[self::STREAMER_VAR]});
+                    }
+                }
+            }
+        }
+        if ($flags === 0) {
+            unset($this->mapping);
+        }
+
+        return true;
+    }
+
+    /**
+     * Returns SyncObject's streamer variable names.
+     *
+     * @return array
+     */
+    public function GetStreamerVars() {
+        $streamerVars = [];
+        foreach ($this->mapping as $v) {
+            $streamerVars[] = $v[self::STREAMER_VAR];
+        }
+
+        return $streamerVars;
+    }
+
+    /**
+     * JsonSerializable interface method.
+     *
+     * Serializes the object to a value that can be serialized natively by json_encode()
+     *
+     * @return array
+     */
+    public function jsonSerialize() {
+        $data = [];
+        foreach ($this->mapping as $k => $v) {
+            if (isset($this->{$v[self::STREAMER_VAR]})) {
+                $data[$v[self::STREAMER_VAR]] = $this->{$v[self::STREAMER_VAR]};
+            }
+        }
+
+        return [
+            'gsSyncStateClass' => get_class($this),
+            'data' => $data,
+        ];
+    }
+
+    /**
+     * Restores the object from a value provided by json_decode.
+     *
+     * @param $stdObj   stdClass Object
+     */
+    public function jsonDeserialize($stdObj) {
+        foreach ($stdObj->data as $k => $v) {
+            if (is_object($v) && isset($v->gsSyncStateClass)) {
+                SLog::Write(LOGLEVEL_DEBUG, sprintf("Streamer->jsonDeserialize(): top class '%s'", $v->gsSyncStateClass));
+                $this->{$k} = new $v->gsSyncStateClass();
+                $this->{$k}->jsonDeserialize($v);
+            }
+            else {
+                $this->{$k} = $v;
+            }
+        }
+    }
+
+    /*----------------------------------------------------------------------------------------------------------
 	 * Private methods for conversion
 	 */
 
-	/**
-	 * Formats a timestamp
-	 * Oh yeah, this is beautiful. Exchange outputs date fields differently in calendar items
-	 * and emails. We could just always send one or the other, but unfortunately nokia's 'Mail for
-	 *  exchange' depends on this quirk. So we have to send a different date type depending on where
-	 * it's used. Sigh.
-	 *
-	 * @param int $ts
-	 * @param int $type
-	 *
-	 * @return string
-	 */
-	private function formatDate($ts, $type) {
-		if ($type == self::STREAMER_TYPE_DATE) {
-			return gmstrftime("%Y%m%dT%H%M%SZ", $ts);
-		}
-		if ($type == self::STREAMER_TYPE_DATE_DASHES) {
-			return gmstrftime("%Y-%m-%dT%H:%M:%S.000Z", $ts);
-		}
-		// fallback to dashes (should never be reached)
-		return gmstrftime("%Y-%m-%dT%H:%M:%S.000Z", $ts);
-	}
-
-	/**
-	 * Transforms an AS timestamp into a unix timestamp.
-	 *
-	 * @param string $ts
-	 *
-	 * @return long
-	 */
-	public function parseDate($ts) {
-		if (preg_match("/(\\d{4})[^0-9]*(\\d{2})[^0-9]*(\\d{2})(T(\\d{2})[^0-9]*(\\d{2})[^0-9]*(\\d{2})(.\\d+)?Z){0,1}$/", $ts, $matches)) {
-			if ($matches[1] >= 2038) {
-				$matches[1] = 2038;
-				$matches[2] = 1;
-				$matches[3] = 18;
-				$matches[5] = $matches[6] = $matches[7] = 0;
-			}
-
-			if (!isset($matches[5])) {
-				$matches[5] = 0;
-			}
-			if (!isset($matches[6])) {
-				$matches[6] = 0;
-			}
-			if (!isset($matches[7])) {
-				$matches[7] = 0;
-			}
-
-			return gmmktime($matches[5], $matches[6], $matches[7], $matches[2], $matches[3], $matches[1]);
-		}
-
-		return 0;
-	}
+    /**
+     * Formats a timestamp
+     * Oh yeah, this is beautiful. Exchange outputs date fields differently in calendar items
+     * and emails. We could just always send one or the other, but unfortunately nokia's 'Mail for
+     *  exchange' depends on this quirk. So we have to send a different date type depending on where
+     * it's used. Sigh.
+     *
+     * @param int $ts
+     * @param int $type
+     *
+     * @return string
+     */
+    private function formatDate($ts, $type) {
+        if ($type == self::STREAMER_TYPE_DATE) {
+            return gmstrftime("%Y%m%dT%H%M%SZ", $ts);
+        }
+        if ($type == self::STREAMER_TYPE_DATE_DASHES) {
+            return gmstrftime("%Y-%m-%dT%H:%M:%S.000Z", $ts);
+        }
+        // fallback to dashes (should never be reached)
+        return gmstrftime("%Y-%m-%dT%H:%M:%S.000Z", $ts);
+    }
+
+    /**
+     * Transforms an AS timestamp into a unix timestamp.
+     *
+     * @param string $ts
+     *
+     * @return long
+     */
+    public function parseDate($ts) {
+        if (preg_match("/(\\d{4})[^0-9]*(\\d{2})[^0-9]*(\\d{2})(T(\\d{2})[^0-9]*(\\d{2})[^0-9]*(\\d{2})(.\\d+)?Z){0,1}$/", $ts, $matches)) {
+            if ($matches[1] >= 2038) {
+                $matches[1] = 2038;
+                $matches[2] = 1;
+                $matches[3] = 18;
+                $matches[5] = $matches[6] = $matches[7] = 0;
+            }
+
+            if (!isset($matches[5])) {
+                $matches[5] = 0;
+            }
+            if (!isset($matches[6])) {
+                $matches[6] = 0;
+            }
+            if (!isset($matches[7])) {
+                $matches[7] = 0;
+            }
+
+            return gmmktime($matches[5], $matches[6], $matches[7], $matches[2], $matches[3], $matches[1]);
+        }
+
+        return 0;
+    }
 }

Braces +26 added lines, -52 removed lines

@@ -70,14 +70,11 @@ 
 					$map = $this->mapping[$entity[EN_TAG]];
 					if (isset($map[self::STREAMER_ARRAY])) {
 						$this->{$map[self::STREAMER_VAR]} = [];
-					}
-					elseif (isset($map[self::STREAMER_PROP]) && $map[self::STREAMER_PROP] == self::STREAMER_TYPE_SEND_EMPTY) {
+					} elseif (isset($map[self::STREAMER_PROP]) && $map[self::STREAMER_PROP] == self::STREAMER_TYPE_SEND_EMPTY) {
 						$this->{$map[self::STREAMER_VAR]} = "1";
-					}
-					elseif (!isset($map[self::STREAMER_TYPE])) {
+					} elseif (!isset($map[self::STREAMER_TYPE])) {
 						$this->{$map[self::STREAMER_VAR]} = "";
-					}
-					elseif ($map[self::STREAMER_TYPE] == self::STREAMER_TYPE_DATE || $map[self::STREAMER_TYPE] == self::STREAMER_TYPE_DATE_DASHES) {
+					} elseif ($map[self::STREAMER_TYPE] == self::STREAMER_TYPE_DATE || $map[self::STREAMER_TYPE] == self::STREAMER_TYPE_DATE_DASHES) {
 						$this->{$map[self::STREAMER_VAR]} = "";
 					}
 
@@ -107,15 +104,13 @@ 
 							$decoded = new $map[self::STREAMER_TYPE]();
 
 							$decoded->Decode($decoder);
-						}
-						else {
+						} else {
 							$decoded = $decoder->getElementContent();
 						}
 
 						if (!isset($this->{$map[self::STREAMER_VAR]})) {
 							$this->{$map[self::STREAMER_VAR]} = [$decoded];
-						}
-						else {
+						} else {
 							array_push($this->{$map[self::STREAMER_VAR]}, $decoded);
 						}
 
@@ -144,8 +139,7 @@ 
 							return false;
 						}
 					}
-				}
-				else { // Handle single value
+				} else { // Handle single value
 					if (isset($map[self::STREAMER_TYPE])) {
 						// Complex type, decode recursively
 						if ($map[self::STREAMER_TYPE] == self::STREAMER_TYPE_DATE || $map[self::STREAMER_TYPE] == self::STREAMER_TYPE_DATE_DASHES) {
@@ -153,8 +147,7 @@ 
 							if (!$decoder->getElementEndTag()) {
 								return false;
 							}
-						}
-						elseif ($map[self::STREAMER_TYPE] == self::STREAMER_TYPE_HEX) {
+						} elseif ($map[self::STREAMER_TYPE] == self::STREAMER_TYPE_HEX) {
 							$decoded = hex2bin($decoder->getElementContent());
 							if (!$decoder->getElementEndTag()) {
 								return false;
@@ -167,14 +160,12 @@ 
 							if (!$decoder->getElementEndTag()) {
 								return false;
 							}
-						}
-						elseif ($map[self::STREAMER_TYPE] == self::STREAMER_TYPE_STREAM_ASPLAIN) {
+						} elseif ($map[self::STREAMER_TYPE] == self::STREAMER_TYPE_STREAM_ASPLAIN) {
 							$decoded = StringStreamWrapper::Open($decoder->getElementContent());
 							if (!$decoder->getElementEndTag()) {
 								return false;
 							}
-						}
-						else {
+						} else {
 							$subdecoder = new $map[self::STREAMER_TYPE]();
 							if ($subdecoder->Decode($decoder) === false) {
 								return false;
@@ -188,8 +179,7 @@ 
 								return false;
 							}
 						}
-					}
-					else {
+					} else {
 						// Simple type, just get content
 						$decoded = $decoder->getElementContent();
 
@@ -208,13 +198,11 @@ 
 					// $decoded now contains data object (or string)
 					$this->{$map[self::STREAMER_VAR]} = $decoded;
 				}
-			}
-			elseif ($entity[EN_TYPE] == EN_TYPE_ENDTAG) {
+			} elseif ($entity[EN_TYPE] == EN_TYPE_ENDTAG) {
 				$decoder->ungetElement($entity);
 
 				break;
-			}
-			else {
+			} else {
 				SLog::Write(LOGLEVEL_WBXMLSTACK, "Unexpected content in type");
 
 				break;
@@ -243,8 +231,7 @@ 
 						if (!$res && isset($map[self::STREAMER_PROP]) && $map[self::STREAMER_PROP] == self::STREAMER_TYPE_SEND_EMPTY) {
 							$encoder->startTag($tag, false, true);
 						}
-					}
-					else {
+					} else {
 						SLog::Write(LOGLEVEL_ERROR, sprintf("Streamer->Encode(): parameter '%s' of object %s is not of type Streamer", $map[self::STREAMER_VAR], get_class($this)));
 					}
 				}
@@ -252,8 +239,7 @@ 
 				elseif (isset($map[self::STREAMER_ARRAY])) {
 					if (empty($this->{$map[self::STREAMER_VAR]}) && isset($map[self::STREAMER_PROP]) && $map[self::STREAMER_PROP] == self::STREAMER_TYPE_SEND_EMPTY) {
 						$encoder->startTag($tag, false, true);
-					}
-					else {
+					} else {
 						// Outputs array container (eg Attachments)
 						// Do not output start and end tag when type is STREAMER_TYPE_NO_CONTAINER
 						if (!isset($map[self::STREAMER_PROP]) || $map[self::STREAMER_PROP] != self::STREAMER_TYPE_NO_CONTAINER) {
@@ -265,8 +251,7 @@ 
 								$encoder->startTag($map[self::STREAMER_ARRAY]); // Outputs object container (eg Attachment)
 								$element->Encode($encoder);
 								$encoder->endTag();
-							}
-							else {
+							} else {
 								if (strlen($element) == 0)
 									  // Do not output empty items. Not sure if we should output an empty tag with $encoder->startTag($map[self::STREAMER_ARRAY], false, true);
 									  ; else {
@@ -282,8 +267,7 @@ 
 							$encoder->endTag();
 						}
 					}
-				}
-				else {
+				} else {
 					if (isset($map[self::STREAMER_TYPE]) && $map[self::STREAMER_TYPE] == self::STREAMER_TYPE_IGNORE) {
 						continue;
 					}
@@ -313,14 +297,11 @@ 
 						if ($this->{$map[self::STREAMER_VAR]} != 0) { // don't output 1-1-1970
 							$encoder->content($this->formatDate($this->{$map[self::STREAMER_VAR]}, $map[self::STREAMER_TYPE]));
 						}
-					}
-					elseif (isset($map[self::STREAMER_TYPE]) && $map[self::STREAMER_TYPE] == self::STREAMER_TYPE_HEX) {
+					} elseif (isset($map[self::STREAMER_TYPE]) && $map[self::STREAMER_TYPE] == self::STREAMER_TYPE_HEX) {
 						$encoder->content(strtoupper(bin2hex($this->{$map[self::STREAMER_VAR]})));
-					}
-					elseif (isset($map[self::STREAMER_TYPE]) && $map[self::STREAMER_TYPE] == self::STREAMER_TYPE_STREAM_ASPLAIN) {
+					} elseif (isset($map[self::STREAMER_TYPE]) && $map[self::STREAMER_TYPE] == self::STREAMER_TYPE_STREAM_ASPLAIN) {
 						$encoder->contentStream($this->{$map[self::STREAMER_VAR]}, false);
-					}
-					elseif (isset($map[self::STREAMER_TYPE]) && ($map[self::STREAMER_TYPE] == self::STREAMER_TYPE_STREAM_ASBASE64 || $map[self::STREAMER_TYPE] == self::STREAMER_TYPE_STREAM)) {
+					} elseif (isset($map[self::STREAMER_TYPE]) && ($map[self::STREAMER_TYPE] == self::STREAMER_TYPE_STREAM_ASBASE64 || $map[self::STREAMER_TYPE] == self::STREAMER_TYPE_STREAM)) {
 						$encoder->contentStream($this->{$map[self::STREAMER_VAR]}, true);
 					}
 					// implode comma or semicolon arrays into a string
@@ -328,8 +309,7 @@ 
 						($map[self::STREAMER_TYPE] == self::STREAMER_TYPE_COMMA_SEPARATED || $map[self::STREAMER_TYPE] == self::STREAMER_TYPE_SEMICOLON_SEPARATED)) {
 						$glue = ($map[self::STREAMER_TYPE] == self::STREAMER_TYPE_COMMA_SEPARATED) ? ", " : "; ";
 						$encoder->content(implode($glue, $this->{$map[self::STREAMER_VAR]}));
-					}
-					else {
+					} else {
 						$encoder->content($this->{$map[self::STREAMER_VAR]});
 					}
 					$encoder->endTag();
@@ -357,27 +337,22 @@ 
 			if (isset($this->{$v[self::STREAMER_VAR]})) {
 				if (is_object($this->{$v[self::STREAMER_VAR]}) && method_exists($this->{$v[self::STREAMER_VAR]}, "StripData")) {
 					$this->{$v[self::STREAMER_VAR]}->StripData($flags);
-				}
-				elseif (isset($v[self::STREAMER_ARRAY]) && !empty($this->{$v[self::STREAMER_VAR]})) {
+				} elseif (isset($v[self::STREAMER_ARRAY]) && !empty($this->{$v[self::STREAMER_VAR]})) {
 					foreach ($this->{$v[self::STREAMER_VAR]} as $element) {
 						if (is_object($element) && method_exists($element, "StripData")) {
 							$element->StripData($flags);
-						}
-						elseif ($flags === Streamer::STRIP_PRIVATE_DATA && isset($v[self::STREAMER_PRIVATE])) {
+						} elseif ($flags === Streamer::STRIP_PRIVATE_DATA && isset($v[self::STREAMER_PRIVATE])) {
 							if ($v[self::STREAMER_PRIVATE] !== true) {
 								$this->{$v[self::STREAMER_VAR]} = $v[self::STREAMER_PRIVATE];
-							}
-							else {
+							} else {
 								unset($this->{$v[self::STREAMER_VAR]});
 							}
 						}
 					}
-				}
-				elseif ($flags === Streamer::STRIP_PRIVATE_DATA && isset($v[self::STREAMER_PRIVATE])) {
+				} elseif ($flags === Streamer::STRIP_PRIVATE_DATA && isset($v[self::STREAMER_PRIVATE])) {
 					if ($v[self::STREAMER_PRIVATE] !== true) {
 						$this->{$v[self::STREAMER_VAR]} = $v[self::STREAMER_PRIVATE];
-					}
-					else {
+					} else {
 						unset($this->{$v[self::STREAMER_VAR]});
 					}
 				}
@@ -436,8 +411,7 @@ 
 				SLog::Write(LOGLEVEL_DEBUG, sprintf("Streamer->jsonDeserialize(): top class '%s'", $v->gsSyncStateClass));
 				$this->{$k} = new $v->gsSyncStateClass();
 				$this->{$k}->jsonDeserialize($v);
-			}
-			else {
+			} else {
 				$this->{$k} = $v;
 			}
 		}

lib/core/slog.php

Indentation +192 added lines, -192 removed lines

@@ -8,142 +8,142 @@ 
  */
 
 class SLog {
-	private static $wbxmlDebug = '';
-	private static $lastLogs = [];
-
-	/**
-	 * @var Log
-	 */
-	private static $logger;
-
-	/**
-	 * Initializes the logging.
-	 *
-	 * @return bool
-	 */
-	public static function Initialize() {
-		// define some constants for the logging
-		if (!defined('LOGUSERLEVEL')) {
-			define('LOGUSERLEVEL', LOGLEVEL_OFF);
-		}
-
-		if (!defined('LOGLEVEL')) {
-			define('LOGLEVEL', LOGLEVEL_OFF);
-		}
-
-		$logger = self::getLogger();
-
-		return true;
-	}
-
-	/**
-	 * Check if WBXML logging is enabled in current LOG(USER)LEVEL.
-	 *
-	 * @return bool
-	 */
-	public static function IsWbxmlDebugEnabled() {
-		return LOGLEVEL >= LOGLEVEL_WBXML || (LOGUSERLEVEL >= LOGLEVEL_WBXML && self::getLogger()->HasSpecialLogUsers());
-	}
-
-	/**
-	 * Writes a log line.
-	 *
-	 * @param int    $loglevel one of the defined LOGLEVELS
-	 * @param string $message
-	 * @param bool   $truncate indicate if the message should be truncated, default true
-	 */
-	public static function Write($loglevel, $message, $truncate = true) {
-		// truncate messages longer than 10 KB
-		$messagesize = strlen($message);
-		if ($truncate && $messagesize > 10240) {
-			$message = substr($message, 0, 10240) . sprintf(" <log message with %d bytes truncated>", $messagesize);
-		}
-
-		self::$lastLogs[$loglevel] = $message;
-
-		try {
-			self::getLogger()->Log($loglevel, $message);
-		}
-		catch (\Exception $e) {
-			// @TODO How should we handle logging error ?
-			// Ignore any error.
-		}
-
-		if ($loglevel & LOGLEVEL_WBXMLSTACK) {
-			self::$wbxmlDebug .= $message . PHP_EOL;
-		}
-	}
-
-	/**
-	 * Returns logged information about the WBXML stack.
-	 *
-	 * @return string
-	 */
-	public static function GetWBXMLDebugInfo() {
-		return trim(self::$wbxmlDebug);
-	}
-
-	/**
-	 * Returns the last message logged for a log level.
-	 *
-	 * @param int $loglevel one of the defined LOGLEVELS
-	 *
-	 * @return string/false     returns false if there was no message logged in that level
-	 */
-	public static function GetLastMessage($loglevel) {
-		return (isset(self::$lastLogs[$loglevel])) ? self::$lastLogs[$loglevel] : false;
-	}
-
-	/**
-	 * If called, the authenticated current user gets an extra log-file.
-	 *
-	 * If called until the user is authenticated (e.g. at the end of IBackend->Logon()) all log
-	 * messages that happened until this point will also be logged.
-	 */
-	public static function SpecialLogUser() {
-		self::getLogger()->SpecialLogUser();
-	}
-
-	/**
-	 * Returns the logger object. If no logger has been initialized, FileLog will be initialized and returned.
-	 *
-	 * @throws Exception thrown if the logger class cannot be instantiated
-	 *
-	 * @return Log
-	 */
-	private static function getLogger() {
-		if (!self::$logger) {
-			global $specialLogUsers; // This variable comes from the configuration file (config.php)
-
-			$logger = LOGBACKEND_CLASS;
-			if (!class_exists($logger)) {
-				$errmsg = 'The configured logging class `' . $logger . '` does not exist. Check your configuration.';
-				error_log($errmsg);
-
-				throw new \Exception($errmsg);
-			}
-
-			// if there is an impersonated user it's used instead of the GET user
-			if (Request::GetImpersonatedUser()) {
-				$user = Request::GetImpersonatedUser();
-			}
-			else {
-				list($user) = Utils::SplitDomainUser(strtolower(Request::GetGETUser()));
-			}
-
-			self::$logger = new $logger();
-			self::$logger->SetUser($user);
-			self::$logger->SetAuthUser(Request::GetAuthUser());
-			self::$logger->SetSpecialLogUsers($specialLogUsers);
-			self::$logger->SetDevid(Request::GetDeviceID());
-			self::$logger->SetPid(@getmypid());
-			self::$logger->AfterInitialize();
-		}
-
-		return self::$logger;
-	}
-
-	/*----------------------------------------------------------------------------------------------------------
+    private static $wbxmlDebug = '';
+    private static $lastLogs = [];
+
+    /**
+     * @var Log
+     */
+    private static $logger;
+
+    /**
+     * Initializes the logging.
+     *
+     * @return bool
+     */
+    public static function Initialize() {
+        // define some constants for the logging
+        if (!defined('LOGUSERLEVEL')) {
+            define('LOGUSERLEVEL', LOGLEVEL_OFF);
+        }
+
+        if (!defined('LOGLEVEL')) {
+            define('LOGLEVEL', LOGLEVEL_OFF);
+        }
+
+        $logger = self::getLogger();
+
+        return true;
+    }
+
+    /**
+     * Check if WBXML logging is enabled in current LOG(USER)LEVEL.
+     *
+     * @return bool
+     */
+    public static function IsWbxmlDebugEnabled() {
+        return LOGLEVEL >= LOGLEVEL_WBXML || (LOGUSERLEVEL >= LOGLEVEL_WBXML && self::getLogger()->HasSpecialLogUsers());
+    }
+
+    /**
+     * Writes a log line.
+     *
+     * @param int    $loglevel one of the defined LOGLEVELS
+     * @param string $message
+     * @param bool   $truncate indicate if the message should be truncated, default true
+     */
+    public static function Write($loglevel, $message, $truncate = true) {
+        // truncate messages longer than 10 KB
+        $messagesize = strlen($message);
+        if ($truncate && $messagesize > 10240) {
+            $message = substr($message, 0, 10240) . sprintf(" <log message with %d bytes truncated>", $messagesize);
+        }
+
+        self::$lastLogs[$loglevel] = $message;
+
+        try {
+            self::getLogger()->Log($loglevel, $message);
+        }
+        catch (\Exception $e) {
+            // @TODO How should we handle logging error ?
+            // Ignore any error.
+        }
+
+        if ($loglevel & LOGLEVEL_WBXMLSTACK) {
+            self::$wbxmlDebug .= $message . PHP_EOL;
+        }
+    }
+
+    /**
+     * Returns logged information about the WBXML stack.
+     *
+     * @return string
+     */
+    public static function GetWBXMLDebugInfo() {
+        return trim(self::$wbxmlDebug);
+    }
+
+    /**
+     * Returns the last message logged for a log level.
+     *
+     * @param int $loglevel one of the defined LOGLEVELS
+     *
+     * @return string/false     returns false if there was no message logged in that level
+     */
+    public static function GetLastMessage($loglevel) {
+        return (isset(self::$lastLogs[$loglevel])) ? self::$lastLogs[$loglevel] : false;
+    }
+
+    /**
+     * If called, the authenticated current user gets an extra log-file.
+     *
+     * If called until the user is authenticated (e.g. at the end of IBackend->Logon()) all log
+     * messages that happened until this point will also be logged.
+     */
+    public static function SpecialLogUser() {
+        self::getLogger()->SpecialLogUser();
+    }
+
+    /**
+     * Returns the logger object. If no logger has been initialized, FileLog will be initialized and returned.
+     *
+     * @throws Exception thrown if the logger class cannot be instantiated
+     *
+     * @return Log
+     */
+    private static function getLogger() {
+        if (!self::$logger) {
+            global $specialLogUsers; // This variable comes from the configuration file (config.php)
+
+            $logger = LOGBACKEND_CLASS;
+            if (!class_exists($logger)) {
+                $errmsg = 'The configured logging class `' . $logger . '` does not exist. Check your configuration.';
+                error_log($errmsg);
+
+                throw new \Exception($errmsg);
+            }
+
+            // if there is an impersonated user it's used instead of the GET user
+            if (Request::GetImpersonatedUser()) {
+                $user = Request::GetImpersonatedUser();
+            }
+            else {
+                list($user) = Utils::SplitDomainUser(strtolower(Request::GetGETUser()));
+            }
+
+            self::$logger = new $logger();
+            self::$logger->SetUser($user);
+            self::$logger->SetAuthUser(Request::GetAuthUser());
+            self::$logger->SetSpecialLogUsers($specialLogUsers);
+            self::$logger->SetDevid(Request::GetDeviceID());
+            self::$logger->SetPid(@getmypid());
+            self::$logger->AfterInitialize();
+        }
+
+        return self::$logger;
+    }
+
+    /*----------------------------------------------------------------------------------------------------------
 	 * private log stuff
 	 */
 }
@@ -154,67 +154,67 @@ 
 
 // TODO review error handler
 function gsync_error_handler($errno, $errstr, $errfile, $errline) {
-	if (defined('LOG_ERROR_MASK')) {
-		$errno &= LOG_ERROR_MASK;
-	}
-
-	switch ($errno) {
-		case 0:
-			// logging disabled by LOG_ERROR_MASK
-			break;
-
-		case E_DEPRECATED:
-			// do not handle this message
-			break;
-
-		case E_NOTICE:
-		case E_WARNING:
-			// TODO check if there is a better way to avoid these messages
-			if (stripos($errfile, 'interprocessdata') !== false && stripos($errstr, 'shm_get_var()') !== false) {
-				break;
-			}
-			SLog::Write(LOGLEVEL_WARN, "{$errfile}:{$errline} {$errstr} ({$errno})");
-			break;
-
-		default:
-			$bt = debug_backtrace();
-			SLog::Write(LOGLEVEL_ERROR, "trace error: {$errfile}:{$errline} {$errstr} ({$errno}) - backtrace: " . (count($bt) - 1) . " steps");
-			for ($i = 1, $bt_length = count($bt); $i < $bt_length; ++$i) {
-				$file = $line = "unknown";
-				if (isset($bt[$i]['file'])) {
-					$file = $bt[$i]['file'];
-				}
-				if (isset($bt[$i]['line'])) {
-					$line = $bt[$i]['line'];
-				}
-				SLog::Write(LOGLEVEL_ERROR, "trace: {$i}:" . $file . ":" . $line . " - " . ((isset($bt[$i]['class'])) ? $bt[$i]['class'] . $bt[$i]['type'] : "") . $bt[$i]['function'] . "()");
-			}
-			// throw new Exception("An error occurred.");
-			break;
-	}
+    if (defined('LOG_ERROR_MASK')) {
+        $errno &= LOG_ERROR_MASK;
+    }
+
+    switch ($errno) {
+        case 0:
+            // logging disabled by LOG_ERROR_MASK
+            break;
+
+        case E_DEPRECATED:
+            // do not handle this message
+            break;
+
+        case E_NOTICE:
+        case E_WARNING:
+            // TODO check if there is a better way to avoid these messages
+            if (stripos($errfile, 'interprocessdata') !== false && stripos($errstr, 'shm_get_var()') !== false) {
+                break;
+            }
+            SLog::Write(LOGLEVEL_WARN, "{$errfile}:{$errline} {$errstr} ({$errno})");
+            break;
+
+        default:
+            $bt = debug_backtrace();
+            SLog::Write(LOGLEVEL_ERROR, "trace error: {$errfile}:{$errline} {$errstr} ({$errno}) - backtrace: " . (count($bt) - 1) . " steps");
+            for ($i = 1, $bt_length = count($bt); $i < $bt_length; ++$i) {
+                $file = $line = "unknown";
+                if (isset($bt[$i]['file'])) {
+                    $file = $bt[$i]['file'];
+                }
+                if (isset($bt[$i]['line'])) {
+                    $line = $bt[$i]['line'];
+                }
+                SLog::Write(LOGLEVEL_ERROR, "trace: {$i}:" . $file . ":" . $line . " - " . ((isset($bt[$i]['class'])) ? $bt[$i]['class'] . $bt[$i]['type'] : "") . $bt[$i]['function'] . "()");
+            }
+            // throw new Exception("An error occurred.");
+            break;
+    }
 }
 
 error_reporting(E_ALL);
 set_error_handler("gsync_error_handler");
 
 function gsync_fatal_handler() {
-	$errfile = "unknown file";
-	$errstr = "shutdown";
-	$errno = E_CORE_ERROR;
-	$errline = 0;
-
-	$error = error_get_last();
-
-	if ($error !== null) {
-		$errno = $error["type"];
-		$errfile = $error["file"];
-		$errline = $error["line"];
-		$errstr = $error["message"];
-
-		// do NOT log PHP Notice, Warning, Deprecated or Strict as FATAL
-		if ($errno & ~(E_NOTICE | E_WARNING | E_DEPRECATED | E_STRICT)) {
-			SLog::Write(LOGLEVEL_FATAL, sprintf("Fatal error: %s:%d - %s (%s)", $errfile, $errline, $errstr, $errno));
-		}
-	}
+    $errfile = "unknown file";
+    $errstr = "shutdown";
+    $errno = E_CORE_ERROR;
+    $errline = 0;
+
+    $error = error_get_last();
+
+    if ($error !== null) {
+        $errno = $error["type"];
+        $errfile = $error["file"];
+        $errline = $error["line"];
+        $errstr = $error["message"];
+
+        // do NOT log PHP Notice, Warning, Deprecated or Strict as FATAL
+        if ($errno & ~(E_NOTICE | E_WARNING | E_DEPRECATED | E_STRICT)) {
+            SLog::Write(LOGLEVEL_FATAL, sprintf("Fatal error: %s:%d - %s (%s)", $errfile, $errline, $errstr, $errno));
+        }
+    }
 }
 register_shutdown_function("gsync_fatal_handler");

Spacing +6 added lines, -6 removed lines

@@ -56,7 +56,7 @@ 
 		// truncate messages longer than 10 KB
 		$messagesize = strlen($message);
 		if ($truncate && $messagesize > 10240) {
-			$message = substr($message, 0, 10240) . sprintf(" <log message with %d bytes truncated>", $messagesize);
+			$message = substr($message, 0, 10240).sprintf(" <log message with %d bytes truncated>", $messagesize);
 		}
 
 		self::$lastLogs[$loglevel] = $message;
@@ -70,7 +70,7 @@ 
 		}
 
 		if ($loglevel & LOGLEVEL_WBXMLSTACK) {
-			self::$wbxmlDebug .= $message . PHP_EOL;
+			self::$wbxmlDebug .= $message.PHP_EOL;
 		}
 	}
 
@@ -117,7 +117,7 @@ 
 
 			$logger = LOGBACKEND_CLASS;
 			if (!class_exists($logger)) {
-				$errmsg = 'The configured logging class `' . $logger . '` does not exist. Check your configuration.';
+				$errmsg = 'The configured logging class `'.$logger.'` does not exist. Check your configuration.';
 				error_log($errmsg);
 
 				throw new \Exception($errmsg);
@@ -178,7 +178,7 @@ 
 
 		default:
 			$bt = debug_backtrace();
-			SLog::Write(LOGLEVEL_ERROR, "trace error: {$errfile}:{$errline} {$errstr} ({$errno}) - backtrace: " . (count($bt) - 1) . " steps");
+			SLog::Write(LOGLEVEL_ERROR, "trace error: {$errfile}:{$errline} {$errstr} ({$errno}) - backtrace: ".(count($bt) - 1)." steps");
 			for ($i = 1, $bt_length = count($bt); $i < $bt_length; ++$i) {
 				$file = $line = "unknown";
 				if (isset($bt[$i]['file'])) {
@@ -187,7 +187,7 @@ 
 				if (isset($bt[$i]['line'])) {
 					$line = $bt[$i]['line'];
 				}
-				SLog::Write(LOGLEVEL_ERROR, "trace: {$i}:" . $file . ":" . $line . " - " . ((isset($bt[$i]['class'])) ? $bt[$i]['class'] . $bt[$i]['type'] : "") . $bt[$i]['function'] . "()");
+				SLog::Write(LOGLEVEL_ERROR, "trace: {$i}:".$file.":".$line." - ".((isset($bt[$i]['class'])) ? $bt[$i]['class'].$bt[$i]['type'] : "").$bt[$i]['function']."()");
 			}
 			// throw new Exception("An error occurred.");
 			break;
@@ -212,7 +212,7 @@ 
 		$errstr = $error["message"];
 
 		// do NOT log PHP Notice, Warning, Deprecated or Strict as FATAL
-		if ($errno & ~(E_NOTICE | E_WARNING | E_DEPRECATED | E_STRICT)) {
+		if ($errno & ~(E_NOTICE|E_WARNING|E_DEPRECATED|E_STRICT)) {
 			SLog::Write(LOGLEVEL_FATAL, sprintf("Fatal error: %s:%d - %s (%s)", $errfile, $errline, $errstr, $errno));
 		}
 	}

Braces +2 added lines, -4 removed lines

@@ -63,8 +63,7 @@ 
 
 		try {
 			self::getLogger()->Log($loglevel, $message);
-		}
-		catch (\Exception $e) {
+		} catch (\Exception $e) {
 			// @TODO How should we handle logging error ?
 			// Ignore any error.
 		}
@@ -126,8 +125,7 @@ 
 			// if there is an impersonated user it's used instead of the GET user
 			if (Request::GetImpersonatedUser()) {
 				$user = Request::GetImpersonatedUser();
-			}
-			else {
+			} else {
 				list($user) = Utils::SplitDomainUser(strtolower(Request::GetGETUser()));
 			}
 

lib/wbxml/wbxmldecoder.php

Indentation +484 added lines, -484 removed lines

@@ -8,491 +8,491 @@
  */
 
 class WBXMLDecoder extends WBXMLDefs {
-	private $in;
-	private $inLog;
-	private $tagcp = 0;
-	private $ungetbuffer;
-	private $log = false;
-	private $logStack = [];
-	private $inputBuffer = "";
-	private $isWBXML = true;
-	private static $loopCounter = [];
-	public const MAXLOOP = 5000;
-	public const VERSION = 0x03;
-
-	/**
-	 * Counts the amount of times a code part has been executed.
-	 * When being executed too often, the code throws a WBMXLException.
-	 *
-	 * @param string $name
-	 *
-	 * @throws WBXMLException
-	 *
-	 * @return bool
-	 */
-	public static function InWhile($name) {
-		if (!isset(self::$loopCounter[$name])) {
-			self::$loopCounter[$name] = 0;
-		}
-		else {
-			++self::$loopCounter[$name];
-		}
-
-		if (self::$loopCounter[$name] > self::MAXLOOP) {
-			throw new WBXMLException(sprintf("Loop count in while too high, code '%s' exceeded max. amount of permitted loops", $name));
-		}
-
-		return true;
-	}
-
-	/**
-	 * Resets the inWhile counter.
-	 *
-	 * @param string $name
-	 *
-	 * @return bool
-	 */
-	public static function ResetInWhile($name) {
-		if (isset(self::$loopCounter[$name])) {
-			unset(self::$loopCounter[$name]);
-		}
-
-		return true;
-	}
-
-	/**
-	 * WBXML Decode Constructor
-	 * We only handle ActiveSync WBXML, which is a subset of WBXML.
-	 *
-	 * @param stream $input the incoming data stream
-	 */
-	public function __construct($input) {
-		$this->log = SLog::IsWbxmlDebugEnabled();
-
-		$this->in = $input;
-
-		$version = $this->getByte();
-		if ($version != self::VERSION) {
-			$this->inputBuffer .= chr($version);
-			$this->isWBXML = false;
-
-			return;
-		}
-
-		$publicid = $this->getMBUInt();
-		if ($publicid !== 1) {
-			throw new WBXMLException("Wrong publicid : " . $publicid);
-		}
-
-		$charsetid = $this->getMBUInt();
-		if ($charsetid !== 106) {
-			throw new WBXMLException("Wrong charset : " . $charsetid);
-		}
-
-		$stringtablesize = $this->getMBUInt();
-		if ($stringtablesize !== 0) {
-			throw new WBXMLException("Wrong string table size : " . $stringtablesize);
-		}
-	}
-
-	/**
-	 * Returns either start, content or end, and auto-concatenates successive content.
-	 *
-	 * @return element/value
-	 */
-	public function getElement() {
-		$element = $this->getToken();
-
-		switch ($element[EN_TYPE]) {
-			case EN_TYPE_STARTTAG:
-				return $element;
-
-			case EN_TYPE_ENDTAG:
-				return $element;
-
-			case EN_TYPE_CONTENT:
-				WBXMLDecoder::ResetInWhile("decoderGetElement");
-				while (WBXMLDecoder::InWhile("decoderGetElement")) {
-					$next = $this->getToken();
-					if ($next == false) {
-						return false;
-					}
-					if ($next[EN_TYPE] == EN_CONTENT) {
-						$element[EN_CONTENT] .= $next[EN_CONTENT];
-					}
-					else {
-						$this->ungetElement($next);
-
-						break;
-					}
-				}
-
-				return $element;
-		}
-
-		return false;
-	}
-
-	/**
-	 * Get a peek at the next element.
-	 *
-	 * @return element
-	 */
-	public function peek() {
-		$element = $this->getElement();
-		$this->ungetElement($element);
-
-		return $element;
-	}
-
-	/**
-	 * Get the element of a StartTag.
-	 *
-	 * @param $tag
-	 *
-	 * @return element/boolean      returns false if not available
-	 */
-	public function getElementStartTag($tag) {
-		$element = $this->getToken();
-
-		if (!$element) {
-			return false;
-		}
-
-		if ($element[EN_TYPE] == EN_TYPE_STARTTAG && $element[EN_TAG] == $tag) {
-			return $element;
-		}
-
-		SLog::Write(LOGLEVEL_WBXMLSTACK, sprintf("WBXMLDecoder->getElementStartTag(): unmatched WBXML tag: '%s' matching '%s' type '%s' flags '%s'", $tag, ((isset($element[EN_TAG])) ? $element[EN_TAG] : ""), ((isset($element[EN_TYPE])) ? $element[EN_TYPE] : ""), ((isset($element[EN_FLAGS])) ? $element[EN_FLAGS] : "")));
-		$this->ungetElement($element);
-
-		return false;
-	}
-
-	/**
-	 * Get the element of a EndTag.
-	 *
-	 * @return element/boolean      returns false if not available
-	 */
-	public function getElementEndTag() {
-		$element = $this->getToken();
-
-		if ($element[EN_TYPE] == EN_TYPE_ENDTAG) {
-			return $element;
-		}
-
-		SLog::Write(LOGLEVEL_WBXMLSTACK, sprintf("WBXMLDecoder->getElementEndTag(): unmatched WBXML tag: '%s' type '%s' flags '%s'", ((isset($element[EN_TAG])) ? $element[EN_TAG] : ""), ((isset($element[EN_TYPE])) ? $element[EN_TYPE] : ""), ((isset($element[EN_FLAGS])) ? $element[EN_FLAGS] : "")));
-
-		$bt = debug_backtrace();
-		SLog::Write(LOGLEVEL_ERROR, sprintf("WBXMLDecoder->getElementEndTag(): could not read end tag in '%s'. Please enable the LOGLEVEL_WBXML and send the log to the grommunio-sync dev team.", $bt[0]["file"] . ":" . $bt[0]["line"]));
-
-		// log the remaining wbxml content
-		$this->ungetElement($element);
-		while ($el = $this->getElement());
-
-		return false;
-	}
-
-	/**
-	 * Get the content of an element.
-	 *
-	 * @return string/boolean       returns false if not available
-	 */
-	public function getElementContent() {
-		$element = $this->getToken();
-
-		if ($element[EN_TYPE] == EN_TYPE_CONTENT) {
-			return $element[EN_CONTENT];
-		}
-
-		SLog::Write(LOGLEVEL_WBXMLSTACK, sprintf("WBXMLDecoder->getElementContent(): unmatched WBXML content: '%s' type '%s' flags '%s'", ((isset($element[EN_TAG])) ? $element[EN_TAG] : ""), ((isset($element[EN_TYPE])) ? $element[EN_TYPE] : ""), ((isset($element[EN_FLAGS])) ? $element[EN_FLAGS] : "")));
-		$this->ungetElement($element);
-
-		return false;
-	}
-
-	/**
-	 * 'Ungets' an element writing it into a buffer to be 'get' again.
-	 *
-	 * @param element $element the element to get ungetten
-	 *
-	 * @return
-	 */
-	public function ungetElement($element) {
-		if ($this->ungetbuffer) {
-			SLog::Write(LOGLEVEL_ERROR, sprintf("WBXMLDecoder->ungetElement(): WBXML double unget on tag: '%s' type '%s' flags '%s'", ((isset($element[EN_TAG])) ? $element[EN_TAG] : ""), ((isset($element[EN_TYPE])) ? $element[EN_TYPE] : ""), ((isset($element[EN_FLAGS])) ? $element[EN_FLAGS] : "")));
-		}
-
-		$this->ungetbuffer = $element;
-	}
-
-	/**
-	 * Returns the plain input stream.
-	 *
-	 * @return string
-	 */
-	public function GetPlainInputStream() {
-		return $this->inputBuffer . stream_get_contents($this->in);
-	}
-
-	/**
-	 * Returns if the input is WBXML.
-	 *
-	 * @return bool
-	 */
-	public function IsWBXML() {
-		return $this->isWBXML;
-	}
-
-	/**
-	 * Reads the remaining data from the input stream.
-	 */
-	public function readRemainingData() {
-		SLog::Write(LOGLEVEL_DEBUG, "WBXMLDecoder->readRemainingData() reading remaining data from input stream");
-		while ($this->getElement());
-	}
-
-	/*----------------------------------------------------------------------------------------------------------
+    private $in;
+    private $inLog;
+    private $tagcp = 0;
+    private $ungetbuffer;
+    private $log = false;
+    private $logStack = [];
+    private $inputBuffer = "";
+    private $isWBXML = true;
+    private static $loopCounter = [];
+    public const MAXLOOP = 5000;
+    public const VERSION = 0x03;
+
+    /**
+     * Counts the amount of times a code part has been executed.
+     * When being executed too often, the code throws a WBMXLException.
+     *
+     * @param string $name
+     *
+     * @throws WBXMLException
+     *
+     * @return bool
+     */
+    public static function InWhile($name) {
+        if (!isset(self::$loopCounter[$name])) {
+            self::$loopCounter[$name] = 0;
+        }
+        else {
+            ++self::$loopCounter[$name];
+        }
+
+        if (self::$loopCounter[$name] > self::MAXLOOP) {
+            throw new WBXMLException(sprintf("Loop count in while too high, code '%s' exceeded max. amount of permitted loops", $name));
+        }
+
+        return true;
+    }
+
+    /**
+     * Resets the inWhile counter.
+     *
+     * @param string $name
+     *
+     * @return bool
+     */
+    public static function ResetInWhile($name) {
+        if (isset(self::$loopCounter[$name])) {
+            unset(self::$loopCounter[$name]);
+        }
+
+        return true;
+    }
+
+    /**
+     * WBXML Decode Constructor
+     * We only handle ActiveSync WBXML, which is a subset of WBXML.
+     *
+     * @param stream $input the incoming data stream
+     */
+    public function __construct($input) {
+        $this->log = SLog::IsWbxmlDebugEnabled();
+
+        $this->in = $input;
+
+        $version = $this->getByte();
+        if ($version != self::VERSION) {
+            $this->inputBuffer .= chr($version);
+            $this->isWBXML = false;
+
+            return;
+        }
+
+        $publicid = $this->getMBUInt();
+        if ($publicid !== 1) {
+            throw new WBXMLException("Wrong publicid : " . $publicid);
+        }
+
+        $charsetid = $this->getMBUInt();
+        if ($charsetid !== 106) {
+            throw new WBXMLException("Wrong charset : " . $charsetid);
+        }
+
+        $stringtablesize = $this->getMBUInt();
+        if ($stringtablesize !== 0) {
+            throw new WBXMLException("Wrong string table size : " . $stringtablesize);
+        }
+    }
+
+    /**
+     * Returns either start, content or end, and auto-concatenates successive content.
+     *
+     * @return element/value
+     */
+    public function getElement() {
+        $element = $this->getToken();
+
+        switch ($element[EN_TYPE]) {
+            case EN_TYPE_STARTTAG:
+                return $element;
+
+            case EN_TYPE_ENDTAG:
+                return $element;
+
+            case EN_TYPE_CONTENT:
+                WBXMLDecoder::ResetInWhile("decoderGetElement");
+                while (WBXMLDecoder::InWhile("decoderGetElement")) {
+                    $next = $this->getToken();
+                    if ($next == false) {
+                        return false;
+                    }
+                    if ($next[EN_TYPE] == EN_CONTENT) {
+                        $element[EN_CONTENT] .= $next[EN_CONTENT];
+                    }
+                    else {
+                        $this->ungetElement($next);
+
+                        break;
+                    }
+                }
+
+                return $element;
+        }
+
+        return false;
+    }
+
+    /**
+     * Get a peek at the next element.
+     *
+     * @return element
+     */
+    public function peek() {
+        $element = $this->getElement();
+        $this->ungetElement($element);
+
+        return $element;
+    }
+
+    /**
+     * Get the element of a StartTag.
+     *
+     * @param $tag
+     *
+     * @return element/boolean      returns false if not available
+     */
+    public function getElementStartTag($tag) {
+        $element = $this->getToken();
+
+        if (!$element) {
+            return false;
+        }
+
+        if ($element[EN_TYPE] == EN_TYPE_STARTTAG && $element[EN_TAG] == $tag) {
+            return $element;
+        }
+
+        SLog::Write(LOGLEVEL_WBXMLSTACK, sprintf("WBXMLDecoder->getElementStartTag(): unmatched WBXML tag: '%s' matching '%s' type '%s' flags '%s'", $tag, ((isset($element[EN_TAG])) ? $element[EN_TAG] : ""), ((isset($element[EN_TYPE])) ? $element[EN_TYPE] : ""), ((isset($element[EN_FLAGS])) ? $element[EN_FLAGS] : "")));
+        $this->ungetElement($element);
+
+        return false;
+    }
+
+    /**
+     * Get the element of a EndTag.
+     *
+     * @return element/boolean      returns false if not available
+     */
+    public function getElementEndTag() {
+        $element = $this->getToken();
+
+        if ($element[EN_TYPE] == EN_TYPE_ENDTAG) {
+            return $element;
+        }
+
+        SLog::Write(LOGLEVEL_WBXMLSTACK, sprintf("WBXMLDecoder->getElementEndTag(): unmatched WBXML tag: '%s' type '%s' flags '%s'", ((isset($element[EN_TAG])) ? $element[EN_TAG] : ""), ((isset($element[EN_TYPE])) ? $element[EN_TYPE] : ""), ((isset($element[EN_FLAGS])) ? $element[EN_FLAGS] : "")));
+
+        $bt = debug_backtrace();
+        SLog::Write(LOGLEVEL_ERROR, sprintf("WBXMLDecoder->getElementEndTag(): could not read end tag in '%s'. Please enable the LOGLEVEL_WBXML and send the log to the grommunio-sync dev team.", $bt[0]["file"] . ":" . $bt[0]["line"]));
+
+        // log the remaining wbxml content
+        $this->ungetElement($element);
+        while ($el = $this->getElement());
+
+        return false;
+    }
+
+    /**
+     * Get the content of an element.
+     *
+     * @return string/boolean       returns false if not available
+     */
+    public function getElementContent() {
+        $element = $this->getToken();
+
+        if ($element[EN_TYPE] == EN_TYPE_CONTENT) {
+            return $element[EN_CONTENT];
+        }
+
+        SLog::Write(LOGLEVEL_WBXMLSTACK, sprintf("WBXMLDecoder->getElementContent(): unmatched WBXML content: '%s' type '%s' flags '%s'", ((isset($element[EN_TAG])) ? $element[EN_TAG] : ""), ((isset($element[EN_TYPE])) ? $element[EN_TYPE] : ""), ((isset($element[EN_FLAGS])) ? $element[EN_FLAGS] : "")));
+        $this->ungetElement($element);
+
+        return false;
+    }
+
+    /**
+     * 'Ungets' an element writing it into a buffer to be 'get' again.
+     *
+     * @param element $element the element to get ungetten
+     *
+     * @return
+     */
+    public function ungetElement($element) {
+        if ($this->ungetbuffer) {
+            SLog::Write(LOGLEVEL_ERROR, sprintf("WBXMLDecoder->ungetElement(): WBXML double unget on tag: '%s' type '%s' flags '%s'", ((isset($element[EN_TAG])) ? $element[EN_TAG] : ""), ((isset($element[EN_TYPE])) ? $element[EN_TYPE] : ""), ((isset($element[EN_FLAGS])) ? $element[EN_FLAGS] : "")));
+        }
+
+        $this->ungetbuffer = $element;
+    }
+
+    /**
+     * Returns the plain input stream.
+     *
+     * @return string
+     */
+    public function GetPlainInputStream() {
+        return $this->inputBuffer . stream_get_contents($this->in);
+    }
+
+    /**
+     * Returns if the input is WBXML.
+     *
+     * @return bool
+     */
+    public function IsWBXML() {
+        return $this->isWBXML;
+    }
+
+    /**
+     * Reads the remaining data from the input stream.
+     */
+    public function readRemainingData() {
+        SLog::Write(LOGLEVEL_DEBUG, "WBXMLDecoder->readRemainingData() reading remaining data from input stream");
+        while ($this->getElement());
+    }
+
+    /*----------------------------------------------------------------------------------------------------------
 	 * Private WBXMLDecoder stuff
 	 */
 
-	/**
-	 * Returns the next token.
-	 *
-	 * @return token
-	 */
-	private function getToken() {
-		// See if there's something in the ungetBuffer
-		if ($this->ungetbuffer) {
-			$element = $this->ungetbuffer;
-			$this->ungetbuffer = false;
-
-			return $element;
-		}
-
-		$el = $this->_getToken();
-		if ($this->log && $el) {
-			$this->logToken($el);
-		}
-
-		return $el;
-	}
-
-	/**
-	 * Log the a token to SLog.
-	 *
-	 * @param string $el token
-	 *
-	 * @return
-	 */
-	private function logToken($el) {
-		$spaces = str_repeat(" ", count($this->logStack));
-
-		switch ($el[EN_TYPE]) {
-			case EN_TYPE_STARTTAG:
-				if ($el[EN_FLAGS] & EN_FLAGS_CONTENT) {
-					SLog::Write(LOGLEVEL_WBXML, "I " . $spaces . " <" . $el[EN_TAG] . ">");
-					array_push($this->logStack, $el[EN_TAG]);
-				}
-				else {
-					SLog::Write(LOGLEVEL_WBXML, "I " . $spaces . " <" . $el[EN_TAG] . "/>");
-				}
-				break;
-
-			case EN_TYPE_ENDTAG:
-				$tag = array_pop($this->logStack);
-				SLog::Write(LOGLEVEL_WBXML, "I " . $spaces . "</" . $tag . ">");
-				break;
-
-			case EN_TYPE_CONTENT:
-				// as we concatenate the string here, the entire content is copied.
-				// when sending an email with an attachment this single log line (which is never logged in INFO)
-				// requires easily additional 20 MB of RAM. See https://jira.z-hub.io/browse/ZP-1159
-				$messagesize = strlen($el[EN_CONTENT]);
-				if ($messagesize > 10240 && !defined('WBXML_DEBUGGING')) {
-					$content = substr($el[EN_CONTENT], 0, 10240) . sprintf(" <log message with %d bytes truncated>", $messagesize);
-				}
-				else {
-					$content = $el[EN_CONTENT];
-				}
-				// Log but make sure it's not truncated again (will be slightly bigger than 10KB)
-				SLog::Write(LOGLEVEL_WBXML, "I " . $spaces . " " . $content, false);
-				break;
-		}
-	}
-
-	/**
-	 * Returns either a start tag, content or end tag.
-	 *
-	 * @return
-	 */
-	private function _getToken() {
-		// Get the data from the input stream
-		$element = [];
-
-		WBXMLDecoder::ResetInWhile("decoderGetToken");
-		while (WBXMLDecoder::InWhile("decoderGetToken")) {
-			$byte = fread($this->in, 1);
-			if ($byte === "" || $byte === false) {
-				break;
-			}
-			$byte = ord($byte);
-
-			switch ($byte) {
-				case self::WBXML_SWITCH_PAGE:
-					$this->tagcp = $this->getByte();
-					break;
-
-				case self::WBXML_END:
-					$element[EN_TYPE] = EN_TYPE_ENDTAG;
-
-					return $element;
-
-				case self::WBXML_STR_I:
-					$element[EN_TYPE] = EN_TYPE_CONTENT;
-					$element[EN_CONTENT] = $this->getTermStr();
-
-					return $element;
-
-				case self::WBXML_OPAQUE:
-					$length = $this->getMBUInt();
-					$element[EN_TYPE] = EN_TYPE_CONTENT;
-					$element[EN_CONTENT] = $this->getOpaque($length);
-
-					return $element;
-
-				case self::WBXML_ENTITY:
-				case self::WBXML_LITERAL:
-				case self::WBXML_EXT_I_0:
-				case self::WBXML_EXT_I_1:
-				case self::WBXML_EXT_I_2:
-				case self::WBXML_PI:
-				case self::WBXML_LITERAL_C:
-				case self::WBXML_EXT_T_0:
-				case self::WBXML_EXT_T_1:
-				case self::WBXML_EXT_T_2:
-				case self::WBXML_STR_T:
-				case self::WBXML_LITERAL_A:
-				case self::WBXML_EXT_0:
-				case self::WBXML_EXT_1:
-				case self::WBXML_EXT_2:
-				case self::WBXML_LITERAL_AC:
-					throw new WBXMLException("Invalid token :" . $byte);
-
-				default:
-					if ($byte & self::WBXML_WITH_ATTRIBUTES) {
-						throw new WBXMLException("Attributes are not allowed :" . $byte);
-					}
-					$element[EN_TYPE] = EN_TYPE_STARTTAG;
-					$element[EN_TAG] = $this->getMapping($this->tagcp, $byte & 0x3F);
-					$element[EN_FLAGS] = ($byte & self::WBXML_WITH_CONTENT ? EN_FLAGS_CONTENT : 0);
-
-					return $element;
-			}
-		}
-	}
-
-	/**
-	 * Reads from the stream until getting a string terminator.
-	 *
-	 * @return string
-	 */
-	private function getTermStr() {
-		if (defined('WBXML_DEBUGGING') && WBXML_DEBUGGING === true) {
-			$str = "";
-			while (1) {
-				$in = $this->getByte();
-				if ($in == 0) {
-					break;
-				}
-
-				$str .= chr($in);
-			}
-
-			return $str;
-		}
-
-		// there is no unlimited "length" for stream_get_line,
-		// so we use a huge value for "length" param (1Gb)
-		// (0 == PHP_SOCK_CHUNK_SIZE (8192))
-		// internally php read at most PHP_SOCK_CHUNK_SIZE at a time,
-		// so we can use a huge value for "length" without problem
-		return stream_get_line($this->in, 1073741824, "\0");
-	}
-
-	/**
-	 * Reads $len from the input stream.
-	 *
-	 * @param int $len
-	 *
-	 * @return string
-	 */
-	private function getOpaque($len) {
-		$d = stream_get_contents($this->in, $len);
-		if ($d === false) {
-			throw new HTTPReturnCodeException("WBXMLDecoder->getOpaque(): stream_get_contents === false", HTTP_CODE_500, null, LOGLEVEL_WARN);
-		}
-		$l = strlen($d);
-		if ($l !== $len) {
-			throw new HTTPReturnCodeException("WBXMLDecoder->getOpaque(): only {$l} byte read instead of {$len}", HTTP_CODE_500, null, LOGLEVEL_WARN);
-		}
-
-		return $d;
-	}
-
-	/**
-	 * Reads one byte from the input stream.
-	 *
-	 * @return int
-	 */
-	private function getByte() {
-		$ch = fread($this->in, 1);
-		if (strlen($ch) > 0) {
-			return ord($ch);
-		}
-	}
-
-	/**
-	 * Reads string length from the input stream.
-	 *
-	 * @return
-	 */
-	private function getMBUInt() {
-		$uint = 0;
-
-		while (1) {
-			$byte = $this->getByte();
-
-			$uint |= $byte & 0x7F;
-
-			if ($byte & 0x80) {
-				$uint = $uint << 7;
-			}
-			else {
-				break;
-			}
-		}
-
-		return $uint;
-	}
-
-	/**
-	 * Returns the mapping for a specified codepage and id.
-	 *
-	 * @param $cp   codepage
-	 * @param $id
-	 *
-	 * @return string
-	 */
-	private function getMapping($cp, $id) {
-		if (!isset($this->dtd["codes"][$cp]) || !isset($this->dtd["codes"][$cp][$id])) {
-			return false;
-		}
-
-		if (isset($this->dtd["namespaces"][$cp])) {
-			return $this->dtd["namespaces"][$cp] . ":" . $this->dtd["codes"][$cp][$id];
-		}
-
-		return $this->dtd["codes"][$cp][$id];
-	}
+    /**
+     * Returns the next token.
+     *
+     * @return token
+     */
+    private function getToken() {
+        // See if there's something in the ungetBuffer
+        if ($this->ungetbuffer) {
+            $element = $this->ungetbuffer;
+            $this->ungetbuffer = false;
+
+            return $element;
+        }
+
+        $el = $this->_getToken();
+        if ($this->log && $el) {
+            $this->logToken($el);
+        }
+
+        return $el;
+    }
+
+    /**
+     * Log the a token to SLog.
+     *
+     * @param string $el token
+     *
+     * @return
+     */
+    private function logToken($el) {
+        $spaces = str_repeat(" ", count($this->logStack));
+
+        switch ($el[EN_TYPE]) {
+            case EN_TYPE_STARTTAG:
+                if ($el[EN_FLAGS] & EN_FLAGS_CONTENT) {
+                    SLog::Write(LOGLEVEL_WBXML, "I " . $spaces . " <" . $el[EN_TAG] . ">");
+                    array_push($this->logStack, $el[EN_TAG]);
+                }
+                else {
+                    SLog::Write(LOGLEVEL_WBXML, "I " . $spaces . " <" . $el[EN_TAG] . "/>");
+                }
+                break;
+
+            case EN_TYPE_ENDTAG:
+                $tag = array_pop($this->logStack);
+                SLog::Write(LOGLEVEL_WBXML, "I " . $spaces . "</" . $tag . ">");
+                break;
+
+            case EN_TYPE_CONTENT:
+                // as we concatenate the string here, the entire content is copied.
+                // when sending an email with an attachment this single log line (which is never logged in INFO)
+                // requires easily additional 20 MB of RAM. See https://jira.z-hub.io/browse/ZP-1159
+                $messagesize = strlen($el[EN_CONTENT]);
+                if ($messagesize > 10240 && !defined('WBXML_DEBUGGING')) {
+                    $content = substr($el[EN_CONTENT], 0, 10240) . sprintf(" <log message with %d bytes truncated>", $messagesize);
+                }
+                else {
+                    $content = $el[EN_CONTENT];
+                }
+                // Log but make sure it's not truncated again (will be slightly bigger than 10KB)
+                SLog::Write(LOGLEVEL_WBXML, "I " . $spaces . " " . $content, false);
+                break;
+        }
+    }
+
+    /**
+     * Returns either a start tag, content or end tag.
+     *
+     * @return
+     */
+    private function _getToken() {
+        // Get the data from the input stream
+        $element = [];
+
+        WBXMLDecoder::ResetInWhile("decoderGetToken");
+        while (WBXMLDecoder::InWhile("decoderGetToken")) {
+            $byte = fread($this->in, 1);
+            if ($byte === "" || $byte === false) {
+                break;
+            }
+            $byte = ord($byte);
+
+            switch ($byte) {
+                case self::WBXML_SWITCH_PAGE:
+                    $this->tagcp = $this->getByte();
+                    break;
+
+                case self::WBXML_END:
+                    $element[EN_TYPE] = EN_TYPE_ENDTAG;
+
+                    return $element;
+
+                case self::WBXML_STR_I:
+                    $element[EN_TYPE] = EN_TYPE_CONTENT;
+                    $element[EN_CONTENT] = $this->getTermStr();
+
+                    return $element;
+
+                case self::WBXML_OPAQUE:
+                    $length = $this->getMBUInt();
+                    $element[EN_TYPE] = EN_TYPE_CONTENT;
+                    $element[EN_CONTENT] = $this->getOpaque($length);
+
+                    return $element;
+
+                case self::WBXML_ENTITY:
+                case self::WBXML_LITERAL:
+                case self::WBXML_EXT_I_0:
+                case self::WBXML_EXT_I_1:
+                case self::WBXML_EXT_I_2:
+                case self::WBXML_PI:
+                case self::WBXML_LITERAL_C:
+                case self::WBXML_EXT_T_0:
+                case self::WBXML_EXT_T_1:
+                case self::WBXML_EXT_T_2:
+                case self::WBXML_STR_T:
+                case self::WBXML_LITERAL_A:
+                case self::WBXML_EXT_0:
+                case self::WBXML_EXT_1:
+                case self::WBXML_EXT_2:
+                case self::WBXML_LITERAL_AC:
+                    throw new WBXMLException("Invalid token :" . $byte);
+
+                default:
+                    if ($byte & self::WBXML_WITH_ATTRIBUTES) {
+                        throw new WBXMLException("Attributes are not allowed :" . $byte);
+                    }
+                    $element[EN_TYPE] = EN_TYPE_STARTTAG;
+                    $element[EN_TAG] = $this->getMapping($this->tagcp, $byte & 0x3F);
+                    $element[EN_FLAGS] = ($byte & self::WBXML_WITH_CONTENT ? EN_FLAGS_CONTENT : 0);
+
+                    return $element;
+            }
+        }
+    }
+
+    /**
+     * Reads from the stream until getting a string terminator.
+     *
+     * @return string
+     */
+    private function getTermStr() {
+        if (defined('WBXML_DEBUGGING') && WBXML_DEBUGGING === true) {
+            $str = "";
+            while (1) {
+                $in = $this->getByte();
+                if ($in == 0) {
+                    break;
+                }
+
+                $str .= chr($in);
+            }
+
+            return $str;
+        }
+
+        // there is no unlimited "length" for stream_get_line,
+        // so we use a huge value for "length" param (1Gb)
+        // (0 == PHP_SOCK_CHUNK_SIZE (8192))
+        // internally php read at most PHP_SOCK_CHUNK_SIZE at a time,
+        // so we can use a huge value for "length" without problem
+        return stream_get_line($this->in, 1073741824, "\0");
+    }
+
+    /**
+     * Reads $len from the input stream.
+     *
+     * @param int $len
+     *
+     * @return string
+     */
+    private function getOpaque($len) {
+        $d = stream_get_contents($this->in, $len);
+        if ($d === false) {
+            throw new HTTPReturnCodeException("WBXMLDecoder->getOpaque(): stream_get_contents === false", HTTP_CODE_500, null, LOGLEVEL_WARN);
+        }
+        $l = strlen($d);
+        if ($l !== $len) {
+            throw new HTTPReturnCodeException("WBXMLDecoder->getOpaque(): only {$l} byte read instead of {$len}", HTTP_CODE_500, null, LOGLEVEL_WARN);
+        }
+
+        return $d;
+    }
+
+    /**
+     * Reads one byte from the input stream.
+     *
+     * @return int
+     */
+    private function getByte() {
+        $ch = fread($this->in, 1);
+        if (strlen($ch) > 0) {
+            return ord($ch);
+        }
+    }
+
+    /**
+     * Reads string length from the input stream.
+     *
+     * @return
+     */
+    private function getMBUInt() {
+        $uint = 0;
+
+        while (1) {
+            $byte = $this->getByte();
+
+            $uint |= $byte & 0x7F;
+
+            if ($byte & 0x80) {
+                $uint = $uint << 7;
+            }
+            else {
+                break;
+            }
+        }
+
+        return $uint;
+    }
+
+    /**
+     * Returns the mapping for a specified codepage and id.
+     *
+     * @param $cp   codepage
+     * @param $id
+     *
+     * @return string
+     */
+    private function getMapping($cp, $id) {
+        if (!isset($this->dtd["codes"][$cp]) || !isset($this->dtd["codes"][$cp][$id])) {
+            return false;
+        }
+
+        if (isset($this->dtd["namespaces"][$cp])) {
+            return $this->dtd["namespaces"][$cp] . ":" . $this->dtd["codes"][$cp][$id];
+        }
+
+        return $this->dtd["codes"][$cp][$id];
+    }
 }

Spacing +14 added lines, -15 removed lines

@@ -34,8 +34,7 @@ 
 		if (!isset(self::$loopCounter[$name])) {
 			self::$loopCounter[$name] = 0;
 		}
-		else {
-			++self::$loopCounter[$name];
+		else {++self::$loopCounter[$name];
 		}
 
 		if (self::$loopCounter[$name] > self::MAXLOOP) {
@@ -81,17 +80,17 @@ 
 
 		$publicid = $this->getMBUInt();
 		if ($publicid !== 1) {
-			throw new WBXMLException("Wrong publicid : " . $publicid);
+			throw new WBXMLException("Wrong publicid : ".$publicid);
 		}
 
 		$charsetid = $this->getMBUInt();
 		if ($charsetid !== 106) {
-			throw new WBXMLException("Wrong charset : " . $charsetid);
+			throw new WBXMLException("Wrong charset : ".$charsetid);
 		}
 
 		$stringtablesize = $this->getMBUInt();
 		if ($stringtablesize !== 0) {
-			throw new WBXMLException("Wrong string table size : " . $stringtablesize);
+			throw new WBXMLException("Wrong string table size : ".$stringtablesize);
 		}
 	}
 
@@ -184,7 +183,7 @@ 
 		SLog::Write(LOGLEVEL_WBXMLSTACK, sprintf("WBXMLDecoder->getElementEndTag(): unmatched WBXML tag: '%s' type '%s' flags '%s'", ((isset($element[EN_TAG])) ? $element[EN_TAG] : ""), ((isset($element[EN_TYPE])) ? $element[EN_TYPE] : ""), ((isset($element[EN_FLAGS])) ? $element[EN_FLAGS] : "")));
 
 		$bt = debug_backtrace();
-		SLog::Write(LOGLEVEL_ERROR, sprintf("WBXMLDecoder->getElementEndTag(): could not read end tag in '%s'. Please enable the LOGLEVEL_WBXML and send the log to the grommunio-sync dev team.", $bt[0]["file"] . ":" . $bt[0]["line"]));
+		SLog::Write(LOGLEVEL_ERROR, sprintf("WBXMLDecoder->getElementEndTag(): could not read end tag in '%s'. Please enable the LOGLEVEL_WBXML and send the log to the grommunio-sync dev team.", $bt[0]["file"].":".$bt[0]["line"]));
 
 		// log the remaining wbxml content
 		$this->ungetElement($element);
@@ -232,7 +231,7 @@ 
 	 * @return string
 	 */
 	public function GetPlainInputStream() {
-		return $this->inputBuffer . stream_get_contents($this->in);
+		return $this->inputBuffer.stream_get_contents($this->in);
 	}
 
 	/**
@@ -291,17 +290,17 @@ 
 		switch ($el[EN_TYPE]) {
 			case EN_TYPE_STARTTAG:
 				if ($el[EN_FLAGS] & EN_FLAGS_CONTENT) {
-					SLog::Write(LOGLEVEL_WBXML, "I " . $spaces . " <" . $el[EN_TAG] . ">");
+					SLog::Write(LOGLEVEL_WBXML, "I ".$spaces." <".$el[EN_TAG].">");
 					array_push($this->logStack, $el[EN_TAG]);
 				}
 				else {
-					SLog::Write(LOGLEVEL_WBXML, "I " . $spaces . " <" . $el[EN_TAG] . "/>");
+					SLog::Write(LOGLEVEL_WBXML, "I ".$spaces." <".$el[EN_TAG]."/>");
 				}
 				break;
 
 			case EN_TYPE_ENDTAG:
 				$tag = array_pop($this->logStack);
-				SLog::Write(LOGLEVEL_WBXML, "I " . $spaces . "</" . $tag . ">");
+				SLog::Write(LOGLEVEL_WBXML, "I ".$spaces."</".$tag.">");
 				break;
 
 			case EN_TYPE_CONTENT:
@@ -310,13 +309,13 @@ 
 				// requires easily additional 20 MB of RAM. See https://jira.z-hub.io/browse/ZP-1159
 				$messagesize = strlen($el[EN_CONTENT]);
 				if ($messagesize > 10240 && !defined('WBXML_DEBUGGING')) {
-					$content = substr($el[EN_CONTENT], 0, 10240) . sprintf(" <log message with %d bytes truncated>", $messagesize);
+					$content = substr($el[EN_CONTENT], 0, 10240).sprintf(" <log message with %d bytes truncated>", $messagesize);
 				}
 				else {
 					$content = $el[EN_CONTENT];
 				}
 				// Log but make sure it's not truncated again (will be slightly bigger than 10KB)
-				SLog::Write(LOGLEVEL_WBXML, "I " . $spaces . " " . $content, false);
+				SLog::Write(LOGLEVEL_WBXML, "I ".$spaces." ".$content, false);
 				break;
 		}
 	}
@@ -377,11 +376,11 @@ 
 				case self::WBXML_EXT_1:
 				case self::WBXML_EXT_2:
 				case self::WBXML_LITERAL_AC:
-					throw new WBXMLException("Invalid token :" . $byte);
+					throw new WBXMLException("Invalid token :".$byte);
 
 				default:
 					if ($byte & self::WBXML_WITH_ATTRIBUTES) {
-						throw new WBXMLException("Attributes are not allowed :" . $byte);
+						throw new WBXMLException("Attributes are not allowed :".$byte);
 					}
 					$element[EN_TYPE] = EN_TYPE_STARTTAG;
 					$element[EN_TAG] = $this->getMapping($this->tagcp, $byte & 0x3F);
@@ -490,7 +489,7 @@ 
 		}
 
 		if (isset($this->dtd["namespaces"][$cp])) {
-			return $this->dtd["namespaces"][$cp] . ":" . $this->dtd["codes"][$cp][$id];
+			return $this->dtd["namespaces"][$cp].":".$this->dtd["codes"][$cp][$id];
 		}
 
 		return $this->dtd["codes"][$cp][$id];

Braces +5 added lines, -10 removed lines

@@ -33,8 +33,7 @@ 
 	public static function InWhile($name) {
 		if (!isset(self::$loopCounter[$name])) {
 			self::$loopCounter[$name] = 0;
-		}
-		else {
+		} else {
 			++self::$loopCounter[$name];
 		}
 
@@ -119,8 +118,7 @@ 
 					}
 					if ($next[EN_TYPE] == EN_CONTENT) {
 						$element[EN_CONTENT] .= $next[EN_CONTENT];
-					}
-					else {
+					} else {
 						$this->ungetElement($next);
 
 						break;
@@ -293,8 +291,7 @@ 
 				if ($el[EN_FLAGS] & EN_FLAGS_CONTENT) {
 					SLog::Write(LOGLEVEL_WBXML, "I " . $spaces . " <" . $el[EN_TAG] . ">");
 					array_push($this->logStack, $el[EN_TAG]);
-				}
-				else {
+				} else {
 					SLog::Write(LOGLEVEL_WBXML, "I " . $spaces . " <" . $el[EN_TAG] . "/>");
 				}
 				break;
@@ -311,8 +308,7 @@ 
 				$messagesize = strlen($el[EN_CONTENT]);
 				if ($messagesize > 10240 && !defined('WBXML_DEBUGGING')) {
 					$content = substr($el[EN_CONTENT], 0, 10240) . sprintf(" <log message with %d bytes truncated>", $messagesize);
-				}
-				else {
+				} else {
 					$content = $el[EN_CONTENT];
 				}
 				// Log but make sure it's not truncated again (will be slightly bigger than 10KB)
@@ -467,8 +463,7 @@ 
 
 			if ($byte & 0x80) {
 				$uint = $uint << 7;
-			}
-			else {
+			} else {
 				break;
 			}
 		}

lib/wbxml/replacenullcharfilter.php

Indentation +20 added lines, -20 removed lines

@@ -8,25 +8,25 @@
  */
 
 class ReplaceNullcharFilter extends php_user_filter {
-	/**
-	 * This method is called whenever data is read from or written to the attached stream.
-	 *
-	 * @see php_user_filter::filter()
-	 *
-	 * @param resource $in
-	 * @param resource $out
-	 * @param int      $consumed
-	 * @param bool     $closing
-	 *
-	 * @return int
-	 */
-	public function filter($in, $out, &$consumed, $closing) {
-		while ($bucket = stream_bucket_make_writeable($in)) {
-			$bucket->data = str_replace("\0", "", $bucket->data);
-			$consumed += $bucket->datalen;
-			stream_bucket_append($out, $bucket);
-		}
+    /**
+     * This method is called whenever data is read from or written to the attached stream.
+     *
+     * @see php_user_filter::filter()
+     *
+     * @param resource $in
+     * @param resource $out
+     * @param int      $consumed
+     * @param bool     $closing
+     *
+     * @return int
+     */
+    public function filter($in, $out, &$consumed, $closing) {
+        while ($bucket = stream_bucket_make_writeable($in)) {
+            $bucket->data = str_replace("\0", "", $bucket->data);
+            $consumed += $bucket->datalen;
+            stream_bucket_append($out, $bucket);
+        }
 
-		return PSFS_PASS_ON;
-	}
+        return PSFS_PASS_ON;
+    }
 }

lib/wbxml/wbxmldefs.php

Indentation +709 added lines, -709 removed lines

@@ -21,714 +21,714 @@
 define('EN_FLAGS_ATTRIBUTES', 2);
 
 class WBXMLDefs {
-	public const WBXML_SWITCH_PAGE = 0x00;
-	public const WBXML_END = 0x01;
-	public const WBXML_ENTITY = 0x02; // not used in ActiveSync
-	public const WBXML_STR_I = 0x03;
-	public const WBXML_LITERAL = 0x04; // not used in ActiveSync
-	public const WBXML_EXT_I_0 = 0x40; // not used in ActiveSync
-	public const WBXML_EXT_I_1 = 0x41; // not used in ActiveSync
-	public const WBXML_EXT_I_2 = 0x42; // not used in ActiveSync
-	public const WBXML_PI = 0x43; // not used in ActiveSync
-	public const WBXML_LITERAL_C = 0x44; // not used in ActiveSync
-	public const WBXML_EXT_T_0 = 0x80; // not used in ActiveSync
-	public const WBXML_EXT_T_1 = 0x81; // not used in ActiveSync
-	public const WBXML_EXT_T_2 = 0x82; // not used in ActiveSync
-	public const WBXML_STR_T = 0x83; // not used in ActiveSync
-	public const WBXML_LITERAL_A = 0x84; // not used in ActiveSync
-	public const WBXML_EXT_0 = 0xC0; // not used in ActiveSync
-	public const WBXML_EXT_1 = 0xC1; // not used in ActiveSync
-	public const WBXML_EXT_2 = 0xC2; // not used in ActiveSync
-	public const WBXML_OPAQUE = 0xC3;
-	public const WBXML_LITERAL_AC = 0xC4; // not used in ActiveSync
-	public const WBXML_WITH_ATTRIBUTES = 0x80; // not used in ActiveSync
-	public const WBXML_WITH_CONTENT = 0x40;
+    public const WBXML_SWITCH_PAGE = 0x00;
+    public const WBXML_END = 0x01;
+    public const WBXML_ENTITY = 0x02; // not used in ActiveSync
+    public const WBXML_STR_I = 0x03;
+    public const WBXML_LITERAL = 0x04; // not used in ActiveSync
+    public const WBXML_EXT_I_0 = 0x40; // not used in ActiveSync
+    public const WBXML_EXT_I_1 = 0x41; // not used in ActiveSync
+    public const WBXML_EXT_I_2 = 0x42; // not used in ActiveSync
+    public const WBXML_PI = 0x43; // not used in ActiveSync
+    public const WBXML_LITERAL_C = 0x44; // not used in ActiveSync
+    public const WBXML_EXT_T_0 = 0x80; // not used in ActiveSync
+    public const WBXML_EXT_T_1 = 0x81; // not used in ActiveSync
+    public const WBXML_EXT_T_2 = 0x82; // not used in ActiveSync
+    public const WBXML_STR_T = 0x83; // not used in ActiveSync
+    public const WBXML_LITERAL_A = 0x84; // not used in ActiveSync
+    public const WBXML_EXT_0 = 0xC0; // not used in ActiveSync
+    public const WBXML_EXT_1 = 0xC1; // not used in ActiveSync
+    public const WBXML_EXT_2 = 0xC2; // not used in ActiveSync
+    public const WBXML_OPAQUE = 0xC3;
+    public const WBXML_LITERAL_AC = 0xC4; // not used in ActiveSync
+    public const WBXML_WITH_ATTRIBUTES = 0x80; // not used in ActiveSync
+    public const WBXML_WITH_CONTENT = 0x40;
 
-	/**
-	 * The WBXML DTDs.
-	 */
-	protected $dtd = [
-		"codes" => [
-			0 => [
-				0x05 => "Synchronize",
-				0x06 => "Replies", // Responses
-				0x07 => "Add",
-				0x08 => "Modify", // Change
-				0x09 => "Remove", // Delete
-				0x0A => "Fetch",
-				0x0B => "SyncKey",
-				0x0C => "ClientEntryId", // ClientId
-				0x0D => "ServerEntryId", // ServerId
-				0x0E => "Status",
-				0x0F => "Folder", // collection
-				0x10 => "FolderType", // class
-				0x11 => "Version", // deprecated
-				0x12 => "FolderId", // CollectionId
-				0x13 => "GetChanges",
-				0x14 => "MoreAvailable",
-				0x15 => "WindowSize", // WindowSize - MaxItems before version 2
-				0x16 => "Perform", // Commands
-				0x17 => "Options",
-				0x18 => "FilterType",
-				0x19 => "Truncation", // 2.0 and 2.5
-				0x1A => "RtfTruncation", // 2.0 and 2.5
-				0x1B => "Conflict",
-				0x1C => "Folders", // Collections
-				0x1D => "Data",
-				0x1E => "DeletesAsMoves",
-				0x1F => "NotifyGUID", // 2.0 and 2.5
-				0x20 => "Supported",
-				0x21 => "SoftDelete",
-				0x22 => "MIMESupport",
-				0x23 => "MIMETruncation",
-				0x24 => "Wait", // Since 12.1
-				0x25 => "Limit", // Since 12.1
-				0x26 => "Partial", // Since 12.1
-				0x27 => "ConversationMode", // Since 14.0
-				0x28 => "MaxItems", // Since 14.0
-				0x29 => "HeartbeatInterval", // Since 14.0 Either this tag or the Wait tag can be present, but not both.
-			],
-			1 => [
-				0x05 => "Anniversary",
-				0x06 => "AssistantName",
-				0x07 => "AssistnamePhoneNumber", // AssistantTelephoneNumber
-				0x08 => "Birthday",
-				0x09 => "Body", // 2.5, AirSyncBase Body is used since version 12.0
-				0x0A => "BodySize", // 2.0 and 2.5, AirSyncBase is used since version 12.0
-				0x0B => "BodyTruncated", // 2.0 and 2.5, AirSyncBase is used since version 12.0
-				0x0C => "Business2PhoneNumber",
-				0x0D => "BusinessCity",
-				0x0E => "BusinessCountry",
-				0x0F => "BusinessPostalCode",
-				0x10 => "BusinessState",
-				0x11 => "BusinessStreet",
-				0x12 => "BusinessFaxNumber",
-				0x13 => "BusinessPhoneNumber",
-				0x14 => "CarPhoneNumber",
-				0x15 => "Categories",
-				0x16 => "Category",
-				0x17 => "Children",
-				0x18 => "Child",
-				0x19 => "CompanyName",
-				0x1A => "Department",
-				0x1B => "Email1Address",
-				0x1C => "Email2Address",
-				0x1D => "Email3Address",
-				0x1E => "FileAs",
-				0x1F => "FirstName",
-				0x20 => "Home2PhoneNumber",
-				0x21 => "HomeCity",
-				0x22 => "HomeCountry",
-				0x23 => "HomePostalCode",
-				0x24 => "HomeState",
-				0x25 => "HomeStreet",
-				0x26 => "HomeFaxNumber",
-				0x27 => "HomePhoneNumber",
-				0x28 => "JobTitle",
-				0x29 => "LastName",
-				0x2A => "MiddleName",
-				0x2B => "MobilePhoneNumber",
-				0x2C => "OfficeLocation",
-				0x2D => "OtherCity",
-				0x2E => "OtherCountry",
-				0x2F => "OtherPostalCode",
-				0x30 => "OtherState",
-				0x31 => "OtherStreet",
-				0x32 => "PagerNumber",
-				0x33 => "RadioPhoneNumber",
-				0x34 => "Spouse",
-				0x35 => "Suffix",
-				0x36 => "Title",
-				0x37 => "WebPage",
-				0x38 => "YomiCompanyName",
-				0x39 => "YomiFirstName",
-				0x3A => "YomiLastName",
-				0x3B => "Rtf", // CompressedRTF - 2.5, deprecated
-				0x3C => "Picture",
-				0x3D => "Alias", // Since 14.0
-				0x3E => "WeightedRank", // Since 14.0
-			],
-			2 => [
-				0x05 => "Attachment", // AirSyncBase Attachments is used since 12.0
-				0x06 => "Attachments", // AirSyncBase Attachments is used since 12.0
-				0x07 => "AttName", // AirSyncBase Attachments is used since 12.0
-				0x08 => "AttSize", // AirSyncBase Attachments is used since 12.0
-				0x09 => "AttOid", // AirSyncBase Attachments is used since 12.0
-				0x0A => "AttMethod", // AirSyncBase Attachments is used since 12.0
-				0x0B => "AttRemoved", // AirSyncBase Attachments is used since 12.0
-				0x0C => "Body", // AirSyncBase Body is used since 12.0
-				0x0D => "BodySize", // AirSyncBase Body is used since 12.0
-				0x0E => "BodyTruncated", // AirSyncBase Body is used since 12.0
-				0x0F => "DateReceived",
-				0x10 => "DisplayName", // AirSyncBase Attachments is used since 12.0
-				0x11 => "DisplayTo",
-				0x12 => "Importance",
-				0x13 => "MessageClass",
-				0x14 => "Subject",
-				0x15 => "Read",
-				0x16 => "To",
-				0x17 => "Cc",
-				0x18 => "From",
-				0x19 => "Reply-To",
-				0x1A => "AllDayEvent",
-				0x1B => "Categories", // Since 14.0
-				0x1C => "Category", // Since 14.0
-				0x1D => "DtStamp",
-				0x1E => "EndTime",
-				0x1F => "InstanceType",
-				0x20 => "BusyStatus",
-				0x21 => "Location", // 2.5, 12.0, 12.1, 14.0 and 14.1. Since 16.0 AirSyncBase Location is used.
-				0x22 => "MeetingRequest",
-				0x23 => "Organizer",
-				0x24 => "RecurrenceId",
-				0x25 => "Reminder",
-				0x26 => "ResponseRequested",
-				0x27 => "Recurrences",
-				0x28 => "Recurrence",
-				0x29 => "Type",
-				0x2A => "Until",
-				0x2B => "Occurrences",
-				0x2C => "Interval",
-				0x2D => "DayOfWeek",
-				0x2E => "DayOfMonth",
-				0x2F => "WeekOfMonth",
-				0x30 => "MonthOfYear",
-				0x31 => "StartTime",
-				0x32 => "Sensitivity",
-				0x33 => "TimeZone",
-				0x34 => "GlobalObjId", // 2.5, 12.0, 12.1, 14.0 and 14.1. UID of Calendar (Code page 4) is used since 16.0
-				0x35 => "ThreadTopic",
-				0x36 => "MIMEData", // 2.5
-				0x37 => "MIMETruncated", // 2.5
-				0x38 => "MIMESize", // 2.5
-				0x39 => "InternetCPID",
-				0x3A => "Flag", // Since 12.0
-				0x3B => "FlagStatus", // Since 12.0
-				0x3C => "ContentClass", // Since 12.0
-				0x3D => "FlagType", // Since 12.0
-				0x3E => "CompleteTime", // Since 12.0
-				0x3F => "DisallowNewTimeProposal", // Since 14.0
-			],
-			3 => [ // Code page 3 is no longer in use, however, tokens 05 through 17 have been defined. 20100501
-				0x05 => "Notify",
-				0x06 => "Notification",
-				0x07 => "Version",
-				0x08 => "Lifetime",
-				0x09 => "DeviceInfo",
-				0x0A => "Enable",
-				0x0B => "Folder",
-				0x0C => "ServerEntryId",
-				0x0D => "DeviceAddress",
-				0x0E => "ValidCarrierProfiles",
-				0x0F => "CarrierProfile",
-				0x10 => "Status",
-				0x11 => "Replies",
-				//                        0x05 => "Version='1.1'",
-				0x12 => "Devices",
-				0x13 => "Device",
-				0x14 => "Id",
-				0x15 => "Expiry",
-				0x16 => "NotifyGUID",
-			],
-			4 => [
-				0x05 => "Timezone",
-				0x06 => "AllDayEvent",
-				0x07 => "Attendees",
-				0x08 => "Attendee",
-				0x09 => "Email",
-				0x0A => "Name",
-				0x0B => "Body", // AirSyncBase Body is used since 12.0
-				0x0C => "BodyTruncated", // AirSyncBase Body is used since 12.0
-				0x0D => "BusyStatus",
-				0x0E => "Categories",
-				0x0F => "Category",
-				0x10 => "Rtf", // 2.5 - deprecated
-				0x11 => "DtStamp",
-				0x12 => "EndTime",
-				0x13 => "Exception",
-				0x14 => "Exceptions",
-				0x15 => "Deleted",
-				0x16 => "ExceptionStartTime", // 2.5, 12.0, 12.1, 14.0 and 14.1.
-				0x17 => "Location", // 2.5, 12.0, 12.1, 14.0 and 14.1. Since 16.0 AirSyncBase Location is used.
-				0x18 => "MeetingStatus",
-				0x19 => "OrganizerEmail",
-				0x1A => "OrganizerName",
-				0x1B => "Recurrence",
-				0x1C => "Type",
-				0x1D => "Until",
-				0x1E => "Occurrences",
-				0x1F => "Interval",
-				0x20 => "DayOfWeek",
-				0x21 => "DayOfMonth",
-				0x22 => "WeekOfMonth",
-				0x23 => "MonthOfYear",
-				0x24 => "Reminder",
-				0x25 => "Sensitivity",
-				0x26 => "Subject",
-				0x27 => "StartTime",
-				0x28 => "UID",
-				0x29 => "Attendee_Status", // Since 12.0
-				0x2A => "Attendee_Type", // Since 12.0
-				0x2B => "Attachment", // Not defined / deprecated
-				0x2C => "Attachments", // Not defined / deprecated
-				0x2D => "AttName", // Not defined / deprecated
-				0x2E => "AttSize", // Not defined / deprecated
-				0x2F => "AttOid", // Not defined / deprecated
-				0x30 => "AttMethod", // Not defined / deprecated
-				0x31 => "AttRemoved", // Not defined / deprecated
-				0x32 => "DisplayName", // Not defined / deprecated
-				0x33 => "DisallowNewTimeProposal", // Since 14.0
-				0x34 => "ResponseRequested", // Since 14.0
-				0x35 => "AppointmentReplyTime", // Since 14.0
-				0x36 => "ResponseType", // Since 14.0
-				0x37 => "CalendarType", // Since 14.0
-				0x38 => "IsLeapMonth", // Since 14.0
-				0x39 => "FirstDayOfWeek", // Since 14.1
-				0x3A => "OnlineMeetingConfLink", // Since 14.1
-				0x3B => "OnlineMeetingExternalLink", // Since 14.1
-			],
-			5 => [
-				0x05 => "Moves",
-				0x06 => "Move",
-				0x07 => "SrcMsgId",
-				0x08 => "SrcFldId",
-				0x09 => "DstFldId",
-				0x0A => "Response",
-				0x0B => "Status",
-				0x0C => "DstMsgId",
-			],
-			6 => [
-				0x05 => "GetItemEstimate",
-				0x06 => "Version", // deprecated
-				0x07 => "Folders", // Collections
-				0x08 => "Folder", // Collection
-				0x09 => "FolderType", // AirSync Class(SYNC_FOLDERTYPE) is used since AS 14.0
-				0x0A => "FolderId", // CollectionId
-				0x0B => "DateTime", // deprecated
-				0x0C => "Estimate",
-				0x0D => "Response",
-				0x0E => "Status",
-			],
-			7 => [
-				0x05 => "Folders", // 2.5, 12.0 and 12.1
-				0x06 => "Folder", // 2.5, 12.0 and 12.1
-				0x07 => "DisplayName",
-				0x08 => "ServerEntryId", // ServerId
-				0x09 => "ParentId",
-				0x0A => "Type",
-				0x0B => "Response", // deprecated
-				0x0C => "Status",
-				0x0D => "ContentClass", // deprecated
-				0x0E => "Changes",
-				0x0F => "Add",
-				0x10 => "Remove",
-				0x11 => "Update",
-				0x12 => "SyncKey",
-				0x13 => "FolderCreate",
-				0x14 => "FolderDelete",
-				0x15 => "FolderUpdate",
-				0x16 => "FolderSync",
-				0x17 => "Count",
-				0x18 => "Version", // 2.0 - not defined in 20100501
-			],
-			8 => [
-				0x05 => "CalendarId",
-				0x06 => "FolderId", // CollectionId
-				0x07 => "MeetingResponse",
-				0x08 => "RequestId",
-				0x09 => "Request",
-				0x0A => "Result",
-				0x0B => "Status",
-				0x0C => "UserResponse",
-				0x0D => "Version", // 2.0 - not defined in 20100501
-				0x0E => "InstanceId", // Since AS 14.1
-			],
-			9 => [
-				0x05 => "Body", // AirSyncBase Body is used since 12.0
-				0x06 => "BodySize", // AirSyncBase Body is used since 12.0
-				0x07 => "BodyTruncated", // AirSyncBase Body is used since 12.0
-				0x08 => "Categories",
-				0x09 => "Category",
-				0x0A => "Complete",
-				0x0B => "DateCompleted",
-				0x0C => "DueDate",
-				0x0D => "UtcDueDate",
-				0x0E => "Importance",
-				0x0F => "Recurrence",
-				0x10 => "Type",
-				0x11 => "Start",
-				0x12 => "Until",
-				0x13 => "Occurrences",
-				0x14 => "Interval",
-				0x15 => "DayOfMonth",
-				0x16 => "DayOfWeek",
-				0x17 => "WeekOfMonth",
-				0x18 => "MonthOfYear",
-				0x19 => "Regenerate",
-				0x1A => "DeadOccur",
-				0x1B => "ReminderSet",
-				0x1C => "ReminderTime",
-				0x1D => "Sensitivity",
-				0x1E => "StartDate",
-				0x1F => "UtcStartDate",
-				0x20 => "Subject",
-				0x21 => "Rtf", // deprecated
-				0x22 => "OrdinalDate", // Since 12.0
-				0x23 => "SubOrdinalDate", // Since 12.0
-				0x24 => "CalendarType", // Since 14.0
-				0x25 => "IsLeapMonth", // Since 14.0
-				0x26 => "FirstDayOfWeek", // Since 14.1
-			],
-			0xA => [
-				0x05 => "ResolveRecipients",
-				0x06 => "Response",
-				0x07 => "Status",
-				0x08 => "Type",
-				0x09 => "Recipient",
-				0x0A => "DisplayName",
-				0x0B => "EmailAddress",
-				0x0C => "Certificates",
-				0x0D => "Certificate",
-				0x0E => "MiniCertificate",
-				0x0F => "Options",
-				0x10 => "To",
-				0x11 => "CertificateRetrieval",
-				0x12 => "RecipientCount",
-				0x13 => "MaxCertificates",
-				0x14 => "MaxAmbiguousRecipients",
-				0x15 => "CertificateCount",
-				0x16 => "Availability", // Since 14.0
-				0x17 => "StartTime", // Since 14.0
-				0x18 => "EndTime", // Since 14.0
-				0x19 => "MergedFreeBusy", // Since 14.0
-				0x1A => "Picture", // Since 14.1
-				0x1B => "MaxSize", // Since 14.1
-				0x1C => "Data", // Since 14.1
-				0x1D => "MaxPictures", // Since 14.1
-			],
-			0xB => [
-				0x05 => "ValidateCert",
-				0x06 => "Certificates",
-				0x07 => "Certificate",
-				0x08 => "CertificateChain",
-				0x09 => "CheckCRL",
-				0x0A => "Status",
-			],
-			0xC => [
-				0x05 => "CustomerId",
-				0x06 => "GovernmentId",
-				0x07 => "IMAddress",
-				0x08 => "IMAddress2",
-				0x09 => "IMAddress3",
-				0x0A => "ManagerName",
-				0x0B => "CompanyMainPhone",
-				0x0C => "AccountName",
-				0x0D => "NickName",
-				0x0E => "MMS",
-			],
-			0xD => [
-				0x05 => "Ping",
-				0x06 => "AutdState", // (Not used by protocol)
-				0x07 => "Status",
-				0x08 => "LifeTime", // HeartbeatInterval
-				0x09 => "Folders",
-				0x0A => "Folder",
-				0x0B => "ServerEntryId", // Id
-				0x0C => "FolderType", // Class
-				0x0D => "MaxFolders",
-				0x0E => "Version", // not defined / deprecated
-			],
-			0xE => [
-				0x05 => "Provision",
-				0x06 => "Policies",
-				0x07 => "Policy",
-				0x08 => "PolicyType",
-				0x09 => "PolicyKey",
-				0x0A => "Data",
-				0x0B => "Status",
-				0x0C => "RemoteWipe",
-				0x0D => "EASProvisionDoc", // Since 12.0
-				0x0E => "DevicePasswordEnabled", // Since 12.0
-				0x0F => "AlphanumericDevicePasswordRequired", // Since 12.0
-				0x10 => "DeviceEncryptionEnabled", // Since 12.1
-				// 0x10 => "RequireStorageCardEncryption", //Since 12.1
-				0x11 => "PasswordRecoveryEnabled", // Since 12.0
-				0x12 => "DocumentBrowseEnabled", // not defined / deprecated
-				0x13 => "AttachmentsEnabled", // Since 12.0
-				0x14 => "MinDevicePasswordLength", // Since 12.0
-				0x15 => "MaxInactivityTimeDeviceLock", // Since 12.0
-				0x16 => "MaxDevicePasswordFailedAttempts", // Since 12.0
-				0x17 => "MaxAttachmentSize", // Since 12.0
-				0x18 => "AllowSimpleDevicePassword", // Since 12.0
-				0x19 => "DevicePasswordExpiration", // Since 12.0
-				0x1A => "DevicePasswordHistory", // Since 12.0
-				0x1B => "AllowStorageCard", // Since 12.1
-				0x1C => "AllowCamera", // Since 12.1
-				0x1D => "RequireDeviceEncryption", // Since 12.1
-				0x1E => "AllowUnsignedApplications", // Since 12.1
-				0x1F => "AllowUnsignedInstallationPackages", // Since 12.1
-				0x20 => "MinDevicePasswordComplexCharacters", // Since 12.1
-				0x21 => "AllowWiFi", // Since 12.1
-				0x22 => "AllowTextMessaging", // Since 12.1
-				0x23 => "AllowPOPIMAPEmail", // Since 12.1
-				0x24 => "AllowBluetooth", // Since 12.1
-				0x25 => "AllowIrDA", // Since 12.1
-				0x26 => "RequireManualSyncWhenRoaming", // Since 12.1
-				0x27 => "AllowDesktopSync", // Since 12.1
-				0x28 => "MaxCalendarAgeFilter", // Since 12.1
-				0x29 => "AllowHTMLEmail", // Since 12.1
-				0x2A => "MaxEmailAgeFilter", // Since 12.1
-				0x2B => "MaxEmailBodyTruncationSize", // Since 12.1
-				0x2C => "MaxEmailHTMLBodyTruncationSize", // Since 12.1
-				0x2D => "RequireSignedSMIMEMessages", // Since 12.1
-				0x2E => "RequireEncryptedSMIMEMessages", // Since 12.1
-				0x2F => "RequireSignedSMIMEAlgorithm", // Since 12.1
-				0x30 => "RequireEncryptionSMIMEAlgorithm", // Since 12.1
-				0x31 => "AllowSMIMEEncryptionAlgorithmNegotiation", // Since 12.1
-				0x32 => "AllowSMIMESoftCerts", // Since 12.1
-				0x33 => "AllowBrowser", // Since 12.1
-				0x34 => "AllowConsumerEmail", // Since 12.1
-				0x35 => "AllowRemoteDesktop", // Since 12.1
-				0x36 => "AllowInternetSharing", // Since 12.1
-				0x37 => "UnapprovedInROMApplicationList", // Since 12.1
-				0x38 => "ApplicationName", // Since 12.1
-				0x39 => "ApprovedApplicationList", // Since 12.1
-				0x3A => "Hash", // Since 12.1
-			],
-			0xF => [
-				0x05 => "Search",
-				0x07 => "Store",
-				0x08 => "Name",
-				0x09 => "Query",
-				0x0A => "Options",
-				0x0B => "Range",
-				0x0C => "Status",
-				0x0D => "Response",
-				0x0E => "Result",
-				0x0F => "Properties",
-				0x10 => "Total",
-				0x11 => "EqualTo",
-				0x12 => "Value",
-				0x13 => "And",
-				0x14 => "Or",
-				0x15 => "FreeText",
-				0x17 => "DeepTraversal",
-				0x18 => "LongId",
-				0x19 => "RebuildResults",
-				0x1A => "LessThan",
-				0x1B => "GreaterThan",
-				0x1C => "Schema",
-				0x1D => "Supported",
-				0x1E => "UserName", // Since 12.1
-				0x1F => "Password", // Since 12.1
-				0x20 => "ConversationId", // Since 14.0
-				0x21 => "Picture", // Since 14.1
-				0x22 => "MaxSize", // Since 14.1
-				0x23 => "MaxPictures", // Since 14.1
-			],
-			0x10 => [
-				0x05 => "DisplayName",
-				0x06 => "Phone",
-				0x07 => "Office",
-				0x08 => "Title",
-				0x09 => "Company",
-				0x0A => "Alias",
-				0x0B => "FirstName",
-				0x0C => "LastName",
-				0x0D => "HomePhone",
-				0x0E => "MobilePhone",
-				0x0F => "EmailAddress",
-				0x10 => "Picture", // Since 14.1
-				0x11 => "Status", // Since 14.1
-				0x12 => "Data", // Since 14.1
-			],
-			0x11 => [ // Since 12.0
-				0x05 => "BodyPreference",
-				0x06 => "Type",
-				0x07 => "TruncationSize",
-				0x08 => "AllOrNone",
-				0x0A => "Body",
-				0x0B => "Data",
-				0x0C => "EstimatedDataSize",
-				0x0D => "Truncated",
-				0x0E => "Attachments",
-				0x0F => "Attachment",
-				0x10 => "DisplayName",
-				0x11 => "FileReference",
-				0x12 => "Method",
-				0x13 => "ContentId",
-				0x14 => "ContentLocation",
-				0x15 => "IsInline",
-				0x16 => "NativeBodyType",
-				0x17 => "ContentType",
-				0x18 => "Preview", // Since 14.0
-				0x19 => "BodyPartPreference", // Since 14.1
-				0x1A => "BodyPart", // Since 14.1
-				0x1B => "Status", // Since 14.1
-			],
-			0x12 => [ // Since 12.0
-				0x05 => "Settings",
-				0x06 => "Status",
-				0x07 => "Get",
-				0x08 => "Set",
-				0x09 => "Oof",
-				0x0A => "OofState",
-				0x0B => "StartTime",
-				0x0C => "EndTime",
-				0x0D => "OofMessage",
-				0x0E => "AppliesToInternal",
-				0x0F => "AppliesToExternalKnown",
-				0x10 => "AppliesToExternalUnknown",
-				0x11 => "Enabled",
-				0x12 => "ReplyMessage",
-				0x13 => "BodyType",
-				0x14 => "DevicePassword",
-				0x15 => "Password",
-				0x16 => "DeviceInformation",
-				0x17 => "Model",
-				0x18 => "IMEI",
-				0x19 => "FriendlyName",
-				0x1A => "OS",
-				0x1B => "OSLanguage",
-				0x1C => "PhoneNumber",
-				0x1D => "UserInformation",
-				0x1E => "EmailAddresses",
-				0x1F => "SmtpAddress",
-				0x20 => "UserAgent", // Since 12.1
-				0x21 => "EnableOutboundSMS", // Since 14.0
-				0x22 => "MobileOperator", // Since 14.0
-				0x23 => "PrimarySmtpAddress", // Since 14.1
-				0x24 => "Accounts", // Since 14.1
-				0x25 => "Account", // Since 14.1
-				0x26 => "AccountId", // Since 14.1
-				0x27 => "AccountName", // Since 14.1
-				0x28 => "UserDisplayName", // Since 14.1
-				0x29 => "SendDisabled", // Since 14.1
-				0x2B => "RightsManagementInformation", // Since 14.1
-			],
-			0x13 => [ // Since 12.0
-				0x05 => "LinkId",
-				0x06 => "DisplayName",
-				0x07 => "IsFolder",
-				0x08 => "CreationDate",
-				0x09 => "LastModifiedDate",
-				0x0A => "IsHidden",
-				0x0B => "ContentLength",
-				0x0C => "ContentType",
-			],
-			0x14 => [ // Since 12.0
-				0x05 => "ItemOperations",
-				0x06 => "Fetch",
-				0x07 => "Store",
-				0x08 => "Options",
-				0x09 => "Range",
-				0x0A => "Total",
-				0x0B => "Properties",
-				0x0C => "Data",
-				0x0D => "Status",
-				0x0E => "Response",
-				0x0F => "Version",
-				0x10 => "Schema",
-				0x11 => "Part",
-				0x12 => "EmptyFolderContents",
-				0x13 => "DeleteSubFolders",
-				0x14 => "UserName", // Since 12.1
-				0x15 => "Password", // Since 12.1
-				0x16 => "Move", // Since 14.0
-				0x17 => "DstFldId", // Since 14.0
-				0x18 => "ConversationId", // Since 14.0
-				0x19 => "MoveAlways", // Since 14.0
-			],
-			0x15 => [ // Since 14.0
-				0x05 => "SendMail",
-				0x06 => "SmartForward",
-				0x07 => "SmartReply",
-				0x08 => "SaveInSentItems",
-				0x09 => "ReplaceMime",
-				0x0A => "Type", // not used
-				0x0B => "Source",
-				0x0C => "FolderId",
-				0x0D => "ItemId",
-				0x0E => "LongId",
-				0x0F => "InstanceId",
-				0x10 => "MIME",
-				0x11 => "ClientId",
-				0x12 => "Status",
-				0x13 => "AccountId", // Since 14.1
-			],
-			0x16 => [ // Since 14.0
-				0x05 => "UmCallerId",
-				0x06 => "UmUserNotes",
-				0x07 => "UmAttDuration",
-				0x08 => "UmAttOrder",
-				0x09 => "ConversationId",
-				0x0A => "ConversationIndex",
-				0x0B => "LastVerbExecuted",
-				0x0C => "LastVerbExecutionTime",
-				0x0D => "ReceivedAsBcc",
-				0x0E => "Sender",
-				0x0F => "CalendarType",
-				0x10 => "IsLeapMonth",
-				0x11 => "AccountId", // Since 14.1
-				0x12 => "FirstDayOfWeek", // Since 14.1
-				0x13 => "MeetingMessageType", // Since 14.1
-			],
-			0x17 => [ // Since 14.0
-				0x05 => "Subject",
-				0x06 => "MessageClass",
-				0x07 => "LastModifiedDate",
-				0x08 => "Categories",
-				0x09 => "Category",
-			],
-			0x18 => [ // Since 14.1
-				0x05 => "RightsManagementSupport",
-				0x06 => "RightsManagementTemplates",
-				0x07 => "RightsManagementTemplate",
-				0x08 => "RightsManagementLicense",
-				0x09 => "EditAllowed",
-				0x0A => "ReplyAllowed",
-				0x0B => "ReplyAllAllowed",
-				0x0C => "ForwardAllowed",
-				0x0D => "ModifyRecipientsAllowed",
-				0x0E => "ExtractAllowed",
-				0x0F => "PrintAllowed",
-				0x10 => "ExportAllowed",
-				0x11 => "ProgrammaticAccessAllowed",
-				0x12 => "Owner",
-				0x13 => "ContentExpiryDate",
-				0x14 => "TemplateID",
-				0x15 => "TemplateName",
-				0x16 => "TemplateDescription",
-				0x17 => "ContentOwner",
-				0x18 => "RemoveRightsManagementProtection",
-			],
-		],
-		"namespaces" => [
-			// 0 => "AirSync", //
-			1 => "POOMCONTACTS",
-			2 => "POOMMAIL",
-			3 => "AirNotify", // no longer used
-			4 => "POOMCAL",
-			5 => "Move",
-			6 => "GetItemEstimate",
-			7 => "FolderHierarchy",
-			8 => "MeetingResponse",
-			9 => "POOMTASKS",
-			0xA => "ResolveRecipients",
-			0xB => "ValidateCert",
-			0xC => "POOMCONTACTS2",
-			0xD => "Ping",
-			0xE => "Provision",
-			0xF => "Search",
-			0x10 => "GAL",
-			0x11 => "AirSyncBase", // 12.0, 12.1 and 14.0
-			0x12 => "Settings", // 12.0, 12.1 and 14.0.
-			0x13 => "DocumentLibrary", // 12.0, 12.1 and 14.0
-			0x14 => "ItemOperations", // 12.0, 12.1 and 14.0
-			0x15 => "ComposeMail", // 14.0
-			0x16 => "POOMMAIL2", // 14.0
-			0x17 => "Notes", // 14.0
-			0x18 => "RightsManagement",
-		],
-	];
+    /**
+     * The WBXML DTDs.
+     */
+    protected $dtd = [
+        "codes" => [
+            0 => [
+                0x05 => "Synchronize",
+                0x06 => "Replies", // Responses
+                0x07 => "Add",
+                0x08 => "Modify", // Change
+                0x09 => "Remove", // Delete
+                0x0A => "Fetch",
+                0x0B => "SyncKey",
+                0x0C => "ClientEntryId", // ClientId
+                0x0D => "ServerEntryId", // ServerId
+                0x0E => "Status",
+                0x0F => "Folder", // collection
+                0x10 => "FolderType", // class
+                0x11 => "Version", // deprecated
+                0x12 => "FolderId", // CollectionId
+                0x13 => "GetChanges",
+                0x14 => "MoreAvailable",
+                0x15 => "WindowSize", // WindowSize - MaxItems before version 2
+                0x16 => "Perform", // Commands
+                0x17 => "Options",
+                0x18 => "FilterType",
+                0x19 => "Truncation", // 2.0 and 2.5
+                0x1A => "RtfTruncation", // 2.0 and 2.5
+                0x1B => "Conflict",
+                0x1C => "Folders", // Collections
+                0x1D => "Data",
+                0x1E => "DeletesAsMoves",
+                0x1F => "NotifyGUID", // 2.0 and 2.5
+                0x20 => "Supported",
+                0x21 => "SoftDelete",
+                0x22 => "MIMESupport",
+                0x23 => "MIMETruncation",
+                0x24 => "Wait", // Since 12.1
+                0x25 => "Limit", // Since 12.1
+                0x26 => "Partial", // Since 12.1
+                0x27 => "ConversationMode", // Since 14.0
+                0x28 => "MaxItems", // Since 14.0
+                0x29 => "HeartbeatInterval", // Since 14.0 Either this tag or the Wait tag can be present, but not both.
+            ],
+            1 => [
+                0x05 => "Anniversary",
+                0x06 => "AssistantName",
+                0x07 => "AssistnamePhoneNumber", // AssistantTelephoneNumber
+                0x08 => "Birthday",
+                0x09 => "Body", // 2.5, AirSyncBase Body is used since version 12.0
+                0x0A => "BodySize", // 2.0 and 2.5, AirSyncBase is used since version 12.0
+                0x0B => "BodyTruncated", // 2.0 and 2.5, AirSyncBase is used since version 12.0
+                0x0C => "Business2PhoneNumber",
+                0x0D => "BusinessCity",
+                0x0E => "BusinessCountry",
+                0x0F => "BusinessPostalCode",
+                0x10 => "BusinessState",
+                0x11 => "BusinessStreet",
+                0x12 => "BusinessFaxNumber",
+                0x13 => "BusinessPhoneNumber",
+                0x14 => "CarPhoneNumber",
+                0x15 => "Categories",
+                0x16 => "Category",
+                0x17 => "Children",
+                0x18 => "Child",
+                0x19 => "CompanyName",
+                0x1A => "Department",
+                0x1B => "Email1Address",
+                0x1C => "Email2Address",
+                0x1D => "Email3Address",
+                0x1E => "FileAs",
+                0x1F => "FirstName",
+                0x20 => "Home2PhoneNumber",
+                0x21 => "HomeCity",
+                0x22 => "HomeCountry",
+                0x23 => "HomePostalCode",
+                0x24 => "HomeState",
+                0x25 => "HomeStreet",
+                0x26 => "HomeFaxNumber",
+                0x27 => "HomePhoneNumber",
+                0x28 => "JobTitle",
+                0x29 => "LastName",
+                0x2A => "MiddleName",
+                0x2B => "MobilePhoneNumber",
+                0x2C => "OfficeLocation",
+                0x2D => "OtherCity",
+                0x2E => "OtherCountry",
+                0x2F => "OtherPostalCode",
+                0x30 => "OtherState",
+                0x31 => "OtherStreet",
+                0x32 => "PagerNumber",
+                0x33 => "RadioPhoneNumber",
+                0x34 => "Spouse",
+                0x35 => "Suffix",
+                0x36 => "Title",
+                0x37 => "WebPage",
+                0x38 => "YomiCompanyName",
+                0x39 => "YomiFirstName",
+                0x3A => "YomiLastName",
+                0x3B => "Rtf", // CompressedRTF - 2.5, deprecated
+                0x3C => "Picture",
+                0x3D => "Alias", // Since 14.0
+                0x3E => "WeightedRank", // Since 14.0
+            ],
+            2 => [
+                0x05 => "Attachment", // AirSyncBase Attachments is used since 12.0
+                0x06 => "Attachments", // AirSyncBase Attachments is used since 12.0
+                0x07 => "AttName", // AirSyncBase Attachments is used since 12.0
+                0x08 => "AttSize", // AirSyncBase Attachments is used since 12.0
+                0x09 => "AttOid", // AirSyncBase Attachments is used since 12.0
+                0x0A => "AttMethod", // AirSyncBase Attachments is used since 12.0
+                0x0B => "AttRemoved", // AirSyncBase Attachments is used since 12.0
+                0x0C => "Body", // AirSyncBase Body is used since 12.0
+                0x0D => "BodySize", // AirSyncBase Body is used since 12.0
+                0x0E => "BodyTruncated", // AirSyncBase Body is used since 12.0
+                0x0F => "DateReceived",
+                0x10 => "DisplayName", // AirSyncBase Attachments is used since 12.0
+                0x11 => "DisplayTo",
+                0x12 => "Importance",
+                0x13 => "MessageClass",
+                0x14 => "Subject",
+                0x15 => "Read",
+                0x16 => "To",
+                0x17 => "Cc",
+                0x18 => "From",
+                0x19 => "Reply-To",
+                0x1A => "AllDayEvent",
+                0x1B => "Categories", // Since 14.0
+                0x1C => "Category", // Since 14.0
+                0x1D => "DtStamp",
+                0x1E => "EndTime",
+                0x1F => "InstanceType",
+                0x20 => "BusyStatus",
+                0x21 => "Location", // 2.5, 12.0, 12.1, 14.0 and 14.1. Since 16.0 AirSyncBase Location is used.
+                0x22 => "MeetingRequest",
+                0x23 => "Organizer",
+                0x24 => "RecurrenceId",
+                0x25 => "Reminder",
+                0x26 => "ResponseRequested",
+                0x27 => "Recurrences",
+                0x28 => "Recurrence",
+                0x29 => "Type",
+                0x2A => "Until",
+                0x2B => "Occurrences",
+                0x2C => "Interval",
+                0x2D => "DayOfWeek",
+                0x2E => "DayOfMonth",
+                0x2F => "WeekOfMonth",
+                0x30 => "MonthOfYear",
+                0x31 => "StartTime",
+                0x32 => "Sensitivity",
+                0x33 => "TimeZone",
+                0x34 => "GlobalObjId", // 2.5, 12.0, 12.1, 14.0 and 14.1. UID of Calendar (Code page 4) is used since 16.0
+                0x35 => "ThreadTopic",
+                0x36 => "MIMEData", // 2.5
+                0x37 => "MIMETruncated", // 2.5
+                0x38 => "MIMESize", // 2.5
+                0x39 => "InternetCPID",
+                0x3A => "Flag", // Since 12.0
+                0x3B => "FlagStatus", // Since 12.0
+                0x3C => "ContentClass", // Since 12.0
+                0x3D => "FlagType", // Since 12.0
+                0x3E => "CompleteTime", // Since 12.0
+                0x3F => "DisallowNewTimeProposal", // Since 14.0
+            ],
+            3 => [ // Code page 3 is no longer in use, however, tokens 05 through 17 have been defined. 20100501
+                0x05 => "Notify",
+                0x06 => "Notification",
+                0x07 => "Version",
+                0x08 => "Lifetime",
+                0x09 => "DeviceInfo",
+                0x0A => "Enable",
+                0x0B => "Folder",
+                0x0C => "ServerEntryId",
+                0x0D => "DeviceAddress",
+                0x0E => "ValidCarrierProfiles",
+                0x0F => "CarrierProfile",
+                0x10 => "Status",
+                0x11 => "Replies",
+                //                        0x05 => "Version='1.1'",
+                0x12 => "Devices",
+                0x13 => "Device",
+                0x14 => "Id",
+                0x15 => "Expiry",
+                0x16 => "NotifyGUID",
+            ],
+            4 => [
+                0x05 => "Timezone",
+                0x06 => "AllDayEvent",
+                0x07 => "Attendees",
+                0x08 => "Attendee",
+                0x09 => "Email",
+                0x0A => "Name",
+                0x0B => "Body", // AirSyncBase Body is used since 12.0
+                0x0C => "BodyTruncated", // AirSyncBase Body is used since 12.0
+                0x0D => "BusyStatus",
+                0x0E => "Categories",
+                0x0F => "Category",
+                0x10 => "Rtf", // 2.5 - deprecated
+                0x11 => "DtStamp",
+                0x12 => "EndTime",
+                0x13 => "Exception",
+                0x14 => "Exceptions",
+                0x15 => "Deleted",
+                0x16 => "ExceptionStartTime", // 2.5, 12.0, 12.1, 14.0 and 14.1.
+                0x17 => "Location", // 2.5, 12.0, 12.1, 14.0 and 14.1. Since 16.0 AirSyncBase Location is used.
+                0x18 => "MeetingStatus",
+                0x19 => "OrganizerEmail",
+                0x1A => "OrganizerName",
+                0x1B => "Recurrence",
+                0x1C => "Type",
+                0x1D => "Until",
+                0x1E => "Occurrences",
+                0x1F => "Interval",
+                0x20 => "DayOfWeek",
+                0x21 => "DayOfMonth",
+                0x22 => "WeekOfMonth",
+                0x23 => "MonthOfYear",
+                0x24 => "Reminder",
+                0x25 => "Sensitivity",
+                0x26 => "Subject",
+                0x27 => "StartTime",
+                0x28 => "UID",
+                0x29 => "Attendee_Status", // Since 12.0
+                0x2A => "Attendee_Type", // Since 12.0
+                0x2B => "Attachment", // Not defined / deprecated
+                0x2C => "Attachments", // Not defined / deprecated
+                0x2D => "AttName", // Not defined / deprecated
+                0x2E => "AttSize", // Not defined / deprecated
+                0x2F => "AttOid", // Not defined / deprecated
+                0x30 => "AttMethod", // Not defined / deprecated
+                0x31 => "AttRemoved", // Not defined / deprecated
+                0x32 => "DisplayName", // Not defined / deprecated
+                0x33 => "DisallowNewTimeProposal", // Since 14.0
+                0x34 => "ResponseRequested", // Since 14.0
+                0x35 => "AppointmentReplyTime", // Since 14.0
+                0x36 => "ResponseType", // Since 14.0
+                0x37 => "CalendarType", // Since 14.0
+                0x38 => "IsLeapMonth", // Since 14.0
+                0x39 => "FirstDayOfWeek", // Since 14.1
+                0x3A => "OnlineMeetingConfLink", // Since 14.1
+                0x3B => "OnlineMeetingExternalLink", // Since 14.1
+            ],
+            5 => [
+                0x05 => "Moves",
+                0x06 => "Move",
+                0x07 => "SrcMsgId",
+                0x08 => "SrcFldId",
+                0x09 => "DstFldId",
+                0x0A => "Response",
+                0x0B => "Status",
+                0x0C => "DstMsgId",
+            ],
+            6 => [
+                0x05 => "GetItemEstimate",
+                0x06 => "Version", // deprecated
+                0x07 => "Folders", // Collections
+                0x08 => "Folder", // Collection
+                0x09 => "FolderType", // AirSync Class(SYNC_FOLDERTYPE) is used since AS 14.0
+                0x0A => "FolderId", // CollectionId
+                0x0B => "DateTime", // deprecated
+                0x0C => "Estimate",
+                0x0D => "Response",
+                0x0E => "Status",
+            ],
+            7 => [
+                0x05 => "Folders", // 2.5, 12.0 and 12.1
+                0x06 => "Folder", // 2.5, 12.0 and 12.1
+                0x07 => "DisplayName",
+                0x08 => "ServerEntryId", // ServerId
+                0x09 => "ParentId",
+                0x0A => "Type",
+                0x0B => "Response", // deprecated
+                0x0C => "Status",
+                0x0D => "ContentClass", // deprecated
+                0x0E => "Changes",
+                0x0F => "Add",
+                0x10 => "Remove",
+                0x11 => "Update",
+                0x12 => "SyncKey",
+                0x13 => "FolderCreate",
+                0x14 => "FolderDelete",
+                0x15 => "FolderUpdate",
+                0x16 => "FolderSync",
+                0x17 => "Count",
+                0x18 => "Version", // 2.0 - not defined in 20100501
+            ],
+            8 => [
+                0x05 => "CalendarId",
+                0x06 => "FolderId", // CollectionId
+                0x07 => "MeetingResponse",
+                0x08 => "RequestId",
+                0x09 => "Request",
+                0x0A => "Result",
+                0x0B => "Status",
+                0x0C => "UserResponse",
+                0x0D => "Version", // 2.0 - not defined in 20100501
+                0x0E => "InstanceId", // Since AS 14.1
+            ],
+            9 => [
+                0x05 => "Body", // AirSyncBase Body is used since 12.0
+                0x06 => "BodySize", // AirSyncBase Body is used since 12.0
+                0x07 => "BodyTruncated", // AirSyncBase Body is used since 12.0
+                0x08 => "Categories",
+                0x09 => "Category",
+                0x0A => "Complete",
+                0x0B => "DateCompleted",
+                0x0C => "DueDate",
+                0x0D => "UtcDueDate",
+                0x0E => "Importance",
+                0x0F => "Recurrence",
+                0x10 => "Type",
+                0x11 => "Start",
+                0x12 => "Until",
+                0x13 => "Occurrences",
+                0x14 => "Interval",
+                0x15 => "DayOfMonth",
+                0x16 => "DayOfWeek",
+                0x17 => "WeekOfMonth",
+                0x18 => "MonthOfYear",
+                0x19 => "Regenerate",
+                0x1A => "DeadOccur",
+                0x1B => "ReminderSet",
+                0x1C => "ReminderTime",
+                0x1D => "Sensitivity",
+                0x1E => "StartDate",
+                0x1F => "UtcStartDate",
+                0x20 => "Subject",
+                0x21 => "Rtf", // deprecated
+                0x22 => "OrdinalDate", // Since 12.0
+                0x23 => "SubOrdinalDate", // Since 12.0
+                0x24 => "CalendarType", // Since 14.0
+                0x25 => "IsLeapMonth", // Since 14.0
+                0x26 => "FirstDayOfWeek", // Since 14.1
+            ],
+            0xA => [
+                0x05 => "ResolveRecipients",
+                0x06 => "Response",
+                0x07 => "Status",
+                0x08 => "Type",
+                0x09 => "Recipient",
+                0x0A => "DisplayName",
+                0x0B => "EmailAddress",
+                0x0C => "Certificates",
+                0x0D => "Certificate",
+                0x0E => "MiniCertificate",
+                0x0F => "Options",
+                0x10 => "To",
+                0x11 => "CertificateRetrieval",
+                0x12 => "RecipientCount",
+                0x13 => "MaxCertificates",
+                0x14 => "MaxAmbiguousRecipients",
+                0x15 => "CertificateCount",
+                0x16 => "Availability", // Since 14.0
+                0x17 => "StartTime", // Since 14.0
+                0x18 => "EndTime", // Since 14.0
+                0x19 => "MergedFreeBusy", // Since 14.0
+                0x1A => "Picture", // Since 14.1
+                0x1B => "MaxSize", // Since 14.1
+                0x1C => "Data", // Since 14.1
+                0x1D => "MaxPictures", // Since 14.1
+            ],
+            0xB => [
+                0x05 => "ValidateCert",
+                0x06 => "Certificates",
+                0x07 => "Certificate",
+                0x08 => "CertificateChain",
+                0x09 => "CheckCRL",
+                0x0A => "Status",
+            ],
+            0xC => [
+                0x05 => "CustomerId",
+                0x06 => "GovernmentId",
+                0x07 => "IMAddress",
+                0x08 => "IMAddress2",
+                0x09 => "IMAddress3",
+                0x0A => "ManagerName",
+                0x0B => "CompanyMainPhone",
+                0x0C => "AccountName",
+                0x0D => "NickName",
+                0x0E => "MMS",
+            ],
+            0xD => [
+                0x05 => "Ping",
+                0x06 => "AutdState", // (Not used by protocol)
+                0x07 => "Status",
+                0x08 => "LifeTime", // HeartbeatInterval
+                0x09 => "Folders",
+                0x0A => "Folder",
+                0x0B => "ServerEntryId", // Id
+                0x0C => "FolderType", // Class
+                0x0D => "MaxFolders",
+                0x0E => "Version", // not defined / deprecated
+            ],
+            0xE => [
+                0x05 => "Provision",
+                0x06 => "Policies",
+                0x07 => "Policy",
+                0x08 => "PolicyType",
+                0x09 => "PolicyKey",
+                0x0A => "Data",
+                0x0B => "Status",
+                0x0C => "RemoteWipe",
+                0x0D => "EASProvisionDoc", // Since 12.0
+                0x0E => "DevicePasswordEnabled", // Since 12.0
+                0x0F => "AlphanumericDevicePasswordRequired", // Since 12.0
+                0x10 => "DeviceEncryptionEnabled", // Since 12.1
+                // 0x10 => "RequireStorageCardEncryption", //Since 12.1
+                0x11 => "PasswordRecoveryEnabled", // Since 12.0
+                0x12 => "DocumentBrowseEnabled", // not defined / deprecated
+                0x13 => "AttachmentsEnabled", // Since 12.0
+                0x14 => "MinDevicePasswordLength", // Since 12.0
+                0x15 => "MaxInactivityTimeDeviceLock", // Since 12.0
+                0x16 => "MaxDevicePasswordFailedAttempts", // Since 12.0
+                0x17 => "MaxAttachmentSize", // Since 12.0
+                0x18 => "AllowSimpleDevicePassword", // Since 12.0
+                0x19 => "DevicePasswordExpiration", // Since 12.0
+                0x1A => "DevicePasswordHistory", // Since 12.0
+                0x1B => "AllowStorageCard", // Since 12.1
+                0x1C => "AllowCamera", // Since 12.1
+                0x1D => "RequireDeviceEncryption", // Since 12.1
+                0x1E => "AllowUnsignedApplications", // Since 12.1
+                0x1F => "AllowUnsignedInstallationPackages", // Since 12.1
+                0x20 => "MinDevicePasswordComplexCharacters", // Since 12.1
+                0x21 => "AllowWiFi", // Since 12.1
+                0x22 => "AllowTextMessaging", // Since 12.1
+                0x23 => "AllowPOPIMAPEmail", // Since 12.1
+                0x24 => "AllowBluetooth", // Since 12.1
+                0x25 => "AllowIrDA", // Since 12.1
+                0x26 => "RequireManualSyncWhenRoaming", // Since 12.1
+                0x27 => "AllowDesktopSync", // Since 12.1
+                0x28 => "MaxCalendarAgeFilter", // Since 12.1
+                0x29 => "AllowHTMLEmail", // Since 12.1
+                0x2A => "MaxEmailAgeFilter", // Since 12.1
+                0x2B => "MaxEmailBodyTruncationSize", // Since 12.1
+                0x2C => "MaxEmailHTMLBodyTruncationSize", // Since 12.1
+                0x2D => "RequireSignedSMIMEMessages", // Since 12.1
+                0x2E => "RequireEncryptedSMIMEMessages", // Since 12.1
+                0x2F => "RequireSignedSMIMEAlgorithm", // Since 12.1
+                0x30 => "RequireEncryptionSMIMEAlgorithm", // Since 12.1
+                0x31 => "AllowSMIMEEncryptionAlgorithmNegotiation", // Since 12.1
+                0x32 => "AllowSMIMESoftCerts", // Since 12.1
+                0x33 => "AllowBrowser", // Since 12.1
+                0x34 => "AllowConsumerEmail", // Since 12.1
+                0x35 => "AllowRemoteDesktop", // Since 12.1
+                0x36 => "AllowInternetSharing", // Since 12.1
+                0x37 => "UnapprovedInROMApplicationList", // Since 12.1
+                0x38 => "ApplicationName", // Since 12.1
+                0x39 => "ApprovedApplicationList", // Since 12.1
+                0x3A => "Hash", // Since 12.1
+            ],
+            0xF => [
+                0x05 => "Search",
+                0x07 => "Store",
+                0x08 => "Name",
+                0x09 => "Query",
+                0x0A => "Options",
+                0x0B => "Range",
+                0x0C => "Status",
+                0x0D => "Response",
+                0x0E => "Result",
+                0x0F => "Properties",
+                0x10 => "Total",
+                0x11 => "EqualTo",
+                0x12 => "Value",
+                0x13 => "And",
+                0x14 => "Or",
+                0x15 => "FreeText",
+                0x17 => "DeepTraversal",
+                0x18 => "LongId",
+                0x19 => "RebuildResults",
+                0x1A => "LessThan",
+                0x1B => "GreaterThan",
+                0x1C => "Schema",
+                0x1D => "Supported",
+                0x1E => "UserName", // Since 12.1
+                0x1F => "Password", // Since 12.1
+                0x20 => "ConversationId", // Since 14.0
+                0x21 => "Picture", // Since 14.1
+                0x22 => "MaxSize", // Since 14.1
+                0x23 => "MaxPictures", // Since 14.1
+            ],
+            0x10 => [
+                0x05 => "DisplayName",
+                0x06 => "Phone",
+                0x07 => "Office",
+                0x08 => "Title",
+                0x09 => "Company",
+                0x0A => "Alias",
+                0x0B => "FirstName",
+                0x0C => "LastName",
+                0x0D => "HomePhone",
+                0x0E => "MobilePhone",
+                0x0F => "EmailAddress",
+                0x10 => "Picture", // Since 14.1
+                0x11 => "Status", // Since 14.1
+                0x12 => "Data", // Since 14.1
+            ],
+            0x11 => [ // Since 12.0
+                0x05 => "BodyPreference",
+                0x06 => "Type",
+                0x07 => "TruncationSize",
+                0x08 => "AllOrNone",
+                0x0A => "Body",
+                0x0B => "Data",
+                0x0C => "EstimatedDataSize",
+                0x0D => "Truncated",
+                0x0E => "Attachments",
+                0x0F => "Attachment",
+                0x10 => "DisplayName",
+                0x11 => "FileReference",
+                0x12 => "Method",
+                0x13 => "ContentId",
+                0x14 => "ContentLocation",
+                0x15 => "IsInline",
+                0x16 => "NativeBodyType",
+                0x17 => "ContentType",
+                0x18 => "Preview", // Since 14.0
+                0x19 => "BodyPartPreference", // Since 14.1
+                0x1A => "BodyPart", // Since 14.1
+                0x1B => "Status", // Since 14.1
+            ],
+            0x12 => [ // Since 12.0
+                0x05 => "Settings",
+                0x06 => "Status",
+                0x07 => "Get",
+                0x08 => "Set",
+                0x09 => "Oof",
+                0x0A => "OofState",
+                0x0B => "StartTime",
+                0x0C => "EndTime",
+                0x0D => "OofMessage",
+                0x0E => "AppliesToInternal",
+                0x0F => "AppliesToExternalKnown",
+                0x10 => "AppliesToExternalUnknown",
+                0x11 => "Enabled",
+                0x12 => "ReplyMessage",
+                0x13 => "BodyType",
+                0x14 => "DevicePassword",
+                0x15 => "Password",
+                0x16 => "DeviceInformation",
+                0x17 => "Model",
+                0x18 => "IMEI",
+                0x19 => "FriendlyName",
+                0x1A => "OS",
+                0x1B => "OSLanguage",
+                0x1C => "PhoneNumber",
+                0x1D => "UserInformation",
+                0x1E => "EmailAddresses",
+                0x1F => "SmtpAddress",
+                0x20 => "UserAgent", // Since 12.1
+                0x21 => "EnableOutboundSMS", // Since 14.0
+                0x22 => "MobileOperator", // Since 14.0
+                0x23 => "PrimarySmtpAddress", // Since 14.1
+                0x24 => "Accounts", // Since 14.1
+                0x25 => "Account", // Since 14.1
+                0x26 => "AccountId", // Since 14.1
+                0x27 => "AccountName", // Since 14.1
+                0x28 => "UserDisplayName", // Since 14.1
+                0x29 => "SendDisabled", // Since 14.1
+                0x2B => "RightsManagementInformation", // Since 14.1
+            ],
+            0x13 => [ // Since 12.0
+                0x05 => "LinkId",
+                0x06 => "DisplayName",
+                0x07 => "IsFolder",
+                0x08 => "CreationDate",
+                0x09 => "LastModifiedDate",
+                0x0A => "IsHidden",
+                0x0B => "ContentLength",
+                0x0C => "ContentType",
+            ],
+            0x14 => [ // Since 12.0
+                0x05 => "ItemOperations",
+                0x06 => "Fetch",
+                0x07 => "Store",
+                0x08 => "Options",
+                0x09 => "Range",
+                0x0A => "Total",
+                0x0B => "Properties",
+                0x0C => "Data",
+                0x0D => "Status",
+                0x0E => "Response",
+                0x0F => "Version",
+                0x10 => "Schema",
+                0x11 => "Part",
+                0x12 => "EmptyFolderContents",
+                0x13 => "DeleteSubFolders",
+                0x14 => "UserName", // Since 12.1
+                0x15 => "Password", // Since 12.1
+                0x16 => "Move", // Since 14.0
+                0x17 => "DstFldId", // Since 14.0
+                0x18 => "ConversationId", // Since 14.0
+                0x19 => "MoveAlways", // Since 14.0
+            ],
+            0x15 => [ // Since 14.0
+                0x05 => "SendMail",
+                0x06 => "SmartForward",
+                0x07 => "SmartReply",
+                0x08 => "SaveInSentItems",
+                0x09 => "ReplaceMime",
+                0x0A => "Type", // not used
+                0x0B => "Source",
+                0x0C => "FolderId",
+                0x0D => "ItemId",
+                0x0E => "LongId",
+                0x0F => "InstanceId",
+                0x10 => "MIME",
+                0x11 => "ClientId",
+                0x12 => "Status",
+                0x13 => "AccountId", // Since 14.1
+            ],
+            0x16 => [ // Since 14.0
+                0x05 => "UmCallerId",
+                0x06 => "UmUserNotes",
+                0x07 => "UmAttDuration",
+                0x08 => "UmAttOrder",
+                0x09 => "ConversationId",
+                0x0A => "ConversationIndex",
+                0x0B => "LastVerbExecuted",
+                0x0C => "LastVerbExecutionTime",
+                0x0D => "ReceivedAsBcc",
+                0x0E => "Sender",
+                0x0F => "CalendarType",
+                0x10 => "IsLeapMonth",
+                0x11 => "AccountId", // Since 14.1
+                0x12 => "FirstDayOfWeek", // Since 14.1
+                0x13 => "MeetingMessageType", // Since 14.1
+            ],
+            0x17 => [ // Since 14.0
+                0x05 => "Subject",
+                0x06 => "MessageClass",
+                0x07 => "LastModifiedDate",
+                0x08 => "Categories",
+                0x09 => "Category",
+            ],
+            0x18 => [ // Since 14.1
+                0x05 => "RightsManagementSupport",
+                0x06 => "RightsManagementTemplates",
+                0x07 => "RightsManagementTemplate",
+                0x08 => "RightsManagementLicense",
+                0x09 => "EditAllowed",
+                0x0A => "ReplyAllowed",
+                0x0B => "ReplyAllAllowed",
+                0x0C => "ForwardAllowed",
+                0x0D => "ModifyRecipientsAllowed",
+                0x0E => "ExtractAllowed",
+                0x0F => "PrintAllowed",
+                0x10 => "ExportAllowed",
+                0x11 => "ProgrammaticAccessAllowed",
+                0x12 => "Owner",
+                0x13 => "ContentExpiryDate",
+                0x14 => "TemplateID",
+                0x15 => "TemplateName",
+                0x16 => "TemplateDescription",
+                0x17 => "ContentOwner",
+                0x18 => "RemoveRightsManagementProtection",
+            ],
+        ],
+        "namespaces" => [
+            // 0 => "AirSync", //
+            1 => "POOMCONTACTS",
+            2 => "POOMMAIL",
+            3 => "AirNotify", // no longer used
+            4 => "POOMCAL",
+            5 => "Move",
+            6 => "GetItemEstimate",
+            7 => "FolderHierarchy",
+            8 => "MeetingResponse",
+            9 => "POOMTASKS",
+            0xA => "ResolveRecipients",
+            0xB => "ValidateCert",
+            0xC => "POOMCONTACTS2",
+            0xD => "Ping",
+            0xE => "Provision",
+            0xF => "Search",
+            0x10 => "GAL",
+            0x11 => "AirSyncBase", // 12.0, 12.1 and 14.0
+            0x12 => "Settings", // 12.0, 12.1 and 14.0.
+            0x13 => "DocumentLibrary", // 12.0, 12.1 and 14.0
+            0x14 => "ItemOperations", // 12.0, 12.1 and 14.0
+            0x15 => "ComposeMail", // 14.0
+            0x16 => "POOMMAIL2", // 14.0
+            0x17 => "Notes", // 14.0
+            0x18 => "RightsManagement",
+        ],
+    ];
 }

Spacing +9 added lines, -9 removed lines

@@ -209,7 +209,7 @@ 
 				0x3E => "CompleteTime", // Since 12.0
 				0x3F => "DisallowNewTimeProposal", // Since 14.0
 			],
-			3 => [ // Code page 3 is no longer in use, however, tokens 05 through 17 have been defined. 20100501
+			3 => [// Code page 3 is no longer in use, however, tokens 05 through 17 have been defined. 20100501
 				0x05 => "Notify",
 				0x06 => "Notification",
 				0x07 => "Version",
@@ -542,7 +542,7 @@ 
 				0x11 => "Status", // Since 14.1
 				0x12 => "Data", // Since 14.1
 			],
-			0x11 => [ // Since 12.0
+			0x11 => [// Since 12.0
 				0x05 => "BodyPreference",
 				0x06 => "Type",
 				0x07 => "TruncationSize",
@@ -566,7 +566,7 @@ 
 				0x1A => "BodyPart", // Since 14.1
 				0x1B => "Status", // Since 14.1
 			],
-			0x12 => [ // Since 12.0
+			0x12 => [// Since 12.0
 				0x05 => "Settings",
 				0x06 => "Status",
 				0x07 => "Get",
@@ -606,7 +606,7 @@ 
 				0x29 => "SendDisabled", // Since 14.1
 				0x2B => "RightsManagementInformation", // Since 14.1
 			],
-			0x13 => [ // Since 12.0
+			0x13 => [// Since 12.0
 				0x05 => "LinkId",
 				0x06 => "DisplayName",
 				0x07 => "IsFolder",
@@ -616,7 +616,7 @@ 
 				0x0B => "ContentLength",
 				0x0C => "ContentType",
 			],
-			0x14 => [ // Since 12.0
+			0x14 => [// Since 12.0
 				0x05 => "ItemOperations",
 				0x06 => "Fetch",
 				0x07 => "Store",
@@ -639,7 +639,7 @@ 
 				0x18 => "ConversationId", // Since 14.0
 				0x19 => "MoveAlways", // Since 14.0
 			],
-			0x15 => [ // Since 14.0
+			0x15 => [// Since 14.0
 				0x05 => "SendMail",
 				0x06 => "SmartForward",
 				0x07 => "SmartReply",
@@ -656,7 +656,7 @@ 
 				0x12 => "Status",
 				0x13 => "AccountId", // Since 14.1
 			],
-			0x16 => [ // Since 14.0
+			0x16 => [// Since 14.0
 				0x05 => "UmCallerId",
 				0x06 => "UmUserNotes",
 				0x07 => "UmAttDuration",
@@ -673,14 +673,14 @@ 
 				0x12 => "FirstDayOfWeek", // Since 14.1
 				0x13 => "MeetingMessageType", // Since 14.1
 			],
-			0x17 => [ // Since 14.0
+			0x17 => [// Since 14.0
 				0x05 => "Subject",
 				0x06 => "MessageClass",
 				0x07 => "LastModifiedDate",
 				0x08 => "Categories",
 				0x09 => "Category",
 			],
-			0x18 => [ // Since 14.1
+			0x18 => [// Since 14.1
 				0x05 => "RightsManagementSupport",
 				0x06 => "RightsManagementTemplates",
 				0x07 => "RightsManagementTemplate",

lib/wbxml/wbxmlencoder.php

Indentation +507 added lines, -507 removed lines

@@ -8,514 +8,514 @@
  */
 
 class WBXMLEncoder extends WBXMLDefs {
-	private $_dtd;
-	private $_out;
-	private $_tagcp = 0;
-	private $log = false;
-	private $logStack = [];
-
-	// We use a delayed output mechanism in which we only output a tag when it actually has something
-	// in it. This can cause entire XML trees to disappear if they don't have output data in them; Ie
-	// calling 'startTag' 10 times, and then 'endTag' will cause 0 bytes of output apart from the header.
-
-	// Only when content() is called do we output the current stack of tags
-
-	private $_stack;
-	private $multipart; // the content is multipart
-	private $bodyparts;
-
-	public function __construct($output, $multipart = false) {
-		$this->log = SLog::IsWbxmlDebugEnabled();
-		$this->_out = $output;
-
-		// reverse-map the DTD
-		foreach ($this->dtd["namespaces"] as $nsid => $nsname) {
-			$this->_dtd["namespaces"][$nsname] = $nsid;
-		}
-
-		foreach ($this->dtd["codes"] as $cp => $value) {
-			$this->_dtd["codes"][$cp] = [];
-			foreach ($this->dtd["codes"][$cp] as $tagid => $tagname) {
-				$this->_dtd["codes"][$cp][$tagname] = $tagid;
-			}
-		}
-		$this->_stack = [];
-		$this->multipart = $multipart;
-		$this->bodyparts = [];
-	}
-
-	/**
-	 * Puts the WBXML header on the stream.
-	 *
-	 * @return
-	 */
-	public function startWBXML() {
-		if ($this->multipart) {
-			header("Content-Type: application/vnd.ms-sync.multipart");
-			SLog::Write(LOGLEVEL_DEBUG, "WBXMLEncoder->startWBXML() type: vnd.ms-sync.multipart");
-		}
-		else {
-			header("Content-Type: application/vnd.ms-sync.wbxml");
-			SLog::Write(LOGLEVEL_DEBUG, "WBXMLEncoder->startWBXML() type: vnd.ms-sync.wbxml");
-		}
-
-		$this->outByte(0x03); // WBXML 1.3
-		$this->outMBUInt(0x01); // Public ID 1
-		$this->outMBUInt(106); // UTF-8
-		$this->outMBUInt(0x00); // string table length (0)
-	}
-
-	/**
-	 * Puts a StartTag on the output stack.
-	 *
-	 * @param $tag
-	 * @param $attributes
-	 * @param $nocontent
-	 *
-	 * @return
-	 */
-	public function startTag($tag, $attributes = false, $nocontent = false) {
-		$stackelem = [];
-
-		if (!$nocontent) {
-			$stackelem['tag'] = $tag;
-			$stackelem['nocontent'] = $nocontent;
-			$stackelem['sent'] = false;
-
-			array_push($this->_stack, $stackelem);
-
-		// If 'nocontent' is specified, then apparently the user wants to force
-			// output of an empty tag, and we therefore output the stack here
-		}
-		else {
-			$this->_outputStack();
-			$this->_startTag($tag, $nocontent);
-		}
-	}
-
-	/**
-	 * Puts an EndTag on the stack.
-	 *
-	 * @return
-	 */
-	public function endTag() {
-		$stackelem = array_pop($this->_stack);
-
-		// Only output end tags for items that have had a start tag sent
-		if ($stackelem['sent']) {
-			$this->_endTag();
-
-			if (count($this->_stack) == 0) {
-				SLog::Write(LOGLEVEL_DEBUG, "WBXMLEncoder->endTag() WBXML output completed");
-			}
-			if (count($this->_stack) == 0 && $this->multipart == true) {
-				$this->processMultipart();
-			}
-			if (count($this->_stack) == 0) {
-				$this->writeLog();
-			}
-		}
-	}
-
-	/**
-	 * Puts content on the output stack.
-	 *
-	 * @param string $content
-	 *
-	 * @return
-	 */
-	public function content($content) {
-		// We need to filter out any \0 chars because it's the string terminator in WBXML. We currently
-		// cannot send \0 characters within the XML content anywhere.
-		$content = str_replace("\0", "", $content);
-		if ("x" . $content == "x") {
-			return;
-		}
-		$this->_outputStack();
-		$this->_content($content);
-	}
-
-	/**
-	 * Puts content of a stream on the output stack AND closes it.
-	 *
-	 * @param resource $stream
-	 * @param bool     $asBase64 if true, the data will be encoded as base64, default: false
-	 * @param bool     $opaque   if true, output the opaque data, default: false
-	 *
-	 * @return
-	 */
-	public function contentStream($stream, $asBase64 = false, $opaque = false) {
-		// Do not append filters to opaque data as it might contain null char
-		if (!$asBase64 && !$opaque) {
-			stream_filter_register('replacenullchar', 'ReplaceNullcharFilter');
-			$rnc_filter = stream_filter_append($stream, 'replacenullchar');
-		}
-
-		$this->_outputStack();
-		$this->_contentStream($stream, $asBase64, $opaque);
-
-		if (!$asBase64 && !$opaque) {
-			stream_filter_remove($rnc_filter);
-		}
-
-		fclose($stream);
-	}
-
-	/**
-	 * Gets the value of multipart.
-	 *
-	 * @return bool
-	 */
-	public function getMultipart() {
-		return $this->multipart;
-	}
-
-	/**
-	 * Adds a bodypart.
-	 *
-	 * @param Stream $bp
-	 */
-	public function addBodypartStream($bp) {
-		if (!is_resource($bp)) {
-			throw new WBXMLException("WBXMLEncoder->addBodypartStream(): trying to add a " . gettype($bp) . " instead of a stream");
-		}
-		if ($this->multipart) {
-			$this->bodyparts[] = $bp;
-		}
-	}
-
-	/**
-	 * Gets the number of bodyparts.
-	 *
-	 * @return int
-	 */
-	public function getBodypartsCount() {
-		return count($this->bodyparts);
-	}
-
-	/*----------------------------------------------------------------------------------------------------------
+    private $_dtd;
+    private $_out;
+    private $_tagcp = 0;
+    private $log = false;
+    private $logStack = [];
+
+    // We use a delayed output mechanism in which we only output a tag when it actually has something
+    // in it. This can cause entire XML trees to disappear if they don't have output data in them; Ie
+    // calling 'startTag' 10 times, and then 'endTag' will cause 0 bytes of output apart from the header.
+
+    // Only when content() is called do we output the current stack of tags
+
+    private $_stack;
+    private $multipart; // the content is multipart
+    private $bodyparts;
+
+    public function __construct($output, $multipart = false) {
+        $this->log = SLog::IsWbxmlDebugEnabled();
+        $this->_out = $output;
+
+        // reverse-map the DTD
+        foreach ($this->dtd["namespaces"] as $nsid => $nsname) {
+            $this->_dtd["namespaces"][$nsname] = $nsid;
+        }
+
+        foreach ($this->dtd["codes"] as $cp => $value) {
+            $this->_dtd["codes"][$cp] = [];
+            foreach ($this->dtd["codes"][$cp] as $tagid => $tagname) {
+                $this->_dtd["codes"][$cp][$tagname] = $tagid;
+            }
+        }
+        $this->_stack = [];
+        $this->multipart = $multipart;
+        $this->bodyparts = [];
+    }
+
+    /**
+     * Puts the WBXML header on the stream.
+     *
+     * @return
+     */
+    public function startWBXML() {
+        if ($this->multipart) {
+            header("Content-Type: application/vnd.ms-sync.multipart");
+            SLog::Write(LOGLEVEL_DEBUG, "WBXMLEncoder->startWBXML() type: vnd.ms-sync.multipart");
+        }
+        else {
+            header("Content-Type: application/vnd.ms-sync.wbxml");
+            SLog::Write(LOGLEVEL_DEBUG, "WBXMLEncoder->startWBXML() type: vnd.ms-sync.wbxml");
+        }
+
+        $this->outByte(0x03); // WBXML 1.3
+        $this->outMBUInt(0x01); // Public ID 1
+        $this->outMBUInt(106); // UTF-8
+        $this->outMBUInt(0x00); // string table length (0)
+    }
+
+    /**
+     * Puts a StartTag on the output stack.
+     *
+     * @param $tag
+     * @param $attributes
+     * @param $nocontent
+     *
+     * @return
+     */
+    public function startTag($tag, $attributes = false, $nocontent = false) {
+        $stackelem = [];
+
+        if (!$nocontent) {
+            $stackelem['tag'] = $tag;
+            $stackelem['nocontent'] = $nocontent;
+            $stackelem['sent'] = false;
+
+            array_push($this->_stack, $stackelem);
+
+        // If 'nocontent' is specified, then apparently the user wants to force
+            // output of an empty tag, and we therefore output the stack here
+        }
+        else {
+            $this->_outputStack();
+            $this->_startTag($tag, $nocontent);
+        }
+    }
+
+    /**
+     * Puts an EndTag on the stack.
+     *
+     * @return
+     */
+    public function endTag() {
+        $stackelem = array_pop($this->_stack);
+
+        // Only output end tags for items that have had a start tag sent
+        if ($stackelem['sent']) {
+            $this->_endTag();
+
+            if (count($this->_stack) == 0) {
+                SLog::Write(LOGLEVEL_DEBUG, "WBXMLEncoder->endTag() WBXML output completed");
+            }
+            if (count($this->_stack) == 0 && $this->multipart == true) {
+                $this->processMultipart();
+            }
+            if (count($this->_stack) == 0) {
+                $this->writeLog();
+            }
+        }
+    }
+
+    /**
+     * Puts content on the output stack.
+     *
+     * @param string $content
+     *
+     * @return
+     */
+    public function content($content) {
+        // We need to filter out any \0 chars because it's the string terminator in WBXML. We currently
+        // cannot send \0 characters within the XML content anywhere.
+        $content = str_replace("\0", "", $content);
+        if ("x" . $content == "x") {
+            return;
+        }
+        $this->_outputStack();
+        $this->_content($content);
+    }
+
+    /**
+     * Puts content of a stream on the output stack AND closes it.
+     *
+     * @param resource $stream
+     * @param bool     $asBase64 if true, the data will be encoded as base64, default: false
+     * @param bool     $opaque   if true, output the opaque data, default: false
+     *
+     * @return
+     */
+    public function contentStream($stream, $asBase64 = false, $opaque = false) {
+        // Do not append filters to opaque data as it might contain null char
+        if (!$asBase64 && !$opaque) {
+            stream_filter_register('replacenullchar', 'ReplaceNullcharFilter');
+            $rnc_filter = stream_filter_append($stream, 'replacenullchar');
+        }
+
+        $this->_outputStack();
+        $this->_contentStream($stream, $asBase64, $opaque);
+
+        if (!$asBase64 && !$opaque) {
+            stream_filter_remove($rnc_filter);
+        }
+
+        fclose($stream);
+    }
+
+    /**
+     * Gets the value of multipart.
+     *
+     * @return bool
+     */
+    public function getMultipart() {
+        return $this->multipart;
+    }
+
+    /**
+     * Adds a bodypart.
+     *
+     * @param Stream $bp
+     */
+    public function addBodypartStream($bp) {
+        if (!is_resource($bp)) {
+            throw new WBXMLException("WBXMLEncoder->addBodypartStream(): trying to add a " . gettype($bp) . " instead of a stream");
+        }
+        if ($this->multipart) {
+            $this->bodyparts[] = $bp;
+        }
+    }
+
+    /**
+     * Gets the number of bodyparts.
+     *
+     * @return int
+     */
+    public function getBodypartsCount() {
+        return count($this->bodyparts);
+    }
+
+    /*----------------------------------------------------------------------------------------------------------
 	 * Private WBXMLEncoder stuff
 	 */
 
-	/**
-	 * Output any tags on the stack that haven't been output yet.
-	 *
-	 * @return
-	 */
-	private function _outputStack() {
-		for ($i = 0; $i < count($this->_stack); ++$i) {
-			if (!$this->_stack[$i]['sent']) {
-				$this->_startTag($this->_stack[$i]['tag'], $this->_stack[$i]['nocontent']);
-				$this->_stack[$i]['sent'] = true;
-			}
-		}
-	}
-
-	/**
-	 * Outputs an actual start tag.
-	 *
-	 * @param mixed $tag
-	 * @param mixed $nocontent
-	 *
-	 * @return
-	 */
-	private function _startTag($tag, $nocontent = false) {
-		if ($this->log) {
-			$this->logStartTag($tag, $nocontent);
-		}
-
-		$mapping = $this->getMapping($tag);
-
-		if (!$mapping) {
-			return false;
-		}
-
-		if ($this->_tagcp != $mapping["cp"]) {
-			$this->outSwitchPage($mapping["cp"]);
-			$this->_tagcp = $mapping["cp"];
-		}
-
-		$code = $mapping["code"];
-
-		if (!isset($nocontent) || !$nocontent) {
-			$code |= 0x40;
-		}
-
-		$this->outByte($code);
-	}
-
-	/**
-	 * Outputs actual data.
-	 *
-	 * @param string $content
-	 *
-	 * @return
-	 */
-	private function _content($content) {
-		if ($this->log) {
-			$this->logContent($content);
-		}
-		$this->outByte(self::WBXML_STR_I);
-		$this->outTermStr($content);
-	}
-
-	/**
-	 * Outputs actual data coming from a stream, optionally encoded as base64.
-	 *
-	 * @param resource $stream
-	 * @param bool     $asBase64
-	 * @param mixed    $opaque
-	 *
-	 * @return
-	 */
-	private function _contentStream($stream, $asBase64, $opaque) {
-		$stat = fstat($stream);
-		// write full stream, including the finalizing terminator to the output stream (stuff outTermStr() would do)
-		if ($opaque) {
-			$this->outByte(self::WBXML_OPAQUE);
-			$this->outMBUInt($stat['size']);
-		}
-		else {
-			$this->outByte(self::WBXML_STR_I);
-		}
-
-		if ($asBase64) {
-			$out_filter = stream_filter_append($this->_out, 'convert.base64-encode');
-		}
-		$written = stream_copy_to_stream($stream, $this->_out);
-		if ($asBase64) {
-			stream_filter_remove($out_filter);
-		}
-		if (!$opaque) {
-			fwrite($this->_out, chr(0));
-		}
-
-		if ($this->log) {
-			// data is out, do some logging
-			$this->logContent(sprintf("<<< written %d of %d bytes of %s data >>>", $written, $stat['size'], $asBase64 ? "base64 encoded" : "plain"));
-		}
-	}
-
-	/**
-	 * Outputs an actual end tag.
-	 *
-	 * @return
-	 */
-	private function _endTag() {
-		if ($this->log) {
-			$this->logEndTag();
-		}
-		$this->outByte(self::WBXML_END);
-	}
-
-	/**
-	 * Outputs a byte.
-	 *
-	 * @param $byte
-	 *
-	 * @return
-	 */
-	private function outByte($byte) {
-		fwrite($this->_out, chr($byte));
-	}
-
-	/**
-	 * Output the multibyte integers to the stream.
-	 *
-	 * A multi-byte integer consists of a series of octets,
-	 * where the most significant bit is the continuation flag
-	 * and the remaining seven bits are a scalar value.
-	 * The octets are arranged in a big-endian order,
-	 * eg, the most significant seven bits are transmitted first.
-	 *
-	 * @see https://www.w3.org/1999/06/NOTE-wbxml-19990624/#_Toc443384895
-	 *
-	 * @param int $uint
-	 */
-	private function outMBUInt($uint) {
-		if ($uint == 0x0) {
-			return $this->outByte($uint);
-		}
-
-		$out = '';
-
-		for ($i = 0; $uint != 0; ++$i) {
-			$byte = $uint & 0x7F;
-			$uint = $uint >> 7;
-			if ($i == 0) {
-				$out = chr($byte) . $out;
-			}
-			else {
-				$out = chr($byte | 0x80) . $out;
-			}
-		}
-		fwrite($this->_out, $out);
-	}
-
-	/**
-	 * Outputs content with string terminator.
-	 *
-	 * @param $content
-	 *
-	 * @return
-	 */
-	private function outTermStr($content) {
-		fwrite($this->_out, $content);
-		fwrite($this->_out, chr(0));
-	}
-
-	/**
-	 * Switches the codepage.
-	 *
-	 * @param $page
-	 *
-	 * @return
-	 */
-	private function outSwitchPage($page) {
-		$this->outByte(self::WBXML_SWITCH_PAGE);
-		$this->outByte($page);
-	}
-
-	/**
-	 * Get the mapping for a tag.
-	 *
-	 * @param $tag
-	 *
-	 * @return array
-	 */
-	private function getMapping($tag) {
-		$mapping = [];
-
-		$split = $this->splitTag($tag);
-
-		if (isset($split["ns"])) {
-			$cp = $this->_dtd["namespaces"][$split["ns"]];
-		}
-		else {
-			$cp = 0;
-		}
-
-		$code = $this->_dtd["codes"][$cp][$split["tag"]];
-
-		$mapping["cp"] = $cp;
-		$mapping["code"] = $code;
-
-		return $mapping;
-	}
-
-	/**
-	 * Split a tag from a the fulltag (namespace + tag).
-	 *
-	 * @param $fulltag
-	 *
-	 * @return array keys: 'ns' (namespace), 'tag' (tag)
-	 */
-	private function splitTag($fulltag) {
-		$ns = false;
-		$pos = strpos($fulltag, chr(58)); // chr(58) == ':'
-
-		if ($pos) {
-			$ns = substr($fulltag, 0, $pos);
-			$tag = substr($fulltag, $pos + 1);
-		}
-		else {
-			$tag = $fulltag;
-		}
-
-		$ret = [];
-		if ($ns) {
-			$ret["ns"] = $ns;
-		}
-		$ret["tag"] = $tag;
-
-		return $ret;
-	}
-
-	/**
-	 * Logs a StartTag to SLog.
-	 *
-	 * @param $tag
-	 * @param $nocontent
-	 *
-	 * @return
-	 */
-	private function logStartTag($tag, $nocontent) {
-		$spaces = str_repeat(" ", count($this->logStack));
-		if ($nocontent) {
-			SLog::Write(LOGLEVEL_WBXML, "O " . $spaces . " <{$tag}/>");
-		}
-		else {
-			array_push($this->logStack, $tag);
-			SLog::Write(LOGLEVEL_WBXML, "O " . $spaces . " <{$tag}>");
-		}
-	}
-
-	/**
-	 * Logs a EndTag to SLog.
-	 *
-	 * @return
-	 */
-	private function logEndTag() {
-		$spaces = str_repeat(" ", count($this->logStack));
-		$tag = array_pop($this->logStack);
-		SLog::Write(LOGLEVEL_WBXML, "O " . $spaces . "</{$tag}>");
-	}
-
-	/**
-	 * Logs content to SLog.
-	 *
-	 * @param string $content
-	 *
-	 * @return
-	 */
-	private function logContent($content) {
-		$spaces = str_repeat(" ", count($this->logStack));
-		SLog::Write(LOGLEVEL_WBXML, "O " . $spaces . $content);
-	}
-
-	/**
-	 * Processes the multipart response.
-	 */
-	private function processMultipart() {
-		SLog::Write(LOGLEVEL_DEBUG, sprintf("WBXMLEncoder->processMultipart() with %d parts to be processed", $this->getBodypartsCount()));
-		$len = ob_get_length();
-		$buffer = ob_get_clean();
-		$nrBodyparts = $this->getBodypartsCount();
-		$blockstart = (($nrBodyparts + 1) * 2) * 4 + 4;
-
-		fwrite($this->_out, pack("iii", ($nrBodyparts + 1), $blockstart, $len));
-
-		foreach ($this->bodyparts as $i => $bp) {
-			$blockstart = $blockstart + $len;
-			$len = fstat($bp);
-			$len = (isset($len['size'])) ? $len['size'] : 0;
-			if ($len == 0) {
-				SLog::Write(LOGLEVEL_WARN, sprintf("WBXMLEncoder->processMultipart(): the length of the body part at position %d is 0", $i));
-			}
-			fwrite($this->_out, pack("ii", $blockstart, $len));
-		}
-
-		fwrite($this->_out, $buffer);
-
-		foreach ($this->bodyparts as $bp) {
-			stream_copy_to_stream($bp, $this->_out);
-			fclose($bp);
-		}
-	}
-
-	/**
-	 * Writes the sent WBXML data to the log if it is not bigger than 512K.
-	 */
-	private function writeLog() {
-		if (ob_get_length() === false) {
-			$data = "output buffer disabled";
-		}
-		elseif (ob_get_length() < 524288) {
-			$data = base64_encode(ob_get_contents());
-		}
-		else {
-			$data = "more than 512K of data";
-		}
-		SLog::Write(LOGLEVEL_WBXML, "WBXML-OUT: " . $data, false);
-	}
+    /**
+     * Output any tags on the stack that haven't been output yet.
+     *
+     * @return
+     */
+    private function _outputStack() {
+        for ($i = 0; $i < count($this->_stack); ++$i) {
+            if (!$this->_stack[$i]['sent']) {
+                $this->_startTag($this->_stack[$i]['tag'], $this->_stack[$i]['nocontent']);
+                $this->_stack[$i]['sent'] = true;
+            }
+        }
+    }
+
+    /**
+     * Outputs an actual start tag.
+     *
+     * @param mixed $tag
+     * @param mixed $nocontent
+     *
+     * @return
+     */
+    private function _startTag($tag, $nocontent = false) {
+        if ($this->log) {
+            $this->logStartTag($tag, $nocontent);
+        }
+
+        $mapping = $this->getMapping($tag);
+
+        if (!$mapping) {
+            return false;
+        }
+
+        if ($this->_tagcp != $mapping["cp"]) {
+            $this->outSwitchPage($mapping["cp"]);
+            $this->_tagcp = $mapping["cp"];
+        }
+
+        $code = $mapping["code"];
+
+        if (!isset($nocontent) || !$nocontent) {
+            $code |= 0x40;
+        }
+
+        $this->outByte($code);
+    }
+
+    /**
+     * Outputs actual data.
+     *
+     * @param string $content
+     *
+     * @return
+     */
+    private function _content($content) {
+        if ($this->log) {
+            $this->logContent($content);
+        }
+        $this->outByte(self::WBXML_STR_I);
+        $this->outTermStr($content);
+    }
+
+    /**
+     * Outputs actual data coming from a stream, optionally encoded as base64.
+     *
+     * @param resource $stream
+     * @param bool     $asBase64
+     * @param mixed    $opaque
+     *
+     * @return
+     */
+    private function _contentStream($stream, $asBase64, $opaque) {
+        $stat = fstat($stream);
+        // write full stream, including the finalizing terminator to the output stream (stuff outTermStr() would do)
+        if ($opaque) {
+            $this->outByte(self::WBXML_OPAQUE);
+            $this->outMBUInt($stat['size']);
+        }
+        else {
+            $this->outByte(self::WBXML_STR_I);
+        }
+
+        if ($asBase64) {
+            $out_filter = stream_filter_append($this->_out, 'convert.base64-encode');
+        }
+        $written = stream_copy_to_stream($stream, $this->_out);
+        if ($asBase64) {
+            stream_filter_remove($out_filter);
+        }
+        if (!$opaque) {
+            fwrite($this->_out, chr(0));
+        }
+
+        if ($this->log) {
+            // data is out, do some logging
+            $this->logContent(sprintf("<<< written %d of %d bytes of %s data >>>", $written, $stat['size'], $asBase64 ? "base64 encoded" : "plain"));
+        }
+    }
+
+    /**
+     * Outputs an actual end tag.
+     *
+     * @return
+     */
+    private function _endTag() {
+        if ($this->log) {
+            $this->logEndTag();
+        }
+        $this->outByte(self::WBXML_END);
+    }
+
+    /**
+     * Outputs a byte.
+     *
+     * @param $byte
+     *
+     * @return
+     */
+    private function outByte($byte) {
+        fwrite($this->_out, chr($byte));
+    }
+
+    /**
+     * Output the multibyte integers to the stream.
+     *
+     * A multi-byte integer consists of a series of octets,
+     * where the most significant bit is the continuation flag
+     * and the remaining seven bits are a scalar value.
+     * The octets are arranged in a big-endian order,
+     * eg, the most significant seven bits are transmitted first.
+     *
+     * @see https://www.w3.org/1999/06/NOTE-wbxml-19990624/#_Toc443384895
+     *
+     * @param int $uint
+     */
+    private function outMBUInt($uint) {
+        if ($uint == 0x0) {
+            return $this->outByte($uint);
+        }
+
+        $out = '';
+
+        for ($i = 0; $uint != 0; ++$i) {
+            $byte = $uint & 0x7F;
+            $uint = $uint >> 7;
+            if ($i == 0) {
+                $out = chr($byte) . $out;
+            }
+            else {
+                $out = chr($byte | 0x80) . $out;
+            }
+        }
+        fwrite($this->_out, $out);
+    }
+
+    /**
+     * Outputs content with string terminator.
+     *
+     * @param $content
+     *
+     * @return
+     */
+    private function outTermStr($content) {
+        fwrite($this->_out, $content);
+        fwrite($this->_out, chr(0));
+    }
+
+    /**
+     * Switches the codepage.
+     *
+     * @param $page
+     *
+     * @return
+     */
+    private function outSwitchPage($page) {
+        $this->outByte(self::WBXML_SWITCH_PAGE);
+        $this->outByte($page);
+    }
+
+    /**
+     * Get the mapping for a tag.
+     *
+     * @param $tag
+     *
+     * @return array
+     */
+    private function getMapping($tag) {
+        $mapping = [];
+
+        $split = $this->splitTag($tag);
+
+        if (isset($split["ns"])) {
+            $cp = $this->_dtd["namespaces"][$split["ns"]];
+        }
+        else {
+            $cp = 0;
+        }
+
+        $code = $this->_dtd["codes"][$cp][$split["tag"]];
+
+        $mapping["cp"] = $cp;
+        $mapping["code"] = $code;
+
+        return $mapping;
+    }
+
+    /**
+     * Split a tag from a the fulltag (namespace + tag).
+     *
+     * @param $fulltag
+     *
+     * @return array keys: 'ns' (namespace), 'tag' (tag)
+     */
+    private function splitTag($fulltag) {
+        $ns = false;
+        $pos = strpos($fulltag, chr(58)); // chr(58) == ':'
+
+        if ($pos) {
+            $ns = substr($fulltag, 0, $pos);
+            $tag = substr($fulltag, $pos + 1);
+        }
+        else {
+            $tag = $fulltag;
+        }
+
+        $ret = [];
+        if ($ns) {
+            $ret["ns"] = $ns;
+        }
+        $ret["tag"] = $tag;
+
+        return $ret;
+    }
+
+    /**
+     * Logs a StartTag to SLog.
+     *
+     * @param $tag
+     * @param $nocontent
+     *
+     * @return
+     */
+    private function logStartTag($tag, $nocontent) {
+        $spaces = str_repeat(" ", count($this->logStack));
+        if ($nocontent) {
+            SLog::Write(LOGLEVEL_WBXML, "O " . $spaces . " <{$tag}/>");
+        }
+        else {
+            array_push($this->logStack, $tag);
+            SLog::Write(LOGLEVEL_WBXML, "O " . $spaces . " <{$tag}>");
+        }
+    }
+
+    /**
+     * Logs a EndTag to SLog.
+     *
+     * @return
+     */
+    private function logEndTag() {
+        $spaces = str_repeat(" ", count($this->logStack));
+        $tag = array_pop($this->logStack);
+        SLog::Write(LOGLEVEL_WBXML, "O " . $spaces . "</{$tag}>");
+    }
+
+    /**
+     * Logs content to SLog.
+     *
+     * @param string $content
+     *
+     * @return
+     */
+    private function logContent($content) {
+        $spaces = str_repeat(" ", count($this->logStack));
+        SLog::Write(LOGLEVEL_WBXML, "O " . $spaces . $content);
+    }
+
+    /**
+     * Processes the multipart response.
+     */
+    private function processMultipart() {
+        SLog::Write(LOGLEVEL_DEBUG, sprintf("WBXMLEncoder->processMultipart() with %d parts to be processed", $this->getBodypartsCount()));
+        $len = ob_get_length();
+        $buffer = ob_get_clean();
+        $nrBodyparts = $this->getBodypartsCount();
+        $blockstart = (($nrBodyparts + 1) * 2) * 4 + 4;
+
+        fwrite($this->_out, pack("iii", ($nrBodyparts + 1), $blockstart, $len));
+
+        foreach ($this->bodyparts as $i => $bp) {
+            $blockstart = $blockstart + $len;
+            $len = fstat($bp);
+            $len = (isset($len['size'])) ? $len['size'] : 0;
+            if ($len == 0) {
+                SLog::Write(LOGLEVEL_WARN, sprintf("WBXMLEncoder->processMultipart(): the length of the body part at position %d is 0", $i));
+            }
+            fwrite($this->_out, pack("ii", $blockstart, $len));
+        }
+
+        fwrite($this->_out, $buffer);
+
+        foreach ($this->bodyparts as $bp) {
+            stream_copy_to_stream($bp, $this->_out);
+            fclose($bp);
+        }
+    }
+
+    /**
+     * Writes the sent WBXML data to the log if it is not bigger than 512K.
+     */
+    private function writeLog() {
+        if (ob_get_length() === false) {
+            $data = "output buffer disabled";
+        }
+        elseif (ob_get_length() < 524288) {
+            $data = base64_encode(ob_get_contents());
+        }
+        else {
+            $data = "more than 512K of data";
+        }
+        SLog::Write(LOGLEVEL_WBXML, "WBXML-OUT: " . $data, false);
+    }
 }

Spacing +9 added lines, -9 removed lines

@@ -128,7 +128,7 @@ 
 		// We need to filter out any \0 chars because it's the string terminator in WBXML. We currently
 		// cannot send \0 characters within the XML content anywhere.
 		$content = str_replace("\0", "", $content);
-		if ("x" . $content == "x") {
+		if ("x".$content == "x") {
 			return;
 		}
 		$this->_outputStack();
@@ -177,7 +177,7 @@ 
 	 */
 	public function addBodypartStream($bp) {
 		if (!is_resource($bp)) {
-			throw new WBXMLException("WBXMLEncoder->addBodypartStream(): trying to add a " . gettype($bp) . " instead of a stream");
+			throw new WBXMLException("WBXMLEncoder->addBodypartStream(): trying to add a ".gettype($bp)." instead of a stream");
 		}
 		if ($this->multipart) {
 			$this->bodyparts[] = $bp;
@@ -343,10 +343,10 @@ 
 			$byte = $uint & 0x7F;
 			$uint = $uint >> 7;
 			if ($i == 0) {
-				$out = chr($byte) . $out;
+				$out = chr($byte).$out;
 			}
 			else {
-				$out = chr($byte | 0x80) . $out;
+				$out = chr($byte|0x80).$out;
 			}
 		}
 		fwrite($this->_out, $out);
@@ -442,11 +442,11 @@ 
 	private function logStartTag($tag, $nocontent) {
 		$spaces = str_repeat(" ", count($this->logStack));
 		if ($nocontent) {
-			SLog::Write(LOGLEVEL_WBXML, "O " . $spaces . " <{$tag}/>");
+			SLog::Write(LOGLEVEL_WBXML, "O ".$spaces." <{$tag}/>");
 		}
 		else {
 			array_push($this->logStack, $tag);
-			SLog::Write(LOGLEVEL_WBXML, "O " . $spaces . " <{$tag}>");
+			SLog::Write(LOGLEVEL_WBXML, "O ".$spaces." <{$tag}>");
 		}
 	}
 
@@ -458,7 +458,7 @@ 
 	private function logEndTag() {
 		$spaces = str_repeat(" ", count($this->logStack));
 		$tag = array_pop($this->logStack);
-		SLog::Write(LOGLEVEL_WBXML, "O " . $spaces . "</{$tag}>");
+		SLog::Write(LOGLEVEL_WBXML, "O ".$spaces."</{$tag}>");
 	}
 
 	/**
@@ -470,7 +470,7 @@ 
 	 */
 	private function logContent($content) {
 		$spaces = str_repeat(" ", count($this->logStack));
-		SLog::Write(LOGLEVEL_WBXML, "O " . $spaces . $content);
+		SLog::Write(LOGLEVEL_WBXML, "O ".$spaces.$content);
 	}
 
 	/**
@@ -516,6 +516,6 @@ 
 		else {
 			$data = "more than 512K of data";
 		}
-		SLog::Write(LOGLEVEL_WBXML, "WBXML-OUT: " . $data, false);
+		SLog::Write(LOGLEVEL_WBXML, "WBXML-OUT: ".$data, false);
 	}
 }

Braces +9 added lines, -18 removed lines

@@ -53,8 +53,7 @@ 
 		if ($this->multipart) {
 			header("Content-Type: application/vnd.ms-sync.multipart");
 			SLog::Write(LOGLEVEL_DEBUG, "WBXMLEncoder->startWBXML() type: vnd.ms-sync.multipart");
-		}
-		else {
+		} else {
 			header("Content-Type: application/vnd.ms-sync.wbxml");
 			SLog::Write(LOGLEVEL_DEBUG, "WBXMLEncoder->startWBXML() type: vnd.ms-sync.wbxml");
 		}
@@ -86,8 +85,7 @@ 
 
 		// If 'nocontent' is specified, then apparently the user wants to force
 			// output of an empty tag, and we therefore output the stack here
-		}
-		else {
+		} else {
 			$this->_outputStack();
 			$this->_startTag($tag, $nocontent);
 		}
@@ -274,8 +272,7 @@ 
 		if ($opaque) {
 			$this->outByte(self::WBXML_OPAQUE);
 			$this->outMBUInt($stat['size']);
-		}
-		else {
+		} else {
 			$this->outByte(self::WBXML_STR_I);
 		}
 
@@ -344,8 +341,7 @@ 
 			$uint = $uint >> 7;
 			if ($i == 0) {
 				$out = chr($byte) . $out;
-			}
-			else {
+			} else {
 				$out = chr($byte | 0x80) . $out;
 			}
 		}
@@ -390,8 +386,7 @@ 
 
 		if (isset($split["ns"])) {
 			$cp = $this->_dtd["namespaces"][$split["ns"]];
-		}
-		else {
+		} else {
 			$cp = 0;
 		}
 
@@ -417,8 +412,7 @@ 
 		if ($pos) {
 			$ns = substr($fulltag, 0, $pos);
 			$tag = substr($fulltag, $pos + 1);
-		}
-		else {
+		} else {
 			$tag = $fulltag;
 		}
 
@@ -443,8 +437,7 @@ 
 		$spaces = str_repeat(" ", count($this->logStack));
 		if ($nocontent) {
 			SLog::Write(LOGLEVEL_WBXML, "O " . $spaces . " <{$tag}/>");
-		}
-		else {
+		} else {
 			array_push($this->logStack, $tag);
 			SLog::Write(LOGLEVEL_WBXML, "O " . $spaces . " <{$tag}>");
 		}
@@ -509,11 +502,9 @@ 
 	private function writeLog() {
 		if (ob_get_length() === false) {
 			$data = "output buffer disabled";
-		}
-		elseif (ob_get_length() < 524288) {
+		} elseif (ob_get_length() < 524288) {
 			$data = base64_encode(ob_get_contents());
-		}
-		else {
+		} else {
 			$data = "more than 512K of data";
 		}
 		SLog::Write(LOGLEVEL_WBXML, "WBXML-OUT: " . $data, false);

lib/utils/compat.php

Indentation +200 added lines, -200 removed lines

@@ -8,227 +8,227 @@
  */
 
 if (!function_exists('apache_request_headers')) {
-	/**
-	 * When using other webservers or using php as cgi in apache
-	 * the function apache_request_headers() is not available.
-	 * This function parses the environment variables to extract
-	 * the necessary headers for grommunio-sync.
-	 */
-	function apache_request_headers() {
-		$headers = [];
-		foreach ($_SERVER as $key => $value) {
-			if (substr($key, 0, 5) == 'HTTP_') {
-				$headers[strtr(substr($key, 5), '_', '-')] = $value;
-			}
-		}
-
-		return $headers;
-	}
+    /**
+     * When using other webservers or using php as cgi in apache
+     * the function apache_request_headers() is not available.
+     * This function parses the environment variables to extract
+     * the necessary headers for grommunio-sync.
+     */
+    function apache_request_headers() {
+        $headers = [];
+        foreach ($_SERVER as $key => $value) {
+            if (substr($key, 0, 5) == 'HTTP_') {
+                $headers[strtr(substr($key, 5), '_', '-')] = $value;
+            }
+        }
+
+        return $headers;
+    }
 }
 
 if (!function_exists('hex2bin')) {
-	/**
-	 * Complementary function to bin2hex() which converts a hex entryid to a binary entryid.
-	 * Since PHP 5.4 an internal hex2bin() implementation is available.
-	 *
-	 * @param string $data the hexadecimal string
-	 *
-	 * @returns string
-	 */
-	function hex2bin($data) {
-		return pack("H*", $data);
-	}
+    /**
+     * Complementary function to bin2hex() which converts a hex entryid to a binary entryid.
+     * Since PHP 5.4 an internal hex2bin() implementation is available.
+     *
+     * @param string $data the hexadecimal string
+     *
+     * @returns string
+     */
+    function hex2bin($data) {
+        return pack("H*", $data);
+    }
 }
 
 if (!function_exists('http_response_code')) {
-	/**
-	 * http_response_code does not exists in PHP < 5.4
-	 * http://php.net/manual/en/function.http-response-code.php.
-	 *
-	 * @param null|mixed $code
-	 */
-	function http_response_code($code = null) {
-		if ($code !== null) {
-			switch ($code) {
-				case 100:
-					$text = 'Continue';
-					break;
-
-				case 101:
-					$text = 'Switching Protocols';
-					break;
-
-				case 200:
-					$text = 'OK';
-					break;
-
-				case 201:
-					$text = 'Created';
-					break;
-
-				case 202:
-					$text = 'Accepted';
-					break;
-
-				case 203:
-					$text = 'Non-Authoritative Information';
-					break;
-
-				case 204:
-					$text = 'No Content';
-					break;
-
-				case 205:
-					$text = 'Reset Content';
-					break;
-
-				case 206:
-					$text = 'Partial Content';
-					break;
-
-				case 300:
-					$text = 'Multiple Choices';
-					break;
-
-				case 301:
-					$text = 'Moved Permanently';
-					break;
-
-				case 302:
-					$text = 'Moved Temporarily';
-					break;
-
-				case 303:
-					$text = 'See Other';
-					break;
-
-				case 304:
-					$text = 'Not Modified';
-					break;
-
-				case 305:
-					$text = 'Use Proxy';
-					break;
-
-				case 400:
-					$text = 'Bad Request';
-					break;
-
-				case 401:
-					$text = 'Unauthorized';
-					break;
-
-				case 402:
-					$text = 'Payment Required';
-					break;
-
-				case 403:
-					$text = 'Forbidden';
-					break;
-
-				case 404:
-					$text = 'Not Found';
-					break;
-
-				case 405:
-					$text = 'Method Not Allowed';
-					break;
-
-				case 406:
-					$text = 'Not Acceptable';
-					break;
-
-				case 407:
-					$text = 'Proxy Authentication Required';
-					break;
-
-				case 408:
-					$text = 'Request Time-out';
-					break;
-
-				case 409:
-					$text = 'Conflict';
-					break;
-
-				case 410:
-					$text = 'Gone';
-					break;
+    /**
+     * http_response_code does not exists in PHP < 5.4
+     * http://php.net/manual/en/function.http-response-code.php.
+     *
+     * @param null|mixed $code
+     */
+    function http_response_code($code = null) {
+        if ($code !== null) {
+            switch ($code) {
+                case 100:
+                    $text = 'Continue';
+                    break;
+
+                case 101:
+                    $text = 'Switching Protocols';
+                    break;
+
+                case 200:
+                    $text = 'OK';
+                    break;
+
+                case 201:
+                    $text = 'Created';
+                    break;
+
+                case 202:
+                    $text = 'Accepted';
+                    break;
+
+                case 203:
+                    $text = 'Non-Authoritative Information';
+                    break;
+
+                case 204:
+                    $text = 'No Content';
+                    break;
+
+                case 205:
+                    $text = 'Reset Content';
+                    break;
+
+                case 206:
+                    $text = 'Partial Content';
+                    break;
+
+                case 300:
+                    $text = 'Multiple Choices';
+                    break;
+
+                case 301:
+                    $text = 'Moved Permanently';
+                    break;
+
+                case 302:
+                    $text = 'Moved Temporarily';
+                    break;
+
+                case 303:
+                    $text = 'See Other';
+                    break;
+
+                case 304:
+                    $text = 'Not Modified';
+                    break;
+
+                case 305:
+                    $text = 'Use Proxy';
+                    break;
+
+                case 400:
+                    $text = 'Bad Request';
+                    break;
+
+                case 401:
+                    $text = 'Unauthorized';
+                    break;
+
+                case 402:
+                    $text = 'Payment Required';
+                    break;
+
+                case 403:
+                    $text = 'Forbidden';
+                    break;
+
+                case 404:
+                    $text = 'Not Found';
+                    break;
+
+                case 405:
+                    $text = 'Method Not Allowed';
+                    break;
+
+                case 406:
+                    $text = 'Not Acceptable';
+                    break;
+
+                case 407:
+                    $text = 'Proxy Authentication Required';
+                    break;
+
+                case 408:
+                    $text = 'Request Time-out';
+                    break;
+
+                case 409:
+                    $text = 'Conflict';
+                    break;
+
+                case 410:
+                    $text = 'Gone';
+                    break;
 
-				case 411:
-					$text = 'Length Required';
-					break;
+                case 411:
+                    $text = 'Length Required';
+                    break;
 
-				case 412:
-					$text = 'Precondition Failed';
-					break;
+                case 412:
+                    $text = 'Precondition Failed';
+                    break;
 
-				case 413:
-					$text = 'Request Entity Too Large';
-					break;
+                case 413:
+                    $text = 'Request Entity Too Large';
+                    break;
 
-				case 414:
-					$text = 'Request-URI Too Large';
-					break;
+                case 414:
+                    $text = 'Request-URI Too Large';
+                    break;
 
-				case 415:
-					$text = 'Unsupported Media Type';
-					break;
+                case 415:
+                    $text = 'Unsupported Media Type';
+                    break;
 
-				case 500:
-					$text = 'Internal Server Error';
-					break;
+                case 500:
+                    $text = 'Internal Server Error';
+                    break;
 
-				case 501:
-					$text = 'Not Implemented';
-					break;
+                case 501:
+                    $text = 'Not Implemented';
+                    break;
 
-				case 502:
-					$text = 'Bad Gateway';
-					break;
+                case 502:
+                    $text = 'Bad Gateway';
+                    break;
 
-				case 503:
-					$text = 'Service Unavailable';
-					break;
+                case 503:
+                    $text = 'Service Unavailable';
+                    break;
 
-				case 504:
-					$text = 'Gateway Time-out';
-					break;
+                case 504:
+                    $text = 'Gateway Time-out';
+                    break;
 
-				case 505:
-					$text = 'HTTP Version not supported';
-					break;
+                case 505:
+                    $text = 'HTTP Version not supported';
+                    break;
 
-				default:
-					exit('Unknown http status code "' . htmlentities($code) . '"');
-					break;
-			}
-
-			$protocol = (isset($_SERVER['SERVER_PROTOCOL']) ? $_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.0');
-			header($protocol . ' ' . $code . ' ' . $text);
+                default:
+                    exit('Unknown http status code "' . htmlentities($code) . '"');
+                    break;
+            }
+
+            $protocol = (isset($_SERVER['SERVER_PROTOCOL']) ? $_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.0');
+            header($protocol . ' ' . $code . ' ' . $text);
 
-			$GLOBALS['http_response_code'] = $code;
-		}
-		else {
-			$code = (isset($GLOBALS['http_response_code']) ? $GLOBALS['http_response_code'] : 200);
-		}
+            $GLOBALS['http_response_code'] = $code;
+        }
+        else {
+            $code = (isset($GLOBALS['http_response_code']) ? $GLOBALS['http_response_code'] : 200);
+        }
 
-		return $code;
-	}
+        return $code;
+    }
 }
 
 if (!function_exists('memory_get_peak_usage')) {
-	/**
-	 * memory_get_peak_usage is not available prior to PHP 5.2.
-	 * This complementary function will return the value of memory_get_usage();.
-	 *
-	 * @see http://php.net/manual/en/function.memory-get-usage.php
-	 * @see http://php.net/manual/en/function.memory-get-peak-usage.php
-	 *
-	 * @param bool $real_usage
-	 */
-	function memory_get_peak_usage($real_usage = false) {
-		SLog::Write(LOGLEVEL_DEBUG, "memory_get_peak_usage() is not available on this system. The value of memory_get_usage() will be used.");
-
-		return memory_get_usage();
-	}
+    /**
+     * memory_get_peak_usage is not available prior to PHP 5.2.
+     * This complementary function will return the value of memory_get_usage();.
+     *
+     * @see http://php.net/manual/en/function.memory-get-usage.php
+     * @see http://php.net/manual/en/function.memory-get-peak-usage.php
+     *
+     * @param bool $real_usage
+     */
+    function memory_get_peak_usage($real_usage = false) {
+        SLog::Write(LOGLEVEL_DEBUG, "memory_get_peak_usage() is not available on this system. The value of memory_get_usage() will be used.");
+
+        return memory_get_usage();
+    }
 }

Spacing +2 added lines, -2 removed lines

@@ -199,12 +199,12 @@
 					break;
 
 				default:
-					exit('Unknown http status code "' . htmlentities($code) . '"');
+					exit('Unknown http status code "'.htmlentities($code).'"');
 					break;
 			}
 
 			$protocol = (isset($_SERVER['SERVER_PROTOCOL']) ? $_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.0');
-			header($protocol . ' ' . $code . ' ' . $text);
+			header($protocol.' '.$code.' '.$text);
 
 			$GLOBALS['http_response_code'] = $code;
 		}

Braces +1 added lines, -2 removed lines

@@ -207,8 +207,7 @@
 			header($protocol . ' ' . $code . ' ' . $text);
 
 			$GLOBALS['http_response_code'] = $code;
-		}
-		else {
+		} else {
 			$code = (isset($GLOBALS['http_response_code']) ? $GLOBALS['http_response_code'] : 200);
 		}