grommunio / grommunio-sync

lib/interface/isearchprovider.php

Indentation +53 added lines, -53 removed lines

@@ -9,63 +9,63 @@
  */
 
 interface ISearchProvider {
-	public const SEARCH_GAL = "GAL";
-	public const SEARCH_MAILBOX = "MAILBOX";
-	public const SEARCH_DOCUMENTLIBRARY = "DOCUMENTLIBRARY";
+    public const SEARCH_GAL = "GAL";
+    public const SEARCH_MAILBOX = "MAILBOX";
+    public const SEARCH_DOCUMENTLIBRARY = "DOCUMENTLIBRARY";
 
-	/**
-	 * Constructor.
-	 *
-	 * @param mixed $searchtype
-	 *
-	 * @throws StatusException, FatalException
-	 */
+    /**
+     * Constructor.
+     *
+     * @param mixed $searchtype
+     *
+     * @throws StatusException, FatalException
+     */
 
-	/**
-	 * Indicates if a search type is supported by this SearchProvider
-	 * Currently only the type SEARCH_GAL (Global Address List) is implemented.
-	 *
-	 * @param string $searchtype
-	 *
-	 * @return bool
-	 */
-	public function SupportsType($searchtype);
+    /**
+     * Indicates if a search type is supported by this SearchProvider
+     * Currently only the type SEARCH_GAL (Global Address List) is implemented.
+     *
+     * @param string $searchtype
+     *
+     * @return bool
+     */
+    public function SupportsType($searchtype);
 
-	/**
-	 * Searches the GAL.
-	 *
-	 * @param string                       $searchquery   string to be searched for
-	 * @param string                       $searchrange   specified searchrange
-	 * @param SyncResolveRecipientsPicture $searchpicture limitations for picture
-	 *
-	 * @throws StatusException
-	 *
-	 * @return array search results
-	 */
-	public function GetGALSearchResults($searchquery, $searchrange, $searchpicture);
+    /**
+     * Searches the GAL.
+     *
+     * @param string                       $searchquery   string to be searched for
+     * @param string                       $searchrange   specified searchrange
+     * @param SyncResolveRecipientsPicture $searchpicture limitations for picture
+     *
+     * @throws StatusException
+     *
+     * @return array search results
+     */
+    public function GetGALSearchResults($searchquery, $searchrange, $searchpicture);
 
-	/**
-	 * Searches for the emails on the server.
-	 *
-	 * @param ContentParameter $cpo
-	 *
-	 * @return array
-	 */
-	public function GetMailboxSearchResults($cpo);
+    /**
+     * Searches for the emails on the server.
+     *
+     * @param ContentParameter $cpo
+     *
+     * @return array
+     */
+    public function GetMailboxSearchResults($cpo);
 
-	/**
-	 * Terminates a search for a given PID.
-	 *
-	 * @param int $pid
-	 *
-	 * @return bool
-	 */
-	public function TerminateSearch($pid);
+    /**
+     * Terminates a search for a given PID.
+     *
+     * @param int $pid
+     *
+     * @return bool
+     */
+    public function TerminateSearch($pid);
 
-	/**
-	 * Disconnects from the current search provider.
-	 *
-	 * @return bool
-	 */
-	public function Disconnect();
+    /**
+     * Disconnects from the current search provider.
+     *
+     * @return bool
+     */
+    public function Disconnect();
 }

lib/interface/iipcprovider.php

Indentation +69 added lines, -69 removed lines

@@ -9,81 +9,81 @@
  */
 
 interface IIpcProvider {
-	/**
-	 * Constructor.
-	 *
-	 * @param int    $type
-	 * @param int    $allocate
-	 * @param string $class
-	 * @param string $serverKey
-	 */
-	public function __construct($type, $allocate, $class, $serverKey);
+    /**
+     * Constructor.
+     *
+     * @param int    $type
+     * @param int    $allocate
+     * @param string $class
+     * @param string $serverKey
+     */
+    public function __construct($type, $allocate, $class, $serverKey);
 
-	/**
-	 * Reinitializes the IPC data. If the provider has no way of performing
-	 * this action, it should return 'false'.
-	 *
-	 * @return bool
-	 */
-	public function ReInitIPC();
+    /**
+     * Reinitializes the IPC data. If the provider has no way of performing
+     * this action, it should return 'false'.
+     *
+     * @return bool
+     */
+    public function ReInitIPC();
 
-	/**
-	 * Cleans up the IPC data block.
-	 *
-	 * @return bool
-	 */
-	public function Clean();
+    /**
+     * Cleans up the IPC data block.
+     *
+     * @return bool
+     */
+    public function Clean();
 
-	/**
-	 * Indicates if the IPC is active.
-	 *
-	 * @return bool
-	 */
-	public function IsActive();
+    /**
+     * Indicates if the IPC is active.
+     *
+     * @return bool
+     */
+    public function IsActive();
 
-	/**
-	 * Blocks the class mutex.
-	 * Method blocks until mutex is available!
-	 * ATTENTION: make sure that you *always* release a blocked mutex!
-	 *
-	 * @return bool
-	 */
-	public function BlockMutex();
+    /**
+     * Blocks the class mutex.
+     * Method blocks until mutex is available!
+     * ATTENTION: make sure that you *always* release a blocked mutex!
+     *
+     * @return bool
+     */
+    public function BlockMutex();
 
-	/**
-	 * Releases the class mutex.
-	 * After the release other processes are able to block the mutex themselves.
-	 *
-	 * @return bool
-	 */
-	public function ReleaseMutex();
+    /**
+     * Releases the class mutex.
+     * After the release other processes are able to block the mutex themselves.
+     *
+     * @return bool
+     */
+    public function ReleaseMutex();
 
-	/**
-	 * Indicates if the requested variable is available in IPC data.
-	 *
-	 * @param int $id int indicating the variable
-	 *
-	 * @return bool
-	 */
-	public function HasData($id = 2);
+    /**
+     * Indicates if the requested variable is available in IPC data.
+     *
+     * @param int $id int indicating the variable
+     *
+     * @return bool
+     */
+    public function HasData($id = 2);
 
-	/**
-	 * Returns the requested variable from IPC data.
-	 *
-	 * @param int $id int indicating the variable
-	 *
-	 * @return mixed
-	 */
-	public function GetData($id = 2);
+    /**
+     * Returns the requested variable from IPC data.
+     *
+     * @param int $id int indicating the variable
+     *
+     * @return mixed
+     */
+    public function GetData($id = 2);
 
-	/**
-	 * Writes the transmitted variable to IPC data.
-	 * Subclasses may never use an id < 2!
-	 *
-	 * @param mixed $data data which should be saved into IPC data
-	 * @param int   $id   int indicating the variable (bigger than 2!)
-	 *
-	 * @return bool
-	 */
-	public function SetData($data, $id = 2);
+    /**
+     * Writes the transmitted variable to IPC data.
+     * Subclasses may never use an id < 2!
+     *
+     * @param mixed $data data which should be saved into IPC data
+     * @param int   $id   int indicating the variable (bigger than 2!)
+     *
+     * @return bool
+     */
+    public function SetData($data, $id = 2);
 }

lib/core/bodypartpreference.php

Indentation +20 added lines, -20 removed lines

@@ -8,26 +8,26 @@
  */
 
 class BodyPartPreference extends StateObject {
-	protected $unsetdata = [
-		'truncationsize' => false,
-		'allornone' => false,
-		'preview' => false,
-	];
+    protected $unsetdata = [
+        'truncationsize' => false,
+        'allornone' => false,
+        'preview' => false,
+    ];
 
-	/**
-	 * Expected magic getters and setters.
-	 *
-	 * GetTruncationSize() + SetTruncationSize()
-	 * GetAllOrNone() + SetAllOrNone()
-	 * GetPreview() + SetPreview()
-	 */
+    /**
+     * Expected magic getters and setters.
+     *
+     * GetTruncationSize() + SetTruncationSize()
+     * GetAllOrNone() + SetAllOrNone()
+     * GetPreview() + SetPreview()
+     */
 
-	/**
-	 * Indicates if this object has values.
-	 *
-	 * @return bool
-	 */
-	public function HasValues() {
-		return count($this->data) > 0;
-	}
+    /**
+     * Indicates if this object has values.
+     *
+     * @return bool
+     */
+    public function HasValues() {
+        return count($this->data) > 0;
+    }
 }

lib/core/redisconnection.php

Indentation +56 added lines, -56 removed lines

@@ -8,8 +8,8 @@ 
  */
 
 class RedisConnection {
-	private $redisObj;
-	private $luaCAS = <<<'EOF'
+    private $redisObj;
+    private $luaCAS = <<<'EOF'
     local old = redis.call('GET', KEYS[1]);
     if not old or old == ARGV[1] then
         redis.call('SET',KEYS[1], ARGV[2]);
@@ -19,7 +19,7 @@ 
     end
 EOF;
 
-	private $luaCASHash = <<<'EOF'
+    private $luaCASHash = <<<'EOF'
     local old = redis.call('HGET', KEYS[1], ARGV[1]);
     if not old or old == ARGV[2] then
         redis.call('HSET', KEYS[1], ARGV[1], ARGV[3]);
@@ -29,64 +29,64 @@ 
     end
 EOF;
 
-	/**
-	 * Constructor.
-	 *
-	 * @param mixed $host
-	 * @param mixed $port
-	 * @param mixed $auth
-	 */
-	public function __construct($host = REDIS_HOST, $port = REDIS_PORT, $auth = REDIS_AUTH) {
-		$this->redisObj = new Redis();
-		// Opening a redis connection
-		$this->redisObj->connect($host, $port);
-		if ($auth) {
-			$this->redisObj->auth($auth);
-		}
-	}
+    /**
+     * Constructor.
+     *
+     * @param mixed $host
+     * @param mixed $port
+     * @param mixed $auth
+     */
+    public function __construct($host = REDIS_HOST, $port = REDIS_PORT, $auth = REDIS_AUTH) {
+        $this->redisObj = new Redis();
+        // Opening a redis connection
+        $this->redisObj->connect($host, $port);
+        if ($auth) {
+            $this->redisObj->auth($auth);
+        }
+    }
 
-	public function getKey($key) {
-		try {
-			return $this->redisObj->get($key);
-		}
-		catch (Exception $e) {
-			SLog::Write(LOGLEVEL_ERROR, sprintf("%s->getKey(): %s", get_class($this), $e->getMessage()));
-		}
-	}
+    public function getKey($key) {
+        try {
+            return $this->redisObj->get($key);
+        }
+        catch (Exception $e) {
+            SLog::Write(LOGLEVEL_ERROR, sprintf("%s->getKey(): %s", get_class($this), $e->getMessage()));
+        }
+    }
 
-	public function setKey($key, $value, $ttl = -1) {
-		try {
-			if ($ttl > 0) {
-				return $this->redisObj->setEx($key, $ttl, $value);
-			}
+    public function setKey($key, $value, $ttl = -1) {
+        try {
+            if ($ttl > 0) {
+                return $this->redisObj->setEx($key, $ttl, $value);
+            }
 
-			return $this->redisObj->set($key, $value);
-		}
-		catch (Exception $e) {
-			SLog::Write(LOGLEVEL_ERROR, sprintf("%s->setKey(): %s", get_class($this), $e->getMessage()));
-		}
-	}
+            return $this->redisObj->set($key, $value);
+        }
+        catch (Exception $e) {
+            SLog::Write(LOGLEVEL_ERROR, sprintf("%s->setKey(): %s", get_class($this), $e->getMessage()));
+        }
+    }
 
-	public function delKey($key) {
-		try {
-			return $this->redisObj->del($key);
-		}
-		catch (Exception $e) {
-			SLog::Write(LOGLEVEL_ERROR, sprintf("%s->delKey(): %s", get_class($this), $e->getMessage()));
-		}
-	}
+    public function delKey($key) {
+        try {
+            return $this->redisObj->del($key);
+        }
+        catch (Exception $e) {
+            SLog::Write(LOGLEVEL_ERROR, sprintf("%s->delKey(): %s", get_class($this), $e->getMessage()));
+        }
+    }
 
-	public function get() {
-		return $this->redisObj;
-	}
+    public function get() {
+        return $this->redisObj;
+    }
 
-	public function CAS($key, $oldvalue, $newvalue) {
-		// custom Compare-and-swap implementation using LUA
-		return $this->redisObj->eval($this->luaCAS, [$key, $oldvalue, $newvalue], 1);
-	}
+    public function CAS($key, $oldvalue, $newvalue) {
+        // custom Compare-and-swap implementation using LUA
+        return $this->redisObj->eval($this->luaCAS, [$key, $oldvalue, $newvalue], 1);
+    }
 
-	public function CASHash($key, $subkey, $oldvalue, $newvalue) {
-		// custom Compare-and-swap implementation using LUA for a hash subkey
-		return $this->redisObj->eval($this->luaCASHash, [$key, $subkey, $oldvalue, $newvalue], 1);
-	}
+    public function CASHash($key, $subkey, $oldvalue, $newvalue) {
+        // custom Compare-and-swap implementation using LUA for a hash subkey
+        return $this->redisObj->eval($this->luaCASHash, [$key, $subkey, $oldvalue, $newvalue], 1);
+    }
 }

Braces +3 added lines, -6 removed lines

@@ -48,8 +48,7 @@ 
 	public function getKey($key) {
 		try {
 			return $this->redisObj->get($key);
-		}
-		catch (Exception $e) {
+		} catch (Exception $e) {
 			SLog::Write(LOGLEVEL_ERROR, sprintf("%s->getKey(): %s", get_class($this), $e->getMessage()));
 		}
 	}
@@ -61,8 +60,7 @@ 
 			}
 
 			return $this->redisObj->set($key, $value);
-		}
-		catch (Exception $e) {
+		} catch (Exception $e) {
 			SLog::Write(LOGLEVEL_ERROR, sprintf("%s->setKey(): %s", get_class($this), $e->getMessage()));
 		}
 	}
@@ -70,8 +68,7 @@ 
 	public function delKey($key) {
 		try {
 			return $this->redisObj->del($key);
-		}
-		catch (Exception $e) {
+		} catch (Exception $e) {
 			SLog::Write(LOGLEVEL_ERROR, sprintf("%s->delKey(): %s", get_class($this), $e->getMessage()));
 		}
 	}

lib/core/topcollector.php

Indentation +210 added lines, -210 removed lines

@@ -10,214 +10,214 @@
  */
 
 class TopCollector extends InterProcessData {
-	public const ENABLEDAT = "grommunio-sync:topenabledat";
-	public const TOPDATA = "grommunio-sync:topdata";
-	public const ENABLED_CACHETIME = 5; // how often in seconds to check the ipc provider if it has data for the TopCollector
-
-	protected $preserved;
-	protected $latest;
-	private $disabled;
-	private $checkEnabledTime;
-	private $enabled;
-
-	/**
-	 * Constructor.
-	 */
-	public function __construct() {
-		// initialize super parameters
-		$this->allocate = 2097152; // 2 MB
-		$this->type = 20;
-		parent::__construct();
-
-		// initialize params
-		$this->initializeParams();
-
-		$this->preserved = [];
-		// static vars come from the parent class
-		$this->latest = ["pid" => self::$pid,
-			"ip" => Request::GetRemoteAddr(),
-			"user" => self::$user,
-			"start" => self::$start,
-			"devtype" => Request::GetDeviceType(),
-			"devid" => self::$devid,
-			"devagent" => Request::GetUserAgent(),
-			"command" => Request::GetCommandCode(),
-			"ended" => 0,
-			"push" => false,
-		];
-		$this->disabled = (bool) (defined('TOPCOLLECTOR_DISABLED') && constant('TOPCOLLECTOR_DISABLED') === true);
-		$this->checkEnabledTime = time() - self::ENABLED_CACHETIME - 1;
-		$this->AnnounceInformation("initializing");
-	}
-
-	/**
-	 * Destructor
-	 * indicates that the process is shutting down.
-	 */
-	public function __destruct() {
-		$this->AnnounceInformation("OK", false, true);
-	}
-
-	/**
-	 * Advices all other processes that they should start/stop
-	 * collecting data. The data saved is a timestamp. It has to be
-	 * reactivated every couple of seconds.
-	 *
-	 * @param bool $stop (opt) default false (do collect)
-	 *
-	 * @return bool indicating if it was set to collect before
-	 */
-	public function CollectData($stop = false) {
-		$wasEnabled = ($this->hasData(self::ENABLEDAT)) ? $this->getData(self::ENABLEDAT) : false;
-
-		$time = time();
-		if ($stop === true) {
-			$time = 0;
-		}
-
-		if (!$this->setData($time, self::ENABLEDAT)) {
-			return false;
-		}
-
-		return $wasEnabled;
-	}
-
-	/**
-	 * Announces a string to the TopCollector.
-	 *
-	 * @param string $info
-	 * @param bool   $preserve    info should be displayed when process terminates
-	 * @param bool   $terminating indicates if the process is terminating
-	 * @param mixed  $addinfo
-	 *
-	 * @return bool
-	 */
-	public function AnnounceInformation($addinfo, $preserve = false, $terminating = false) {
-		if ($this->disabled) {
-			return true;
-		}
-
-		$this->latest["addinfo"] = $addinfo;
-		$this->latest["update"] = time();
-
-		if ($terminating) {
-			$this->latest["ended"] = time();
-			foreach ($this->preserved as $p) {
-				$this->latest["addinfo"] .= " : " . $p;
-			}
-		}
-
-		if ($preserve) {
-			$this->preserved[] = $addinfo;
-		}
-
-		if ($this->isEnabled()) {
-			// use the pid as subkey
-			$ok = $this->setDeviceUserData(self::TOPDATA, $this->latest, self::$devid, self::$user, self::$pid);
-			if (!$ok) {
-				SLog::Write(LOGLEVEL_WARN, "TopCollector::AnnounceInformation(): could not write to redis. grommunio-sync top will not display this data.");
-
-				return false;
-			}
-		}
-
-		return true;
-	}
-
-	/**
-	 * Returns all available top data.
-	 *
-	 * @return array
-	 */
-	public function ReadLatest() {
-		return $this->getAllDeviceUserData(self::TOPDATA);
-	}
-
-	/**
-	 * Cleans up data collected so far.
-	 *
-	 * @param bool $all (optional) if set all data independently from the age is removed
-	 *
-	 * @return bool status
-	 */
-	public function ClearLatest($all = false) {
-		// it's ok when doing this every 10 sec
-		if ($all == false && time() % 10 != 0) {
-			return true;
-		}
-
-		if ($all == true) {
-			$this->getRedis()->delKey(self::TOPDATA);
-		}
-		else {
-			foreach ($this->getRawDeviceUserData(self::TOPDATA) as $compKey => $rawline) {
-				$line = json_decode($rawline, true);
-				// remove everything which terminated for 20 secs or is not updated for more than 120 secs
-				if (($line["ended"] != 0 && time() - $line["ended"] > 20) ||
-					time() - $line["update"] > 120) {
-					$this->getRedis()->get()->hDel(self::TOPDATA, $compKey);
-				}
-			}
-		}
-
-		return true;
-	}
-
-	/**
-	 * Sets a different UserAgent for this connection.
-	 *
-	 * @param string $agent
-	 *
-	 * @return bool
-	 */
-	public function SetUserAgent($agent) {
-		$this->latest["devagent"] = $agent;
-
-		return true;
-	}
-
-	/**
-	 * Marks this process as push connection.
-	 *
-	 * @param string $agent
-	 *
-	 * @return bool
-	 */
-	public function SetAsPushConnection() {
-		$this->latest["push"] = true;
-
-		return true;
-	}
-
-	/**
-	 * Reinitializes the IPC data.
-	 *
-	 * @return bool
-	 */
-	public function ReInitIPC() {
-		return parent::ReInitIPC();
-		if (!status) {
-			$this->getRedis()->delKey(self::TOPDATA);
-		}
-
-		return $status;
-	}
-
-	/**
-	 * Indicates if top data should be saved or not
-	 * Returns true for 10 seconds after the latest CollectData()
-	 * SHOULD only be called with locked mutex!
-	 *
-	 * @return bool
-	 */
-	private function isEnabled() {
-		$time = time();
-		if ($this->checkEnabledTime + self::ENABLED_CACHETIME < $time) {
-			$isEnabled = ($this->hasData(self::ENABLEDAT)) ? $this->getData(self::ENABLEDAT) : false;
-			$this->enabled = ($isEnabled !== false && ($isEnabled + 300) > $time);
-			$this->checkEnabledTime = $time;
-		}
-
-		return $this->enabled;
-	}
+    public const ENABLEDAT = "grommunio-sync:topenabledat";
+    public const TOPDATA = "grommunio-sync:topdata";
+    public const ENABLED_CACHETIME = 5; // how often in seconds to check the ipc provider if it has data for the TopCollector
+
+    protected $preserved;
+    protected $latest;
+    private $disabled;
+    private $checkEnabledTime;
+    private $enabled;
+
+    /**
+     * Constructor.
+     */
+    public function __construct() {
+        // initialize super parameters
+        $this->allocate = 2097152; // 2 MB
+        $this->type = 20;
+        parent::__construct();
+
+        // initialize params
+        $this->initializeParams();
+
+        $this->preserved = [];
+        // static vars come from the parent class
+        $this->latest = ["pid" => self::$pid,
+            "ip" => Request::GetRemoteAddr(),
+            "user" => self::$user,
+            "start" => self::$start,
+            "devtype" => Request::GetDeviceType(),
+            "devid" => self::$devid,
+            "devagent" => Request::GetUserAgent(),
+            "command" => Request::GetCommandCode(),
+            "ended" => 0,
+            "push" => false,
+        ];
+        $this->disabled = (bool) (defined('TOPCOLLECTOR_DISABLED') && constant('TOPCOLLECTOR_DISABLED') === true);
+        $this->checkEnabledTime = time() - self::ENABLED_CACHETIME - 1;
+        $this->AnnounceInformation("initializing");
+    }
+
+    /**
+     * Destructor
+     * indicates that the process is shutting down.
+     */
+    public function __destruct() {
+        $this->AnnounceInformation("OK", false, true);
+    }
+
+    /**
+     * Advices all other processes that they should start/stop
+     * collecting data. The data saved is a timestamp. It has to be
+     * reactivated every couple of seconds.
+     *
+     * @param bool $stop (opt) default false (do collect)
+     *
+     * @return bool indicating if it was set to collect before
+     */
+    public function CollectData($stop = false) {
+        $wasEnabled = ($this->hasData(self::ENABLEDAT)) ? $this->getData(self::ENABLEDAT) : false;
+
+        $time = time();
+        if ($stop === true) {
+            $time = 0;
+        }
+
+        if (!$this->setData($time, self::ENABLEDAT)) {
+            return false;
+        }
+
+        return $wasEnabled;
+    }
+
+    /**
+     * Announces a string to the TopCollector.
+     *
+     * @param string $info
+     * @param bool   $preserve    info should be displayed when process terminates
+     * @param bool   $terminating indicates if the process is terminating
+     * @param mixed  $addinfo
+     *
+     * @return bool
+     */
+    public function AnnounceInformation($addinfo, $preserve = false, $terminating = false) {
+        if ($this->disabled) {
+            return true;
+        }
+
+        $this->latest["addinfo"] = $addinfo;
+        $this->latest["update"] = time();
+
+        if ($terminating) {
+            $this->latest["ended"] = time();
+            foreach ($this->preserved as $p) {
+                $this->latest["addinfo"] .= " : " . $p;
+            }
+        }
+
+        if ($preserve) {
+            $this->preserved[] = $addinfo;
+        }
+
+        if ($this->isEnabled()) {
+            // use the pid as subkey
+            $ok = $this->setDeviceUserData(self::TOPDATA, $this->latest, self::$devid, self::$user, self::$pid);
+            if (!$ok) {
+                SLog::Write(LOGLEVEL_WARN, "TopCollector::AnnounceInformation(): could not write to redis. grommunio-sync top will not display this data.");
+
+                return false;
+            }
+        }
+
+        return true;
+    }
+
+    /**
+     * Returns all available top data.
+     *
+     * @return array
+     */
+    public function ReadLatest() {
+        return $this->getAllDeviceUserData(self::TOPDATA);
+    }
+
+    /**
+     * Cleans up data collected so far.
+     *
+     * @param bool $all (optional) if set all data independently from the age is removed
+     *
+     * @return bool status
+     */
+    public function ClearLatest($all = false) {
+        // it's ok when doing this every 10 sec
+        if ($all == false && time() % 10 != 0) {
+            return true;
+        }
+
+        if ($all == true) {
+            $this->getRedis()->delKey(self::TOPDATA);
+        }
+        else {
+            foreach ($this->getRawDeviceUserData(self::TOPDATA) as $compKey => $rawline) {
+                $line = json_decode($rawline, true);
+                // remove everything which terminated for 20 secs or is not updated for more than 120 secs
+                if (($line["ended"] != 0 && time() - $line["ended"] > 20) ||
+                    time() - $line["update"] > 120) {
+                    $this->getRedis()->get()->hDel(self::TOPDATA, $compKey);
+                }
+            }
+        }
+
+        return true;
+    }
+
+    /**
+     * Sets a different UserAgent for this connection.
+     *
+     * @param string $agent
+     *
+     * @return bool
+     */
+    public function SetUserAgent($agent) {
+        $this->latest["devagent"] = $agent;
+
+        return true;
+    }
+
+    /**
+     * Marks this process as push connection.
+     *
+     * @param string $agent
+     *
+     * @return bool
+     */
+    public function SetAsPushConnection() {
+        $this->latest["push"] = true;
+
+        return true;
+    }
+
+    /**
+     * Reinitializes the IPC data.
+     *
+     * @return bool
+     */
+    public function ReInitIPC() {
+        return parent::ReInitIPC();
+        if (!status) {
+            $this->getRedis()->delKey(self::TOPDATA);
+        }
+
+        return $status;
+    }
+
+    /**
+     * Indicates if top data should be saved or not
+     * Returns true for 10 seconds after the latest CollectData()
+     * SHOULD only be called with locked mutex!
+     *
+     * @return bool
+     */
+    private function isEnabled() {
+        $time = time();
+        if ($this->checkEnabledTime + self::ENABLED_CACHETIME < $time) {
+            $isEnabled = ($this->hasData(self::ENABLEDAT)) ? $this->getData(self::ENABLEDAT) : false;
+            $this->enabled = ($isEnabled !== false && ($isEnabled + 300) > $time);
+            $this->checkEnabledTime = $time;
+        }
+
+        return $this->enabled;
+    }
 }

Spacing +2 added lines, -2 removed lines

@@ -45,7 +45,7 @@ 
 			"ended" => 0,
 			"push" => false,
 		];
-		$this->disabled = (bool) (defined('TOPCOLLECTOR_DISABLED') && constant('TOPCOLLECTOR_DISABLED') === true);
+		$this->disabled = (bool)(defined('TOPCOLLECTOR_DISABLED') && constant('TOPCOLLECTOR_DISABLED') === true);
 		$this->checkEnabledTime = time() - self::ENABLED_CACHETIME - 1;
 		$this->AnnounceInformation("initializing");
 	}
@@ -103,7 +103,7 @@ 
 		if ($terminating) {
 			$this->latest["ended"] = time();
 			foreach ($this->preserved as $p) {
-				$this->latest["addinfo"] .= " : " . $p;
+				$this->latest["addinfo"] .= " : ".$p;
 			}
 		}
 

Braces +1 added lines, -2 removed lines

@@ -148,8 +148,7 @@
 
 		if ($all == true) {
 			$this->getRedis()->delKey(self::TOPDATA);
-		}
-		else {
+		} else {
 			foreach ($this->getRawDeviceUserData(self::TOPDATA) as $compKey => $rawline) {
 				$line = json_decode($rawline, true);
 				// remove everything which terminated for 20 secs or is not updated for more than 120 secs

lib/core/bodypreference.php

Indentation +20 added lines, -20 removed lines

@@ -8,26 +8,26 @@
  */
 
 class BodyPreference extends StateObject {
-	protected $unsetdata = [
-		'truncationsize' => false,
-		'allornone' => false,
-		'preview' => false,
-	];
+    protected $unsetdata = [
+        'truncationsize' => false,
+        'allornone' => false,
+        'preview' => false,
+    ];
 
-	/**
-	 * expected magic getters and setters.
-	 *
-	 * GetTruncationSize() + SetTruncationSize()
-	 * GetAllOrNone() + SetAllOrNone()
-	 * GetPreview() + SetPreview()
-	 */
+    /**
+     * expected magic getters and setters.
+     *
+     * GetTruncationSize() + SetTruncationSize()
+     * GetAllOrNone() + SetAllOrNone()
+     * GetPreview() + SetPreview()
+     */
 
-	/**
-	 * Indicates if this object has values.
-	 *
-	 * @return bool
-	 */
-	public function HasValues() {
-		return count($this->data) > 0;
-	}
+    /**
+     * Indicates if this object has values.
+     *
+     * @return bool
+     */
+    public function HasValues() {
+        return count($this->data) > 0;
+    }
 }

lib/core/hierarchycache.php

Indentation +180 added lines, -180 removed lines

@@ -8,184 +8,184 @@
  */
 
 class HierarchyCache extends StateObject {
-	protected $changed = false;
-	protected $data;
-	private $dataOld;
-
-	/**
-	 * Constructor of the HierarchyCache.
-	 *
-	 * @return
-	 */
-	public function __construct() {
-		$this->data = [];
-		$this->dataOld = $this->data;
-		$this->changed = true;
-	}
-
-	/**
-	 * Indicates if the cache was changed.
-	 *
-	 * @return bool
-	 */
-	public function IsStateChanged() {
-		return $this->changed;
-	}
-
-	/**
-	 * Copy current data to memory.
-	 *
-	 * @return bool
-	 */
-	public function CopyOldState() {
-		$this->dataOld = $this->data;
-		$this->changed = false;
-
-		return true;
-	}
-
-	/**
-	 * Returns the SyncFolder object for a folder id
-	 * If $oldstate is set, then the data from the previous state is returned.
-	 *
-	 * @param string $serverid
-	 * @param bool   $oldstate (optional) by default false
-	 * @param mixed  $oldState
-	 *
-	 * @return SyncObject/boolean       false if not found
-	 */
-	public function GetFolder($serverid, $oldState = false) {
-		if (!$oldState && array_key_exists($serverid, $this->data)) {
-			return $this->data[$serverid];
-		}
-		if ($oldState && array_key_exists($serverid, $this->dataOld)) {
-			return $this->dataOld[$serverid];
-		}
-
-		return false;
-	}
-
-	/**
-	 * Adds a folder to the HierarchyCache.
-	 *
-	 * @param SyncObject $folder
-	 *
-	 * @return bool
-	 */
-	public function AddFolder($folder) {
-		SLog::Write(LOGLEVEL_DEBUG, "HierarchyCache: AddFolder() serverid: {$folder->serverid} displayname: {$folder->displayname}");
-
-		// on update the $folder does most of the times not contain a type
-		// we copy the value in this case to the new $folder object
-		if (isset($this->data[$folder->serverid]) && (!isset($folder->type) || $folder->type == false) && isset($this->data[$folder->serverid]->type)) {
-			$folder->type = $this->data[$folder->serverid]->type;
-			SLog::Write(LOGLEVEL_DEBUG, sprintf("HierarchyCache: AddFolder() is an update: used type '%s' from old object", $folder->type));
-		}
-
-		// add/update
-		$this->data[$folder->serverid] = $folder;
-		$this->changed = true;
-
-		return true;
-	}
-
-	/**
-	 * Removes a folder to the HierarchyCache.
-	 *
-	 * @param string $serverid id of folder to be removed
-	 *
-	 * @return bool
-	 */
-	public function DelFolder($serverid) {
-		$ftype = $this->GetFolder($serverid);
-
-		SLog::Write(LOGLEVEL_DEBUG, sprintf("HierarchyCache: DelFolder() serverid: '%s' - type: '%s'", $serverid, $ftype->type));
-		unset($this->data[$serverid]);
-		$this->changed = true;
-
-		return true;
-	}
-
-	/**
-	 * Imports a folder array to the HierarchyCache.
-	 *
-	 * @param array $folders folders to the HierarchyCache
-	 *
-	 * @return bool
-	 */
-	public function ImportFolders($folders) {
-		if (!is_array($folders)) {
-			return false;
-		}
-
-		$this->data = [];
-
-		foreach ($folders as $folder) {
-			if (!isset($folder->type)) {
-				continue;
-			}
-			$this->AddFolder($folder);
-		}
-
-		return true;
-	}
-
-	/**
-	 * Exports all folders from the HierarchyCache.
-	 *
-	 * @param bool $oldstate (optional) by default false
-	 *
-	 * @return array
-	 */
-	public function ExportFolders($oldstate = false) {
-		if ($oldstate === false) {
-			return $this->data;
-		}
-
-		return $this->dataOld;
-	}
-
-	/**
-	 * Returns all folder objects which were deleted in this operation.
-	 *
-	 * @return array with SyncFolder objects
-	 */
-	public function GetDeletedFolders() {
-		// diffing the Olddata with data we know if folders were deleted
-		return array_diff_key($this->dataOld, $this->data);
-	}
-
-	/**
-	 * Returns some statistics about the HierarchyCache.
-	 *
-	 * @return string
-	 */
-	public function GetStat() {
-		return sprintf("HierarchyCache is %s - Cached objects: %d", ((isset($this->data)) ? "up" : "down"), ((isset($this->data)) ? count($this->data) : "0"));
-	}
-
-	/**
-	 * Removes internal data from the object, so this data can not be exposed.
-	 *
-	 * @return bool
-	 */
-	public function StripData() {
-		unset($this->changed, $this->dataOld);
-
-		foreach ($this->data as $id => $folder) {
-			$folder->StripData();
-		}
-
-		return true;
-	}
-
-	/**
-	 * Returns objects which should be persistent
-	 * called before serialization.
-	 *
-	 * @return array
-	 */
-	public function __sleep() {
-		return ["data"];
-	}
+    protected $changed = false;
+    protected $data;
+    private $dataOld;
+
+    /**
+     * Constructor of the HierarchyCache.
+     *
+     * @return
+     */
+    public function __construct() {
+        $this->data = [];
+        $this->dataOld = $this->data;
+        $this->changed = true;
+    }
+
+    /**
+     * Indicates if the cache was changed.
+     *
+     * @return bool
+     */
+    public function IsStateChanged() {
+        return $this->changed;
+    }
+
+    /**
+     * Copy current data to memory.
+     *
+     * @return bool
+     */
+    public function CopyOldState() {
+        $this->dataOld = $this->data;
+        $this->changed = false;
+
+        return true;
+    }
+
+    /**
+     * Returns the SyncFolder object for a folder id
+     * If $oldstate is set, then the data from the previous state is returned.
+     *
+     * @param string $serverid
+     * @param bool   $oldstate (optional) by default false
+     * @param mixed  $oldState
+     *
+     * @return SyncObject/boolean       false if not found
+     */
+    public function GetFolder($serverid, $oldState = false) {
+        if (!$oldState && array_key_exists($serverid, $this->data)) {
+            return $this->data[$serverid];
+        }
+        if ($oldState && array_key_exists($serverid, $this->dataOld)) {
+            return $this->dataOld[$serverid];
+        }
+
+        return false;
+    }
+
+    /**
+     * Adds a folder to the HierarchyCache.
+     *
+     * @param SyncObject $folder
+     *
+     * @return bool
+     */
+    public function AddFolder($folder) {
+        SLog::Write(LOGLEVEL_DEBUG, "HierarchyCache: AddFolder() serverid: {$folder->serverid} displayname: {$folder->displayname}");
+
+        // on update the $folder does most of the times not contain a type
+        // we copy the value in this case to the new $folder object
+        if (isset($this->data[$folder->serverid]) && (!isset($folder->type) || $folder->type == false) && isset($this->data[$folder->serverid]->type)) {
+            $folder->type = $this->data[$folder->serverid]->type;
+            SLog::Write(LOGLEVEL_DEBUG, sprintf("HierarchyCache: AddFolder() is an update: used type '%s' from old object", $folder->type));
+        }
+
+        // add/update
+        $this->data[$folder->serverid] = $folder;
+        $this->changed = true;
+
+        return true;
+    }
+
+    /**
+     * Removes a folder to the HierarchyCache.
+     *
+     * @param string $serverid id of folder to be removed
+     *
+     * @return bool
+     */
+    public function DelFolder($serverid) {
+        $ftype = $this->GetFolder($serverid);
+
+        SLog::Write(LOGLEVEL_DEBUG, sprintf("HierarchyCache: DelFolder() serverid: '%s' - type: '%s'", $serverid, $ftype->type));
+        unset($this->data[$serverid]);
+        $this->changed = true;
+
+        return true;
+    }
+
+    /**
+     * Imports a folder array to the HierarchyCache.
+     *
+     * @param array $folders folders to the HierarchyCache
+     *
+     * @return bool
+     */
+    public function ImportFolders($folders) {
+        if (!is_array($folders)) {
+            return false;
+        }
+
+        $this->data = [];
+
+        foreach ($folders as $folder) {
+            if (!isset($folder->type)) {
+                continue;
+            }
+            $this->AddFolder($folder);
+        }
+
+        return true;
+    }
+
+    /**
+     * Exports all folders from the HierarchyCache.
+     *
+     * @param bool $oldstate (optional) by default false
+     *
+     * @return array
+     */
+    public function ExportFolders($oldstate = false) {
+        if ($oldstate === false) {
+            return $this->data;
+        }
+
+        return $this->dataOld;
+    }
+
+    /**
+     * Returns all folder objects which were deleted in this operation.
+     *
+     * @return array with SyncFolder objects
+     */
+    public function GetDeletedFolders() {
+        // diffing the Olddata with data we know if folders were deleted
+        return array_diff_key($this->dataOld, $this->data);
+    }
+
+    /**
+     * Returns some statistics about the HierarchyCache.
+     *
+     * @return string
+     */
+    public function GetStat() {
+        return sprintf("HierarchyCache is %s - Cached objects: %d", ((isset($this->data)) ? "up" : "down"), ((isset($this->data)) ? count($this->data) : "0"));
+    }
+
+    /**
+     * Removes internal data from the object, so this data can not be exposed.
+     *
+     * @return bool
+     */
+    public function StripData() {
+        unset($this->changed, $this->dataOld);
+
+        foreach ($this->data as $id => $folder) {
+            $folder->StripData();
+        }
+
+        return true;
+    }
+
+    /**
+     * Returns objects which should be persistent
+     * called before serialization.
+     *
+     * @return array
+     */
+    public function __sleep() {
+        return ["data"];
+    }
 }

lib/core/changesmemorywrapper.php

Indentation +402 added lines, -402 removed lines

@@ -8,412 +8,412 @@
  */
 
 class ChangesMemoryWrapper extends HierarchyCache implements IImportChanges, IExportChanges {
-	public const CHANGE = 1;
-	public const DELETION = 2;
-	public const SOFTDELETION = 3;
-	public const SYNCHRONIZING = 4;
-
-	private $changes;
-	private $step;
-	private $destinationImporter;
-	private $exportImporter;
-	private $impersonating;
-	private $foldersWithoutPermissions;
-
-	/**
-	 * Constructor.
-	 *
-	 * @return
-	 */
-	public function __construct() {
-		$this->changes = [];
-		$this->step = 0;
-		$this->impersonating = null;
-		$this->foldersWithoutPermissions = [];
-		parent::__construct();
-	}
-
-	/**
-	 * Only used to load additional folder sync information for hierarchy changes.
-	 *
-	 * @param array $state current state of additional hierarchy folders
-	 * @param mixed $flags
-	 *
-	 * @return bool
-	 */
-	public function Config($state, $flags = 0) {
-		if ($this->impersonating == null) {
-			$this->impersonating = (Request::GetImpersonatedUser()) ? strtolower(Request::GetImpersonatedUser()) : false;
-		}
-
-		// we should never forward this changes to a backend
-		if (!isset($this->destinationImporter)) {
-			foreach ($state as $addKey => $addFolder) {
-				SLog::Write(LOGLEVEL_DEBUG, sprintf("ChangesMemoryWrapper->Config(AdditionalFolders) : process folder '%s'", $addFolder->displayname));
-				if (isset($addFolder->NoBackendFolder) && $addFolder->NoBackendFolder == true) {
-					// check rights for readonly access only
-					$hasRights = GSync::GetBackend()->Setup($addFolder->Store, true, $addFolder->BackendId, true);
-					// delete the folder on the device
-					if (!$hasRights) {
-						// delete the folder only if it was an additional folder before, else ignore it
-						$synchedfolder = $this->GetFolder($addFolder->serverid);
-						if (isset($synchedfolder->NoBackendFolder) && $synchedfolder->NoBackendFolder == true) {
-							$this->ImportFolderDeletion($addFolder);
-						}
-
-						continue;
-					}
-				}
-				// make sure, if the folder is already in cache, to set the TypeReal flag (if available)
-				$cacheFolder = $this->GetFolder($addFolder->serverid);
-				if (isset($cacheFolder->TypeReal)) {
-					$addFolder->TypeReal = $cacheFolder->TypeReal;
-					SLog::Write(LOGLEVEL_DEBUG, sprintf("ChangesMemoryWrapper->Config(): Set REAL foldertype for folder '%s' from cache: '%s'", $addFolder->displayname, $addFolder->TypeReal));
-				}
-
-				// add folder to the device - if folder is already on the device, nothing will happen
-				$this->ImportFolderChange($addFolder);
-			}
-
-			// look for folders which are currently on the device if there are now not to be synched anymore
-			$alreadyDeleted = $this->GetDeletedFolders();
-			$folderIdsOnClient = [];
-			foreach ($this->ExportFolders(true) as $sid => $folder) {
-				// we are only looking at additional folders
-				if (isset($folder->NoBackendFolder)) {
-					// look if this folder is still in the list of additional folders and was not already deleted (e.g. missing permissions)
-					if (!array_key_exists($sid, $state) && !array_key_exists($sid, $alreadyDeleted)) {
-						SLog::Write(LOGLEVEL_INFO, sprintf("ChangesMemoryWrapper->Config(AdditionalFolders) : previously synchronized folder '%s' is not to be synched anymore. Sending delete to mobile.", $folder->displayname));
-						$this->ImportFolderDeletion($folder);
-					}
-				}
-				else {
-					$folderIdsOnClient[] = $sid;
-				}
-			}
-
-			// check permissions on impersonated folders
-			if ($this->impersonating) {
-				SLog::Write(LOGLEVEL_DEBUG, "ChangesMemoryWrapper->Config(): check permissions of folders of impersonated account");
-				$hierarchy = GSync::GetBackend()->GetHierarchy();
-				foreach ($hierarchy as $folder) {
-					// Check for at least read permissions of the impersonater on folders
-					$hasRights = GSync::GetBackend()->Setup($this->impersonating, true, $folder->BackendId, true);
-
-					// the folder has no permissions
-					if (!$hasRights) {
-						$this->foldersWithoutPermissions[$folder->serverid] = $folder;
-						// if it's on the device, remove it
-						if (in_array($folder->serverid, $folderIdsOnClient)) {
-							SLog::Write(LOGLEVEL_DEBUG, sprintf("ChangesMemoryWrapper->Config(AdditionalFolders) : previously synchronized folder '%s' has no permissions anymore. Sending delete to mobile.", $folder->displayname));
-							// delete folder into memory so it's then sent to the client
-							$this->ImportFolderDeletion($folder);
-						}
-					}
-					// has permissions but is not on the device, add it
-					elseif (!in_array($folder->serverid, $folderIdsOnClient)) {
-						$folder->flags = SYNC_NEWMESSAGE;
-						$this->ImportFolderChange($folder);
-					}
-				}
-			}
-		}
-
-		return true;
-	}
-
-	/**
-	 * Implement interfaces which are never used.
-	 */
-	public function GetState() {
-		return false;
-	}
-
-	public function LoadConflicts($contentparameters, $state) {
-		return true;
-	}
-
-	public function ConfigContentParameters($contentparameters) {
-		return true;
-	}
-
-	public function ImportMessageReadFlag($id, $flags, $categories = []) {
-		return true;
-	}
-
-	public function ImportMessageMove($id, $newfolder) {
-		return true;
-	}
-
-	/*----------------------------------------------------------------------------------------------------------
+    public const CHANGE = 1;
+    public const DELETION = 2;
+    public const SOFTDELETION = 3;
+    public const SYNCHRONIZING = 4;
+
+    private $changes;
+    private $step;
+    private $destinationImporter;
+    private $exportImporter;
+    private $impersonating;
+    private $foldersWithoutPermissions;
+
+    /**
+     * Constructor.
+     *
+     * @return
+     */
+    public function __construct() {
+        $this->changes = [];
+        $this->step = 0;
+        $this->impersonating = null;
+        $this->foldersWithoutPermissions = [];
+        parent::__construct();
+    }
+
+    /**
+     * Only used to load additional folder sync information for hierarchy changes.
+     *
+     * @param array $state current state of additional hierarchy folders
+     * @param mixed $flags
+     *
+     * @return bool
+     */
+    public function Config($state, $flags = 0) {
+        if ($this->impersonating == null) {
+            $this->impersonating = (Request::GetImpersonatedUser()) ? strtolower(Request::GetImpersonatedUser()) : false;
+        }
+
+        // we should never forward this changes to a backend
+        if (!isset($this->destinationImporter)) {
+            foreach ($state as $addKey => $addFolder) {
+                SLog::Write(LOGLEVEL_DEBUG, sprintf("ChangesMemoryWrapper->Config(AdditionalFolders) : process folder '%s'", $addFolder->displayname));
+                if (isset($addFolder->NoBackendFolder) && $addFolder->NoBackendFolder == true) {
+                    // check rights for readonly access only
+                    $hasRights = GSync::GetBackend()->Setup($addFolder->Store, true, $addFolder->BackendId, true);
+                    // delete the folder on the device
+                    if (!$hasRights) {
+                        // delete the folder only if it was an additional folder before, else ignore it
+                        $synchedfolder = $this->GetFolder($addFolder->serverid);
+                        if (isset($synchedfolder->NoBackendFolder) && $synchedfolder->NoBackendFolder == true) {
+                            $this->ImportFolderDeletion($addFolder);
+                        }
+
+                        continue;
+                    }
+                }
+                // make sure, if the folder is already in cache, to set the TypeReal flag (if available)
+                $cacheFolder = $this->GetFolder($addFolder->serverid);
+                if (isset($cacheFolder->TypeReal)) {
+                    $addFolder->TypeReal = $cacheFolder->TypeReal;
+                    SLog::Write(LOGLEVEL_DEBUG, sprintf("ChangesMemoryWrapper->Config(): Set REAL foldertype for folder '%s' from cache: '%s'", $addFolder->displayname, $addFolder->TypeReal));
+                }
+
+                // add folder to the device - if folder is already on the device, nothing will happen
+                $this->ImportFolderChange($addFolder);
+            }
+
+            // look for folders which are currently on the device if there are now not to be synched anymore
+            $alreadyDeleted = $this->GetDeletedFolders();
+            $folderIdsOnClient = [];
+            foreach ($this->ExportFolders(true) as $sid => $folder) {
+                // we are only looking at additional folders
+                if (isset($folder->NoBackendFolder)) {
+                    // look if this folder is still in the list of additional folders and was not already deleted (e.g. missing permissions)
+                    if (!array_key_exists($sid, $state) && !array_key_exists($sid, $alreadyDeleted)) {
+                        SLog::Write(LOGLEVEL_INFO, sprintf("ChangesMemoryWrapper->Config(AdditionalFolders) : previously synchronized folder '%s' is not to be synched anymore. Sending delete to mobile.", $folder->displayname));
+                        $this->ImportFolderDeletion($folder);
+                    }
+                }
+                else {
+                    $folderIdsOnClient[] = $sid;
+                }
+            }
+
+            // check permissions on impersonated folders
+            if ($this->impersonating) {
+                SLog::Write(LOGLEVEL_DEBUG, "ChangesMemoryWrapper->Config(): check permissions of folders of impersonated account");
+                $hierarchy = GSync::GetBackend()->GetHierarchy();
+                foreach ($hierarchy as $folder) {
+                    // Check for at least read permissions of the impersonater on folders
+                    $hasRights = GSync::GetBackend()->Setup($this->impersonating, true, $folder->BackendId, true);
+
+                    // the folder has no permissions
+                    if (!$hasRights) {
+                        $this->foldersWithoutPermissions[$folder->serverid] = $folder;
+                        // if it's on the device, remove it
+                        if (in_array($folder->serverid, $folderIdsOnClient)) {
+                            SLog::Write(LOGLEVEL_DEBUG, sprintf("ChangesMemoryWrapper->Config(AdditionalFolders) : previously synchronized folder '%s' has no permissions anymore. Sending delete to mobile.", $folder->displayname));
+                            // delete folder into memory so it's then sent to the client
+                            $this->ImportFolderDeletion($folder);
+                        }
+                    }
+                    // has permissions but is not on the device, add it
+                    elseif (!in_array($folder->serverid, $folderIdsOnClient)) {
+                        $folder->flags = SYNC_NEWMESSAGE;
+                        $this->ImportFolderChange($folder);
+                    }
+                }
+            }
+        }
+
+        return true;
+    }
+
+    /**
+     * Implement interfaces which are never used.
+     */
+    public function GetState() {
+        return false;
+    }
+
+    public function LoadConflicts($contentparameters, $state) {
+        return true;
+    }
+
+    public function ConfigContentParameters($contentparameters) {
+        return true;
+    }
+
+    public function ImportMessageReadFlag($id, $flags, $categories = []) {
+        return true;
+    }
+
+    public function ImportMessageMove($id, $newfolder) {
+        return true;
+    }
+
+    /*----------------------------------------------------------------------------------------------------------
 	 * IImportChanges & destination importer
 	 */
 
-	/**
-	 * Sets an importer where incoming changes should be sent to.
-	 *
-	 * @param IImportChanges $importer message to be changed
-	 *
-	 * @return bool
-	 */
-	public function SetDestinationImporter(&$importer) {
-		$this->destinationImporter = $importer;
-
-		return true;
-	}
-
-	/**
-	 * Imports a message change, which is imported into memory.
-	 *
-	 * @param string     $id      id of message which is changed
-	 * @param SyncObject $message message to be changed
-	 *
-	 * @return bool
-	 */
-	public function ImportMessageChange($id, $message) {
-		$this->changes[] = [self::CHANGE, $id];
-
-		return true;
-	}
-
-	/**
-	 * Imports a message deletion, which is imported into memory.
-	 *
-	 * @param string $id           id of message which is deleted
-	 * @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 ($asSoftDelete === true) {
-			$this->changes[] = [self::SOFTDELETION, $id];
-		}
-		else {
-			$this->changes[] = [self::DELETION, $id];
-		}
-
-		return true;
-	}
-
-	/**
-	 * Checks if a message id is flagged as changed.
-	 *
-	 * @param string $id message id
-	 *
-	 * @return bool
-	 */
-	public function IsChanged($id) {
-		return (array_search([self::CHANGE, $id], $this->changes) === false) ? false : true;
-	}
-
-	/**
-	 * Checks if a message id is flagged as deleted.
-	 *
-	 * @param string $id message id
-	 *
-	 * @return bool
-	 */
-	public function IsDeleted($id) {
-		return !((array_search([self::DELETION, $id], $this->changes) === false) && (array_search([self::SOFTDELETION, $id], $this->changes) === false));
-	}
-
-	/**
-	 * Imports a folder change.
-	 *
-	 * @param SyncFolder $folder folder to be changed
-	 *
-	 * @return boolean/SyncObject           status/object with the ath least the serverid of the folder set
-	 */
-	public function ImportFolderChange($folder) {
-		// if the destinationImporter is set, then this folder should be processed by another importer
-		// instead of being loaded in memory.
-		if (isset($this->destinationImporter)) {
-			// normally the $folder->type is not set, but we need this value to check if the change operation is permitted
-			// e.g. system folders can normally not be changed - set the type from cache and let the destinationImporter decide
-			if (!isset($folder->type) || !$folder->type) {
-				$cacheFolder = $this->GetFolder($folder->serverid);
-				$folder->type = $cacheFolder->type;
-				SLog::Write(LOGLEVEL_DEBUG, sprintf("ChangesMemoryWrapper->ImportFolderChange(): Set foldertype for folder '%s' from cache as it was not sent: '%s'", $folder->displayname, $folder->type));
-				if (isset($cacheFolder->TypeReal)) {
-					$folder->TypeReal = $cacheFolder->TypeReal;
-					SLog::Write(LOGLEVEL_DEBUG, sprintf("ChangesMemoryWrapper->ImportFolderChange(): Set REAL foldertype for folder '%s' from cache: '%s'", $folder->displayname, $folder->TypeReal));
-				}
-			}
-
-			$retFolder = $this->destinationImporter->ImportFolderChange($folder);
-
-			// if the operation was successful, update the HierarchyCache
-			if ($retFolder) {
-				// if we get a folder back, we need to update some data in the cache
-				if (isset($retFolder->serverid) && $retFolder->serverid) {
-					// for folder creation, the serverid & backendid are not set and have to be updated
-					if (!isset($folder->serverid) || $folder->serverid == "") {
-						$folder->serverid = $retFolder->serverid;
-						if (isset($retFolder->BackendId) && $retFolder->BackendId) {
-							$folder->BackendId = $retFolder->BackendId;
-						}
-					}
-
-					// if the parentid changed (folder was moved) this needs to be updated as well
-					if ($retFolder->parentid != $folder->parentid) {
-						$folder->parentid = $retFolder->parentid;
-					}
-				}
-
-				$this->AddFolder($folder);
-			}
-
-			return $retFolder;
-		}
-		// load into memory
-
-		if (isset($folder->serverid)) {
-			// The grommunio HierarchyExporter exports all kinds of changes for folders (e.g. update no. of unread messages in a folder).
-			// These changes are not relevant for the mobiles, as something changes but the relevant displayname and parentid
-			// stay the same. These changes will be dropped and are not sent!
-			if ($folder->equals($this->GetFolder($folder->serverid), false, true)) {
-				SLog::Write(LOGLEVEL_DEBUG, sprintf("ChangesMemoryWrapper->ImportFolderChange(): Change for folder '%s' will not be sent as modification is not relevant.", $folder->displayname));
-
-				return false;
-			}
-
-			// check if the parent ID is known on the device
-			if (!isset($folder->parentid) || ($folder->parentid != "0" && !$this->GetFolder($folder->parentid))) {
-				SLog::Write(LOGLEVEL_DEBUG, sprintf("ChangesMemoryWrapper->ImportFolderChange(): Change for folder '%s' will not be sent as parent folder is not set or not known on mobile.", $folder->displayname));
-
-				return false;
-			}
-
-			// folder changes are only sent if the user has permissions on that folder, if not, change is ignored
-			if ($this->impersonating && array_key_exists($folder->serverid, $this->foldersWithoutPermissions)) {
-				SLog::Write(LOGLEVEL_DEBUG, sprintf("ChangesMemoryWrapper->ImportFolderChange(): Change for folder '%s' will not be sent as impersonating user has no permissions on folder.", $folder->displayname));
-
-				return false;
-			}
-
-			// load this change into memory
-			$this->changes[] = [self::CHANGE, $folder];
-
-			// HierarchyCache: already add/update the folder so changes are not sent twice (if exported twice)
-			$this->AddFolder($folder);
-
-			return true;
-		}
-
-		return false;
-	}
-
-	/**
-	 * Imports a folder deletion.
-	 *
-	 * @param SyncFolder $folder at least "serverid" needs to be set
-	 *
-	 * @return bool
-	 */
-	public function ImportFolderDeletion($folder) {
-		$id = $folder->serverid;
-
-		// if the forwarder is set, then this folder should be processed by another importer
-		// instead of being loaded in mem.
-		if (isset($this->destinationImporter)) {
-			$ret = $this->destinationImporter->ImportFolderDeletion($folder);
-
-			// if the operation was successful, update the HierarchyCache
-			if ($ret) {
-				$this->DelFolder($id);
-			}
-
-			return $ret;
-		}
-
-		// if this folder is not in the cache, the change does not need to be streamed to the mobile
-		if ($this->GetFolder($id)) {
-			// load this change into memory
-			$this->changes[] = [self::DELETION, $folder];
-
-			// HierarchyCache: delete the folder so changes are not sent twice (if exported twice)
-			$this->DelFolder($id);
-
-			return true;
-		}
-	}
-
-	/*----------------------------------------------------------------------------------------------------------
+    /**
+     * Sets an importer where incoming changes should be sent to.
+     *
+     * @param IImportChanges $importer message to be changed
+     *
+     * @return bool
+     */
+    public function SetDestinationImporter(&$importer) {
+        $this->destinationImporter = $importer;
+
+        return true;
+    }
+
+    /**
+     * Imports a message change, which is imported into memory.
+     *
+     * @param string     $id      id of message which is changed
+     * @param SyncObject $message message to be changed
+     *
+     * @return bool
+     */
+    public function ImportMessageChange($id, $message) {
+        $this->changes[] = [self::CHANGE, $id];
+
+        return true;
+    }
+
+    /**
+     * Imports a message deletion, which is imported into memory.
+     *
+     * @param string $id           id of message which is deleted
+     * @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 ($asSoftDelete === true) {
+            $this->changes[] = [self::SOFTDELETION, $id];
+        }
+        else {
+            $this->changes[] = [self::DELETION, $id];
+        }
+
+        return true;
+    }
+
+    /**
+     * Checks if a message id is flagged as changed.
+     *
+     * @param string $id message id
+     *
+     * @return bool
+     */
+    public function IsChanged($id) {
+        return (array_search([self::CHANGE, $id], $this->changes) === false) ? false : true;
+    }
+
+    /**
+     * Checks if a message id is flagged as deleted.
+     *
+     * @param string $id message id
+     *
+     * @return bool
+     */
+    public function IsDeleted($id) {
+        return !((array_search([self::DELETION, $id], $this->changes) === false) && (array_search([self::SOFTDELETION, $id], $this->changes) === false));
+    }
+
+    /**
+     * Imports a folder change.
+     *
+     * @param SyncFolder $folder folder to be changed
+     *
+     * @return boolean/SyncObject           status/object with the ath least the serverid of the folder set
+     */
+    public function ImportFolderChange($folder) {
+        // if the destinationImporter is set, then this folder should be processed by another importer
+        // instead of being loaded in memory.
+        if (isset($this->destinationImporter)) {
+            // normally the $folder->type is not set, but we need this value to check if the change operation is permitted
+            // e.g. system folders can normally not be changed - set the type from cache and let the destinationImporter decide
+            if (!isset($folder->type) || !$folder->type) {
+                $cacheFolder = $this->GetFolder($folder->serverid);
+                $folder->type = $cacheFolder->type;
+                SLog::Write(LOGLEVEL_DEBUG, sprintf("ChangesMemoryWrapper->ImportFolderChange(): Set foldertype for folder '%s' from cache as it was not sent: '%s'", $folder->displayname, $folder->type));
+                if (isset($cacheFolder->TypeReal)) {
+                    $folder->TypeReal = $cacheFolder->TypeReal;
+                    SLog::Write(LOGLEVEL_DEBUG, sprintf("ChangesMemoryWrapper->ImportFolderChange(): Set REAL foldertype for folder '%s' from cache: '%s'", $folder->displayname, $folder->TypeReal));
+                }
+            }
+
+            $retFolder = $this->destinationImporter->ImportFolderChange($folder);
+
+            // if the operation was successful, update the HierarchyCache
+            if ($retFolder) {
+                // if we get a folder back, we need to update some data in the cache
+                if (isset($retFolder->serverid) && $retFolder->serverid) {
+                    // for folder creation, the serverid & backendid are not set and have to be updated
+                    if (!isset($folder->serverid) || $folder->serverid == "") {
+                        $folder->serverid = $retFolder->serverid;
+                        if (isset($retFolder->BackendId) && $retFolder->BackendId) {
+                            $folder->BackendId = $retFolder->BackendId;
+                        }
+                    }
+
+                    // if the parentid changed (folder was moved) this needs to be updated as well
+                    if ($retFolder->parentid != $folder->parentid) {
+                        $folder->parentid = $retFolder->parentid;
+                    }
+                }
+
+                $this->AddFolder($folder);
+            }
+
+            return $retFolder;
+        }
+        // load into memory
+
+        if (isset($folder->serverid)) {
+            // The grommunio HierarchyExporter exports all kinds of changes for folders (e.g. update no. of unread messages in a folder).
+            // These changes are not relevant for the mobiles, as something changes but the relevant displayname and parentid
+            // stay the same. These changes will be dropped and are not sent!
+            if ($folder->equals($this->GetFolder($folder->serverid), false, true)) {
+                SLog::Write(LOGLEVEL_DEBUG, sprintf("ChangesMemoryWrapper->ImportFolderChange(): Change for folder '%s' will not be sent as modification is not relevant.", $folder->displayname));
+
+                return false;
+            }
+
+            // check if the parent ID is known on the device
+            if (!isset($folder->parentid) || ($folder->parentid != "0" && !$this->GetFolder($folder->parentid))) {
+                SLog::Write(LOGLEVEL_DEBUG, sprintf("ChangesMemoryWrapper->ImportFolderChange(): Change for folder '%s' will not be sent as parent folder is not set or not known on mobile.", $folder->displayname));
+
+                return false;
+            }
+
+            // folder changes are only sent if the user has permissions on that folder, if not, change is ignored
+            if ($this->impersonating && array_key_exists($folder->serverid, $this->foldersWithoutPermissions)) {
+                SLog::Write(LOGLEVEL_DEBUG, sprintf("ChangesMemoryWrapper->ImportFolderChange(): Change for folder '%s' will not be sent as impersonating user has no permissions on folder.", $folder->displayname));
+
+                return false;
+            }
+
+            // load this change into memory
+            $this->changes[] = [self::CHANGE, $folder];
+
+            // HierarchyCache: already add/update the folder so changes are not sent twice (if exported twice)
+            $this->AddFolder($folder);
+
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * Imports a folder deletion.
+     *
+     * @param SyncFolder $folder at least "serverid" needs to be set
+     *
+     * @return bool
+     */
+    public function ImportFolderDeletion($folder) {
+        $id = $folder->serverid;
+
+        // if the forwarder is set, then this folder should be processed by another importer
+        // instead of being loaded in mem.
+        if (isset($this->destinationImporter)) {
+            $ret = $this->destinationImporter->ImportFolderDeletion($folder);
+
+            // if the operation was successful, update the HierarchyCache
+            if ($ret) {
+                $this->DelFolder($id);
+            }
+
+            return $ret;
+        }
+
+        // if this folder is not in the cache, the change does not need to be streamed to the mobile
+        if ($this->GetFolder($id)) {
+            // load this change into memory
+            $this->changes[] = [self::DELETION, $folder];
+
+            // HierarchyCache: delete the folder so changes are not sent twice (if exported twice)
+            $this->DelFolder($id);
+
+            return true;
+        }
+    }
+
+    /*----------------------------------------------------------------------------------------------------------
 	 * IExportChanges & destination importer
 	 */
 
-	/**
-	 * Initializes the Exporter where changes are synchronized to.
-	 *
-	 * @param IImportChanges $importer
-	 *
-	 * @return bool
-	 */
-	public function InitializeExporter(&$importer) {
-		$this->exportImporter = $importer;
-		$this->step = 0;
-
-		return true;
-	}
-
-	/**
-	 * Returns the amount of changes to be exported.
-	 *
-	 * @return int
-	 */
-	public function GetChangeCount() {
-		return count($this->changes);
-	}
-
-	/**
-	 * Synchronizes a change. Only HierarchyChanges will be Synchronized().
-	 *
-	 * @return array
-	 */
-	public function Synchronize() {
-		if ($this->step < count($this->changes) && isset($this->exportImporter)) {
-			$change = $this->changes[$this->step];
-
-			if ($change[0] == self::CHANGE) {
-				if (!$this->GetFolder($change[1]->serverid, true)) {
-					$change[1]->flags = SYNC_NEWMESSAGE;
-				}
-
-				$this->exportImporter->ImportFolderChange($change[1]);
-			}
-			// deletion
-			else {
-				$this->exportImporter->ImportFolderDeletion($change[1]);
-			}
-			++$this->step;
-
-			// return progress array
-			return ["steps" => count($this->changes), "progress" => $this->step];
-		}
-
-		return false;
-	}
-
-	/**
-	 * Initializes a few instance variables
-	 * called after unserialization.
-	 *
-	 * @return array
-	 */
-	public function __wakeup() {
-		$this->changes = [];
-		$this->step = 0;
-		$this->foldersWithoutPermissions = [];
-	}
-
-	/**
-	 * Removes internal data from the object, so this data can not be exposed.
-	 *
-	 * @return bool
-	 */
-	public function StripData() {
-		unset($this->changes, $this->step, $this->destinationImporter, $this->exportImporter);
-
-		return parent::StripData();
-	}
+    /**
+     * Initializes the Exporter where changes are synchronized to.
+     *
+     * @param IImportChanges $importer
+     *
+     * @return bool
+     */
+    public function InitializeExporter(&$importer) {
+        $this->exportImporter = $importer;
+        $this->step = 0;
+
+        return true;
+    }
+
+    /**
+     * Returns the amount of changes to be exported.
+     *
+     * @return int
+     */
+    public function GetChangeCount() {
+        return count($this->changes);
+    }
+
+    /**
+     * Synchronizes a change. Only HierarchyChanges will be Synchronized().
+     *
+     * @return array
+     */
+    public function Synchronize() {
+        if ($this->step < count($this->changes) && isset($this->exportImporter)) {
+            $change = $this->changes[$this->step];
+
+            if ($change[0] == self::CHANGE) {
+                if (!$this->GetFolder($change[1]->serverid, true)) {
+                    $change[1]->flags = SYNC_NEWMESSAGE;
+                }
+
+                $this->exportImporter->ImportFolderChange($change[1]);
+            }
+            // deletion
+            else {
+                $this->exportImporter->ImportFolderDeletion($change[1]);
+            }
+            ++$this->step;
+
+            // return progress array
+            return ["steps" => count($this->changes), "progress" => $this->step];
+        }
+
+        return false;
+    }
+
+    /**
+     * Initializes a few instance variables
+     * called after unserialization.
+     *
+     * @return array
+     */
+    public function __wakeup() {
+        $this->changes = [];
+        $this->step = 0;
+        $this->foldersWithoutPermissions = [];
+    }
+
+    /**
+     * Removes internal data from the object, so this data can not be exposed.
+     *
+     * @return bool
+     */
+    public function StripData() {
+        unset($this->changes, $this->step, $this->destinationImporter, $this->exportImporter);
+
+        return parent::StripData();
+    }
 }

Braces +2 added lines, -4 removed lines

@@ -86,8 +86,7 @@ 
 						SLog::Write(LOGLEVEL_INFO, sprintf("ChangesMemoryWrapper->Config(AdditionalFolders) : previously synchronized folder '%s' is not to be synched anymore. Sending delete to mobile.", $folder->displayname));
 						$this->ImportFolderDeletion($folder);
 					}
-				}
-				else {
+				} else {
 					$folderIdsOnClient[] = $sid;
 				}
 			}
@@ -187,8 +186,7 @@ 
 	public function ImportMessageDeletion($id, $asSoftDelete = false) {
 		if ($asSoftDelete === true) {
 			$this->changes[] = [self::SOFTDELETION, $id];
-		}
-		else {
+		} else {
 			$this->changes[] = [self::DELETION, $id];
 		}
 

lib/core/interprocessdata.php

Indentation +259 added lines, -259 removed lines

@@ -9,293 +9,293 @@
  */
 
 abstract class InterProcessData {
-	public const CLEANUPTIME = 1;
+    public const CLEANUPTIME = 1;
 
-	protected static $devid;
-	protected static $pid;
-	protected static $user;
-	protected static $start;
-	protected $type;
-	protected $allocate;
+    protected static $devid;
+    protected static $pid;
+    protected static $user;
+    protected static $start;
+    protected $type;
+    protected $allocate;
 
-	/**
-	 * @var IIpcProvider
-	 */
-	private $ipcProvider;
+    /**
+     * @var IIpcProvider
+     */
+    private $ipcProvider;
 
-	/**
-	 * Constructor.
-	 */
-	public function __construct() {
-		if (!isset($this->type) || !isset($this->allocate)) {
-			throw new FatalNotImplementedException(sprintf("Class InterProcessData can not be initialized. Subclass %s did not initialize type and allocable memory.", get_class($this)));
-		}
+    /**
+     * Constructor.
+     */
+    public function __construct() {
+        if (!isset($this->type) || !isset($this->allocate)) {
+            throw new FatalNotImplementedException(sprintf("Class InterProcessData can not be initialized. Subclass %s did not initialize type and allocable memory.", get_class($this)));
+        }
 
-		try {
-			// ZP-987: use an own mutex + storage key for each device on non-shared-memory IPC
-			// this method is not suitable for the TopCollector atm
-			$type = Request::GetDeviceID();
-			$this->ipcProvider = GSync::GetRedis();
-		}
-		catch (Exception $e) {
-			// ipcProvider could not initialise
-			SLog::Write(LOGLEVEL_ERROR, sprintf("%s could not initialise IPC Redis provider: %s", get_class($this), $e->getMessage()));
-		}
-	}
+        try {
+            // ZP-987: use an own mutex + storage key for each device on non-shared-memory IPC
+            // this method is not suitable for the TopCollector atm
+            $type = Request::GetDeviceID();
+            $this->ipcProvider = GSync::GetRedis();
+        }
+        catch (Exception $e) {
+            // ipcProvider could not initialise
+            SLog::Write(LOGLEVEL_ERROR, sprintf("%s could not initialise IPC Redis provider: %s", get_class($this), $e->getMessage()));
+        }
+    }
 
-	/**
-	 * Initializes internal parameters.
-	 *
-	 * @return bool
-	 */
-	protected function initializeParams() {
-		if (!isset(self::$devid)) {
-			self::$devid = Request::GetDeviceID();
-			self::$pid = @getmypid();
-			self::$user = Request::GetAuthUserString(); // we want to see everything here
-			self::$start = time();
-			if (!self::$devid) {
-				self::$devid = "none";
-			}
-		}
+    /**
+     * Initializes internal parameters.
+     *
+     * @return bool
+     */
+    protected function initializeParams() {
+        if (!isset(self::$devid)) {
+            self::$devid = Request::GetDeviceID();
+            self::$pid = @getmypid();
+            self::$user = Request::GetAuthUserString(); // we want to see everything here
+            self::$start = time();
+            if (!self::$devid) {
+                self::$devid = "none";
+            }
+        }
 
-		return true;
-	}
+        return true;
+    }
 
-	/**
-	 * Returns the underlying redis connection object.
-	 *
-	 * @return RedisConnection
-	 */
-	protected function getRedis() {
-		return $this->ipcProvider;
-	}
+    /**
+     * Returns the underlying redis connection object.
+     *
+     * @return RedisConnection
+     */
+    protected function getRedis() {
+        return $this->ipcProvider;
+    }
 
-	/**
-	 * Reinitializes the IPC data by removing, detaching and re-allocating it.
-	 *
-	 * @return bool
-	 */
-	public function ReInitIPC() {
-		// TODO: do we need this?
-		return false;
-	}
+    /**
+     * Reinitializes the IPC data by removing, detaching and re-allocating it.
+     *
+     * @return bool
+     */
+    public function ReInitIPC() {
+        // TODO: do we need this?
+        return false;
+    }
 
-	/**
-	 * Cleans up the IPC data block.
-	 *
-	 * @return bool
-	 */
-	public function Clean() {
-		// TODO: do we need this?
-		return false;
-	}
+    /**
+     * Cleans up the IPC data block.
+     *
+     * @return bool
+     */
+    public function Clean() {
+        // TODO: do we need this?
+        return false;
+    }
 
-	/**
-	 * Indicates if the IPC is active.
-	 *
-	 * @return bool
-	 */
-	public function IsActive() {
-		return true;
-	}
+    /**
+     * Indicates if the IPC is active.
+     *
+     * @return bool
+     */
+    public function IsActive() {
+        return true;
+    }
 
-	/**
-	 * Blocks the class mutex.
-	 * Method blocks until mutex is available!
-	 * ATTENTION: make sure that you *always* release a blocked mutex!
-	 *
-	 * @return bool
-	 */
-	protected function blockMutex() {
-		return true;
-	}
+    /**
+     * Blocks the class mutex.
+     * Method blocks until mutex is available!
+     * ATTENTION: make sure that you *always* release a blocked mutex!
+     *
+     * @return bool
+     */
+    protected function blockMutex() {
+        return true;
+    }
 
-	/**
-	 * Releases the class mutex.
-	 * After the release other processes are able to block the mutex themselves.
-	 *
-	 * @return bool
-	 */
-	protected function releaseMutex() {
-		return true;
-	}
+    /**
+     * Releases the class mutex.
+     * After the release other processes are able to block the mutex themselves.
+     *
+     * @return bool
+     */
+    protected function releaseMutex() {
+        return true;
+    }
 
-	/**
-	 * Indicates if the requested variable is available in IPC data.
-	 *
-	 * @param int $id int indicating the variable
-	 *
-	 * @return bool
-	 */
-	protected function hasData($id = 2) {
-		return $this->ipcProvider ? $this->ipcProvider->get()->exists($id) : false;
-	}
+    /**
+     * Indicates if the requested variable is available in IPC data.
+     *
+     * @param int $id int indicating the variable
+     *
+     * @return bool
+     */
+    protected function hasData($id = 2) {
+        return $this->ipcProvider ? $this->ipcProvider->get()->exists($id) : false;
+    }
 
-	/**
-	 * Returns the requested variable from IPC data.
-	 *
-	 * @param int $id int indicating the variable
-	 *
-	 * @return mixed
-	 */
-	protected function getData($id = 2) {
-		return $this->ipcProvider ? json_decode($this->ipcProvider->getKey($id), true) : null;
-	}
+    /**
+     * Returns the requested variable from IPC data.
+     *
+     * @param int $id int indicating the variable
+     *
+     * @return mixed
+     */
+    protected function getData($id = 2) {
+        return $this->ipcProvider ? json_decode($this->ipcProvider->getKey($id), true) : null;
+    }
 
-	/**
-	 * Writes the transmitted variable to IPC data.
-	 * Subclasses may never use an id < 2!
-	 *
-	 * @param mixed $data data which should be saved into IPC data
-	 * @param int   $id   int indicating the variable (bigger than 2!)
-	 * @param mixed $ttl
-	 *
-	 * @return bool
-	 */
-	protected function setData($data, $id = 2, $ttl = -1) {
-		return $this->ipcProvider ? $this->ipcProvider->setKey($id, json_encode($data), $ttl) : false;
-	}
+    /**
+     * Writes the transmitted variable to IPC data.
+     * Subclasses may never use an id < 2!
+     *
+     * @param mixed $data data which should be saved into IPC data
+     * @param int   $id   int indicating the variable (bigger than 2!)
+     * @param mixed $ttl
+     *
+     * @return bool
+     */
+    protected function setData($data, $id = 2, $ttl = -1) {
+        return $this->ipcProvider ? $this->ipcProvider->setKey($id, json_encode($data), $ttl) : false;
+    }
 
-	protected function setDeviceUserData($key, $data, $devid, $user, $subkey = -1, $doCas = false, $rawdata = false) {
-		$compKey = $this->getComposedKey($devid, $user, $subkey);
+    protected function setDeviceUserData($key, $data, $devid, $user, $subkey = -1, $doCas = false, $rawdata = false) {
+        $compKey = $this->getComposedKey($devid, $user, $subkey);
 
-		// overwrite
-		if (!$doCas) {
-			$ok = ($this->ipcProvider->get()->hset($key, $compKey, json_encode($data)) !== false);
-		}
-		// merge data and do CAS on the $compKey
-		elseif ($doCas == "merge") {
-			$ok = false;
-			$okCount = 0;
-			// TODO: make this configurable (retrycount)?
-			while (!$ok && $okCount < 5) {
-				$newData = $data;
-				// step 1:  get current data
-				$_rawdata = $this->ipcProvider->get()->hget($key, $compKey);
-				// step 2:  if data exists, merge it with the new data. Keys within
-				//          within the new data overwrite possible existing old data (update).
-				if ($_rawdata && $_rawdata !== null) {
-					$_old = json_decode($_rawdata, true);
-					$newData = array_merge($_old, $data);
-				}
-				// step 3:  replace old with new data
-				$ok = $this->ipcProvider->CASHash($key, $compKey, $_rawdata, json_encode($newData));
-				if (!$ok) {
-					++$okCount;
-					// retry in 0.1s
-					// TODO: make this configurable?
-					usleep(1000000);
-				}
-			}
-		}
-		// replace data and do CAS on the $compKey - fail hard if CAS fails
-		elseif ($doCas == "replace") {
-			if (!$rawdata) {
-				$ok = ($this->ipcProvider->get()->hset($key, $compKey, json_encode($data)) !== false);
-			}
-			else {
-				$ok = $this->ipcProvider->CASHash($key, $compKey, $rawdata, json_encode($data));
-			}
-		}
-		// delete keys of data and do CAS on the $compKey
-		elseif ($doCas == "deletekeys") {
-			$ok = false;
-			$okCount = 0;
-			// TODO: make this configurable (retrycount)?
-			while (!$ok && $okCount < 5) {
-				// step 1:  get current data
-				$_rawdata = $this->ipcProvider->get()->hget($key, $compKey);
-				$newData = json_decode($_rawdata, true);
-				# no data to delete from, done
-				if (!is_array($newData) || count($newData) == 0) {
-					break;
-				}
-				// step 2:  if data exists, delete the keys of $data from it
-				foreach ($data as $delKey) {
-					unset($newData[$delKey]);
-				}
-				$rawNewData = json_encode($newData);
-				// step 3:  check if the data actually changed (not the correctest way to compare these, but still valid for our data)
-				if ($_rawdata == $rawNewData) {
-					break;
-				}
-				// step 4:  replace old with new data
-				$ok = $this->ipcProvider->CASHash($key, $compKey, $_rawdata, $rawNewData);
-				if (!$ok) {
-					++$okCount;
-					// TODO: make this configurable?
-					// retry in 0.1s
-					usleep(100000);
-					SLog::Write(LOG_DEBUG, "InterProcessData: setDeviceUserData CAS failed, retrying...");
-				}
-			}
-		}
+        // overwrite
+        if (!$doCas) {
+            $ok = ($this->ipcProvider->get()->hset($key, $compKey, json_encode($data)) !== false);
+        }
+        // merge data and do CAS on the $compKey
+        elseif ($doCas == "merge") {
+            $ok = false;
+            $okCount = 0;
+            // TODO: make this configurable (retrycount)?
+            while (!$ok && $okCount < 5) {
+                $newData = $data;
+                // step 1:  get current data
+                $_rawdata = $this->ipcProvider->get()->hget($key, $compKey);
+                // step 2:  if data exists, merge it with the new data. Keys within
+                //          within the new data overwrite possible existing old data (update).
+                if ($_rawdata && $_rawdata !== null) {
+                    $_old = json_decode($_rawdata, true);
+                    $newData = array_merge($_old, $data);
+                }
+                // step 3:  replace old with new data
+                $ok = $this->ipcProvider->CASHash($key, $compKey, $_rawdata, json_encode($newData));
+                if (!$ok) {
+                    ++$okCount;
+                    // retry in 0.1s
+                    // TODO: make this configurable?
+                    usleep(1000000);
+                }
+            }
+        }
+        // replace data and do CAS on the $compKey - fail hard if CAS fails
+        elseif ($doCas == "replace") {
+            if (!$rawdata) {
+                $ok = ($this->ipcProvider->get()->hset($key, $compKey, json_encode($data)) !== false);
+            }
+            else {
+                $ok = $this->ipcProvider->CASHash($key, $compKey, $rawdata, json_encode($data));
+            }
+        }
+        // delete keys of data and do CAS on the $compKey
+        elseif ($doCas == "deletekeys") {
+            $ok = false;
+            $okCount = 0;
+            // TODO: make this configurable (retrycount)?
+            while (!$ok && $okCount < 5) {
+                // step 1:  get current data
+                $_rawdata = $this->ipcProvider->get()->hget($key, $compKey);
+                $newData = json_decode($_rawdata, true);
+                # no data to delete from, done
+                if (!is_array($newData) || count($newData) == 0) {
+                    break;
+                }
+                // step 2:  if data exists, delete the keys of $data from it
+                foreach ($data as $delKey) {
+                    unset($newData[$delKey]);
+                }
+                $rawNewData = json_encode($newData);
+                // step 3:  check if the data actually changed (not the correctest way to compare these, but still valid for our data)
+                if ($_rawdata == $rawNewData) {
+                    break;
+                }
+                // step 4:  replace old with new data
+                $ok = $this->ipcProvider->CASHash($key, $compKey, $_rawdata, $rawNewData);
+                if (!$ok) {
+                    ++$okCount;
+                    // TODO: make this configurable?
+                    // retry in 0.1s
+                    usleep(100000);
+                    SLog::Write(LOG_DEBUG, "InterProcessData: setDeviceUserData CAS failed, retrying...");
+                }
+            }
+        }
 
-		return $ok;
-	}
+        return $ok;
+    }
 
-	protected function getDeviceUserData($key, $devid, $user, $subkey = -1, $returnRaw = false) {
-		$compKey = $this->getComposedKey($devid, $user, $subkey);
-		$_rawdata = $this->ipcProvider->get()->hget($key, $compKey);
-		if ($returnRaw) {
-			if ($_rawdata) {
-				return [json_decode($_rawdata, true), $_rawdata];
-			}
+    protected function getDeviceUserData($key, $devid, $user, $subkey = -1, $returnRaw = false) {
+        $compKey = $this->getComposedKey($devid, $user, $subkey);
+        $_rawdata = $this->ipcProvider->get()->hget($key, $compKey);
+        if ($returnRaw) {
+            if ($_rawdata) {
+                return [json_decode($_rawdata, true), $_rawdata];
+            }
 
-			return [[], false];
-		}
+            return [[], false];
+        }
 
-		if ($_rawdata) {
-			return json_decode($_rawdata, true);
-		}
+        if ($_rawdata) {
+            return json_decode($_rawdata, true);
+        }
 
-		return [];
-	}
+        return [];
+    }
 
-	protected function delDeviceUserData($key, $devid, $user, $subkey = -1) {
-		$compKey = $this->getComposedKey($devid, $user, $subkey);
+    protected function delDeviceUserData($key, $devid, $user, $subkey = -1) {
+        $compKey = $this->getComposedKey($devid, $user, $subkey);
 
-		return $this->ipcProvider->get()->hdel($key, $compKey);
-	}
+        return $this->ipcProvider->get()->hdel($key, $compKey);
+    }
 
-	protected function getAllDeviceUserData($key) {
-		$_data = [];
-		$raw = $this->ipcProvider->get()->hGetAll($key);
-		foreach ($raw as $compKey => $status) {
-			$_linedata = json_decode($status, true);
-			list($devid, $user, $subkey) = explode("|-|", $compKey);
-			if (!isset($_data[$devid])) {
-				$_data[$devid] = [];
-			}
-			if (!$subkey) {
-				$_data[$devid][$user] = $_data;
-			}
-			else {
-				if (!isset($_data[$devid][$user])) {
-					$_data[$devid][$user] = [];
-				}
-				$_data[$devid][$user][$subkey] = $_linedata;
-			}
-		}
+    protected function getAllDeviceUserData($key) {
+        $_data = [];
+        $raw = $this->ipcProvider->get()->hGetAll($key);
+        foreach ($raw as $compKey => $status) {
+            $_linedata = json_decode($status, true);
+            list($devid, $user, $subkey) = explode("|-|", $compKey);
+            if (!isset($_data[$devid])) {
+                $_data[$devid] = [];
+            }
+            if (!$subkey) {
+                $_data[$devid][$user] = $_data;
+            }
+            else {
+                if (!isset($_data[$devid][$user])) {
+                    $_data[$devid][$user] = [];
+                }
+                $_data[$devid][$user][$subkey] = $_linedata;
+            }
+        }
 
-		return $_data;
-	}
+        return $_data;
+    }
 
-	protected function getRawDeviceUserData($key) {
-		return $this->ipcProvider->get()->hGetAll($key);
-	}
+    protected function getRawDeviceUserData($key) {
+        return $this->ipcProvider->get()->hGetAll($key);
+    }
 
-	protected function getComposedKey($key1, $key2, $key3 = -1) {
-		$_k = $key1;
-		if ($key2 > -1) {
-			$_k .= "|-|" . $key2;
-		}
+    protected function getComposedKey($key1, $key2, $key3 = -1) {
+        $_k = $key1;
+        if ($key2 > -1) {
+            $_k .= "|-|" . $key2;
+        }
 
-		if ($key3 > -1) {
-			$_k .= "|-|" . $key3;
-		}
+        if ($key3 > -1) {
+            $_k .= "|-|" . $key3;
+        }
 
-		return $_k;
-	}
+        return $_k;
+    }
 }

Spacing +2 added lines, -2 removed lines

@@ -289,11 +289,11 @@
 	protected function getComposedKey($key1, $key2, $key3 = -1) {
 		$_k = $key1;
 		if ($key2 > -1) {
-			$_k .= "|-|" . $key2;
+			$_k .= "|-|".$key2;
 		}
 
 		if ($key3 > -1) {
-			$_k .= "|-|" . $key3;
+			$_k .= "|-|".$key3;
 		}
 
 		return $_k;

Braces +3 added lines, -6 removed lines

@@ -36,8 +36,7 @@ 
 			// this method is not suitable for the TopCollector atm
 			$type = Request::GetDeviceID();
 			$this->ipcProvider = GSync::GetRedis();
-		}
-		catch (Exception $e) {
+		} catch (Exception $e) {
 			// ipcProvider could not initialise
 			SLog::Write(LOGLEVEL_ERROR, sprintf("%s could not initialise IPC Redis provider: %s", get_class($this), $e->getMessage()));
 		}
@@ -193,8 +192,7 @@ 
 		elseif ($doCas == "replace") {
 			if (!$rawdata) {
 				$ok = ($this->ipcProvider->get()->hset($key, $compKey, json_encode($data)) !== false);
-			}
-			else {
+			} else {
 				$ok = $this->ipcProvider->CASHash($key, $compKey, $rawdata, json_encode($data));
 			}
 		}
@@ -270,8 +268,7 @@ 
 			}
 			if (!$subkey) {
 				$_data[$devid][$user] = $_data;
-			}
-			else {
+			} else {
 				if (!isset($_data[$devid][$user])) {
 					$_data[$devid][$user] = [];
 				}