grommunio / grommunio-sync

lib/utils/stringstreamwrapper.php

Indentation +152 added lines, -152 removed lines

@@ -9,158 +9,158 @@
  */
 
 class StringStreamWrapper {
-	public const PROTOCOL = "stringstream";
-
-	private $stringstream;
-	private $position;
-	private $stringlength;
-	private $truncateHtmlSafe;
-	private $context;
-
-	/**
-	 * Opens the stream
-	 * The string to be streamed is passed over the context.
-	 *
-	 * @param string $path        Specifies the URL that was passed to the original function
-	 * @param string $mode        The mode used to open the file, as detailed for fopen()
-	 * @param int    $options     Holds additional flags set by the streams API
-	 * @param string $opened_path if the path is opened successfully, and STREAM_USE_PATH is set in options,
-	 *                            opened_path should be set to the full path of the file/resource that was actually opened
-	 *
-	 * @return bool
-	 */
-	public function stream_open($path, $mode, $options, &$opened_path) {
-		$contextOptions = stream_context_get_options($this->context);
-		if (!isset($contextOptions[self::PROTOCOL]['string'])) {
-			return false;
-		}
-
-		$this->position = 0;
-
-		// this is our stream!
-		$this->stringstream = $contextOptions[self::PROTOCOL]['string'];
-		$this->truncateHtmlSafe = (isset($contextOptions[self::PROTOCOL]['truncatehtmlsafe'])) ? $contextOptions[self::PROTOCOL]['truncatehtmlsafe'] : false;
-
-		$this->stringlength = strlen($this->stringstream);
-		SLog::Write(LOGLEVEL_DEBUG, sprintf("StringStreamWrapper::stream_open(): initialized stream length: %d - HTML-safe-truncate: %s", $this->stringlength, Utils::PrintAsString($this->truncateHtmlSafe)));
-
-		return true;
-	}
-
-	/**
-	 * Reads from stream.
-	 *
-	 * @param int $len amount of bytes to be read
-	 *
-	 * @return string
-	 */
-	public function stream_read($len) {
-		$data = substr($this->stringstream, $this->position, $len);
-		$this->position += strlen($data);
-
-		return $data;
-	}
-
-	/**
-	 * Writes data to the stream.
-	 *
-	 * @param string $data
-	 *
-	 * @return int
-	 */
-	public function stream_write($data) {
-		$l = strlen($data);
-		$this->stringstream = substr($this->stringstream, 0, $this->position) . $data . substr($this->stringstream, $this->position += $l);
-		$this->stringlength = strlen($this->stringstream);
-
-		return $l;
-	}
-
-	/**
-	 * Stream "seek" functionality.
-	 *
-	 * @param int $offset
-	 * @param int $whence
-	 *
-	 * @return bool
-	 */
-	public function stream_seek($offset, $whence = SEEK_SET) {
-		if ($whence == SEEK_CUR) {
-			$this->position += $offset;
-		}
-		elseif ($whence == SEEK_END) {
-			$this->position = $this->stringlength + $offset;
-		}
-		else {
-			$this->position = $offset;
-		}
-
-		return true;
-	}
-
-	/**
-	 * Returns the current position on stream.
-	 *
-	 * @return int
-	 */
-	public function stream_tell() {
-		return $this->position;
-	}
-
-	/**
-	 * Indicates if 'end of file' is reached.
-	 *
-	 * @return bool
-	 */
-	public function stream_eof() {
-		return $this->position >= $this->stringlength;
-	}
-
-	/**
-	 * Truncates the stream to the new size.
-	 *
-	 * @param int $new_size
-	 *
-	 * @return bool
-	 */
-	public function stream_truncate($new_size) {
-		// cut the string!
-		$this->stringstream = Utils::Utf8_truncate($this->stringstream, $new_size, $this->truncateHtmlSafe);
-		$this->stringlength = strlen($this->stringstream);
-
-		if ($this->position > $this->stringlength) {
-			SLog::Write(LOGLEVEL_WARN, sprintf("StringStreamWrapper->stream_truncate(): stream position (%d) ahead of new size of %d. Repositioning pointer to end of stream.", $this->position, $this->stringlength));
-			$this->position = $this->stringlength;
-		}
-
-		return true;
-	}
-
-	/**
-	 * Retrieves information about a stream.
-	 *
-	 * @return array
-	 */
-	public function stream_stat() {
-		return [
-			7 => $this->stringlength,
-			'size' => $this->stringlength,
-		];
-	}
-
-	/**
-	 * Instantiates a StringStreamWrapper.
-	 *
-	 * @param string $string           The string to be wrapped
-	 * @param bool   $truncatehtmlsafe Indicates if a truncation should be done html-safe - default: false
-	 *
-	 * @return StringStreamWrapper
-	 */
-	public static function Open($string, $truncatehtmlsafe = false) {
-		$context = stream_context_create([self::PROTOCOL => ['string' => &$string, 'truncatehtmlsafe' => $truncatehtmlsafe]]);
-
-		return fopen(self::PROTOCOL . "://", 'r', false, $context);
-	}
+    public const PROTOCOL = "stringstream";
+
+    private $stringstream;
+    private $position;
+    private $stringlength;
+    private $truncateHtmlSafe;
+    private $context;
+
+    /**
+     * Opens the stream
+     * The string to be streamed is passed over the context.
+     *
+     * @param string $path        Specifies the URL that was passed to the original function
+     * @param string $mode        The mode used to open the file, as detailed for fopen()
+     * @param int    $options     Holds additional flags set by the streams API
+     * @param string $opened_path if the path is opened successfully, and STREAM_USE_PATH is set in options,
+     *                            opened_path should be set to the full path of the file/resource that was actually opened
+     *
+     * @return bool
+     */
+    public function stream_open($path, $mode, $options, &$opened_path) {
+        $contextOptions = stream_context_get_options($this->context);
+        if (!isset($contextOptions[self::PROTOCOL]['string'])) {
+            return false;
+        }
+
+        $this->position = 0;
+
+        // this is our stream!
+        $this->stringstream = $contextOptions[self::PROTOCOL]['string'];
+        $this->truncateHtmlSafe = (isset($contextOptions[self::PROTOCOL]['truncatehtmlsafe'])) ? $contextOptions[self::PROTOCOL]['truncatehtmlsafe'] : false;
+
+        $this->stringlength = strlen($this->stringstream);
+        SLog::Write(LOGLEVEL_DEBUG, sprintf("StringStreamWrapper::stream_open(): initialized stream length: %d - HTML-safe-truncate: %s", $this->stringlength, Utils::PrintAsString($this->truncateHtmlSafe)));
+
+        return true;
+    }
+
+    /**
+     * Reads from stream.
+     *
+     * @param int $len amount of bytes to be read
+     *
+     * @return string
+     */
+    public function stream_read($len) {
+        $data = substr($this->stringstream, $this->position, $len);
+        $this->position += strlen($data);
+
+        return $data;
+    }
+
+    /**
+     * Writes data to the stream.
+     *
+     * @param string $data
+     *
+     * @return int
+     */
+    public function stream_write($data) {
+        $l = strlen($data);
+        $this->stringstream = substr($this->stringstream, 0, $this->position) . $data . substr($this->stringstream, $this->position += $l);
+        $this->stringlength = strlen($this->stringstream);
+
+        return $l;
+    }
+
+    /**
+     * Stream "seek" functionality.
+     *
+     * @param int $offset
+     * @param int $whence
+     *
+     * @return bool
+     */
+    public function stream_seek($offset, $whence = SEEK_SET) {
+        if ($whence == SEEK_CUR) {
+            $this->position += $offset;
+        }
+        elseif ($whence == SEEK_END) {
+            $this->position = $this->stringlength + $offset;
+        }
+        else {
+            $this->position = $offset;
+        }
+
+        return true;
+    }
+
+    /**
+     * Returns the current position on stream.
+     *
+     * @return int
+     */
+    public function stream_tell() {
+        return $this->position;
+    }
+
+    /**
+     * Indicates if 'end of file' is reached.
+     *
+     * @return bool
+     */
+    public function stream_eof() {
+        return $this->position >= $this->stringlength;
+    }
+
+    /**
+     * Truncates the stream to the new size.
+     *
+     * @param int $new_size
+     *
+     * @return bool
+     */
+    public function stream_truncate($new_size) {
+        // cut the string!
+        $this->stringstream = Utils::Utf8_truncate($this->stringstream, $new_size, $this->truncateHtmlSafe);
+        $this->stringlength = strlen($this->stringstream);
+
+        if ($this->position > $this->stringlength) {
+            SLog::Write(LOGLEVEL_WARN, sprintf("StringStreamWrapper->stream_truncate(): stream position (%d) ahead of new size of %d. Repositioning pointer to end of stream.", $this->position, $this->stringlength));
+            $this->position = $this->stringlength;
+        }
+
+        return true;
+    }
+
+    /**
+     * Retrieves information about a stream.
+     *
+     * @return array
+     */
+    public function stream_stat() {
+        return [
+            7 => $this->stringlength,
+            'size' => $this->stringlength,
+        ];
+    }
+
+    /**
+     * Instantiates a StringStreamWrapper.
+     *
+     * @param string $string           The string to be wrapped
+     * @param bool   $truncatehtmlsafe Indicates if a truncation should be done html-safe - default: false
+     *
+     * @return StringStreamWrapper
+     */
+    public static function Open($string, $truncatehtmlsafe = false) {
+        $context = stream_context_create([self::PROTOCOL => ['string' => &$string, 'truncatehtmlsafe' => $truncatehtmlsafe]]);
+
+        return fopen(self::PROTOCOL . "://", 'r', false, $context);
+    }
 }
 
 stream_wrapper_register(StringStreamWrapper::PROTOCOL, "StringStreamWrapper");

lib/utils/g_RFC822.php

Indentation +952 added lines, -952 removed lines

@@ -75,956 +75,956 @@
  * @license BSD
  */
 class Mail_RFC822 {
-	/**
-	 * The address being parsed by the RFC822 object.
-	 *
-	 * @var string
-	 */
-	public $address = '';
-
-	/**
-	 * The default domain to use for unqualified addresses.
-	 *
-	 * @var string
-	 */
-	public $default_domain = 'localhost';
-
-	/**
-	 * Should we return a nested array showing groups, or flatten everything?
-	 *
-	 * @var bool
-	 */
-	public $nestGroups = true;
-
-	/**
-	 * Whether or not to validate atoms for non-ascii characters.
-	 *
-	 * @var bool
-	 */
-	public $validate = true;
-
-	/**
-	 * The array of raw addresses built up as we parse.
-	 *
-	 * @var array
-	 */
-	public $addresses = [];
-
-	/**
-	 * The final array of parsed address information that we build up.
-	 *
-	 * @var array
-	 */
-	public $structure = [];
-
-	/**
-	 * The current error message, if any.
-	 *
-	 * @var string
-	 */
-	public $error;
-
-	/**
-	 * An internal counter/pointer.
-	 *
-	 * @var int
-	 */
-	public $index;
-
-	/**
-	 * The number of groups that have been found in the address list.
-	 *
-	 * @var int
-	 */
-	public $num_groups = 0;
-
-	/**
-	 * A variable so that we can tell whether or not we're inside a
-	 * Mail_RFC822 object.
-	 *
-	 * @var bool
-	 */
-	public $mailRFC822 = true;
-
-	/**
-	 * A limit after which processing stops.
-	 *
-	 * @var int
-	 */
-	public $limit;
-
-	/**
-	 * Sets up the object. The address must either be set here or when
-	 * calling parseAddressList(). One or the other.
-	 *
-	 * @param string     $address        the address(es) to validate
-	 * @param string     $default_domain Default domain/host etc. If not supplied, will be set to localhost.
-	 * @param bool       $nest_groups    whether to return the structure with groups nested for easier viewing
-	 * @param bool       $validate       Whether to validate atoms. Turn this off if you need to run addresses through before encoding the personal names, for instance.
-	 * @param null|mixed $limit
-	 *
-	 * @return object mail_RFC822 A new Mail_RFC822 object
-	 */
-	public function __construct($address = null, $default_domain = null, $nest_groups = null, $validate = null, $limit = null) {
-		if (isset($address)) {
-			$this->address = $address;
-		}
-		if (isset($default_domain)) {
-			$this->default_domain = $default_domain;
-		}
-		if (isset($nest_groups)) {
-			$this->nestGroups = $nest_groups;
-		}
-		if (isset($validate)) {
-			$this->validate = $validate;
-		}
-		if (isset($limit)) {
-			$this->limit = $limit;
-		}
-	}
-
-	/**
-	 * Starts the whole process. The address must either be set here
-	 * or when creating the object. One or the other.
-	 *
-	 * @param string     $address        the address(es) to validate
-	 * @param string     $default_domain default domain/host etc
-	 * @param bool       $nest_groups    whether to return the structure with groups nested for easier viewing
-	 * @param bool       $validate       Whether to validate atoms. Turn this off if you need to run addresses through before encoding the personal names, for instance.
-	 * @param null|mixed $limit
-	 *
-	 * @return array a structured array of addresses
-	 */
-	public function parseAddressList($address = null, $default_domain = null, $nest_groups = null, $validate = null, $limit = null) {
-		if (!isset($this) || !isset($this->mailRFC822)) {
-			$obj = new Mail_RFC822($address, $default_domain, $nest_groups, $validate, $limit);
-
-			return $obj->parseAddressList();
-		}
-
-		if (isset($address)) {
-			$this->address = $address;
-		}
-		// grommunio-sync addition
-		if (strlen(trim($this->address)) == 0) {
-			return [];
-		}
-		if (isset($default_domain)) {
-			$this->default_domain = $default_domain;
-		}
-		if (isset($nest_groups)) {
-			$this->nestGroups = $nest_groups;
-		}
-		if (isset($validate)) {
-			$this->validate = $validate;
-		}
-		if (isset($limit)) {
-			$this->limit = $limit;
-		}
-
-		$this->structure = [];
-		$this->addresses = [];
-		$this->error = null;
-		$this->index = null;
-
-		// Unfold any long lines in $this->address.
-		$this->address = preg_replace('/\r?\n/', "\r\n", $this->address);
-		$this->address = preg_replace('/\r\n(\t| )+/', ' ', $this->address);
-
-		while ($this->address = $this->_splitAddresses($this->address));
-
-		if ($this->address === false || isset($this->error)) {
-			// require_once 'PEAR.php';
-			return $this->raiseError($this->error);
-		}
-
-		// Validate each address individually.  If we encounter an invalid
-		// address, stop iterating and return an error immediately.
-		foreach ($this->addresses as $address) {
-			$valid = $this->_validateAddress($address);
-
-			if ($valid === false || isset($this->error)) {
-				// require_once 'PEAR.php';
-				return $this->raiseError($this->error);
-			}
-
-			if (!$this->nestGroups) {
-				$this->structure = array_merge($this->structure, $valid);
-			}
-			else {
-				$this->structure[] = $valid;
-			}
-		}
-
-		return $this->structure;
-	}
-
-	/**
-	 * Splits an address into separate addresses.
-	 *
-	 * @param string $address the addresses to split
-	 *
-	 * @return bool success or failure
-	 */
-	protected function _splitAddresses($address) {
-		if (!empty($this->limit) && count($this->addresses) == $this->limit) {
-			return '';
-		}
-
-		if ($this->_isGroup($address) && !isset($this->error)) {
-			$split_char = ';';
-			$is_group = true;
-		}
-		elseif (!isset($this->error)) {
-			$split_char = ',';
-			$is_group = false;
-		}
-		elseif (isset($this->error)) {
-			return false;
-		}
-
-		// Split the string based on the above ten or so lines.
-		$parts = explode($split_char, $address);
-		$string = $this->_splitCheck($parts, $split_char);
-
-		// If a group...
-		if ($is_group) {
-			// If $string does not contain a colon outside of
-			// brackets/quotes etc then something's fubar.
-
-			// First check there's a colon at all:
-			if (strpos($string, ':') === false) {
-				$this->error = 'Invalid address: ' . $string;
-
-				return false;
-			}
-
-			// Now check it's outside of brackets/quotes:
-			if (!$this->_splitCheck(explode(':', $string), ':')) {
-				return false;
-			}
-
-			// We must have a group at this point, so increase the counter:
-			++$this->num_groups;
-		}
-
-		// $string now contains the first full address/group.
-		// Add to the addresses array.
-		$this->addresses[] = [
-			'address' => trim($string),
-			'group' => $is_group,
-		];
-
-		// Remove the now stored address from the initial line, the +1
-		// is to account for the explode character.
-		$address = trim(substr($address, strlen($string) + 1));
-
-		// If the next char is a comma and this was a group, then
-		// there are more addresses, otherwise, if there are any more
-		// chars, then there is another address.
-		if ($is_group && substr($address, 0, 1) == ',') {
-			return trim(substr($address, 1));
-		}
-		if (strlen($address) > 0) {
-			return $address;
-		}
-
-		return '';
-		// If you got here then something's off
-		return false;
-	}
-
-	/**
-	 * Checks for a group at the start of the string.
-	 *
-	 * @param string $address the address to check
-	 *
-	 * @return bool whether or not there is a group at the start of the string
-	 */
-	protected function _isGroup($address) {
-		// First comma not in quotes, angles or escaped:
-		$parts = explode(',', $address);
-		$string = $this->_splitCheck($parts, ',');
-
-		// Now we have the first address, we can reliably check for a
-		// group by searching for a colon that's not escaped or in
-		// quotes or angle brackets.
-		if (count($parts = explode(':', $string)) > 1) {
-			$string2 = $this->_splitCheck($parts, ':');
-
-			return $string2 !== $string;
-		}
-
-		return false;
-	}
-
-	/**
-	 * A common function that will check an exploded string.
-	 *
-	 * @param array  $parts the exloded string
-	 * @param string $char  the char that was exploded on
-	 *
-	 * @return mixed false if the string contains unclosed quotes/brackets, or the string on success
-	 */
-	protected function _splitCheck($parts, $char) {
-		$string = $parts[0];
-
-		for ($i = 0; $i < count($parts); ++$i) {
-			if ($this->_hasUnclosedQuotes($string) ||
-				$this->_hasUnclosedBrackets($string, '<>') ||
-				$this->_hasUnclosedBrackets($string, '[]') ||
-				$this->_hasUnclosedBrackets($string, '()') ||
-				substr($string, -1) == '\\') {
-				if (isset($parts[$i + 1])) {
-					$string = $string . $char . $parts[$i + 1];
-				}
-				else {
-					$this->error = 'Invalid address spec. Unclosed bracket or quotes';
-
-					return false;
-				}
-			}
-			else {
-				$this->index = $i;
-
-				break;
-			}
-		}
-
-		return $string;
-	}
-
-	/**
-	 * Checks if a string has unclosed quotes or not.
-	 *
-	 * @param string $string the string to check
-	 *
-	 * @return bool true if there are unclosed quotes inside the string,
-	 *              false otherwise
-	 */
-	protected function _hasUnclosedQuotes($string) {
-		$string = trim($string);
-		$iMax = strlen($string);
-		$in_quote = false;
-		$i = $slashes = 0;
-
-		for (; $i < $iMax; ++$i) {
-			switch ($string[$i]) {
-			case '\\':
-				++$slashes;
-
-				break;
-
-			case '"':
-				if ($slashes % 2 == 0) {
-					$in_quote = !$in_quote;
-				}
-				// Fall through to default action below.
-
-				// no break
-			default:
-				$slashes = 0;
-
-				break;
-			}
-		}
-
-		return $in_quote;
-	}
-
-	/**
-	 * Checks if a string has an unclosed brackets or not. IMPORTANT:
-	 * This function handles both angle brackets and square brackets;.
-	 *
-	 * @param string $string the string to check
-	 * @param string $chars  the characters to check for
-	 *
-	 * @return bool true if there are unclosed brackets inside the string, false otherwise
-	 */
-	protected function _hasUnclosedBrackets($string, $chars) {
-		$num_angle_start = substr_count($string, $chars[0]);
-		$num_angle_end = substr_count($string, $chars[1]);
-
-		$this->_hasUnclosedBracketsSub($string, $num_angle_start, $chars[0]);
-		$this->_hasUnclosedBracketsSub($string, $num_angle_end, $chars[1]);
-
-		if ($num_angle_start < $num_angle_end) {
-			$this->error = 'Invalid address spec. Unmatched quote or bracket (' . $chars . ')';
-
-			return false;
-		}
-
-		return $num_angle_start > $num_angle_end;
-	}
-
-	/**
-	 * Sub function that is used only by hasUnclosedBrackets().
-	 *
-	 * @param string $string the string to check
-	 * @param int    &$num   The number of occurrences
-	 * @param string $char   the character to count
-	 *
-	 * @return int the number of occurrences of $char in $string, adjusted for backslashes
-	 */
-	protected function _hasUnclosedBracketsSub($string, &$num, $char) {
-		$parts = explode($char, $string);
-		for ($i = 0; $i < count($parts); ++$i) {
-			if (substr($parts[$i], -1) == '\\' || $this->_hasUnclosedQuotes($parts[$i])) {
-				--$num;
-			}
-			if (isset($parts[$i + 1])) {
-				$parts[$i + 1] = $parts[$i] . $char . $parts[$i + 1];
-			}
-		}
-
-		return $num;
-	}
-
-	/**
-	 * Function to begin checking the address.
-	 *
-	 * @param string $address the address to validate
-	 *
-	 * @return mixed false on failure, or a structured array of address information on success
-	 */
-	protected function _validateAddress($address) {
-		$is_group = false;
-		$addresses = [];
-
-		if ($address['group']) {
-			$is_group = true;
-
-			// Get the group part of the name
-			$parts = explode(':', $address['address']);
-			$groupname = $this->_splitCheck($parts, ':');
-			$structure = [];
-
-			// And validate the group part of the name.
-			if (!$this->_validatePhrase($groupname)) {
-				$this->error = 'Group name did not validate.';
-
-				return false;
-			}
-			// Don't include groups if we are not nesting
-			// them. This avoids returning invalid addresses.
-			if ($this->nestGroups) {
-				$structure = new stdClass();
-				$structure->groupname = $groupname;
-			}
-
-			$address['address'] = ltrim(substr($address['address'], strlen($groupname . ':')));
-		}
-
-		// If a group then split on comma and put into an array.
-		// Otherwise, Just put the whole address in an array.
-		if ($is_group) {
-			while (strlen($address['address']) > 0) {
-				$parts = explode(',', $address['address']);
-				$addresses[] = $this->_splitCheck($parts, ',');
-				$address['address'] = trim(substr($address['address'], strlen(end($addresses) . ',')));
-			}
-		}
-		else {
-			$addresses[] = $address['address'];
-		}
-
-		// Trim the whitespace from all of the address strings.
-		array_map('trim', $addresses);
-
-		// Validate each mailbox.
-		// Format could be one of: name <geezer@domain.com>
-		//                         geezer@domain.com
-		//                         geezer
-		// ... or any other format valid by RFC 822.
-		for ($i = 0; $i < count($addresses); ++$i) {
-			if (!$this->validateMailbox($addresses[$i])) {
-				if (empty($this->error)) {
-					$this->error = 'Validation failed for: ' . $addresses[$i];
-				}
-
-				return false;
-			}
-		}
-
-		// Nested format
-		if ($this->nestGroups) {
-			if ($is_group) {
-				$structure->addresses = $addresses;
-			}
-			else {
-				$structure = $addresses[0];
-			}
-
-			// Flat format
-		}
-		else {
-			if ($is_group) {
-				$structure = array_merge($structure, $addresses);
-			}
-			else {
-				$structure = $addresses;
-			}
-		}
-
-		return $structure;
-	}
-
-	/**
-	 * Function to validate a phrase.
-	 *
-	 * @param string $phrase the phrase to check
-	 *
-	 * @return bool success or failure
-	 */
-	protected function _validatePhrase($phrase) {
-		// Splits on one or more Tab or space.
-		$parts = preg_split('/[ \\x09]+/', $phrase, -1, PREG_SPLIT_NO_EMPTY);
-
-		$phrase_parts = [];
-		while (count($parts) > 0) {
-			$phrase_parts[] = $this->_splitCheck($parts, ' ');
-			for ($i = 0; $i < $this->index + 1; ++$i) {
-				array_shift($parts);
-			}
-		}
-
-		foreach ($phrase_parts as $part) {
-			// If quoted string:
-			if (substr($part, 0, 1) == '"') {
-				if (!$this->_validateQuotedString($part)) {
-					return false;
-				}
-
-				continue;
-			}
-
-			// Otherwise it's an atom:
-			if (!$this->_validateAtom($part)) {
-				return false;
-			}
-		}
-
-		return true;
-	}
-
-	/**
-	 * Function to validate an atom which from rfc822 is:
-	 * atom = 1*<any CHAR except specials, SPACE and CTLs>.
-	 *
-	 * If validation ($this->validate) has been turned off, then
-	 * validateAtom() doesn't actually check anything. This is so that you
-	 * can split a list of addresses up before encoding personal names
-	 * (umlauts, etc.), for example.
-	 *
-	 * @param string $atom the string to check
-	 *
-	 * @return bool success or failure
-	 */
-	protected function _validateAtom($atom) {
-		if (!$this->validate) {
-			// Validation has been turned off; assume the atom is okay.
-			return true;
-		}
-
-		// Check for any char from ASCII 0 - ASCII 127
-		if (!preg_match('/^[\\x00-\\x7E]+$/i', $atom, $matches)) {
-			return false;
-		}
-
-		// Check for specials:
-		if (preg_match('/[][()<>@,;\\:". ]/', $atom)) {
-			return false;
-		}
-
-		// Check for control characters (ASCII 0-31):
-		if (preg_match('/[\\x00-\\x1F]+/', $atom)) {
-			return false;
-		}
-
-		return true;
-	}
-
-	/**
-	 * Function to validate quoted string, which is:
-	 * quoted-string = <"> *(qtext/quoted-pair) <">.
-	 *
-	 * @param string $qstring The string to check
-	 *
-	 * @return bool success or failure
-	 */
-	protected function _validateQuotedString($qstring) {
-		// Leading and trailing "
-		$qstring = substr($qstring, 1, -1);
-
-		// Perform check, removing quoted characters first.
-		return !preg_match('/[\x0D\\\\"]/', preg_replace('/\\\\./', '', $qstring));
-	}
-
-	/**
-	 * Function to validate a mailbox, which is:
-	 * mailbox =   addr-spec         ; simple address
-	 *           / phrase route-addr ; name and route-addr.
-	 *
-	 * @param string &$mailbox The string to check
-	 *
-	 * @return bool success or failure
-	 */
-	public function validateMailbox(&$mailbox) {
-		// A couple of defaults.
-		$phrase = '';
-		$comment = '';
-		$comments = [];
-
-		// Catch any RFC822 comments and store them separately.
-		$_mailbox = $mailbox;
-		while (strlen(trim($_mailbox)) > 0) {
-			$parts = explode('(', $_mailbox);
-			$before_comment = $this->_splitCheck($parts, '(');
-			if ($before_comment != $_mailbox) {
-				// First char should be a (.
-				$comment = substr(str_replace($before_comment, '', $_mailbox), 1);
-				$parts = explode(')', $comment);
-				$comment = $this->_splitCheck($parts, ')');
-				$comments[] = $comment;
-
-				// +2 is for the brackets
-				$_mailbox = substr($_mailbox, strpos($_mailbox, '(' . $comment) + strlen($comment) + 2);
-			}
-			else {
-				break;
-			}
-		}
-
-		foreach ($comments as $comment) {
-			$mailbox = str_replace("({$comment})", '', $mailbox);
-		}
-
-		$mailbox = trim($mailbox);
-
-		// Check for name + route-addr
-		if (substr($mailbox, -1) == '>' && substr($mailbox, 0, 1) != '<') {
-			$parts = explode('<', $mailbox);
-			$name = $this->_splitCheck($parts, '<');
-
-			$phrase = trim($name);
-			$route_addr = trim(substr($mailbox, strlen($name . '<'), -1));
-
-			// grommunio-sync fix for umlauts and other special chars
-			if (substr($phrase, 0, 1) != '"' && substr($phrase, -1) != '"') {
-				$phrase = '"' . $phrase . '"';
-			}
-
-			if ($this->_validatePhrase($phrase) === false || ($route_addr = $this->_validateRouteAddr($route_addr)) === false) {
-				return false;
-			}
-
-			// Only got addr-spec
-		}
-		else {
-			// First snip angle brackets if present.
-			if (substr($mailbox, 0, 1) == '<' && substr($mailbox, -1) == '>') {
-				$addr_spec = substr($mailbox, 1, -1);
-			}
-			else {
-				$addr_spec = $mailbox;
-			}
-
-			if (($addr_spec = $this->_validateAddrSpec($addr_spec)) === false) {
-				return false;
-			}
-		}
-
-		// Construct the object that will be returned.
-		$mbox = new stdClass();
-
-		// Add the phrase (even if empty) and comments
-		$mbox->personal = $phrase;
-		$mbox->comment = isset($comments) ? $comments : [];
-
-		if (isset($route_addr)) {
-			$mbox->mailbox = $route_addr['local_part'];
-			$mbox->host = $route_addr['domain'];
-			$route_addr['adl'] !== '' ? $mbox->adl = $route_addr['adl'] : '';
-		}
-		else {
-			$mbox->mailbox = $addr_spec['local_part'];
-			$mbox->host = $addr_spec['domain'];
-		}
-
-		$mailbox = $mbox;
-
-		return true;
-	}
-
-	/**
-	 * This function validates a route-addr which is:
-	 * route-addr = "<" [route] addr-spec ">".
-	 *
-	 * Angle brackets have already been removed at the point of
-	 * getting to this function.
-	 *
-	 * @param string $route_addr the string to check
-	 *
-	 * @return mixed false on failure, or an array containing validated address/route information on success
-	 */
-	protected function _validateRouteAddr($route_addr) {
-		// Check for colon.
-		if (strpos($route_addr, ':') !== false) {
-			$parts = explode(':', $route_addr);
-			$route = $this->_splitCheck($parts, ':');
-		}
-		else {
-			$route = $route_addr;
-		}
-
-		// If $route is same as $route_addr then the colon was in
-		// quotes or brackets or, of course, non existent.
-		if ($route === $route_addr) {
-			unset($route);
-			$addr_spec = $route_addr;
-			if (($addr_spec = $this->_validateAddrSpec($addr_spec)) === false) {
-				return false;
-			}
-		}
-		else {
-			// Validate route part.
-			if (($route = $this->_validateRoute($route)) === false) {
-				return false;
-			}
-
-			$addr_spec = substr($route_addr, strlen($route . ':'));
-
-			// Validate addr-spec part.
-			if (($addr_spec = $this->_validateAddrSpec($addr_spec)) === false) {
-				return false;
-			}
-		}
-
-		if (isset($route)) {
-			$return['adl'] = $route;
-		}
-		else {
-			$return['adl'] = '';
-		}
-
-		return array_merge($return, $addr_spec);
-	}
-
-	/**
-	 * Function to validate a route, which is:
-	 * route = 1#("@" domain) ":".
-	 *
-	 * @param string $route the string to check
-	 *
-	 * @return mixed false on failure, or the validated $route on success
-	 */
-	protected function _validateRoute($route) {
-		// Split on comma.
-		$domains = explode(',', trim($route));
-
-		foreach ($domains as $domain) {
-			$domain = str_replace('@', '', trim($domain));
-			if (!$this->_validateDomain($domain)) {
-				return false;
-			}
-		}
-
-		return $route;
-	}
-
-	/**
-	 * Function to validate a domain, though this is not quite what
-	 * you expect of a strict internet domain.
-	 *
-	 * domain = sub-domain *("." sub-domain)
-	 *
-	 * @param string $domain the string to check
-	 *
-	 * @return mixed false on failure, or the validated domain on success
-	 */
-	protected function _validateDomain($domain) {
-		// Note the different use of $subdomains and $sub_domains
-		$subdomains = explode('.', $domain);
-
-		while (count($subdomains) > 0) {
-			$sub_domains[] = $this->_splitCheck($subdomains, '.');
-			for ($i = 0; $i < $this->index + 1; ++$i) {
-				array_shift($subdomains);
-			}
-		}
-
-		foreach ($sub_domains as $sub_domain) {
-			if (!$this->_validateSubdomain(trim($sub_domain))) {
-				return false;
-			}
-		}
-
-		// Managed to get here, so return input.
-		return $domain;
-	}
-
-	/**
-	 * Function to validate a subdomain:
-	 *   subdomain = domain-ref / domain-literal.
-	 *
-	 * @param string $subdomain the string to check
-	 *
-	 * @return bool success or failure
-	 */
-	protected function _validateSubdomain($subdomain) {
-		if (preg_match('|^\[(.*)]$|', $subdomain, $arr)) {
-			if (!$this->_validateDliteral($arr[1])) {
-				return false;
-			}
-		}
-		else {
-			if (!$this->_validateAtom($subdomain)) {
-				return false;
-			}
-		}
-
-		// Got here, so return successful.
-		return true;
-	}
-
-	/**
-	 * Function to validate a domain literal:
-	 *   domain-literal =  "[" *(dtext / quoted-pair) "]".
-	 *
-	 * @param string $dliteral the string to check
-	 *
-	 * @return bool success or failure
-	 */
-	protected function _validateDliteral($dliteral) {
-		return !preg_match('/(.)[][\x0D\\\\]/', $dliteral, $matches) && ((!isset($matches[1])) || $matches[1] != '\\');
-	}
-
-	/**
-	 * Function to validate an addr-spec.
-	 *
-	 * addr-spec = local-part "@" domain
-	 *
-	 * @param string $addr_spec the string to check
-	 *
-	 * @return mixed false on failure, or the validated addr-spec on success
-	 */
-	protected function _validateAddrSpec($addr_spec) {
-		$addr_spec = trim($addr_spec);
-
-		// Split on @ sign if there is one.
-		if (strpos($addr_spec, '@') !== false) {
-			$parts = explode('@', $addr_spec);
-			$local_part = $this->_splitCheck($parts, '@');
-			$domain = substr($addr_spec, strlen($local_part . '@'));
-
-		// No @ sign so assume the default domain.
-		}
-		else {
-			$local_part = $addr_spec;
-			$domain = $this->default_domain;
-		}
-
-		if (($local_part = $this->_validateLocalPart($local_part)) === false) {
-			return false;
-		}
-		if (($domain = $this->_validateDomain($domain)) === false) {
-			return false;
-		}
-
-		// Got here so return successful.
-		return ['local_part' => $local_part, 'domain' => $domain];
-	}
-
-	/**
-	 * Function to validate the local part of an address:
-	 *   local-part = word *("." word).
-	 *
-	 * @param string $local_part
-	 *
-	 * @return mixed false on failure, or the validated local part on success
-	 */
-	protected function _validateLocalPart($local_part) {
-		$parts = explode('.', $local_part);
-		$words = [];
-
-		// Split the local_part into words.
-		while (count($parts) > 0) {
-			$words[] = $this->_splitCheck($parts, '.');
-			for ($i = 0; $i < $this->index + 1; ++$i) {
-				array_shift($parts);
-			}
-		}
-
-		// Validate each word.
-		foreach ($words as $word) {
-			// word cannot be empty (#17317)
-			if ($word === '') {
-				return false;
-			}
-			// If this word contains an unquoted space, it is invalid. (6.2.4)
-			if (strpos($word, ' ') && $word[0] !== '"') {
-				return false;
-			}
-
-			if ($this->_validatePhrase(trim($word)) === false) {
-				return false;
-			}
-		}
-
-		// Managed to get here, so return the input.
-		return $local_part;
-	}
-
-	/**
-	 * Returns an approximate count of how many addresses are in the
-	 * given string. This is APPROXIMATE as it only splits based on a
-	 * comma which has no preceding backslash. Could be useful as
-	 * large amounts of addresses will end up producing *large*
-	 * structures when used with parseAddressList().
-	 *
-	 * @param string $data Addresses to count
-	 *
-	 * @return int Approximate count
-	 */
-	public function approximateCount($data) {
-		return count(preg_split('/(?<!\\\\),/', $data));
-	}
-
-	/**
-	 * This is a email validating function separate to the rest of the
-	 * class. It simply validates whether an email is of the common
-	 * internet form: <user>@<domain>. This can be sufficient for most
-	 * people. Optional stricter mode can be utilised which restricts
-	 * mailbox characters allowed to alphanumeric, full stop, hyphen
-	 * and underscore.
-	 *
-	 * @param string $data   Address to check
-	 * @param bool   $strict Optional stricter mode
-	 *
-	 * @return mixed False if it fails, an indexed array
-	 *               username/domain if it matches
-	 */
-	public function isValidInetAddress($data, $strict = false) {
-		$regex = $strict ? '/^([.0-9a-z_+-]+)@(([0-9a-z-]+\.)+[0-9a-z]{2,})$/i' : '/^([*+!.&#$|\'\\%\/0-9a-z^_`{}=?~:-]+)@(([0-9a-z-]+\.)+[0-9a-z]{2,})$/i';
-		if (preg_match($regex, trim($data), $matches)) {
-			return [$matches[1], $matches[2]];
-		}
-
-		return false;
-	}
-
-	/**
-	 * grommunio-sync helper for error logging
-	 * removing PEAR dependency.
-	 *
-	 * @param  string  debug message
-	 * @param mixed $message
-	 *
-	 * @return bool always false as there was an error
-	 */
-	public function raiseError($message) {
-		SLog::Write(LOGLEVEL_ERROR, "z_RFC822 error: " . $message);
-
-		return false;
-	}
+    /**
+     * The address being parsed by the RFC822 object.
+     *
+     * @var string
+     */
+    public $address = '';
+
+    /**
+     * The default domain to use for unqualified addresses.
+     *
+     * @var string
+     */
+    public $default_domain = 'localhost';
+
+    /**
+     * Should we return a nested array showing groups, or flatten everything?
+     *
+     * @var bool
+     */
+    public $nestGroups = true;
+
+    /**
+     * Whether or not to validate atoms for non-ascii characters.
+     *
+     * @var bool
+     */
+    public $validate = true;
+
+    /**
+     * The array of raw addresses built up as we parse.
+     *
+     * @var array
+     */
+    public $addresses = [];
+
+    /**
+     * The final array of parsed address information that we build up.
+     *
+     * @var array
+     */
+    public $structure = [];
+
+    /**
+     * The current error message, if any.
+     *
+     * @var string
+     */
+    public $error;
+
+    /**
+     * An internal counter/pointer.
+     *
+     * @var int
+     */
+    public $index;
+
+    /**
+     * The number of groups that have been found in the address list.
+     *
+     * @var int
+     */
+    public $num_groups = 0;
+
+    /**
+     * A variable so that we can tell whether or not we're inside a
+     * Mail_RFC822 object.
+     *
+     * @var bool
+     */
+    public $mailRFC822 = true;
+
+    /**
+     * A limit after which processing stops.
+     *
+     * @var int
+     */
+    public $limit;
+
+    /**
+     * Sets up the object. The address must either be set here or when
+     * calling parseAddressList(). One or the other.
+     *
+     * @param string     $address        the address(es) to validate
+     * @param string     $default_domain Default domain/host etc. If not supplied, will be set to localhost.
+     * @param bool       $nest_groups    whether to return the structure with groups nested for easier viewing
+     * @param bool       $validate       Whether to validate atoms. Turn this off if you need to run addresses through before encoding the personal names, for instance.
+     * @param null|mixed $limit
+     *
+     * @return object mail_RFC822 A new Mail_RFC822 object
+     */
+    public function __construct($address = null, $default_domain = null, $nest_groups = null, $validate = null, $limit = null) {
+        if (isset($address)) {
+            $this->address = $address;
+        }
+        if (isset($default_domain)) {
+            $this->default_domain = $default_domain;
+        }
+        if (isset($nest_groups)) {
+            $this->nestGroups = $nest_groups;
+        }
+        if (isset($validate)) {
+            $this->validate = $validate;
+        }
+        if (isset($limit)) {
+            $this->limit = $limit;
+        }
+    }
+
+    /**
+     * Starts the whole process. The address must either be set here
+     * or when creating the object. One or the other.
+     *
+     * @param string     $address        the address(es) to validate
+     * @param string     $default_domain default domain/host etc
+     * @param bool       $nest_groups    whether to return the structure with groups nested for easier viewing
+     * @param bool       $validate       Whether to validate atoms. Turn this off if you need to run addresses through before encoding the personal names, for instance.
+     * @param null|mixed $limit
+     *
+     * @return array a structured array of addresses
+     */
+    public function parseAddressList($address = null, $default_domain = null, $nest_groups = null, $validate = null, $limit = null) {
+        if (!isset($this) || !isset($this->mailRFC822)) {
+            $obj = new Mail_RFC822($address, $default_domain, $nest_groups, $validate, $limit);
+
+            return $obj->parseAddressList();
+        }
+
+        if (isset($address)) {
+            $this->address = $address;
+        }
+        // grommunio-sync addition
+        if (strlen(trim($this->address)) == 0) {
+            return [];
+        }
+        if (isset($default_domain)) {
+            $this->default_domain = $default_domain;
+        }
+        if (isset($nest_groups)) {
+            $this->nestGroups = $nest_groups;
+        }
+        if (isset($validate)) {
+            $this->validate = $validate;
+        }
+        if (isset($limit)) {
+            $this->limit = $limit;
+        }
+
+        $this->structure = [];
+        $this->addresses = [];
+        $this->error = null;
+        $this->index = null;
+
+        // Unfold any long lines in $this->address.
+        $this->address = preg_replace('/\r?\n/', "\r\n", $this->address);
+        $this->address = preg_replace('/\r\n(\t| )+/', ' ', $this->address);
+
+        while ($this->address = $this->_splitAddresses($this->address));
+
+        if ($this->address === false || isset($this->error)) {
+            // require_once 'PEAR.php';
+            return $this->raiseError($this->error);
+        }
+
+        // Validate each address individually.  If we encounter an invalid
+        // address, stop iterating and return an error immediately.
+        foreach ($this->addresses as $address) {
+            $valid = $this->_validateAddress($address);
+
+            if ($valid === false || isset($this->error)) {
+                // require_once 'PEAR.php';
+                return $this->raiseError($this->error);
+            }
+
+            if (!$this->nestGroups) {
+                $this->structure = array_merge($this->structure, $valid);
+            }
+            else {
+                $this->structure[] = $valid;
+            }
+        }
+
+        return $this->structure;
+    }
+
+    /**
+     * Splits an address into separate addresses.
+     *
+     * @param string $address the addresses to split
+     *
+     * @return bool success or failure
+     */
+    protected function _splitAddresses($address) {
+        if (!empty($this->limit) && count($this->addresses) == $this->limit) {
+            return '';
+        }
+
+        if ($this->_isGroup($address) && !isset($this->error)) {
+            $split_char = ';';
+            $is_group = true;
+        }
+        elseif (!isset($this->error)) {
+            $split_char = ',';
+            $is_group = false;
+        }
+        elseif (isset($this->error)) {
+            return false;
+        }
+
+        // Split the string based on the above ten or so lines.
+        $parts = explode($split_char, $address);
+        $string = $this->_splitCheck($parts, $split_char);
+
+        // If a group...
+        if ($is_group) {
+            // If $string does not contain a colon outside of
+            // brackets/quotes etc then something's fubar.
+
+            // First check there's a colon at all:
+            if (strpos($string, ':') === false) {
+                $this->error = 'Invalid address: ' . $string;
+
+                return false;
+            }
+
+            // Now check it's outside of brackets/quotes:
+            if (!$this->_splitCheck(explode(':', $string), ':')) {
+                return false;
+            }
+
+            // We must have a group at this point, so increase the counter:
+            ++$this->num_groups;
+        }
+
+        // $string now contains the first full address/group.
+        // Add to the addresses array.
+        $this->addresses[] = [
+            'address' => trim($string),
+            'group' => $is_group,
+        ];
+
+        // Remove the now stored address from the initial line, the +1
+        // is to account for the explode character.
+        $address = trim(substr($address, strlen($string) + 1));
+
+        // If the next char is a comma and this was a group, then
+        // there are more addresses, otherwise, if there are any more
+        // chars, then there is another address.
+        if ($is_group && substr($address, 0, 1) == ',') {
+            return trim(substr($address, 1));
+        }
+        if (strlen($address) > 0) {
+            return $address;
+        }
+
+        return '';
+        // If you got here then something's off
+        return false;
+    }
+
+    /**
+     * Checks for a group at the start of the string.
+     *
+     * @param string $address the address to check
+     *
+     * @return bool whether or not there is a group at the start of the string
+     */
+    protected function _isGroup($address) {
+        // First comma not in quotes, angles or escaped:
+        $parts = explode(',', $address);
+        $string = $this->_splitCheck($parts, ',');
+
+        // Now we have the first address, we can reliably check for a
+        // group by searching for a colon that's not escaped or in
+        // quotes or angle brackets.
+        if (count($parts = explode(':', $string)) > 1) {
+            $string2 = $this->_splitCheck($parts, ':');
+
+            return $string2 !== $string;
+        }
+
+        return false;
+    }
+
+    /**
+     * A common function that will check an exploded string.
+     *
+     * @param array  $parts the exloded string
+     * @param string $char  the char that was exploded on
+     *
+     * @return mixed false if the string contains unclosed quotes/brackets, or the string on success
+     */
+    protected function _splitCheck($parts, $char) {
+        $string = $parts[0];
+
+        for ($i = 0; $i < count($parts); ++$i) {
+            if ($this->_hasUnclosedQuotes($string) ||
+                $this->_hasUnclosedBrackets($string, '<>') ||
+                $this->_hasUnclosedBrackets($string, '[]') ||
+                $this->_hasUnclosedBrackets($string, '()') ||
+                substr($string, -1) == '\\') {
+                if (isset($parts[$i + 1])) {
+                    $string = $string . $char . $parts[$i + 1];
+                }
+                else {
+                    $this->error = 'Invalid address spec. Unclosed bracket or quotes';
+
+                    return false;
+                }
+            }
+            else {
+                $this->index = $i;
+
+                break;
+            }
+        }
+
+        return $string;
+    }
+
+    /**
+     * Checks if a string has unclosed quotes or not.
+     *
+     * @param string $string the string to check
+     *
+     * @return bool true if there are unclosed quotes inside the string,
+     *              false otherwise
+     */
+    protected function _hasUnclosedQuotes($string) {
+        $string = trim($string);
+        $iMax = strlen($string);
+        $in_quote = false;
+        $i = $slashes = 0;
+
+        for (; $i < $iMax; ++$i) {
+            switch ($string[$i]) {
+            case '\\':
+                ++$slashes;
+
+                break;
+
+            case '"':
+                if ($slashes % 2 == 0) {
+                    $in_quote = !$in_quote;
+                }
+                // Fall through to default action below.
+
+                // no break
+            default:
+                $slashes = 0;
+
+                break;
+            }
+        }
+
+        return $in_quote;
+    }
+
+    /**
+     * Checks if a string has an unclosed brackets or not. IMPORTANT:
+     * This function handles both angle brackets and square brackets;.
+     *
+     * @param string $string the string to check
+     * @param string $chars  the characters to check for
+     *
+     * @return bool true if there are unclosed brackets inside the string, false otherwise
+     */
+    protected function _hasUnclosedBrackets($string, $chars) {
+        $num_angle_start = substr_count($string, $chars[0]);
+        $num_angle_end = substr_count($string, $chars[1]);
+
+        $this->_hasUnclosedBracketsSub($string, $num_angle_start, $chars[0]);
+        $this->_hasUnclosedBracketsSub($string, $num_angle_end, $chars[1]);
+
+        if ($num_angle_start < $num_angle_end) {
+            $this->error = 'Invalid address spec. Unmatched quote or bracket (' . $chars . ')';
+
+            return false;
+        }
+
+        return $num_angle_start > $num_angle_end;
+    }
+
+    /**
+     * Sub function that is used only by hasUnclosedBrackets().
+     *
+     * @param string $string the string to check
+     * @param int    &$num   The number of occurrences
+     * @param string $char   the character to count
+     *
+     * @return int the number of occurrences of $char in $string, adjusted for backslashes
+     */
+    protected function _hasUnclosedBracketsSub($string, &$num, $char) {
+        $parts = explode($char, $string);
+        for ($i = 0; $i < count($parts); ++$i) {
+            if (substr($parts[$i], -1) == '\\' || $this->_hasUnclosedQuotes($parts[$i])) {
+                --$num;
+            }
+            if (isset($parts[$i + 1])) {
+                $parts[$i + 1] = $parts[$i] . $char . $parts[$i + 1];
+            }
+        }
+
+        return $num;
+    }
+
+    /**
+     * Function to begin checking the address.
+     *
+     * @param string $address the address to validate
+     *
+     * @return mixed false on failure, or a structured array of address information on success
+     */
+    protected function _validateAddress($address) {
+        $is_group = false;
+        $addresses = [];
+
+        if ($address['group']) {
+            $is_group = true;
+
+            // Get the group part of the name
+            $parts = explode(':', $address['address']);
+            $groupname = $this->_splitCheck($parts, ':');
+            $structure = [];
+
+            // And validate the group part of the name.
+            if (!$this->_validatePhrase($groupname)) {
+                $this->error = 'Group name did not validate.';
+
+                return false;
+            }
+            // Don't include groups if we are not nesting
+            // them. This avoids returning invalid addresses.
+            if ($this->nestGroups) {
+                $structure = new stdClass();
+                $structure->groupname = $groupname;
+            }
+
+            $address['address'] = ltrim(substr($address['address'], strlen($groupname . ':')));
+        }
+
+        // If a group then split on comma and put into an array.
+        // Otherwise, Just put the whole address in an array.
+        if ($is_group) {
+            while (strlen($address['address']) > 0) {
+                $parts = explode(',', $address['address']);
+                $addresses[] = $this->_splitCheck($parts, ',');
+                $address['address'] = trim(substr($address['address'], strlen(end($addresses) . ',')));
+            }
+        }
+        else {
+            $addresses[] = $address['address'];
+        }
+
+        // Trim the whitespace from all of the address strings.
+        array_map('trim', $addresses);
+
+        // Validate each mailbox.
+        // Format could be one of: name <geezer@domain.com>
+        //                         geezer@domain.com
+        //                         geezer
+        // ... or any other format valid by RFC 822.
+        for ($i = 0; $i < count($addresses); ++$i) {
+            if (!$this->validateMailbox($addresses[$i])) {
+                if (empty($this->error)) {
+                    $this->error = 'Validation failed for: ' . $addresses[$i];
+                }
+
+                return false;
+            }
+        }
+
+        // Nested format
+        if ($this->nestGroups) {
+            if ($is_group) {
+                $structure->addresses = $addresses;
+            }
+            else {
+                $structure = $addresses[0];
+            }
+
+            // Flat format
+        }
+        else {
+            if ($is_group) {
+                $structure = array_merge($structure, $addresses);
+            }
+            else {
+                $structure = $addresses;
+            }
+        }
+
+        return $structure;
+    }
+
+    /**
+     * Function to validate a phrase.
+     *
+     * @param string $phrase the phrase to check
+     *
+     * @return bool success or failure
+     */
+    protected function _validatePhrase($phrase) {
+        // Splits on one or more Tab or space.
+        $parts = preg_split('/[ \\x09]+/', $phrase, -1, PREG_SPLIT_NO_EMPTY);
+
+        $phrase_parts = [];
+        while (count($parts) > 0) {
+            $phrase_parts[] = $this->_splitCheck($parts, ' ');
+            for ($i = 0; $i < $this->index + 1; ++$i) {
+                array_shift($parts);
+            }
+        }
+
+        foreach ($phrase_parts as $part) {
+            // If quoted string:
+            if (substr($part, 0, 1) == '"') {
+                if (!$this->_validateQuotedString($part)) {
+                    return false;
+                }
+
+                continue;
+            }
+
+            // Otherwise it's an atom:
+            if (!$this->_validateAtom($part)) {
+                return false;
+            }
+        }
+
+        return true;
+    }
+
+    /**
+     * Function to validate an atom which from rfc822 is:
+     * atom = 1*<any CHAR except specials, SPACE and CTLs>.
+     *
+     * If validation ($this->validate) has been turned off, then
+     * validateAtom() doesn't actually check anything. This is so that you
+     * can split a list of addresses up before encoding personal names
+     * (umlauts, etc.), for example.
+     *
+     * @param string $atom the string to check
+     *
+     * @return bool success or failure
+     */
+    protected function _validateAtom($atom) {
+        if (!$this->validate) {
+            // Validation has been turned off; assume the atom is okay.
+            return true;
+        }
+
+        // Check for any char from ASCII 0 - ASCII 127
+        if (!preg_match('/^[\\x00-\\x7E]+$/i', $atom, $matches)) {
+            return false;
+        }
+
+        // Check for specials:
+        if (preg_match('/[][()<>@,;\\:". ]/', $atom)) {
+            return false;
+        }
+
+        // Check for control characters (ASCII 0-31):
+        if (preg_match('/[\\x00-\\x1F]+/', $atom)) {
+            return false;
+        }
+
+        return true;
+    }
+
+    /**
+     * Function to validate quoted string, which is:
+     * quoted-string = <"> *(qtext/quoted-pair) <">.
+     *
+     * @param string $qstring The string to check
+     *
+     * @return bool success or failure
+     */
+    protected function _validateQuotedString($qstring) {
+        // Leading and trailing "
+        $qstring = substr($qstring, 1, -1);
+
+        // Perform check, removing quoted characters first.
+        return !preg_match('/[\x0D\\\\"]/', preg_replace('/\\\\./', '', $qstring));
+    }
+
+    /**
+     * Function to validate a mailbox, which is:
+     * mailbox =   addr-spec         ; simple address
+     *           / phrase route-addr ; name and route-addr.
+     *
+     * @param string &$mailbox The string to check
+     *
+     * @return bool success or failure
+     */
+    public function validateMailbox(&$mailbox) {
+        // A couple of defaults.
+        $phrase = '';
+        $comment = '';
+        $comments = [];
+
+        // Catch any RFC822 comments and store them separately.
+        $_mailbox = $mailbox;
+        while (strlen(trim($_mailbox)) > 0) {
+            $parts = explode('(', $_mailbox);
+            $before_comment = $this->_splitCheck($parts, '(');
+            if ($before_comment != $_mailbox) {
+                // First char should be a (.
+                $comment = substr(str_replace($before_comment, '', $_mailbox), 1);
+                $parts = explode(')', $comment);
+                $comment = $this->_splitCheck($parts, ')');
+                $comments[] = $comment;
+
+                // +2 is for the brackets
+                $_mailbox = substr($_mailbox, strpos($_mailbox, '(' . $comment) + strlen($comment) + 2);
+            }
+            else {
+                break;
+            }
+        }
+
+        foreach ($comments as $comment) {
+            $mailbox = str_replace("({$comment})", '', $mailbox);
+        }
+
+        $mailbox = trim($mailbox);
+
+        // Check for name + route-addr
+        if (substr($mailbox, -1) == '>' && substr($mailbox, 0, 1) != '<') {
+            $parts = explode('<', $mailbox);
+            $name = $this->_splitCheck($parts, '<');
+
+            $phrase = trim($name);
+            $route_addr = trim(substr($mailbox, strlen($name . '<'), -1));
+
+            // grommunio-sync fix for umlauts and other special chars
+            if (substr($phrase, 0, 1) != '"' && substr($phrase, -1) != '"') {
+                $phrase = '"' . $phrase . '"';
+            }
+
+            if ($this->_validatePhrase($phrase) === false || ($route_addr = $this->_validateRouteAddr($route_addr)) === false) {
+                return false;
+            }
+
+            // Only got addr-spec
+        }
+        else {
+            // First snip angle brackets if present.
+            if (substr($mailbox, 0, 1) == '<' && substr($mailbox, -1) == '>') {
+                $addr_spec = substr($mailbox, 1, -1);
+            }
+            else {
+                $addr_spec = $mailbox;
+            }
+
+            if (($addr_spec = $this->_validateAddrSpec($addr_spec)) === false) {
+                return false;
+            }
+        }
+
+        // Construct the object that will be returned.
+        $mbox = new stdClass();
+
+        // Add the phrase (even if empty) and comments
+        $mbox->personal = $phrase;
+        $mbox->comment = isset($comments) ? $comments : [];
+
+        if (isset($route_addr)) {
+            $mbox->mailbox = $route_addr['local_part'];
+            $mbox->host = $route_addr['domain'];
+            $route_addr['adl'] !== '' ? $mbox->adl = $route_addr['adl'] : '';
+        }
+        else {
+            $mbox->mailbox = $addr_spec['local_part'];
+            $mbox->host = $addr_spec['domain'];
+        }
+
+        $mailbox = $mbox;
+
+        return true;
+    }
+
+    /**
+     * This function validates a route-addr which is:
+     * route-addr = "<" [route] addr-spec ">".
+     *
+     * Angle brackets have already been removed at the point of
+     * getting to this function.
+     *
+     * @param string $route_addr the string to check
+     *
+     * @return mixed false on failure, or an array containing validated address/route information on success
+     */
+    protected function _validateRouteAddr($route_addr) {
+        // Check for colon.
+        if (strpos($route_addr, ':') !== false) {
+            $parts = explode(':', $route_addr);
+            $route = $this->_splitCheck($parts, ':');
+        }
+        else {
+            $route = $route_addr;
+        }
+
+        // If $route is same as $route_addr then the colon was in
+        // quotes or brackets or, of course, non existent.
+        if ($route === $route_addr) {
+            unset($route);
+            $addr_spec = $route_addr;
+            if (($addr_spec = $this->_validateAddrSpec($addr_spec)) === false) {
+                return false;
+            }
+        }
+        else {
+            // Validate route part.
+            if (($route = $this->_validateRoute($route)) === false) {
+                return false;
+            }
+
+            $addr_spec = substr($route_addr, strlen($route . ':'));
+
+            // Validate addr-spec part.
+            if (($addr_spec = $this->_validateAddrSpec($addr_spec)) === false) {
+                return false;
+            }
+        }
+
+        if (isset($route)) {
+            $return['adl'] = $route;
+        }
+        else {
+            $return['adl'] = '';
+        }
+
+        return array_merge($return, $addr_spec);
+    }
+
+    /**
+     * Function to validate a route, which is:
+     * route = 1#("@" domain) ":".
+     *
+     * @param string $route the string to check
+     *
+     * @return mixed false on failure, or the validated $route on success
+     */
+    protected function _validateRoute($route) {
+        // Split on comma.
+        $domains = explode(',', trim($route));
+
+        foreach ($domains as $domain) {
+            $domain = str_replace('@', '', trim($domain));
+            if (!$this->_validateDomain($domain)) {
+                return false;
+            }
+        }
+
+        return $route;
+    }
+
+    /**
+     * Function to validate a domain, though this is not quite what
+     * you expect of a strict internet domain.
+     *
+     * domain = sub-domain *("." sub-domain)
+     *
+     * @param string $domain the string to check
+     *
+     * @return mixed false on failure, or the validated domain on success
+     */
+    protected function _validateDomain($domain) {
+        // Note the different use of $subdomains and $sub_domains
+        $subdomains = explode('.', $domain);
+
+        while (count($subdomains) > 0) {
+            $sub_domains[] = $this->_splitCheck($subdomains, '.');
+            for ($i = 0; $i < $this->index + 1; ++$i) {
+                array_shift($subdomains);
+            }
+        }
+
+        foreach ($sub_domains as $sub_domain) {
+            if (!$this->_validateSubdomain(trim($sub_domain))) {
+                return false;
+            }
+        }
+
+        // Managed to get here, so return input.
+        return $domain;
+    }
+
+    /**
+     * Function to validate a subdomain:
+     *   subdomain = domain-ref / domain-literal.
+     *
+     * @param string $subdomain the string to check
+     *
+     * @return bool success or failure
+     */
+    protected function _validateSubdomain($subdomain) {
+        if (preg_match('|^\[(.*)]$|', $subdomain, $arr)) {
+            if (!$this->_validateDliteral($arr[1])) {
+                return false;
+            }
+        }
+        else {
+            if (!$this->_validateAtom($subdomain)) {
+                return false;
+            }
+        }
+
+        // Got here, so return successful.
+        return true;
+    }
+
+    /**
+     * Function to validate a domain literal:
+     *   domain-literal =  "[" *(dtext / quoted-pair) "]".
+     *
+     * @param string $dliteral the string to check
+     *
+     * @return bool success or failure
+     */
+    protected function _validateDliteral($dliteral) {
+        return !preg_match('/(.)[][\x0D\\\\]/', $dliteral, $matches) && ((!isset($matches[1])) || $matches[1] != '\\');
+    }
+
+    /**
+     * Function to validate an addr-spec.
+     *
+     * addr-spec = local-part "@" domain
+     *
+     * @param string $addr_spec the string to check
+     *
+     * @return mixed false on failure, or the validated addr-spec on success
+     */
+    protected function _validateAddrSpec($addr_spec) {
+        $addr_spec = trim($addr_spec);
+
+        // Split on @ sign if there is one.
+        if (strpos($addr_spec, '@') !== false) {
+            $parts = explode('@', $addr_spec);
+            $local_part = $this->_splitCheck($parts, '@');
+            $domain = substr($addr_spec, strlen($local_part . '@'));
+
+        // No @ sign so assume the default domain.
+        }
+        else {
+            $local_part = $addr_spec;
+            $domain = $this->default_domain;
+        }
+
+        if (($local_part = $this->_validateLocalPart($local_part)) === false) {
+            return false;
+        }
+        if (($domain = $this->_validateDomain($domain)) === false) {
+            return false;
+        }
+
+        // Got here so return successful.
+        return ['local_part' => $local_part, 'domain' => $domain];
+    }
+
+    /**
+     * Function to validate the local part of an address:
+     *   local-part = word *("." word).
+     *
+     * @param string $local_part
+     *
+     * @return mixed false on failure, or the validated local part on success
+     */
+    protected function _validateLocalPart($local_part) {
+        $parts = explode('.', $local_part);
+        $words = [];
+
+        // Split the local_part into words.
+        while (count($parts) > 0) {
+            $words[] = $this->_splitCheck($parts, '.');
+            for ($i = 0; $i < $this->index + 1; ++$i) {
+                array_shift($parts);
+            }
+        }
+
+        // Validate each word.
+        foreach ($words as $word) {
+            // word cannot be empty (#17317)
+            if ($word === '') {
+                return false;
+            }
+            // If this word contains an unquoted space, it is invalid. (6.2.4)
+            if (strpos($word, ' ') && $word[0] !== '"') {
+                return false;
+            }
+
+            if ($this->_validatePhrase(trim($word)) === false) {
+                return false;
+            }
+        }
+
+        // Managed to get here, so return the input.
+        return $local_part;
+    }
+
+    /**
+     * Returns an approximate count of how many addresses are in the
+     * given string. This is APPROXIMATE as it only splits based on a
+     * comma which has no preceding backslash. Could be useful as
+     * large amounts of addresses will end up producing *large*
+     * structures when used with parseAddressList().
+     *
+     * @param string $data Addresses to count
+     *
+     * @return int Approximate count
+     */
+    public function approximateCount($data) {
+        return count(preg_split('/(?<!\\\\),/', $data));
+    }
+
+    /**
+     * This is a email validating function separate to the rest of the
+     * class. It simply validates whether an email is of the common
+     * internet form: <user>@<domain>. This can be sufficient for most
+     * people. Optional stricter mode can be utilised which restricts
+     * mailbox characters allowed to alphanumeric, full stop, hyphen
+     * and underscore.
+     *
+     * @param string $data   Address to check
+     * @param bool   $strict Optional stricter mode
+     *
+     * @return mixed False if it fails, an indexed array
+     *               username/domain if it matches
+     */
+    public function isValidInetAddress($data, $strict = false) {
+        $regex = $strict ? '/^([.0-9a-z_+-]+)@(([0-9a-z-]+\.)+[0-9a-z]{2,})$/i' : '/^([*+!.&#$|\'\\%\/0-9a-z^_`{}=?~:-]+)@(([0-9a-z-]+\.)+[0-9a-z]{2,})$/i';
+        if (preg_match($regex, trim($data), $matches)) {
+            return [$matches[1], $matches[2]];
+        }
+
+        return false;
+    }
+
+    /**
+     * grommunio-sync helper for error logging
+     * removing PEAR dependency.
+     *
+     * @param  string  debug message
+     * @param mixed $message
+     *
+     * @return bool always false as there was an error
+     */
+    public function raiseError($message) {
+        SLog::Write(LOGLEVEL_ERROR, "z_RFC822 error: " . $message);
+
+        return false;
+    }
 }

lib/utils/utils.php

Indentation +928 added lines, -928 removed lines

@@ -8,960 +8,960 @@ 
  */
 
 class Utils {
-	/**
-	 * Prints a variable as string
-	 * If a boolean is sent, 'true' or 'false' is displayed.
-	 *
-	 * @param string $var
-	 *
-	 * @return string
-	 */
-	public static function PrintAsString($var) {
-		return ($var) ? (($var === true) ? 'true' : $var) : (($var === false) ? 'false' : (($var === '') ? 'empty' : (($var === null) ? 'null' : $var)));
-	}
-
-	/**
-	 * Splits a "domain\user" string into two values
-	 * If the string contains only the user, domain is returned empty.
-	 *
-	 * @param string $domainuser
-	 *
-	 * @return array index 0: user  1: domain
-	 */
-	public static function SplitDomainUser($domainuser) {
-		$pos = strrpos($domainuser, '\\');
-		if ($pos === false) {
-			$user = $domainuser;
-			$domain = '';
-		}
-		else {
-			$domain = substr($domainuser, 0, $pos);
-			$user = substr($domainuser, $pos + 1);
-		}
-
-		return [$user, $domain];
-	}
-
-	/**
-	 * Build an address string from the components.
-	 *
-	 * @param string $street  the street
-	 * @param string $zip     the zip code
-	 * @param string $city    the city
-	 * @param string $state   the state
-	 * @param string $country the country
-	 *
-	 * @return string the address string or null
-	 */
-	public static function BuildAddressString($street, $zip, $city, $state, $country) {
-		$out = "";
-
-		if (isset($country) && $street != "") {
-			$out = $country;
-		}
-
-		$zcs = "";
-		if (isset($zip) && $zip != "") {
-			$zcs = $zip;
-		}
-		if (isset($city) && $city != "") {
-			$zcs .= (($zcs) ? " " : "") . $city;
-		}
-		if (isset($state) && $state != "") {
-			$zcs .= (($zcs) ? " " : "") . $state;
-		}
-		if ($zcs) {
-			$out = $zcs . "\r\n" . $out;
-		}
-
-		if (isset($street) && $street != "") {
-			$out = $street . (($out) ? "\r\n\r\n" . $out : "");
-		}
-
-		return ($out) ? $out : null;
-	}
-
-	/**
-	 * Build the fileas string from the components according to the configuration.
-	 *
-	 * @param string $lastname
-	 * @param string $firstname
-	 * @param string $middlename
-	 * @param string $company
-	 *
-	 * @return string fileas
-	 */
-	public static function BuildFileAs($lastname = "", $firstname = "", $middlename = "", $company = "") {
-		if (defined('FILEAS_ORDER')) {
-			$fileas = $lastfirst = $firstlast = "";
-			$names = trim($firstname . " " . $middlename);
-			$lastname = trim($lastname);
-			$company = trim($company);
-
-			// lastfirst is "lastname, firstname middlename"
-			// firstlast is "firstname middlename lastname"
-			if (strlen($lastname) > 0) {
-				$lastfirst = $lastname;
-				if (strlen($names) > 0) {
-					$lastfirst .= ", {$names}";
-					$firstlast = "{$names} {$lastname}";
-				}
-				else {
-					$firstlast = $lastname;
-				}
-			}
-			elseif (strlen($names) > 0) {
-				$lastfirst = $firstlast = $names;
-			}
-
-			// if fileas with a company is selected
-			// but company is empty then it will
-			// fallback to firstlast or lastfirst
-			// (depending on which is selected for company)
-			switch (FILEAS_ORDER) {
-				case SYNC_FILEAS_COMPANYONLY:
-					if (strlen($company) > 0) {
-						$fileas = $company;
-					}
-					elseif (strlen($firstlast) > 0) {
-						$fileas = $lastfirst;
-					}
-					break;
-
-				case SYNC_FILEAS_COMPANYLAST:
-					if (strlen($company) > 0) {
-						$fileas = $company;
-						if (strlen($lastfirst) > 0) {
-							$fileas .= "({$lastfirst})";
-						}
-					}
-					elseif (strlen($lastfirst) > 0) {
-						$fileas = $lastfirst;
-					}
-					break;
-
-				case SYNC_FILEAS_COMPANYFIRST:
-					if (strlen($company) > 0) {
-						$fileas = $company;
-						if (strlen($firstlast) > 0) {
-							$fileas .= " ({$firstlast})";
-						}
-					}
-					elseif (strlen($firstlast) > 0) {
-						$fileas = $firstlast;
-					}
-					break;
-
-				case SYNC_FILEAS_FIRSTCOMPANY:
-					if (strlen($firstlast) > 0) {
-						$fileas = $firstlast;
-						if (strlen($company) > 0) {
-							$fileas .= " ({$company})";
-						}
-					}
-					elseif (strlen($company) > 0) {
-						$fileas = $company;
-					}
-					break;
-
-				case SYNC_FILEAS_LASTCOMPANY:
-					if (strlen($lastfirst) > 0) {
-						$fileas = $lastfirst;
-						if (strlen($company) > 0) {
-							$fileas .= " ({$company})";
-						}
-					}
-					elseif (strlen($company) > 0) {
-						$fileas = $company;
-					}
-					break;
-
-				case SYNC_FILEAS_LASTFIRST:
-					if (strlen($lastfirst) > 0) {
-						$fileas = $lastfirst;
-					}
-					break;
-
-				default:
-					$fileas = $firstlast;
-					break;
-			}
-			if (strlen($fileas) == 0) {
-				SLog::Write(LOGLEVEL_DEBUG, "Fileas is empty.");
-			}
-
-			return $fileas;
-		}
-		SLog::Write(LOGLEVEL_DEBUG, "FILEAS_ORDER not defined. Add it to your config.php.");
-
-		return null;
-	}
-
-	/**
-	 * Checks if the PHP-MAPI extension is available and in a requested version.
-	 *
-	 * @param string $version the version to be checked ("6.30.10-18495", parts or build number)
-	 *
-	 * @return bool installed version is superior to the checked string
-	 */
-	public static function CheckMapiExtVersion($version = "") {
-		if (!extension_loaded("mapi")) {
-			return false;
-		}
-		// compare build number if requested
-		if (preg_match('/^\d+$/', $version) && strlen($version) > 3) {
-			$vs = preg_split('/-/', phpversion("mapi"));
-
-			return $version <= $vs[1];
-		}
-		if (version_compare(phpversion("mapi"), $version) == -1) {
-			return false;
-		}
-
-		return true;
-	}
-
-	/**
-	 * Parses and returns an ecoded vCal-Uid from an OL compatible GlobalObjectID.
-	 *
-	 * @param string $olUid an OL compatible GlobalObjectID
-	 *
-	 * @return string the vCal-Uid if available in the olUid, else the original olUid as HEX
-	 */
-	public static function GetICalUidFromOLUid($olUid) {
-		// check if "vCal-Uid" is somewhere in outlookid case-insensitive
-		$icalUid = stristr($olUid, "vCal-Uid");
-		if ($icalUid !== false) {
-			// get the length of the ical id - go back 4 position from where "vCal-Uid" was found
-			$begin = unpack("V", substr($olUid, strlen($icalUid) * (-1) - 4, 4));
-			// remove "vCal-Uid" and packed "1" and use the ical id length
-			return substr($icalUid, 12, ($begin[1] - 13));
-		}
-
-		return strtoupper(bin2hex($olUid));
-	}
-
-	/**
-	 * Checks the given UID if it is an OL compatible GlobalObjectID
-	 * If not, the given UID is encoded inside the GlobalObjectID.
-	 *
-	 * @param string $icalUid an appointment uid as HEX
-	 *
-	 * @return string an OL compatible GlobalObjectID
-	 */
-	public static function GetOLUidFromICalUid($icalUid) {
-		if (strlen($icalUid) <= 64) {
-			$len = 13 + strlen($icalUid);
-			$OLUid = pack("V", $len);
-			$OLUid .= "vCal-Uid";
-			$OLUid .= pack("V", 1);
-			$OLUid .= $icalUid;
-
-			return hex2bin("040000008200E00074C5B7101A82E0080000000000000000000000000000000000000000" . bin2hex($OLUid) . "00");
-		}
-
-		return hex2bin($icalUid);
-	}
-
-	/**
-	 * Extracts the basedate of the GlobalObjectID and the RecurStartTime.
-	 *
-	 * @param string $goid           OL compatible GlobalObjectID
-	 * @param long   $recurStartTime
-	 *
-	 * @return long basedate
-	 */
-	public static function ExtractBaseDate($goid, $recurStartTime) {
-		$hexbase = substr(bin2hex($goid), 32, 8);
-		$day = hexdec(substr($hexbase, 6, 2));
-		$month = hexdec(substr($hexbase, 4, 2));
-		$year = hexdec(substr($hexbase, 0, 4));
-
-		if ($day && $month && $year) {
-			$h = $recurStartTime >> 12;
-			$m = ($recurStartTime - $h * 4096) >> 6;
-			$s = $recurStartTime - $h * 4096 - $m * 64;
-
-			return gmmktime($h, $m, $s, $month, $day, $year);
-		}
-
-		return false;
-	}
-
-	/**
-	 * Converts SYNC_FILTERTYPE into a timestamp.
-	 *
-	 * @param int $filtertype Filtertype
-	 *
-	 * @return long
-	 */
-	public static function GetCutOffDate($filtertype) {
-		$back = Utils::GetFiltertypeInterval($filtertype);
-
-		if ($back === false) {
-			return 0; // unlimited
-		}
-
-		return time() - $back;
-	}
-
-	/**
-	 * Returns the interval indicated by the filtertype.
-	 *
-	 * @param int $filtertype
-	 *
-	 * @return bool|long returns false on invalid filtertype
-	 */
-	public static function GetFiltertypeInterval($filtertype) {
-		$back = false;
-
-		switch ($filtertype) {
-			case SYNC_FILTERTYPE_1DAY:
-				$back = 60 * 60 * 24;
-				break;
-
-			case SYNC_FILTERTYPE_3DAYS:
-				$back = 60 * 60 * 24 * 3;
-				break;
-
-			case SYNC_FILTERTYPE_1WEEK:
-				$back = 60 * 60 * 24 * 7;
-				break;
-
-			case SYNC_FILTERTYPE_2WEEKS:
-				$back = 60 * 60 * 24 * 14;
-				break;
-
-			case SYNC_FILTERTYPE_1MONTH:
-				$back = 60 * 60 * 24 * 31;
-				break;
-
-			case SYNC_FILTERTYPE_3MONTHS:
-				$back = 60 * 60 * 24 * 31 * 3;
-				break;
-
-			case SYNC_FILTERTYPE_6MONTHS:
-				$back = 60 * 60 * 24 * 31 * 6;
-				break;
-
-			default:
-				$back = false;
-		}
-
-		return $back;
-	}
-
-	/**
-	 * Converts SYNC_TRUNCATION into bytes.
-	 *
-	 * @param int       SYNC_TRUNCATION
-	 * @param mixed $truncation
-	 *
-	 * @return long
-	 */
-	public static function GetTruncSize($truncation) {
-		switch ($truncation) {
-			case SYNC_TRUNCATION_HEADERS:
-				return 0;
-
-			case SYNC_TRUNCATION_512B:
-				return 512;
-
-			case SYNC_TRUNCATION_1K:
-				return 1024;
-
-			case SYNC_TRUNCATION_2K:
-				return 2 * 1024;
-
-			case SYNC_TRUNCATION_5K:
-				return 5 * 1024;
-
-			case SYNC_TRUNCATION_10K:
-				return 10 * 1024;
-
-			case SYNC_TRUNCATION_20K:
-				return 20 * 1024;
-
-			case SYNC_TRUNCATION_50K:
-				return 50 * 1024;
-
-			case SYNC_TRUNCATION_100K:
-				return 100 * 1024;
-
-			case SYNC_TRUNCATION_ALL:
-				return 1024 * 1024; // We'll limit to 1MB anyway
-
-			default:
-				return 1024; // Default to 1Kb
-		}
-	}
-
-	/**
-	 * Truncate an UTF-8 encoded string correctly.
-	 *
-	 * If it's not possible to truncate properly, an empty string is returned
-	 *
-	 * @param string $string   the string
-	 * @param string $length   position where string should be cut
-	 * @param bool   $htmlsafe doesn't cut html tags in half, doesn't ensure correct html - default: false
-	 *
-	 * @return string truncated string
-	 */
-	public static function Utf8_truncate($string, $length, $htmlsafe = false) {
-		// make sure length is always an integer
-		$length = (int) $length;
-
-		// if the input string is shorter then the trunction, make sure it's valid UTF-8!
-		if (strlen($string) <= $length) {
-			$length = strlen($string) - 1;
-		}
-
-		// The intent is not to cut HTML tags in half which causes displaying issues (see ZP-1240).
-		// The used method just tries to cut outside of tags, without checking tag validity and closing tags.
-		if ($htmlsafe) {
-			$offset = 0 - strlen($string) + $length;
-			$validPos = strrpos($string, "<", $offset);
-			if ($validPos > strrpos($string, ">", $offset)) {
-				$length = $validPos;
-			}
-		}
-
-		while ($length >= 0) {
-			if ((ord($string[$length]) < 0x80) || (ord($string[$length]) >= 0xC0)) {
-				return substr($string, 0, $length);
-			}
-			--$length;
-		}
-
-		return "";
-	}
-
-	/**
-	 * Indicates if the specified folder type is a system folder.
-	 *
-	 * @param int $foldertype
-	 *
-	 * @return bool
-	 */
-	public static function IsSystemFolder($foldertype) {
-		return (
-			$foldertype == SYNC_FOLDER_TYPE_INBOX ||
-			$foldertype == SYNC_FOLDER_TYPE_DRAFTS ||
-			$foldertype == SYNC_FOLDER_TYPE_WASTEBASKET ||
-			$foldertype == SYNC_FOLDER_TYPE_SENTMAIL ||
-			$foldertype == SYNC_FOLDER_TYPE_OUTBOX ||
-			$foldertype == SYNC_FOLDER_TYPE_TASK ||
-			$foldertype == SYNC_FOLDER_TYPE_APPOINTMENT ||
-			$foldertype == SYNC_FOLDER_TYPE_CONTACT ||
-			$foldertype == SYNC_FOLDER_TYPE_NOTE ||
-			$foldertype == SYNC_FOLDER_TYPE_JOURNAL
-			) ? true : false;
-	}
-
-	/**
-	 * Checks for valid email addresses
-	 * The used regex actually only checks if a valid email address is part of the submitted string
-	 * it also returns true for the mailbox format, but this is not checked explicitly.
-	 *
-	 * @param string $email address to be checked
-	 *
-	 * @return bool
-	 */
-	public static function CheckEmail($email) {
-		return strpos($email, '@') !== false ? true : false;
-	}
-
-	/**
-	 * Checks if a string is base64 encoded.
-	 *
-	 * @param string $string the string to be checked
-	 *
-	 * @return bool
-	 */
-	public static function IsBase64String($string) {
-		return (bool) preg_match("#^([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{2}==|[A-Za-z0-9+\\/]{3}=|[A-Za-z0-9+/]{4})?$#", $string);
-	}
+    /**
+     * Prints a variable as string
+     * If a boolean is sent, 'true' or 'false' is displayed.
+     *
+     * @param string $var
+     *
+     * @return string
+     */
+    public static function PrintAsString($var) {
+        return ($var) ? (($var === true) ? 'true' : $var) : (($var === false) ? 'false' : (($var === '') ? 'empty' : (($var === null) ? 'null' : $var)));
+    }
+
+    /**
+     * Splits a "domain\user" string into two values
+     * If the string contains only the user, domain is returned empty.
+     *
+     * @param string $domainuser
+     *
+     * @return array index 0: user  1: domain
+     */
+    public static function SplitDomainUser($domainuser) {
+        $pos = strrpos($domainuser, '\\');
+        if ($pos === false) {
+            $user = $domainuser;
+            $domain = '';
+        }
+        else {
+            $domain = substr($domainuser, 0, $pos);
+            $user = substr($domainuser, $pos + 1);
+        }
+
+        return [$user, $domain];
+    }
+
+    /**
+     * Build an address string from the components.
+     *
+     * @param string $street  the street
+     * @param string $zip     the zip code
+     * @param string $city    the city
+     * @param string $state   the state
+     * @param string $country the country
+     *
+     * @return string the address string or null
+     */
+    public static function BuildAddressString($street, $zip, $city, $state, $country) {
+        $out = "";
+
+        if (isset($country) && $street != "") {
+            $out = $country;
+        }
+
+        $zcs = "";
+        if (isset($zip) && $zip != "") {
+            $zcs = $zip;
+        }
+        if (isset($city) && $city != "") {
+            $zcs .= (($zcs) ? " " : "") . $city;
+        }
+        if (isset($state) && $state != "") {
+            $zcs .= (($zcs) ? " " : "") . $state;
+        }
+        if ($zcs) {
+            $out = $zcs . "\r\n" . $out;
+        }
+
+        if (isset($street) && $street != "") {
+            $out = $street . (($out) ? "\r\n\r\n" . $out : "");
+        }
+
+        return ($out) ? $out : null;
+    }
+
+    /**
+     * Build the fileas string from the components according to the configuration.
+     *
+     * @param string $lastname
+     * @param string $firstname
+     * @param string $middlename
+     * @param string $company
+     *
+     * @return string fileas
+     */
+    public static function BuildFileAs($lastname = "", $firstname = "", $middlename = "", $company = "") {
+        if (defined('FILEAS_ORDER')) {
+            $fileas = $lastfirst = $firstlast = "";
+            $names = trim($firstname . " " . $middlename);
+            $lastname = trim($lastname);
+            $company = trim($company);
+
+            // lastfirst is "lastname, firstname middlename"
+            // firstlast is "firstname middlename lastname"
+            if (strlen($lastname) > 0) {
+                $lastfirst = $lastname;
+                if (strlen($names) > 0) {
+                    $lastfirst .= ", {$names}";
+                    $firstlast = "{$names} {$lastname}";
+                }
+                else {
+                    $firstlast = $lastname;
+                }
+            }
+            elseif (strlen($names) > 0) {
+                $lastfirst = $firstlast = $names;
+            }
+
+            // if fileas with a company is selected
+            // but company is empty then it will
+            // fallback to firstlast or lastfirst
+            // (depending on which is selected for company)
+            switch (FILEAS_ORDER) {
+                case SYNC_FILEAS_COMPANYONLY:
+                    if (strlen($company) > 0) {
+                        $fileas = $company;
+                    }
+                    elseif (strlen($firstlast) > 0) {
+                        $fileas = $lastfirst;
+                    }
+                    break;
+
+                case SYNC_FILEAS_COMPANYLAST:
+                    if (strlen($company) > 0) {
+                        $fileas = $company;
+                        if (strlen($lastfirst) > 0) {
+                            $fileas .= "({$lastfirst})";
+                        }
+                    }
+                    elseif (strlen($lastfirst) > 0) {
+                        $fileas = $lastfirst;
+                    }
+                    break;
+
+                case SYNC_FILEAS_COMPANYFIRST:
+                    if (strlen($company) > 0) {
+                        $fileas = $company;
+                        if (strlen($firstlast) > 0) {
+                            $fileas .= " ({$firstlast})";
+                        }
+                    }
+                    elseif (strlen($firstlast) > 0) {
+                        $fileas = $firstlast;
+                    }
+                    break;
+
+                case SYNC_FILEAS_FIRSTCOMPANY:
+                    if (strlen($firstlast) > 0) {
+                        $fileas = $firstlast;
+                        if (strlen($company) > 0) {
+                            $fileas .= " ({$company})";
+                        }
+                    }
+                    elseif (strlen($company) > 0) {
+                        $fileas = $company;
+                    }
+                    break;
+
+                case SYNC_FILEAS_LASTCOMPANY:
+                    if (strlen($lastfirst) > 0) {
+                        $fileas = $lastfirst;
+                        if (strlen($company) > 0) {
+                            $fileas .= " ({$company})";
+                        }
+                    }
+                    elseif (strlen($company) > 0) {
+                        $fileas = $company;
+                    }
+                    break;
+
+                case SYNC_FILEAS_LASTFIRST:
+                    if (strlen($lastfirst) > 0) {
+                        $fileas = $lastfirst;
+                    }
+                    break;
+
+                default:
+                    $fileas = $firstlast;
+                    break;
+            }
+            if (strlen($fileas) == 0) {
+                SLog::Write(LOGLEVEL_DEBUG, "Fileas is empty.");
+            }
+
+            return $fileas;
+        }
+        SLog::Write(LOGLEVEL_DEBUG, "FILEAS_ORDER not defined. Add it to your config.php.");
+
+        return null;
+    }
+
+    /**
+     * Checks if the PHP-MAPI extension is available and in a requested version.
+     *
+     * @param string $version the version to be checked ("6.30.10-18495", parts or build number)
+     *
+     * @return bool installed version is superior to the checked string
+     */
+    public static function CheckMapiExtVersion($version = "") {
+        if (!extension_loaded("mapi")) {
+            return false;
+        }
+        // compare build number if requested
+        if (preg_match('/^\d+$/', $version) && strlen($version) > 3) {
+            $vs = preg_split('/-/', phpversion("mapi"));
+
+            return $version <= $vs[1];
+        }
+        if (version_compare(phpversion("mapi"), $version) == -1) {
+            return false;
+        }
+
+        return true;
+    }
+
+    /**
+     * Parses and returns an ecoded vCal-Uid from an OL compatible GlobalObjectID.
+     *
+     * @param string $olUid an OL compatible GlobalObjectID
+     *
+     * @return string the vCal-Uid if available in the olUid, else the original olUid as HEX
+     */
+    public static function GetICalUidFromOLUid($olUid) {
+        // check if "vCal-Uid" is somewhere in outlookid case-insensitive
+        $icalUid = stristr($olUid, "vCal-Uid");
+        if ($icalUid !== false) {
+            // get the length of the ical id - go back 4 position from where "vCal-Uid" was found
+            $begin = unpack("V", substr($olUid, strlen($icalUid) * (-1) - 4, 4));
+            // remove "vCal-Uid" and packed "1" and use the ical id length
+            return substr($icalUid, 12, ($begin[1] - 13));
+        }
+
+        return strtoupper(bin2hex($olUid));
+    }
+
+    /**
+     * Checks the given UID if it is an OL compatible GlobalObjectID
+     * If not, the given UID is encoded inside the GlobalObjectID.
+     *
+     * @param string $icalUid an appointment uid as HEX
+     *
+     * @return string an OL compatible GlobalObjectID
+     */
+    public static function GetOLUidFromICalUid($icalUid) {
+        if (strlen($icalUid) <= 64) {
+            $len = 13 + strlen($icalUid);
+            $OLUid = pack("V", $len);
+            $OLUid .= "vCal-Uid";
+            $OLUid .= pack("V", 1);
+            $OLUid .= $icalUid;
+
+            return hex2bin("040000008200E00074C5B7101A82E0080000000000000000000000000000000000000000" . bin2hex($OLUid) . "00");
+        }
+
+        return hex2bin($icalUid);
+    }
+
+    /**
+     * Extracts the basedate of the GlobalObjectID and the RecurStartTime.
+     *
+     * @param string $goid           OL compatible GlobalObjectID
+     * @param long   $recurStartTime
+     *
+     * @return long basedate
+     */
+    public static function ExtractBaseDate($goid, $recurStartTime) {
+        $hexbase = substr(bin2hex($goid), 32, 8);
+        $day = hexdec(substr($hexbase, 6, 2));
+        $month = hexdec(substr($hexbase, 4, 2));
+        $year = hexdec(substr($hexbase, 0, 4));
+
+        if ($day && $month && $year) {
+            $h = $recurStartTime >> 12;
+            $m = ($recurStartTime - $h * 4096) >> 6;
+            $s = $recurStartTime - $h * 4096 - $m * 64;
+
+            return gmmktime($h, $m, $s, $month, $day, $year);
+        }
+
+        return false;
+    }
+
+    /**
+     * Converts SYNC_FILTERTYPE into a timestamp.
+     *
+     * @param int $filtertype Filtertype
+     *
+     * @return long
+     */
+    public static function GetCutOffDate($filtertype) {
+        $back = Utils::GetFiltertypeInterval($filtertype);
+
+        if ($back === false) {
+            return 0; // unlimited
+        }
+
+        return time() - $back;
+    }
+
+    /**
+     * Returns the interval indicated by the filtertype.
+     *
+     * @param int $filtertype
+     *
+     * @return bool|long returns false on invalid filtertype
+     */
+    public static function GetFiltertypeInterval($filtertype) {
+        $back = false;
+
+        switch ($filtertype) {
+            case SYNC_FILTERTYPE_1DAY:
+                $back = 60 * 60 * 24;
+                break;
+
+            case SYNC_FILTERTYPE_3DAYS:
+                $back = 60 * 60 * 24 * 3;
+                break;
+
+            case SYNC_FILTERTYPE_1WEEK:
+                $back = 60 * 60 * 24 * 7;
+                break;
+
+            case SYNC_FILTERTYPE_2WEEKS:
+                $back = 60 * 60 * 24 * 14;
+                break;
+
+            case SYNC_FILTERTYPE_1MONTH:
+                $back = 60 * 60 * 24 * 31;
+                break;
+
+            case SYNC_FILTERTYPE_3MONTHS:
+                $back = 60 * 60 * 24 * 31 * 3;
+                break;
+
+            case SYNC_FILTERTYPE_6MONTHS:
+                $back = 60 * 60 * 24 * 31 * 6;
+                break;
+
+            default:
+                $back = false;
+        }
+
+        return $back;
+    }
+
+    /**
+     * Converts SYNC_TRUNCATION into bytes.
+     *
+     * @param int       SYNC_TRUNCATION
+     * @param mixed $truncation
+     *
+     * @return long
+     */
+    public static function GetTruncSize($truncation) {
+        switch ($truncation) {
+            case SYNC_TRUNCATION_HEADERS:
+                return 0;
+
+            case SYNC_TRUNCATION_512B:
+                return 512;
+
+            case SYNC_TRUNCATION_1K:
+                return 1024;
+
+            case SYNC_TRUNCATION_2K:
+                return 2 * 1024;
+
+            case SYNC_TRUNCATION_5K:
+                return 5 * 1024;
+
+            case SYNC_TRUNCATION_10K:
+                return 10 * 1024;
+
+            case SYNC_TRUNCATION_20K:
+                return 20 * 1024;
+
+            case SYNC_TRUNCATION_50K:
+                return 50 * 1024;
+
+            case SYNC_TRUNCATION_100K:
+                return 100 * 1024;
+
+            case SYNC_TRUNCATION_ALL:
+                return 1024 * 1024; // We'll limit to 1MB anyway
+
+            default:
+                return 1024; // Default to 1Kb
+        }
+    }
+
+    /**
+     * Truncate an UTF-8 encoded string correctly.
+     *
+     * If it's not possible to truncate properly, an empty string is returned
+     *
+     * @param string $string   the string
+     * @param string $length   position where string should be cut
+     * @param bool   $htmlsafe doesn't cut html tags in half, doesn't ensure correct html - default: false
+     *
+     * @return string truncated string
+     */
+    public static function Utf8_truncate($string, $length, $htmlsafe = false) {
+        // make sure length is always an integer
+        $length = (int) $length;
+
+        // if the input string is shorter then the trunction, make sure it's valid UTF-8!
+        if (strlen($string) <= $length) {
+            $length = strlen($string) - 1;
+        }
+
+        // The intent is not to cut HTML tags in half which causes displaying issues (see ZP-1240).
+        // The used method just tries to cut outside of tags, without checking tag validity and closing tags.
+        if ($htmlsafe) {
+            $offset = 0 - strlen($string) + $length;
+            $validPos = strrpos($string, "<", $offset);
+            if ($validPos > strrpos($string, ">", $offset)) {
+                $length = $validPos;
+            }
+        }
+
+        while ($length >= 0) {
+            if ((ord($string[$length]) < 0x80) || (ord($string[$length]) >= 0xC0)) {
+                return substr($string, 0, $length);
+            }
+            --$length;
+        }
+
+        return "";
+    }
+
+    /**
+     * Indicates if the specified folder type is a system folder.
+     *
+     * @param int $foldertype
+     *
+     * @return bool
+     */
+    public static function IsSystemFolder($foldertype) {
+        return (
+            $foldertype == SYNC_FOLDER_TYPE_INBOX ||
+            $foldertype == SYNC_FOLDER_TYPE_DRAFTS ||
+            $foldertype == SYNC_FOLDER_TYPE_WASTEBASKET ||
+            $foldertype == SYNC_FOLDER_TYPE_SENTMAIL ||
+            $foldertype == SYNC_FOLDER_TYPE_OUTBOX ||
+            $foldertype == SYNC_FOLDER_TYPE_TASK ||
+            $foldertype == SYNC_FOLDER_TYPE_APPOINTMENT ||
+            $foldertype == SYNC_FOLDER_TYPE_CONTACT ||
+            $foldertype == SYNC_FOLDER_TYPE_NOTE ||
+            $foldertype == SYNC_FOLDER_TYPE_JOURNAL
+            ) ? true : false;
+    }
+
+    /**
+     * Checks for valid email addresses
+     * The used regex actually only checks if a valid email address is part of the submitted string
+     * it also returns true for the mailbox format, but this is not checked explicitly.
+     *
+     * @param string $email address to be checked
+     *
+     * @return bool
+     */
+    public static function CheckEmail($email) {
+        return strpos($email, '@') !== false ? true : false;
+    }
+
+    /**
+     * Checks if a string is base64 encoded.
+     *
+     * @param string $string the string to be checked
+     *
+     * @return bool
+     */
+    public static function IsBase64String($string) {
+        return (bool) preg_match("#^([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{2}==|[A-Za-z0-9+\\/]{3}=|[A-Za-z0-9+/]{4})?$#", $string);
+    }
 
-	/**
-	 * Returns a command string for a given command code.
-	 *
-	 * @param int $code
-	 *
-	 * @return string or false if code is unknown
-	 */
-	public static function GetCommandFromCode($code) {
-		switch ($code) {
-			case GSync::COMMAND_SYNC:                 return 'Sync';
+    /**
+     * Returns a command string for a given command code.
+     *
+     * @param int $code
+     *
+     * @return string or false if code is unknown
+     */
+    public static function GetCommandFromCode($code) {
+        switch ($code) {
+            case GSync::COMMAND_SYNC:                 return 'Sync';
 
-			case GSync::COMMAND_SENDMAIL:             return 'SendMail';
+            case GSync::COMMAND_SENDMAIL:             return 'SendMail';
 
-			case GSync::COMMAND_SMARTFORWARD:         return 'SmartForward';
+            case GSync::COMMAND_SMARTFORWARD:         return 'SmartForward';
 
-			case GSync::COMMAND_SMARTREPLY:           return 'SmartReply';
+            case GSync::COMMAND_SMARTREPLY:           return 'SmartReply';
 
-			case GSync::COMMAND_GETATTACHMENT:        return 'GetAttachment';
+            case GSync::COMMAND_GETATTACHMENT:        return 'GetAttachment';
 
-			case GSync::COMMAND_FOLDERSYNC:           return 'FolderSync';
+            case GSync::COMMAND_FOLDERSYNC:           return 'FolderSync';
 
-			case GSync::COMMAND_FOLDERCREATE:         return 'FolderCreate';
+            case GSync::COMMAND_FOLDERCREATE:         return 'FolderCreate';
 
-			case GSync::COMMAND_FOLDERDELETE:         return 'FolderDelete';
+            case GSync::COMMAND_FOLDERDELETE:         return 'FolderDelete';
 
-			case GSync::COMMAND_FOLDERUPDATE:         return 'FolderUpdate';
+            case GSync::COMMAND_FOLDERUPDATE:         return 'FolderUpdate';
 
-			case GSync::COMMAND_MOVEITEMS:            return 'MoveItems';
+            case GSync::COMMAND_MOVEITEMS:            return 'MoveItems';
 
-			case GSync::COMMAND_GETITEMESTIMATE:      return 'GetItemEstimate';
+            case GSync::COMMAND_GETITEMESTIMATE:      return 'GetItemEstimate';
 
-			case GSync::COMMAND_MEETINGRESPONSE:      return 'MeetingResponse';
+            case GSync::COMMAND_MEETINGRESPONSE:      return 'MeetingResponse';
 
-			case GSync::COMMAND_SEARCH:               return 'Search';
+            case GSync::COMMAND_SEARCH:               return 'Search';
 
-			case GSync::COMMAND_SETTINGS:             return 'Settings';
+            case GSync::COMMAND_SETTINGS:             return 'Settings';
 
-			case GSync::COMMAND_PING:                 return 'Ping';
+            case GSync::COMMAND_PING:                 return 'Ping';
 
-			case GSync::COMMAND_ITEMOPERATIONS:       return 'ItemOperations';
+            case GSync::COMMAND_ITEMOPERATIONS:       return 'ItemOperations';
 
-			case GSync::COMMAND_PROVISION:            return 'Provision';
+            case GSync::COMMAND_PROVISION:            return 'Provision';
 
-			case GSync::COMMAND_RESOLVERECIPIENTS:    return 'ResolveRecipients';
+            case GSync::COMMAND_RESOLVERECIPIENTS:    return 'ResolveRecipients';
 
-			case GSync::COMMAND_VALIDATECERT:         return 'ValidateCert';
-			// Deprecated commands
-			case GSync::COMMAND_GETHIERARCHY:         return 'GetHierarchy';
+            case GSync::COMMAND_VALIDATECERT:         return 'ValidateCert';
+            // Deprecated commands
+            case GSync::COMMAND_GETHIERARCHY:         return 'GetHierarchy';
 
-			case GSync::COMMAND_CREATECOLLECTION:     return 'CreateCollection';
+            case GSync::COMMAND_CREATECOLLECTION:     return 'CreateCollection';
 
-			case GSync::COMMAND_DELETECOLLECTION:     return 'DeleteCollection';
+            case GSync::COMMAND_DELETECOLLECTION:     return 'DeleteCollection';
 
-			case GSync::COMMAND_MOVECOLLECTION:       return 'MoveCollection';
+            case GSync::COMMAND_MOVECOLLECTION:       return 'MoveCollection';
 
-			case GSync::COMMAND_NOTIFY:               return 'Notify';
-		}
+            case GSync::COMMAND_NOTIFY:               return 'Notify';
+        }
 
-		return false;
-	}
+        return false;
+    }
 
-	/**
-	 * Returns a command code for a given command.
-	 *
-	 * @param string $command
-	 *
-	 * @return int or false if command is unknown
-	 */
-	public static function GetCodeFromCommand($command) {
-		switch ($command) {
-			case 'Sync':                 return GSync::COMMAND_SYNC;
+    /**
+     * Returns a command code for a given command.
+     *
+     * @param string $command
+     *
+     * @return int or false if command is unknown
+     */
+    public static function GetCodeFromCommand($command) {
+        switch ($command) {
+            case 'Sync':                 return GSync::COMMAND_SYNC;
 
-			case 'SendMail':             return GSync::COMMAND_SENDMAIL;
+            case 'SendMail':             return GSync::COMMAND_SENDMAIL;
 
-			case 'SmartForward':         return GSync::COMMAND_SMARTFORWARD;
+            case 'SmartForward':         return GSync::COMMAND_SMARTFORWARD;
 
-			case 'SmartReply':           return GSync::COMMAND_SMARTREPLY;
+            case 'SmartReply':           return GSync::COMMAND_SMARTREPLY;
 
-			case 'GetAttachment':        return GSync::COMMAND_GETATTACHMENT;
+            case 'GetAttachment':        return GSync::COMMAND_GETATTACHMENT;
 
-			case 'FolderSync':           return GSync::COMMAND_FOLDERSYNC;
+            case 'FolderSync':           return GSync::COMMAND_FOLDERSYNC;
 
-			case 'FolderCreate':         return GSync::COMMAND_FOLDERCREATE;
+            case 'FolderCreate':         return GSync::COMMAND_FOLDERCREATE;
 
-			case 'FolderDelete':         return GSync::COMMAND_FOLDERDELETE;
+            case 'FolderDelete':         return GSync::COMMAND_FOLDERDELETE;
 
-			case 'FolderUpdate':         return GSync::COMMAND_FOLDERUPDATE;
+            case 'FolderUpdate':         return GSync::COMMAND_FOLDERUPDATE;
 
-			case 'MoveItems':            return GSync::COMMAND_MOVEITEMS;
+            case 'MoveItems':            return GSync::COMMAND_MOVEITEMS;
 
-			case 'GetItemEstimate':      return GSync::COMMAND_GETITEMESTIMATE;
+            case 'GetItemEstimate':      return GSync::COMMAND_GETITEMESTIMATE;
 
-			case 'MeetingResponse':      return GSync::COMMAND_MEETINGRESPONSE;
+            case 'MeetingResponse':      return GSync::COMMAND_MEETINGRESPONSE;
 
-			case 'Search':               return GSync::COMMAND_SEARCH;
+            case 'Search':               return GSync::COMMAND_SEARCH;
 
-			case 'Settings':             return GSync::COMMAND_SETTINGS;
+            case 'Settings':             return GSync::COMMAND_SETTINGS;
 
-			case 'Ping':                 return GSync::COMMAND_PING;
+            case 'Ping':                 return GSync::COMMAND_PING;
 
-			case 'ItemOperations':       return GSync::COMMAND_ITEMOPERATIONS;
+            case 'ItemOperations':       return GSync::COMMAND_ITEMOPERATIONS;
 
-			case 'Provision':            return GSync::COMMAND_PROVISION;
+            case 'Provision':            return GSync::COMMAND_PROVISION;
 
-			case 'ResolveRecipients':    return GSync::COMMAND_RESOLVERECIPIENTS;
+            case 'ResolveRecipients':    return GSync::COMMAND_RESOLVERECIPIENTS;
 
-			case 'ValidateCert':         return GSync::COMMAND_VALIDATECERT;
-			// Deprecated commands
-			case 'GetHierarchy':         return GSync::COMMAND_GETHIERARCHY;
+            case 'ValidateCert':         return GSync::COMMAND_VALIDATECERT;
+            // Deprecated commands
+            case 'GetHierarchy':         return GSync::COMMAND_GETHIERARCHY;
 
-			case 'CreateCollection':     return GSync::COMMAND_CREATECOLLECTION;
+            case 'CreateCollection':     return GSync::COMMAND_CREATECOLLECTION;
 
-			case 'DeleteCollection':     return GSync::COMMAND_DELETECOLLECTION;
+            case 'DeleteCollection':     return GSync::COMMAND_DELETECOLLECTION;
 
-			case 'MoveCollection':       return GSync::COMMAND_MOVECOLLECTION;
-
-			case 'Notify':               return GSync::COMMAND_NOTIFY;
-		}
-
-		return false;
-	}
-
-	/**
-	 * Normalize the given timestamp to the start of the day.
-	 *
-	 * @param long $timestamp
-	 *
-	 * @return long
-	 */
-	public static function getDayStartOfTimestamp($timestamp) {
-		return $timestamp - ($timestamp % (60 * 60 * 24));
-	}
-
-	/**
-	 * Returns a formatted string output from an optional timestamp.
-	 * If no timestamp is sent, NOW is used.
-	 *
-	 * @param long $timestamp
-	 *
-	 * @return string
-	 */
-	public static function GetFormattedTime($timestamp = false) {
-		if (!$timestamp) {
-			return @strftime("%d/%m/%Y %H:%M:%S");
-		}
-
-		return @strftime("%d/%m/%Y %H:%M:%S", $timestamp);
-	}
-
-	/**
-	 * Get charset name from a codepage.
-	 *
-	 * @see http://msdn.microsoft.com/en-us/library/dd317756(VS.85).aspx
-	 *
-	 * Table taken from common/codepage.cpp
-	 *
-	 * @param int codepage Codepage
-	 * @param mixed $codepage
-	 *
-	 * @return string iconv-compatible charset name
-	 */
-	public static function GetCodepageCharset($codepage) {
-		$codepages = [
-			20106 => "DIN_66003",
-			20108 => "NS_4551-1",
-			20107 => "SEN_850200_B",
-			950 => "big5",
-			50221 => "csISO2022JP",
-			51932 => "euc-jp",
-			51936 => "euc-cn",
-			51949 => "euc-kr",
-			949 => "euc-kr",
-			936 => "gb18030",
-			52936 => "csgb2312",
-			852 => "ibm852",
-			866 => "ibm866",
-			50220 => "iso-2022-jp",
-			50222 => "iso-2022-jp",
-			50225 => "iso-2022-kr",
-			1252 => "windows-1252",
-			28591 => "iso-8859-1",
-			28592 => "iso-8859-2",
-			28593 => "iso-8859-3",
-			28594 => "iso-8859-4",
-			28595 => "iso-8859-5",
-			28596 => "iso-8859-6",
-			28597 => "iso-8859-7",
-			28598 => "iso-8859-8",
-			28599 => "iso-8859-9",
-			28603 => "iso-8859-13",
-			28605 => "iso-8859-15",
-			20866 => "koi8-r",
-			21866 => "koi8-u",
-			932 => "shift-jis",
-			1200 => "unicode",
-			1201 => "unicodebig",
-			65000 => "utf-7",
-			65001 => "utf-8",
-			1250 => "windows-1250",
-			1251 => "windows-1251",
-			1253 => "windows-1253",
-			1254 => "windows-1254",
-			1255 => "windows-1255",
-			1256 => "windows-1256",
-			1257 => "windows-1257",
-			1258 => "windows-1258",
-			874 => "windows-874",
-			20127 => "us-ascii",
-		];
-
-		if (isset($codepages[$codepage])) {
-			return $codepages[$codepage];
-		}
-		// Defaulting to iso-8859-15 since it is more likely for someone to make a mistake in the codepage
-		// when using west-european charsets then when using other charsets since utf-8 is binary compatible
-		// with the bottom 7 bits of west-european
-		return "iso-8859-15";
-	}
-
-	/**
-	 * Converts a string encoded with codepage into an UTF-8 string.
-	 *
-	 * @param int    $codepage
-	 * @param string $string
-	 *
-	 * @return string
-	 */
-	public static function ConvertCodepageStringToUtf8($codepage, $string) {
-		if (function_exists("iconv")) {
-			$charset = self::GetCodepageCharset($codepage);
-
-			return iconv($charset, "utf-8", $string);
-		}
-
-		SLog::Write(LOGLEVEL_WARN, "Utils::ConvertCodepageStringToUtf8() 'iconv' is not available. Charset conversion skipped.");
-
-		return $string;
-	}
-
-	/**
-	 * Converts a string to another charset.
-	 *
-	 * @param int    $in
-	 * @param int    $out
-	 * @param string $string
-	 *
-	 * @return string
-	 */
-	public static function ConvertCodepage($in, $out, $string) {
-		// do nothing if both charsets are the same
-		if ($in == $out) {
-			return $string;
-		}
-
-		if (function_exists("iconv")) {
-			$inCharset = self::GetCodepageCharset($in);
-			$outCharset = self::GetCodepageCharset($out);
-
-			return iconv($inCharset, $outCharset, $string);
-		}
-
-		SLog::Write(LOGLEVEL_WARN, "Utils::ConvertCodepage() 'iconv' is not available. Charset conversion skipped.");
-
-		return $string;
-	}
-
-	/**
-	 * Returns the best match of preferred body preference types.
-	 *
-	 * @param array $bpTypes
-	 *
-	 * @return int
-	 */
-	public static function GetBodyPreferenceBestMatch($bpTypes) {
-		if ($bpTypes === false) {
-			return SYNC_BODYPREFERENCE_PLAIN;
-		}
-		// The best choice is RTF, then HTML and then MIME in order to save bandwidth
-		// because MIME is a complete message including the headers and attachments
-		if (in_array(SYNC_BODYPREFERENCE_RTF, $bpTypes)) {
-			return SYNC_BODYPREFERENCE_RTF;
-		}
-		if (in_array(SYNC_BODYPREFERENCE_HTML, $bpTypes)) {
-			return SYNC_BODYPREFERENCE_HTML;
-		}
-		if (in_array(SYNC_BODYPREFERENCE_MIME, $bpTypes)) {
-			return SYNC_BODYPREFERENCE_MIME;
-		}
-
-		return SYNC_BODYPREFERENCE_PLAIN;
-	}
-
-	/**
-	 * Checks if a file has the same owner and group as the parent directory.
-	 * If not, owner and group are fixed (being updated to the owner/group of the directory).
-	 * If the given file is a special file (i.g., /dev/null, fifo), nothing is changed.
-	 * Function code contributed by Robert Scheck aka rsc.
-	 *
-	 * @param string $file
-	 *
-	 * @return bool
-	 */
-	public static function FixFileOwner($file) {
-		if (!function_exists('posix_getuid')) {
-			SLog::Write(LOGLEVEL_DEBUG, "Utils::FixeFileOwner(): Posix subsystem not available, skipping.");
-
-			return false;
-		}
-		if (posix_getuid() == 0 && is_file($file)) {
-			$dir = dirname($file);
-			$perm_dir = stat($dir);
-			$perm_file = stat($file);
-
-			if ($perm_file['uid'] == 0 && $perm_dir['uid'] == 0 && $perm_dir['gid'] == 0) {
-				unlink($file);
-
-				throw new FatalException("FixFileOwner: {$dir} must be owned by the nginx/apache/php user instead of root for debian based systems and by root:grosync for RHEL-based systems");
-			}
-
-			if ($perm_dir['uid'] !== $perm_file['uid'] || $perm_dir['gid'] !== $perm_file['gid']) {
-				chown($file, $perm_dir['uid']);
-				chgrp($file, $perm_dir['gid']);
-				chmod($file, 0664);
-			}
-		}
-
-		return true;
-	}
-
-	/**
-	 * Returns AS-style LastVerbExecuted value from the server value.
-	 *
-	 * @param int $verb
-	 *
-	 * @return int
-	 */
-	public static function GetLastVerbExecuted($verb) {
-		switch ($verb) {
-			case NOTEIVERB_REPLYTOSENDER:   return AS_REPLYTOSENDER;
-
-			case NOTEIVERB_REPLYTOALL:      return AS_REPLYTOALL;
-
-			case NOTEIVERB_FORWARD:         return AS_FORWARD;
-		}
-
-		return 0;
-	}
-
-	/**
-	 * Returns the local part from email address.
-	 *
-	 * @param string $email
-	 *
-	 * @return string
-	 */
-	public static function GetLocalPartFromEmail($email) {
-		$pos = strpos($email, '@');
-		if ($pos === false) {
-			return $email;
-		}
-
-		return substr($email, 0, $pos);
-	}
-
-	/**
-	 * Format bytes to a more human readable value.
-	 *
-	 * @param int $bytes
-	 * @param int $precision
-	 *
-	 * @return string|void
-	 */
-	public static function FormatBytes($bytes, $precision = 2) {
-		if ($bytes <= 0) {
-			return '0 B';
-		}
-
-		$units = ['B', 'KiB', 'MiB', 'GiB', 'TiB', 'PiB', 'EiB', 'ZiB'];
-		$base = log($bytes, 1024);
-		$fBase = floor($base);
-		$pow = pow(1024, $base - $fBase);
-
-		return sprintf("%.{$precision}f %s", $pow, $units[$fBase]);
-	}
-
-	/**
-	 * Returns folder origin identifier from its id.
-	 *
-	 * @param string $folderid
-	 *
-	 * @return bool|string matches values of DeviceManager::FLD_ORIGIN_*
-	 */
-	public static function GetFolderOriginFromId($folderid) {
-		$origin = substr($folderid, 0, 1);
-
-		switch ($origin) {
-			case DeviceManager::FLD_ORIGIN_CONFIG:
-			case DeviceManager::FLD_ORIGIN_GAB:
-			case DeviceManager::FLD_ORIGIN_SHARED:
-			case DeviceManager::FLD_ORIGIN_USER:
-			case DeviceManager::FLD_ORIGIN_IMPERSONATED:
-				return $origin;
-		}
-		SLog::Write(LOGLEVEL_WARN, sprintf("Utils->GetFolderOriginFromId(): Unknown folder origin for folder with id '%s'", $folderid));
-
-		return false;
-	}
-
-	/**
-	 * Returns folder origin as string from its id.
-	 *
-	 * @param string $folderid
-	 *
-	 * @return string
-	 */
-	public static function GetFolderOriginStringFromId($folderid) {
-		$origin = substr($folderid, 0, 1);
-
-		switch ($origin) {
-			case DeviceManager::FLD_ORIGIN_CONFIG:
-				return 'configured';
-
-			case DeviceManager::FLD_ORIGIN_GAB:
-				return 'GAB';
-
-			case DeviceManager::FLD_ORIGIN_SHARED:
-				return 'shared';
-
-			case DeviceManager::FLD_ORIGIN_USER:
-				return 'user';
-
-			case DeviceManager::FLD_ORIGIN_IMPERSONATED:
-				return 'impersonated';
-		}
-		SLog::Write(LOGLEVEL_WARN, sprintf("Utils->GetFolderOriginStringFromId(): Unknown folder origin for folder with id '%s'", $folderid));
-
-		return 'unknown';
-	}
-
-	/**
-	 * Splits the id into folder id and message id parts. A colon in the $id indicates
-	 * that the id has folderid:messageid format.
-	 *
-	 * @param string $id
-	 *
-	 * @return array
-	 */
-	public static function SplitMessageId($id) {
-		if (strpos($id, ':') !== false) {
-			return explode(':', $id);
-		}
-
-		return [null, $id];
-	}
-
-	/**
-	 * Converts a string freebusy type into a numeric status.
-	 *
-	 * @param string $fbType
-	 *
-	 * @return int
-	 */
-	public static function GetFbStatusFromType($fbType) {
-		switch ($fbType) {
-			case 'Free':
-				return fbFree;
-
-			case 'Tentative':
-				return fbTentative;
-
-			case 'Busy':
-				return fbBusy;
-
-			case 'OOF':
-				return fbOutOfOffice;
-		}
-		SLog::Write(LOGLEVEL_WARN, sprintf("Utils->GetFbStatusFromType(): Unknown free busy type '%s'", $fbType));
-
-		return fbNoData;
-	}
+            case 'MoveCollection':       return GSync::COMMAND_MOVECOLLECTION;
+
+            case 'Notify':               return GSync::COMMAND_NOTIFY;
+        }
+
+        return false;
+    }
+
+    /**
+     * Normalize the given timestamp to the start of the day.
+     *
+     * @param long $timestamp
+     *
+     * @return long
+     */
+    public static function getDayStartOfTimestamp($timestamp) {
+        return $timestamp - ($timestamp % (60 * 60 * 24));
+    }
+
+    /**
+     * Returns a formatted string output from an optional timestamp.
+     * If no timestamp is sent, NOW is used.
+     *
+     * @param long $timestamp
+     *
+     * @return string
+     */
+    public static function GetFormattedTime($timestamp = false) {
+        if (!$timestamp) {
+            return @strftime("%d/%m/%Y %H:%M:%S");
+        }
+
+        return @strftime("%d/%m/%Y %H:%M:%S", $timestamp);
+    }
+
+    /**
+     * Get charset name from a codepage.
+     *
+     * @see http://msdn.microsoft.com/en-us/library/dd317756(VS.85).aspx
+     *
+     * Table taken from common/codepage.cpp
+     *
+     * @param int codepage Codepage
+     * @param mixed $codepage
+     *
+     * @return string iconv-compatible charset name
+     */
+    public static function GetCodepageCharset($codepage) {
+        $codepages = [
+            20106 => "DIN_66003",
+            20108 => "NS_4551-1",
+            20107 => "SEN_850200_B",
+            950 => "big5",
+            50221 => "csISO2022JP",
+            51932 => "euc-jp",
+            51936 => "euc-cn",
+            51949 => "euc-kr",
+            949 => "euc-kr",
+            936 => "gb18030",
+            52936 => "csgb2312",
+            852 => "ibm852",
+            866 => "ibm866",
+            50220 => "iso-2022-jp",
+            50222 => "iso-2022-jp",
+            50225 => "iso-2022-kr",
+            1252 => "windows-1252",
+            28591 => "iso-8859-1",
+            28592 => "iso-8859-2",
+            28593 => "iso-8859-3",
+            28594 => "iso-8859-4",
+            28595 => "iso-8859-5",
+            28596 => "iso-8859-6",
+            28597 => "iso-8859-7",
+            28598 => "iso-8859-8",
+            28599 => "iso-8859-9",
+            28603 => "iso-8859-13",
+            28605 => "iso-8859-15",
+            20866 => "koi8-r",
+            21866 => "koi8-u",
+            932 => "shift-jis",
+            1200 => "unicode",
+            1201 => "unicodebig",
+            65000 => "utf-7",
+            65001 => "utf-8",
+            1250 => "windows-1250",
+            1251 => "windows-1251",
+            1253 => "windows-1253",
+            1254 => "windows-1254",
+            1255 => "windows-1255",
+            1256 => "windows-1256",
+            1257 => "windows-1257",
+            1258 => "windows-1258",
+            874 => "windows-874",
+            20127 => "us-ascii",
+        ];
+
+        if (isset($codepages[$codepage])) {
+            return $codepages[$codepage];
+        }
+        // Defaulting to iso-8859-15 since it is more likely for someone to make a mistake in the codepage
+        // when using west-european charsets then when using other charsets since utf-8 is binary compatible
+        // with the bottom 7 bits of west-european
+        return "iso-8859-15";
+    }
+
+    /**
+     * Converts a string encoded with codepage into an UTF-8 string.
+     *
+     * @param int    $codepage
+     * @param string $string
+     *
+     * @return string
+     */
+    public static function ConvertCodepageStringToUtf8($codepage, $string) {
+        if (function_exists("iconv")) {
+            $charset = self::GetCodepageCharset($codepage);
+
+            return iconv($charset, "utf-8", $string);
+        }
+
+        SLog::Write(LOGLEVEL_WARN, "Utils::ConvertCodepageStringToUtf8() 'iconv' is not available. Charset conversion skipped.");
+
+        return $string;
+    }
+
+    /**
+     * Converts a string to another charset.
+     *
+     * @param int    $in
+     * @param int    $out
+     * @param string $string
+     *
+     * @return string
+     */
+    public static function ConvertCodepage($in, $out, $string) {
+        // do nothing if both charsets are the same
+        if ($in == $out) {
+            return $string;
+        }
+
+        if (function_exists("iconv")) {
+            $inCharset = self::GetCodepageCharset($in);
+            $outCharset = self::GetCodepageCharset($out);
+
+            return iconv($inCharset, $outCharset, $string);
+        }
+
+        SLog::Write(LOGLEVEL_WARN, "Utils::ConvertCodepage() 'iconv' is not available. Charset conversion skipped.");
+
+        return $string;
+    }
+
+    /**
+     * Returns the best match of preferred body preference types.
+     *
+     * @param array $bpTypes
+     *
+     * @return int
+     */
+    public static function GetBodyPreferenceBestMatch($bpTypes) {
+        if ($bpTypes === false) {
+            return SYNC_BODYPREFERENCE_PLAIN;
+        }
+        // The best choice is RTF, then HTML and then MIME in order to save bandwidth
+        // because MIME is a complete message including the headers and attachments
+        if (in_array(SYNC_BODYPREFERENCE_RTF, $bpTypes)) {
+            return SYNC_BODYPREFERENCE_RTF;
+        }
+        if (in_array(SYNC_BODYPREFERENCE_HTML, $bpTypes)) {
+            return SYNC_BODYPREFERENCE_HTML;
+        }
+        if (in_array(SYNC_BODYPREFERENCE_MIME, $bpTypes)) {
+            return SYNC_BODYPREFERENCE_MIME;
+        }
+
+        return SYNC_BODYPREFERENCE_PLAIN;
+    }
+
+    /**
+     * Checks if a file has the same owner and group as the parent directory.
+     * If not, owner and group are fixed (being updated to the owner/group of the directory).
+     * If the given file is a special file (i.g., /dev/null, fifo), nothing is changed.
+     * Function code contributed by Robert Scheck aka rsc.
+     *
+     * @param string $file
+     *
+     * @return bool
+     */
+    public static function FixFileOwner($file) {
+        if (!function_exists('posix_getuid')) {
+            SLog::Write(LOGLEVEL_DEBUG, "Utils::FixeFileOwner(): Posix subsystem not available, skipping.");
+
+            return false;
+        }
+        if (posix_getuid() == 0 && is_file($file)) {
+            $dir = dirname($file);
+            $perm_dir = stat($dir);
+            $perm_file = stat($file);
+
+            if ($perm_file['uid'] == 0 && $perm_dir['uid'] == 0 && $perm_dir['gid'] == 0) {
+                unlink($file);
+
+                throw new FatalException("FixFileOwner: {$dir} must be owned by the nginx/apache/php user instead of root for debian based systems and by root:grosync for RHEL-based systems");
+            }
+
+            if ($perm_dir['uid'] !== $perm_file['uid'] || $perm_dir['gid'] !== $perm_file['gid']) {
+                chown($file, $perm_dir['uid']);
+                chgrp($file, $perm_dir['gid']);
+                chmod($file, 0664);
+            }
+        }
+
+        return true;
+    }
+
+    /**
+     * Returns AS-style LastVerbExecuted value from the server value.
+     *
+     * @param int $verb
+     *
+     * @return int
+     */
+    public static function GetLastVerbExecuted($verb) {
+        switch ($verb) {
+            case NOTEIVERB_REPLYTOSENDER:   return AS_REPLYTOSENDER;
+
+            case NOTEIVERB_REPLYTOALL:      return AS_REPLYTOALL;
+
+            case NOTEIVERB_FORWARD:         return AS_FORWARD;
+        }
+
+        return 0;
+    }
+
+    /**
+     * Returns the local part from email address.
+     *
+     * @param string $email
+     *
+     * @return string
+     */
+    public static function GetLocalPartFromEmail($email) {
+        $pos = strpos($email, '@');
+        if ($pos === false) {
+            return $email;
+        }
+
+        return substr($email, 0, $pos);
+    }
+
+    /**
+     * Format bytes to a more human readable value.
+     *
+     * @param int $bytes
+     * @param int $precision
+     *
+     * @return string|void
+     */
+    public static function FormatBytes($bytes, $precision = 2) {
+        if ($bytes <= 0) {
+            return '0 B';
+        }
+
+        $units = ['B', 'KiB', 'MiB', 'GiB', 'TiB', 'PiB', 'EiB', 'ZiB'];
+        $base = log($bytes, 1024);
+        $fBase = floor($base);
+        $pow = pow(1024, $base - $fBase);
+
+        return sprintf("%.{$precision}f %s", $pow, $units[$fBase]);
+    }
+
+    /**
+     * Returns folder origin identifier from its id.
+     *
+     * @param string $folderid
+     *
+     * @return bool|string matches values of DeviceManager::FLD_ORIGIN_*
+     */
+    public static function GetFolderOriginFromId($folderid) {
+        $origin = substr($folderid, 0, 1);
+
+        switch ($origin) {
+            case DeviceManager::FLD_ORIGIN_CONFIG:
+            case DeviceManager::FLD_ORIGIN_GAB:
+            case DeviceManager::FLD_ORIGIN_SHARED:
+            case DeviceManager::FLD_ORIGIN_USER:
+            case DeviceManager::FLD_ORIGIN_IMPERSONATED:
+                return $origin;
+        }
+        SLog::Write(LOGLEVEL_WARN, sprintf("Utils->GetFolderOriginFromId(): Unknown folder origin for folder with id '%s'", $folderid));
+
+        return false;
+    }
+
+    /**
+     * Returns folder origin as string from its id.
+     *
+     * @param string $folderid
+     *
+     * @return string
+     */
+    public static function GetFolderOriginStringFromId($folderid) {
+        $origin = substr($folderid, 0, 1);
+
+        switch ($origin) {
+            case DeviceManager::FLD_ORIGIN_CONFIG:
+                return 'configured';
+
+            case DeviceManager::FLD_ORIGIN_GAB:
+                return 'GAB';
+
+            case DeviceManager::FLD_ORIGIN_SHARED:
+                return 'shared';
+
+            case DeviceManager::FLD_ORIGIN_USER:
+                return 'user';
+
+            case DeviceManager::FLD_ORIGIN_IMPERSONATED:
+                return 'impersonated';
+        }
+        SLog::Write(LOGLEVEL_WARN, sprintf("Utils->GetFolderOriginStringFromId(): Unknown folder origin for folder with id '%s'", $folderid));
+
+        return 'unknown';
+    }
+
+    /**
+     * Splits the id into folder id and message id parts. A colon in the $id indicates
+     * that the id has folderid:messageid format.
+     *
+     * @param string $id
+     *
+     * @return array
+     */
+    public static function SplitMessageId($id) {
+        if (strpos($id, ':') !== false) {
+            return explode(':', $id);
+        }
+
+        return [null, $id];
+    }
+
+    /**
+     * Converts a string freebusy type into a numeric status.
+     *
+     * @param string $fbType
+     *
+     * @return int
+     */
+    public static function GetFbStatusFromType($fbType) {
+        switch ($fbType) {
+            case 'Free':
+                return fbFree;
+
+            case 'Tentative':
+                return fbTentative;
+
+            case 'Busy':
+                return fbBusy;
+
+            case 'OOF':
+                return fbOutOfOffice;
+        }
+        SLog::Write(LOGLEVEL_WARN, sprintf("Utils->GetFbStatusFromType(): Unknown free busy type '%s'", $fbType));
+
+        return fbNoData;
+    }
 }
 
 // TODO Win1252/UTF8 functions are deprecated and will be removed sometime
@@ -969,41 +969,41 @@ 
 // STORE_SUPPORTS_UNICODE is true and the conversion will not be done
 // for other backends.
 function utf8_to_windows1252($string, $option = "", $force_convert = false) {
-	// if the store supports unicode return the string without converting it
-	if (!$force_convert && defined('STORE_SUPPORTS_UNICODE') && STORE_SUPPORTS_UNICODE == true) {
-		return $string;
-	}
+    // if the store supports unicode return the string without converting it
+    if (!$force_convert && defined('STORE_SUPPORTS_UNICODE') && STORE_SUPPORTS_UNICODE == true) {
+        return $string;
+    }
 
-	if (function_exists("iconv")) {
-		return @iconv("UTF-8", "Windows-1252" . $option, $string);
-	}
+    if (function_exists("iconv")) {
+        return @iconv("UTF-8", "Windows-1252" . $option, $string);
+    }
 
-	return utf8_decode($string); // no euro support here
+    return utf8_decode($string); // no euro support here
 }
 
 function windows1252_to_utf8($string, $option = "", $force_convert = false) {
-	// if the store supports unicode return the string without converting it
-	if (!$force_convert && defined('STORE_SUPPORTS_UNICODE') && STORE_SUPPORTS_UNICODE == true) {
-		return $string;
-	}
+    // if the store supports unicode return the string without converting it
+    if (!$force_convert && defined('STORE_SUPPORTS_UNICODE') && STORE_SUPPORTS_UNICODE == true) {
+        return $string;
+    }
 
-	if (function_exists("iconv")) {
-		return @iconv("Windows-1252", "UTF-8" . $option, $string);
-	}
+    if (function_exists("iconv")) {
+        return @iconv("Windows-1252", "UTF-8" . $option, $string);
+    }
 
-	return utf8_encode($string); // no euro support here
+    return utf8_encode($string); // no euro support here
 }
 
 function w2u($string) {
-	return windows1252_to_utf8($string);
+    return windows1252_to_utf8($string);
 }
 function u2w($string) {
-	return utf8_to_windows1252($string);
+    return utf8_to_windows1252($string);
 }
 
 function w2ui($string) {
-	return windows1252_to_utf8($string, "//TRANSLIT");
+    return windows1252_to_utf8($string, "//TRANSLIT");
 }
 function u2wi($string) {
-	return utf8_to_windows1252($string, "//TRANSLIT");
+    return utf8_to_windows1252($string, "//TRANSLIT");
 }

lib/exceptions/notimplementedexception.php

Indentation +1 added lines, -1 removed lines

@@ -8,5 +8,5 @@
  * available which is non-fatal.
  */
 class NotImplementedException extends GSyncException {
-	protected $defaultLogLevel = LOGLEVEL_ERROR;
+    protected $defaultLogLevel = LOGLEVEL_ERROR;
 }

lib/exceptions/syncobjectbrokenexception.php

Indentation +21 added lines, -21 removed lines

@@ -9,28 +9,28 @@
  */
 
 class SyncObjectBrokenException extends GSyncException {
-	protected $defaultLogLevel = LOGLEVEL_WARN;
-	private $syncObject;
+    protected $defaultLogLevel = LOGLEVEL_WARN;
+    private $syncObject;
 
-	/**
-	 * Returns the SyncObject which caused this Exception (if set).
-	 *
-	 * @return SyncObject
-	 */
-	public function GetSyncObject() {
-		return isset($this->syncObject) ? $this->syncObject : false;
-	}
+    /**
+     * Returns the SyncObject which caused this Exception (if set).
+     *
+     * @return SyncObject
+     */
+    public function GetSyncObject() {
+        return isset($this->syncObject) ? $this->syncObject : false;
+    }
 
-	/**
-	 * Sets the SyncObject which caused the exception so it can be later retrieved.
-	 *
-	 * @param SyncObject $syncobject
-	 *
-	 * @return bool
-	 */
-	public function SetSyncObject($syncobject) {
-		$this->syncObject = $syncobject;
+    /**
+     * Sets the SyncObject which caused the exception so it can be later retrieved.
+     *
+     * @param SyncObject $syncobject
+     *
+     * @return bool
+     */
+    public function SetSyncObject($syncobject) {
+        $this->syncObject = $syncobject;
 
-		return true;
-	}
+        return true;
+    }
 }

lib/exceptions/authenticationrequiredexception.php

Indentation +5 added lines, -5 removed lines

@@ -7,9 +7,9 @@
  * Exception sending a "401 Unauthorized" to the mobile
  */
 class AuthenticationRequiredException extends HTTPReturnCodeException {
-	protected $defaultLogLevel = LOGLEVEL_INFO;
-	protected $httpReturnCode = HTTP_CODE_401;
-	protected $httpReturnMessage = "Unauthorized";
-	protected $httpHeaders = ['WWW-Authenticate: Basic realm="GSync"'];
-	protected $showLegal = true;
+    protected $defaultLogLevel = LOGLEVEL_INFO;
+    protected $httpReturnCode = HTTP_CODE_401;
+    protected $httpReturnMessage = "Unauthorized";
+    protected $httpHeaders = ['WWW-Authenticate: Basic realm="GSync"'];
+    protected $showLegal = true;
 }

lib/exceptions/statusexception.php

Indentation +1 added lines, -1 removed lines

@@ -7,5 +7,5 @@
  * Main exception related to errors regarding synchronization
  */
 class StatusException extends GSyncException {
-	protected $defaultLogLevel = LOGLEVEL_INFO;
+    protected $defaultLogLevel = LOGLEVEL_INFO;
 }

lib/exceptions/gsyncexception.php

Indentation +24 added lines, -24 removed lines

@@ -8,34 +8,34 @@
  */
 
 class GSyncException extends Exception {
-	protected $defaultLogLevel = LOGLEVEL_FATAL;
-	protected $httpReturnCode = HTTP_CODE_500;
-	protected $httpReturnMessage = "Internal Server Error";
-	protected $httpHeaders = [];
-	protected $showLegal = true;
+    protected $defaultLogLevel = LOGLEVEL_FATAL;
+    protected $httpReturnCode = HTTP_CODE_500;
+    protected $httpReturnMessage = "Internal Server Error";
+    protected $httpHeaders = [];
+    protected $showLegal = true;
 
-	public function __construct($message = "", $code = 0, $previous = null, $logLevel = false) {
-		if (!$message) {
-			$message = $this->httpReturnMessage;
-		}
+    public function __construct($message = "", $code = 0, $previous = null, $logLevel = false) {
+        if (!$message) {
+            $message = $this->httpReturnMessage;
+        }
 
-		if (!$logLevel) {
-			$logLevel = $this->defaultLogLevel;
-		}
+        if (!$logLevel) {
+            $logLevel = $this->defaultLogLevel;
+        }
 
-		parent::__construct($message, (int) $code);
-		SLog::Write($logLevel, get_class($this) . ': ' . $message . ' - code: ' . $code . ' - file: ' . $this->getFile() . ':' . $this->getLine(), false);
-	}
+        parent::__construct($message, (int) $code);
+        SLog::Write($logLevel, get_class($this) . ': ' . $message . ' - code: ' . $code . ' - file: ' . $this->getFile() . ':' . $this->getLine(), false);
+    }
 
-	public function getHTTPCodeString() {
-		return $this->httpReturnCode . " " . $this->httpReturnMessage;
-	}
+    public function getHTTPCodeString() {
+        return $this->httpReturnCode . " " . $this->httpReturnMessage;
+    }
 
-	public function getHTTPHeaders() {
-		return $this->httpHeaders;
-	}
+    public function getHTTPHeaders() {
+        return $this->httpHeaders;
+    }
 
-	public function showLegalNotice() {
-		return $this->showLegal;
-	}
+    public function showLegalNotice() {
+        return $this->showLegal;
+    }
 }

lib/exceptions/provisioningrequiredexception.php

Indentation +3 added lines, -3 removed lines

@@ -7,7 +7,7 @@
  * Exception announcing to the mobile that a provisioning request is required
  */
 class ProvisioningRequiredException extends HTTPReturnCodeException {
-	protected $defaultLogLevel = LOGLEVEL_INFO;
-	protected $httpReturnCode = HTTP_CODE_449;
-	protected $httpReturnMessage = "Retry after sending a PROVISION command";
+    protected $defaultLogLevel = LOGLEVEL_INFO;
+    protected $httpReturnCode = HTTP_CODE_449;
+    protected $httpReturnMessage = "Retry after sending a PROVISION command";
 }