grommunio / grommunio-sync

mapi/mapi.util.php

Indentation +183 added lines, -183 removed lines

@@ -23,7 +23,7 @@ 
  * @param mixed $guid
  */
 function makeGuid($guid) {
-	return pack("vvvv", hexdec(substr($guid, 5, 4)), hexdec(substr($guid, 1, 4)), hexdec(substr($guid, 10, 4)), hexdec(substr($guid, 15, 4))) . hex2bin(substr($guid, 20, 4)) . hex2bin(substr($guid, 25, 12));
+    return pack("vvvv", hexdec(substr($guid, 5, 4)), hexdec(substr($guid, 1, 4)), hexdec(substr($guid, 10, 4)), hexdec(substr($guid, 15, 4))) . hex2bin(substr($guid, 20, 4)) . hex2bin(substr($guid, 25, 12));
 }
 
 /**
@@ -34,37 +34,37 @@ 
  *@return string The defined name for the MAPI error code
  */
 function get_mapi_error_name($errcode = null) {
-	if ($errcode === null) {
-		$errcode = mapi_last_hresult();
-	}
-
-	if ($errcode !== 0) {
-		// Retrieve constants categories, MAPI error names are defined
-		// in the 'user' category, since the WebApp code defines it in mapicode.php.
-		foreach (get_defined_constants(true)['user'] as $key => $value) {
-			/*
+    if ($errcode === null) {
+        $errcode = mapi_last_hresult();
+    }
+
+    if ($errcode !== 0) {
+        // Retrieve constants categories, MAPI error names are defined
+        // in the 'user' category, since the WebApp code defines it in mapicode.php.
+        foreach (get_defined_constants(true)['user'] as $key => $value) {
+            /*
 			 * If PHP encounters a number beyond the bounds of the integer type,
 			 * it will be interpreted as a float instead, so when comparing these error codes
 			 * we have to manually typecast value to integer, so float will be converted in integer,
 			 * but still its out of bound for integer limit so it will be auto adjusted to minus value
 			 */
-			if ($errcode == (int) $value) {
-				// Check that we have an actual MAPI error or warning definition
-				$prefix = substr($key, 0, 7);
-				if ($prefix == "MAPI_E_" || $prefix == "MAPI_W_") {
-					return $key;
-				}
-			}
-		}
-	}
-	else {
-		return "NOERROR";
-	}
-
-	// error code not found, return hex value (this is a fix for 64-bit systems, we can't use the dechex() function for this)
-	$result = unpack("H*", pack("N", $errcode));
-
-	return "0x" . $result[1];
+            if ($errcode == (int) $value) {
+                // Check that we have an actual MAPI error or warning definition
+                $prefix = substr($key, 0, 7);
+                if ($prefix == "MAPI_E_" || $prefix == "MAPI_W_") {
+                    return $key;
+                }
+            }
+        }
+    }
+    else {
+        return "NOERROR";
+    }
+
+    // error code not found, return hex value (this is a fix for 64-bit systems, we can't use the dechex() function for this)
+    $result = unpack("H*", pack("N", $errcode));
+
+    return "0x" . $result[1];
 }
 
 /**
@@ -78,66 +78,66 @@ 
  * @param mixed $mapping
  */
 function getPropIdsFromStrings($store, $mapping) {
-	$props = [];
-
-	$ids = ["name" => [], "id" => [], "guid" => [], "type" => []]; // this array stores all the information needed to retrieve a named property
-	$num = 0;
-
-	// caching
-	$guids = [];
-
-	foreach ($mapping as $name => $val) {
-		if (is_string($val)) {
-			$split = explode(":", $val);
-
-			if (count($split) != 3) { // invalid string, ignore
-				trigger_error(sprintf("Invalid property: %s \"%s\"", $name, $val), E_USER_NOTICE);
-
-				continue;
-			}
-
-			if (substr($split[2], 0, 2) == "0x") {
-				$id = hexdec(substr($split[2], 2));
-			}
-			else {
-				$id = $split[2];
-			}
-
-			// have we used this guid before?
-			if (!defined($split[1])) {
-				if (!array_key_exists($split[1], $guids)) {
-					$guids[$split[1]] = makeguid($split[1]);
-				}
-				$guid = $guids[$split[1]];
-			}
-			else {
-				$guid = constant($split[1]);
-			}
-
-			// temp store info about named prop, so we have to call mapi_getidsfromnames just one time
-			$ids["name"][$num] = $name;
-			$ids["id"][$num] = $id;
-			$ids["guid"][$num] = $guid;
-			$ids["type"][$num] = $split[0];
-			++$num;
-		}
-		else {
-			// not a named property
-			$props[$name] = $val;
-		}
-	}
-
-	if (empty($ids["id"])) {
-		return $props;
-	}
-
-	// get the ids
-	$named = mapi_getidsfromnames($store, $ids["id"], $ids["guid"]);
-	foreach ($named as $num => $prop) {
-		$props[$ids["name"][$num]] = mapi_prop_tag(constant($ids["type"][$num]), mapi_prop_id($prop));
-	}
-
-	return $props;
+    $props = [];
+
+    $ids = ["name" => [], "id" => [], "guid" => [], "type" => []]; // this array stores all the information needed to retrieve a named property
+    $num = 0;
+
+    // caching
+    $guids = [];
+
+    foreach ($mapping as $name => $val) {
+        if (is_string($val)) {
+            $split = explode(":", $val);
+
+            if (count($split) != 3) { // invalid string, ignore
+                trigger_error(sprintf("Invalid property: %s \"%s\"", $name, $val), E_USER_NOTICE);
+
+                continue;
+            }
+
+            if (substr($split[2], 0, 2) == "0x") {
+                $id = hexdec(substr($split[2], 2));
+            }
+            else {
+                $id = $split[2];
+            }
+
+            // have we used this guid before?
+            if (!defined($split[1])) {
+                if (!array_key_exists($split[1], $guids)) {
+                    $guids[$split[1]] = makeguid($split[1]);
+                }
+                $guid = $guids[$split[1]];
+            }
+            else {
+                $guid = constant($split[1]);
+            }
+
+            // temp store info about named prop, so we have to call mapi_getidsfromnames just one time
+            $ids["name"][$num] = $name;
+            $ids["id"][$num] = $id;
+            $ids["guid"][$num] = $guid;
+            $ids["type"][$num] = $split[0];
+            ++$num;
+        }
+        else {
+            // not a named property
+            $props[$name] = $val;
+        }
+    }
+
+    if (empty($ids["id"])) {
+        return $props;
+    }
+
+    // get the ids
+    $named = mapi_getidsfromnames($store, $ids["id"], $ids["guid"]);
+    foreach ($named as $num => $prop) {
+        $props[$ids["name"][$num]] = mapi_prop_tag(constant($ids["type"][$num]), mapi_prop_id($prop));
+    }
+
+    return $props;
 }
 
 /**
@@ -153,11 +153,11 @@ 
  * @return mixed Gives back false when there is no error, if there is, gives the error
  */
 function propIsError($property, $propArray) {
-	if (array_key_exists(mapi_prop_tag(PT_ERROR, mapi_prop_id($property)), $propArray)) {
-		return $propArray[mapi_prop_tag(PT_ERROR, mapi_prop_id($property))];
-	}
+    if (array_key_exists(mapi_prop_tag(PT_ERROR, mapi_prop_id($property)), $propArray)) {
+        return $propArray[mapi_prop_tag(PT_ERROR, mapi_prop_id($property))];
+    }
 
-	return false;
+    return false;
 }
 
 /* Macro Functions for PR_DISPLAY_TYPE_EX values */
@@ -167,7 +167,7 @@ 
  * @param mixed $value
  */
 function DTE_IS_REMOTE_VALID($value) {
-	return (bool) ($value & DTE_FLAG_REMOTE_VALID);
+    return (bool) ($value & DTE_FLAG_REMOTE_VALID);
 }
 
 /**
@@ -176,15 +176,15 @@ 
  * @param mixed $value
  */
 function DTE_IS_ACL_CAPABLE($value) {
-	return (bool) ($value & DTE_FLAG_ACL_CAPABLE);
+    return (bool) ($value & DTE_FLAG_ACL_CAPABLE);
 }
 
 function DTE_REMOTE($value) {
-	return ($value & DTE_MASK_REMOTE) >> 8;
+    return ($value & DTE_MASK_REMOTE) >> 8;
 }
 
 function DTE_LOCAL($value) {
-	return $value & DTE_MASK_LOCAL;
+    return $value & DTE_MASK_LOCAL;
 }
 
 /**
@@ -204,92 +204,92 @@ 
  *                    expanded so that it seems that there are only many single appointments in the table.
  */
 function getCalendarItems($store, $calendar, $viewstart, $viewend, $propsrequested) {
-	$result = [];
-	$properties = getPropIdsFromStrings($store, [
-		"duedate" => "PT_SYSTIME:PSETID_Appointment:0x820e",
-		"startdate" => "PT_SYSTIME:PSETID_Appointment:0x820d",
-		"enddate_recurring" => "PT_SYSTIME:PSETID_Appointment:0x8236",
-		"recurring" => "PT_BOOLEAN:PSETID_Appointment:0x8223",
-		"recurring_data" => "PT_BINARY:PSETID_Appointment:0x8216",
-		"timezone_data" => "PT_BINARY:PSETID_Appointment:0x8233",
-		"label" => "PT_LONG:PSETID_Appointment:0x8214",
-	]);
-
-	// Create a restriction that will discard rows of appointments that are definitely not in our
-	// requested time frame
-
-	$table = mapi_folder_getcontentstable($calendar);
-
-	$restriction =
-		// OR
-		[
-			RES_OR,
-			[
-				[
-					RES_AND,    // Normal items: itemEnd must be after viewStart, itemStart must be before viewEnd
-					[
-						[
-							RES_PROPERTY,
-							[
-								RELOP => RELOP_GT,
-								ULPROPTAG => $properties["duedate"],
-								VALUE => $viewstart,
-							],
-						],
-						[
-							RES_PROPERTY,
-							[
-								RELOP => RELOP_LT,
-								ULPROPTAG => $properties["startdate"],
-								VALUE => $viewend,
-							],
-						],
-					],
-				],
-				// OR
-				[
-					RES_PROPERTY,
-					[
-						RELOP => RELOP_EQ,
-						ULPROPTAG => $properties["recurring"],
-						VALUE => true,
-					],
-				],
-			], // EXISTS OR
-		];        // global OR
-
-	// Get requested properties, plus whatever we need
-	$proplist = [PR_ENTRYID, $properties["recurring"], $properties["recurring_data"], $properties["timezone_data"]];
-	$proplist = array_merge($proplist, $propsrequested);
-
-	$rows = mapi_table_queryallrows($table, $proplist, $restriction);
-
-	// $rows now contains all the items that MAY be in the window; a recurring item needs expansion before including in the output.
-
-	foreach ($rows as $row) {
-		$items = [];
-
-		if (isset($row[$properties["recurring"]]) && $row[$properties["recurring"]]) {
-			// Recurring item
-			$rec = new Recurrence($store, $row);
-
-			// GetItems guarantees that the item overlaps the interval <$viewstart, $viewend>
-			$occurrences = $rec->getItems($viewstart, $viewend);
-			foreach ($occurrences as $occurrence) {
-				// The occurrence takes all properties from the main row, but overrides some properties (like start and end obviously)
-				$item = $occurrence + $row;
-				array_push($items, $item);
-			}
-		}
-		else {
-			// Normal item, it matched the search criteria and therefore overlaps the interval <$viewstart, $viewend>
-			array_push($items, $row);
-		}
-
-		$result = array_merge($result, $items);
-	}
-
-	// All items are guaranteed to overlap the interval <$viewstart, $viewend>. Note that we may be returning a few extra
-	// properties that the caller did not request (recurring, etc). This shouldn't be a problem though.
-	return $result;
+    $result = [];
+    $properties = getPropIdsFromStrings($store, [
+        "duedate" => "PT_SYSTIME:PSETID_Appointment:0x820e",
+        "startdate" => "PT_SYSTIME:PSETID_Appointment:0x820d",
+        "enddate_recurring" => "PT_SYSTIME:PSETID_Appointment:0x8236",
+        "recurring" => "PT_BOOLEAN:PSETID_Appointment:0x8223",
+        "recurring_data" => "PT_BINARY:PSETID_Appointment:0x8216",
+        "timezone_data" => "PT_BINARY:PSETID_Appointment:0x8233",
+        "label" => "PT_LONG:PSETID_Appointment:0x8214",
+    ]);
+
+    // Create a restriction that will discard rows of appointments that are definitely not in our
+    // requested time frame
+
+    $table = mapi_folder_getcontentstable($calendar);
+
+    $restriction =
+        // OR
+        [
+            RES_OR,
+            [
+                [
+                    RES_AND,    // Normal items: itemEnd must be after viewStart, itemStart must be before viewEnd
+                    [
+                        [
+                            RES_PROPERTY,
+                            [
+                                RELOP => RELOP_GT,
+                                ULPROPTAG => $properties["duedate"],
+                                VALUE => $viewstart,
+                            ],
+                        ],
+                        [
+                            RES_PROPERTY,
+                            [
+                                RELOP => RELOP_LT,
+                                ULPROPTAG => $properties["startdate"],
+                                VALUE => $viewend,
+                            ],
+                        ],
+                    ],
+                ],
+                // OR
+                [
+                    RES_PROPERTY,
+                    [
+                        RELOP => RELOP_EQ,
+                        ULPROPTAG => $properties["recurring"],
+                        VALUE => true,
+                    ],
+                ],
+            ], // EXISTS OR
+        ];        // global OR
+
+    // Get requested properties, plus whatever we need
+    $proplist = [PR_ENTRYID, $properties["recurring"], $properties["recurring_data"], $properties["timezone_data"]];
+    $proplist = array_merge($proplist, $propsrequested);
+
+    $rows = mapi_table_queryallrows($table, $proplist, $restriction);
+
+    // $rows now contains all the items that MAY be in the window; a recurring item needs expansion before including in the output.
+
+    foreach ($rows as $row) {
+        $items = [];
+
+        if (isset($row[$properties["recurring"]]) && $row[$properties["recurring"]]) {
+            // Recurring item
+            $rec = new Recurrence($store, $row);
+
+            // GetItems guarantees that the item overlaps the interval <$viewstart, $viewend>
+            $occurrences = $rec->getItems($viewstart, $viewend);
+            foreach ($occurrences as $occurrence) {
+                // The occurrence takes all properties from the main row, but overrides some properties (like start and end obviously)
+                $item = $occurrence + $row;
+                array_push($items, $item);
+            }
+        }
+        else {
+            // Normal item, it matched the search criteria and therefore overlaps the interval <$viewstart, $viewend>
+            array_push($items, $row);
+        }
+
+        $result = array_merge($result, $items);
+    }
+
+    // All items are guaranteed to overlap the interval <$viewstart, $viewend>. Note that we may be returning a few extra
+    // properties that the caller did not request (recurring, etc). This shouldn't be a problem though.
+    return $result;
 }

Spacing +7 added lines, -7 removed lines

@@ -23,7 +23,7 @@ 
  * @param mixed $guid
  */
 function makeGuid($guid) {
-	return pack("vvvv", hexdec(substr($guid, 5, 4)), hexdec(substr($guid, 1, 4)), hexdec(substr($guid, 10, 4)), hexdec(substr($guid, 15, 4))) . hex2bin(substr($guid, 20, 4)) . hex2bin(substr($guid, 25, 12));
+	return pack("vvvv", hexdec(substr($guid, 5, 4)), hexdec(substr($guid, 1, 4)), hexdec(substr($guid, 10, 4)), hexdec(substr($guid, 15, 4))).hex2bin(substr($guid, 20, 4)).hex2bin(substr($guid, 25, 12));
 }
 
 /**
@@ -48,7 +48,7 @@ 
 			 * we have to manually typecast value to integer, so float will be converted in integer,
 			 * but still its out of bound for integer limit so it will be auto adjusted to minus value
 			 */
-			if ($errcode == (int) $value) {
+			if ($errcode == (int)$value) {
 				// Check that we have an actual MAPI error or warning definition
 				$prefix = substr($key, 0, 7);
 				if ($prefix == "MAPI_E_" || $prefix == "MAPI_W_") {
@@ -64,7 +64,7 @@ 
 	// error code not found, return hex value (this is a fix for 64-bit systems, we can't use the dechex() function for this)
 	$result = unpack("H*", pack("N", $errcode));
 
-	return "0x" . $result[1];
+	return "0x".$result[1];
 }
 
 /**
@@ -167,7 +167,7 @@ 
  * @param mixed $value
  */
 function DTE_IS_REMOTE_VALID($value) {
-	return (bool) ($value & DTE_FLAG_REMOTE_VALID);
+	return (bool)($value & DTE_FLAG_REMOTE_VALID);
 }
 
 /**
@@ -176,7 +176,7 @@ 
  * @param mixed $value
  */
 function DTE_IS_ACL_CAPABLE($value) {
-	return (bool) ($value & DTE_FLAG_ACL_CAPABLE);
+	return (bool)($value & DTE_FLAG_ACL_CAPABLE);
 }
 
 function DTE_REMOTE($value) {
@@ -226,7 +226,7 @@ 
 			RES_OR,
 			[
 				[
-					RES_AND,    // Normal items: itemEnd must be after viewStart, itemStart must be before viewEnd
+					RES_AND, // Normal items: itemEnd must be after viewStart, itemStart must be before viewEnd
 					[
 						[
 							RES_PROPERTY,
@@ -256,7 +256,7 @@ 
 					],
 				],
 			], // EXISTS OR
-		];        // global OR
+		]; // global OR
 
 	// Get requested properties, plus whatever we need
 	$proplist = [PR_ENTRYID, $properties["recurring"], $properties["recurring_data"], $properties["timezone_data"]];

Braces +5 added lines, -10 removed lines

@@ -56,8 +56,7 @@ 
 				}
 			}
 		}
-	}
-	else {
+	} else {
 		return "NOERROR";
 	}
 
@@ -98,8 +97,7 @@ 
 
 			if (substr($split[2], 0, 2) == "0x") {
 				$id = hexdec(substr($split[2], 2));
-			}
-			else {
+			} else {
 				$id = $split[2];
 			}
 
@@ -109,8 +107,7 @@ 
 					$guids[$split[1]] = makeguid($split[1]);
 				}
 				$guid = $guids[$split[1]];
-			}
-			else {
+			} else {
 				$guid = constant($split[1]);
 			}
 
@@ -120,8 +117,7 @@ 
 			$ids["guid"][$num] = $guid;
 			$ids["type"][$num] = $split[0];
 			++$num;
-		}
-		else {
+		} else {
 			// not a named property
 			$props[$name] = $val;
 		}
@@ -280,8 +276,7 @@ 
 				$item = $occurrence + $row;
 				array_push($items, $item);
 			}
-		}
-		else {
+		} else {
 			// Normal item, it matched the search criteria and therefore overlaps the interval <$viewstart, $viewend>
 			array_push($items, $row);
 		}

mapi/mapidefs.php

Indentation +1 added lines, -1 removed lines

@@ -632,7 +632,7 @@
 /* PersistElementType Values ElementIDs for persist data of PR_IPM_OL2007_ENTRYIDS / PR_ADDITIONAL_REN_ENTRYIDS_EX */
 define('ELEMENT_SENTINEL', 0x0000); // 0 bytes Indicates that the PersistElement structure is the last one contained in the DataElements field of the PersistData structure.
 define('RSF_ELID_ENTRYID', 0x0001); // variable Indicates that the ElementData field contains the entry ID of the special folder
-														   // that is of the type indicated by the value of the PersistID field of the PersistData structure.
+                                                            // that is of the type indicated by the value of the PersistID field of the PersistData structure.
 define('RSF_ELID_HEADER', 0x0002); // 4 bytes Indicates that the ElementData field contains a 4-byte header value equal to 0x00000000.
 
 define('STGM_DIRECT', 0x00000000);

Spacing +96 added lines, -96 removed lines

@@ -16,40 +16,40 @@ 
 
 /* Object type */
 
-define('MAPI_STORE', 0x00000001);    /* Message Store */
-define('MAPI_ADDRBOOK', 0x00000002);    /* Address Book */
-define('MAPI_FOLDER', 0x00000003);    /* Folder */
-define('MAPI_ABCONT', 0x00000004);    /* Address Book Container */
-define('MAPI_MESSAGE', 0x00000005);    /* Message */
-define('MAPI_MAILUSER', 0x00000006);    /* Individual Recipient */
-define('MAPI_ATTACH', 0x00000007);    /* Attachment */
-define('MAPI_DISTLIST', 0x00000008);    /* Distribution List Recipient */
-define('MAPI_PROFSECT', 0x00000009);    /* Profile Section */
-define('MAPI_STATUS', 0x0000000A);    /* Status Object */
-define('MAPI_SESSION', 0x0000000B);    /* Session */
-define('MAPI_FORMINFO', 0x0000000C);    /* Form Information */
+define('MAPI_STORE', 0x00000001); /* Message Store */
+define('MAPI_ADDRBOOK', 0x00000002); /* Address Book */
+define('MAPI_FOLDER', 0x00000003); /* Folder */
+define('MAPI_ABCONT', 0x00000004); /* Address Book Container */
+define('MAPI_MESSAGE', 0x00000005); /* Message */
+define('MAPI_MAILUSER', 0x00000006); /* Individual Recipient */
+define('MAPI_ATTACH', 0x00000007); /* Attachment */
+define('MAPI_DISTLIST', 0x00000008); /* Distribution List Recipient */
+define('MAPI_PROFSECT', 0x00000009); /* Profile Section */
+define('MAPI_STATUS', 0x0000000A); /* Status Object */
+define('MAPI_SESSION', 0x0000000B); /* Session */
+define('MAPI_FORMINFO', 0x0000000C); /* Form Information */
 
 define('MV_FLAG', 0x1000);
 define('MV_INSTANCE', 0x2000);
-define('MVI_FLAG', MV_FLAG | MV_INSTANCE);
-
-define('PT_UNSPECIFIED', 0);    /* (Reserved for interface use) type doesn't matter to caller */
-define('PT_NULL', 1);    /* NULL property value */
-define('PT_I2', 2);    /* Signed 16-bit value */
-define('PT_LONG', 3);    /* Signed 32-bit value */
-define('PT_R4', 4);    /* 4-byte floating point */
-define('PT_DOUBLE', 5);    /* Floating point double */
-define('PT_CURRENCY', 6);    /* Signed 64-bit int (decimal w/    4 digits right of decimal pt) */
-define('PT_APPTIME', 7);    /* Application time */
-define('PT_ERROR', 10);    /* 32-bit error value */
-define('PT_BOOLEAN', 11);    /* 16-bit boolean (non-zero true) */
-define('PT_OBJECT', 13);    /* Embedded object in a property */
-define('PT_I8', 20);    /* 8-byte signed integer */
-define('PT_STRING8', 30);    /* Null terminated 8-bit character string */
-define('PT_UNICODE', 31);    /* Null terminated Unicode string */
-define('PT_SYSTIME', 64);    /* FILETIME 64-bit int w/ number of 100ns periods since Jan 1,1601 */
-define('PT_CLSID', 72);    /* OLE GUID */
-define('PT_BINARY', 258);   /* Uninterpreted (counted byte array) */
+define('MVI_FLAG', MV_FLAG|MV_INSTANCE);
+
+define('PT_UNSPECIFIED', 0); /* (Reserved for interface use) type doesn't matter to caller */
+define('PT_NULL', 1); /* NULL property value */
+define('PT_I2', 2); /* Signed 16-bit value */
+define('PT_LONG', 3); /* Signed 32-bit value */
+define('PT_R4', 4); /* 4-byte floating point */
+define('PT_DOUBLE', 5); /* Floating point double */
+define('PT_CURRENCY', 6); /* Signed 64-bit int (decimal w/    4 digits right of decimal pt) */
+define('PT_APPTIME', 7); /* Application time */
+define('PT_ERROR', 10); /* 32-bit error value */
+define('PT_BOOLEAN', 11); /* 16-bit boolean (non-zero true) */
+define('PT_OBJECT', 13); /* Embedded object in a property */
+define('PT_I8', 20); /* 8-byte signed integer */
+define('PT_STRING8', 30); /* Null terminated 8-bit character string */
+define('PT_UNICODE', 31); /* Null terminated Unicode string */
+define('PT_SYSTIME', 64); /* FILETIME 64-bit int w/ number of 100ns periods since Jan 1,1601 */
+define('PT_CLSID', 72); /* OLE GUID */
+define('PT_BINARY', 258); /* Uninterpreted (counted byte array) */
 /* Changes are likely to these numbers, and to their structures. */
 
 /* Alternate property type names for ease of use */
@@ -61,18 +61,18 @@ 
 
 define('PT_TSTRING', PT_STRING8);
 
-define('PT_MV_I2', (MV_FLAG | PT_I2));
-define('PT_MV_LONG', (MV_FLAG | PT_LONG));
-define('PT_MV_R4', (MV_FLAG | PT_R4));
-define('PT_MV_DOUBLE', (MV_FLAG | PT_DOUBLE));
-define('PT_MV_CURRENCY', (MV_FLAG | PT_CURRENCY));
-define('PT_MV_APPTIME', (MV_FLAG | PT_APPTIME));
-define('PT_MV_SYSTIME', (MV_FLAG | PT_SYSTIME));
-define('PT_MV_STRING8', (MV_FLAG | PT_STRING8));
-define('PT_MV_BINARY', (MV_FLAG | PT_BINARY));
-define('PT_MV_UNICODE', (MV_FLAG | PT_UNICODE));
-define('PT_MV_CLSID', (MV_FLAG | PT_CLSID));
-define('PT_MV_I8', (MV_FLAG | PT_I8));
+define('PT_MV_I2', (MV_FLAG|PT_I2));
+define('PT_MV_LONG', (MV_FLAG|PT_LONG));
+define('PT_MV_R4', (MV_FLAG|PT_R4));
+define('PT_MV_DOUBLE', (MV_FLAG|PT_DOUBLE));
+define('PT_MV_CURRENCY', (MV_FLAG|PT_CURRENCY));
+define('PT_MV_APPTIME', (MV_FLAG|PT_APPTIME));
+define('PT_MV_SYSTIME', (MV_FLAG|PT_SYSTIME));
+define('PT_MV_STRING8', (MV_FLAG|PT_STRING8));
+define('PT_MV_BINARY', (MV_FLAG|PT_BINARY));
+define('PT_MV_UNICODE', (MV_FLAG|PT_UNICODE));
+define('PT_MV_CLSID', (MV_FLAG|PT_CLSID));
+define('PT_MV_I8', (MV_FLAG|PT_I8));
 
 define('PT_MV_TSTRING', PT_MV_STRING8);
 /* bit 0: set if descending, clear if ascending */
@@ -190,14 +190,14 @@ 
 
 /* Values for PR_RESOURCE_TYPE, _METHODS, _FLAGS */
 
-define('MAPI_STORE_PROVIDER', 33);    /* Message Store */
-define('MAPI_AB', 34);    /* Address Book */
-define('MAPI_AB_PROVIDER', 35);    /* Address Book Provider */
-define('MAPI_TRANSPORT_PROVIDER', 36);    /* Transport Provider */
-define('MAPI_SPOOLER', 37);    /* Message Spooler */
-define('MAPI_PROFILE_PROVIDER', 38);    /* Profile Provider */
-define('MAPI_SUBSYSTEM', 39);    /* Overall Subsystem Status */
-define('MAPI_HOOK_PROVIDER', 40);    /* Spooler Hook */
+define('MAPI_STORE_PROVIDER', 33); /* Message Store */
+define('MAPI_AB', 34); /* Address Book */
+define('MAPI_AB_PROVIDER', 35); /* Address Book Provider */
+define('MAPI_TRANSPORT_PROVIDER', 36); /* Transport Provider */
+define('MAPI_SPOOLER', 37); /* Message Spooler */
+define('MAPI_PROFILE_PROVIDER', 38); /* Profile Provider */
+define('MAPI_SUBSYSTEM', 39); /* Overall Subsystem Status */
+define('MAPI_HOOK_PROVIDER', 40); /* Spooler Hook */
 define('STATUS_VALIDATE_STATE', 0x00000001);
 define('STATUS_SETTINGS_DIALOG', 0x00000002);
 define('STATUS_CHANGE_PASSWORD', 0x00000004);
@@ -243,10 +243,10 @@ 
 define('MODRECIP_MODIFY', 0x00000004);
 define('MODRECIP_REMOVE', 0x00000008);
 
-define('MAPI_ORIG', 0);          /* Recipient is message originator */
-define('MAPI_TO', 1);          /* Recipient is a primary recipient */
-define('MAPI_CC', 2);          /* Recipient is a copy recipient */
-define('MAPI_BCC', 3);          /* Recipient is blind copy recipient */
+define('MAPI_ORIG', 0); /* Recipient is message originator */
+define('MAPI_TO', 1); /* Recipient is a primary recipient */
+define('MAPI_CC', 2); /* Recipient is a copy recipient */
+define('MAPI_BCC', 3); /* Recipient is blind copy recipient */
 
 /* IAttach Interface ------------------------------------------------------- */
 
@@ -438,23 +438,23 @@ 
 define('BMR_NEZ', 0x00000001);
 
 /* array index values of restrictions -- same values are used in php-ext/main.cpp::PHPArraytoSRestriction() */
-define('VALUE', 0);        // propval
-define('RELOP', 1);        // compare method
-define('FUZZYLEVEL', 2);        // string search flags
-define('CB', 3);        // size restriction
-define('ULTYPE', 4);        // bit mask restriction type BMR_xxx
-define('ULMASK', 5);        // bitmask
-define('ULPROPTAG', 6);        // property
-define('ULPROPTAG1', 7);        // RES_COMPAREPROPS 1st property
-define('ULPROPTAG2', 8);        // RES_COMPAREPROPS 2nd property
-define('PROPS', 9);        // RES_COMMENT properties
-define('RESTRICTION', 10);       // RES_COMMENT and RES_SUBRESTRICTION restriction
+define('VALUE', 0); // propval
+define('RELOP', 1); // compare method
+define('FUZZYLEVEL', 2); // string search flags
+define('CB', 3); // size restriction
+define('ULTYPE', 4); // bit mask restriction type BMR_xxx
+define('ULMASK', 5); // bitmask
+define('ULPROPTAG', 6); // property
+define('ULPROPTAG1', 7); // RES_COMPAREPROPS 1st property
+define('ULPROPTAG2', 8); // RES_COMPAREPROPS 2nd property
+define('PROPS', 9); // RES_COMMENT properties
+define('RESTRICTION', 10); // RES_COMMENT and RES_SUBRESTRICTION restriction
 
 /* GUID's for PR_MDB_PROVIDER */
-define("ZARAFA_SERVICE_GUID", makeGuid("{3C253DCA-D227-443C-94FE-425FAB958C19}"));    // default store
-define("ZARAFA_STORE_PUBLIC_GUID", makeGuid("{70FAB278-F7AF-CD11-9BC8-00AA002FC45A}"));    // public store
-define("ZARAFA_STORE_DELEGATE_GUID", makeGuid("{7C7C1085-BC6D-4E53-9DAB-8A53F8DEF808}"));    // other store
-define('ZARAFA_STORE_ARCHIVER_GUID', makeGuid("{BC8953AD-2E3F-4172-9404-896FF459870F}"));    // archive store
+define("ZARAFA_SERVICE_GUID", makeGuid("{3C253DCA-D227-443C-94FE-425FAB958C19}")); // default store
+define("ZARAFA_STORE_PUBLIC_GUID", makeGuid("{70FAB278-F7AF-CD11-9BC8-00AA002FC45A}")); // public store
+define("ZARAFA_STORE_DELEGATE_GUID", makeGuid("{7C7C1085-BC6D-4E53-9DAB-8A53F8DEF808}")); // other store
+define('ZARAFA_STORE_ARCHIVER_GUID', makeGuid("{BC8953AD-2E3F-4172-9404-896FF459870F}")); // archive store
 
 /* global profile section guid */
 define('pbGlobalProfileSectionGuid', makeGuid("{C8B0DB13-05AA-1A10-9BB0-00AA002FC45A}"));
@@ -481,10 +481,10 @@ 
 // define('ecrightsContact'                       ,0x00000200);
 define('ecRightsFolderVisible', 0x00000400);
 
-define('ecRightsAll', ecRightsReadAny | ecRightsCreate | ecRightsEditOwned | ecRightsDeleteOwned | ecRightsEditAny | ecRightsDeleteAny | ecRightsCreateSubfolder | ecRightsFolderAccess | ecRightsFolderVisible);
-define('ecRightsFullControl', ecRightsReadAny | ecRightsCreate | ecRightsEditOwned | ecRightsDeleteOwned | ecRightsEditAny | ecRightsDeleteAny | ecRightsCreateSubfolder | ecRightsFolderVisible);
-define('ecRightsDefault', ecRightsNone | ecRightsFolderVisible);
-define('ecRightsDefaultPublic', ecRightsReadAny | ecRightsFolderVisible);
+define('ecRightsAll', ecRightsReadAny|ecRightsCreate|ecRightsEditOwned|ecRightsDeleteOwned|ecRightsEditAny|ecRightsDeleteAny|ecRightsCreateSubfolder|ecRightsFolderAccess|ecRightsFolderVisible);
+define('ecRightsFullControl', ecRightsReadAny|ecRightsCreate|ecRightsEditOwned|ecRightsDeleteOwned|ecRightsEditAny|ecRightsDeleteAny|ecRightsCreateSubfolder|ecRightsFolderVisible);
+define('ecRightsDefault', ecRightsNone|ecRightsFolderVisible);
+define('ecRightsDefaultPublic', ecRightsReadAny|ecRightsFolderVisible);
 define('ecRightsAdmin', 0x00001000);
 define('ecRightsAllMask', 0x000015FB);
 
@@ -500,7 +500,7 @@ 
 define('ROW_ADD', 0x0001);
 define('ROW_MODIFY', 0x0002);
 define('ROW_REMOVE', 0x0004);
-define('ROW_EMPTY', (ROW_ADD | ROW_REMOVE));
+define('ROW_EMPTY', (ROW_ADD|ROW_REMOVE));
 
 // new property types
 define('PT_SRESTRICTION', 0x00FD);
@@ -570,38 +570,38 @@ 
 define('SYNC_NO_FOREIGN_KEYS', 0x100);
 define('SYNC_LIMITED_IMESSAGE', 0x200);
 define('SYNC_CATCHUP', 0x400);
-define('SYNC_NEW_MESSAGE', 0x800);         // only applicable to ImportMessageChange()
-define('SYNC_MSG_SELECTIVE', 0x1000);        // Used internally.      Will reject if used by clients.
+define('SYNC_NEW_MESSAGE', 0x800); // only applicable to ImportMessageChange()
+define('SYNC_MSG_SELECTIVE', 0x1000); // Used internally.      Will reject if used by clients.
 define('SYNC_BEST_BODY', 0x2000);
 define('SYNC_IGNORE_SPECIFIED_ON_ASSOCIATED', 0x4000);
-define('SYNC_PROGRESS_MODE', 0x8000);        // AirMapi progress mode
+define('SYNC_PROGRESS_MODE', 0x8000); // AirMapi progress mode
 define('SYNC_FXRECOVERMODE', 0x10000);
 define('SYNC_DEFER_CONFIG', 0x20000);
-define('SYNC_FORCE_UNICODE', 0x40000);       // Forces server to return Unicode properties
-define('SYNC_STATE_READONLY', 0x80000);       // Server will not update the states in the DB, setting up exporter with this flag states are read only
+define('SYNC_FORCE_UNICODE', 0x40000); // Forces server to return Unicode properties
+define('SYNC_STATE_READONLY', 0x80000); // Server will not update the states in the DB, setting up exporter with this flag states are read only
 
-define('EMS_AB_ADDRESS_LOOKUP', 0x00000001);    // Flag for resolvename to resolve only exact matches
+define('EMS_AB_ADDRESS_LOOKUP', 0x00000001); // Flag for resolvename to resolve only exact matches
 
-define('TBL_BATCH', 0x00000002);    // Batch multiple table commands
+define('TBL_BATCH', 0x00000002); // Batch multiple table commands
 
 /* Flags for recipients in exceptions */
-define('recipSendable', 0x00000001);    // sendable attendee.
-define('recipOrganizer', 0x00000002);    // meeting organizer
-define('recipExceptionalResponse', 0x00000010);    // attendee gave a response for the exception
-define('recipExceptionalDeleted', 0x00000020);    // recipientRow exists, but it is treated as if the corresponding recipient is deleted from meeting
-define('recipOriginal', 0x00000100);    // recipient is an original Attendee
+define('recipSendable', 0x00000001); // sendable attendee.
+define('recipOrganizer', 0x00000002); // meeting organizer
+define('recipExceptionalResponse', 0x00000010); // attendee gave a response for the exception
+define('recipExceptionalDeleted', 0x00000020); // recipientRow exists, but it is treated as if the corresponding recipient is deleted from meeting
+define('recipOriginal', 0x00000100); // recipient is an original Attendee
 define('recipReserved', 0x00000200);
 
 /* Flags which indicates type of Meeting Object */
-define('mtgEmpty', 0x00000000);    // Unspecified.
-define('mtgRequest', 0x00000001);    // Initial meeting request.
-define('mtgFull', 0x00010000);    // Full update.
-define('mtgInfo', 0x00020000);    // Informational update.
-define('mtgOutOfDate', 0x00080000);    // A newer Meeting Request object or Meeting Update object was received after this one.
-define('mtgDelegatorCopy', 0x00100000);    // This is set on the delegator's copy when a delegate will handle meeting-related objects.
-
-define('MAPI_ONE_OFF_UNICODE', 0x8000);        // the flag that defines whether the embedded strings are Unicode in one off entryids.
-define('MAPI_ONE_OFF_NO_RICH_INFO', 0x0001);        // the flag that specifies whether the recipient gets TNEF or not.
+define('mtgEmpty', 0x00000000); // Unspecified.
+define('mtgRequest', 0x00000001); // Initial meeting request.
+define('mtgFull', 0x00010000); // Full update.
+define('mtgInfo', 0x00020000); // Informational update.
+define('mtgOutOfDate', 0x00080000); // A newer Meeting Request object or Meeting Update object was received after this one.
+define('mtgDelegatorCopy', 0x00100000); // This is set on the delegator's copy when a delegate will handle meeting-related objects.
+
+define('MAPI_ONE_OFF_UNICODE', 0x8000); // the flag that defines whether the embedded strings are Unicode in one off entryids.
+define('MAPI_ONE_OFF_NO_RICH_INFO', 0x0001); // the flag that specifies whether the recipient gets TNEF or not.
 
 /* Mask flags for mapi_msgstore_advise */
 define('fnevCriticalError', 0x00000001);

mapi/class.taskrequest.php

Indentation +1219 added lines, -1219 removed lines

@@ -4,7 +4,7 @@ 
  * SPDX-FileCopyrightText: Copyright 2005-2016 Zarafa Deutschland GmbH
  * SPDX-FileCopyrightText: Copyright 2020-2022 grommunio GmbH
  */
-	/*
+    /*
 	* In general
 	*
 	* This class never actually modifies a task item unless we receive a task request update. This means
@@ -16,93 +16,93 @@ 
 	* task request is sent via sendTaskRequest.
 	*/
 
-	/* The TaskMode value is only used for the IPM.TaskRequest items.
+    /* The TaskMode value is only used for the IPM.TaskRequest items.
 	 * It must 0 (tdmtNothing) on IPM.Task items.
 	 *
 	 * It is used to indicate the type of change that is being
 	 * carried in the IPM.TaskRequest item (although this information seems
 	 * redundant due to that information already being available in PR_MESSAGE_CLASS).
 	 */
-	define('tdmtNothing', 0);            // Value in IPM.Task items
-	define('tdmtTaskReq', 1);            // Assigner -> Assignee
-	define('tdmtTaskAcc', 2);            // Assignee -> Assigner
-	define('tdmtTaskDec', 3);            // Assignee -> Assigner
-	define('tdmtTaskUpd', 4);            // Assignee -> Assigner
-	define('tdmtTaskSELF', 5);            // Assigner -> Assigner (?)
-
-	/* The TaskHistory is used to show the last action on the task
+    define('tdmtNothing', 0);            // Value in IPM.Task items
+    define('tdmtTaskReq', 1);            // Assigner -> Assignee
+    define('tdmtTaskAcc', 2);            // Assignee -> Assigner
+    define('tdmtTaskDec', 3);            // Assignee -> Assigner
+    define('tdmtTaskUpd', 4);            // Assignee -> Assigner
+    define('tdmtTaskSELF', 5);            // Assigner -> Assigner (?)
+
+    /* The TaskHistory is used to show the last action on the task
 	 * on both the assigner and the assignee's side.
 	 *
 	 * It is used in combination with 'task_assigned_time' and 'tasklastdelegate'
 	 * or 'tasklastuser' to show the information at the top of the task request in
 	 * the format 'Accepted by <user> on 01-01-2010 11:00'.
 	 */
-	define('thNone', 0);
-	define('thAccepted', 1);            // Set by assignee
-	define('thDeclined', 2);            // Set by assignee
-	define('thUpdated', 3);                // Set by assignee
-	define('thDueDateChanged', 4);
-	define('thAssigned', 5);            // Set by assigner
-
-	/* The TaskState value is used to differentiate the version of a task
+    define('thNone', 0);
+    define('thAccepted', 1);            // Set by assignee
+    define('thDeclined', 2);            // Set by assignee
+    define('thUpdated', 3);                // Set by assignee
+    define('thDueDateChanged', 4);
+    define('thAssigned', 5);            // Set by assigner
+
+    /* The TaskState value is used to differentiate the version of a task
 	 * in the assigner's folder and the version in the
 	 * assignee's folder. The buttons shown depend on this and
 	 * the 'taskaccepted' boolean (for the assignee)
 	 */
-	define('tdsNOM', 0);        // Got a response to a deleted task, and re-created the task for the assigner
-	define('tdsOWNNEW', 1);        // Not assigned
-	define('tdsOWN', 2);        // Assignee version
-	define('tdsACC', 3);        // Assigner version
-	define('tdsDEC', 4);        // Assigner version, but assignee declined
-
-	/* The TaskAcceptanceState is used for the assigner to indicate state */
-	define('olTaskNotDelegated', 0);
-	define('olTaskDelegationUnknown', 1); // After sending req
-	define('olTaskDelegationAccepted', 2); // After receiving accept
-	define('olTaskDelegationDeclined', 3); // After receiving decline
-
-	/* The task ownership indicates the role of the current user relative to the task. */
-	define('olNewTask', 0);
-	define('olDelegatedTask', 1);    // Task has been assigned
-	define('olOwnTask', 2);            // Task owned
-
-	/* taskmultrecips indicates whether the task request sent or received has multiple assignees or not. */
-	define('tmrNone', 0);
-	define('tmrSent', 1);        // Task has been sent to multiple assignee
-	define('tmrReceived', 2);    // Task Request received has multiple assignee
-
-	// Task icon index.
-	define('ICON_TASK_ASSIGNEE', 0x00000502);
-	define('ICON_TASK_DECLINE', 0x00000506);
-	define('ICON_TASK_ASSIGNER', 0x00000503);
-
-	class TaskRequest {
-		private $props;
-		private $store;
-		private $message;
-		private $session;
-		private $taskCommentsInfo;
-
-		// All recipient properties
-		public $recipProps = [
-			PR_ENTRYID,
-			PR_DISPLAY_NAME,
-			PR_EMAIL_ADDRESS,
-			PR_RECIPIENT_ENTRYID,
-			PR_RECIPIENT_TYPE,
-			PR_SEND_INTERNET_ENCODING,
-			PR_SEND_RICH_INFO,
-			PR_RECIPIENT_DISPLAY_NAME,
-			PR_ADDRTYPE,
-			PR_DISPLAY_TYPE,
-			PR_RECIPIENT_TRACKSTATUS,
-			PR_RECIPIENT_TRACKSTATUS_TIME,
-			PR_RECIPIENT_FLAGS,
-			PR_ROWID,
-			PR_SEARCH_KEY,
-		];
-
-		/* Constructor
+    define('tdsNOM', 0);        // Got a response to a deleted task, and re-created the task for the assigner
+    define('tdsOWNNEW', 1);        // Not assigned
+    define('tdsOWN', 2);        // Assignee version
+    define('tdsACC', 3);        // Assigner version
+    define('tdsDEC', 4);        // Assigner version, but assignee declined
+
+    /* The TaskAcceptanceState is used for the assigner to indicate state */
+    define('olTaskNotDelegated', 0);
+    define('olTaskDelegationUnknown', 1); // After sending req
+    define('olTaskDelegationAccepted', 2); // After receiving accept
+    define('olTaskDelegationDeclined', 3); // After receiving decline
+
+    /* The task ownership indicates the role of the current user relative to the task. */
+    define('olNewTask', 0);
+    define('olDelegatedTask', 1);    // Task has been assigned
+    define('olOwnTask', 2);            // Task owned
+
+    /* taskmultrecips indicates whether the task request sent or received has multiple assignees or not. */
+    define('tmrNone', 0);
+    define('tmrSent', 1);        // Task has been sent to multiple assignee
+    define('tmrReceived', 2);    // Task Request received has multiple assignee
+
+    // Task icon index.
+    define('ICON_TASK_ASSIGNEE', 0x00000502);
+    define('ICON_TASK_DECLINE', 0x00000506);
+    define('ICON_TASK_ASSIGNER', 0x00000503);
+
+    class TaskRequest {
+        private $props;
+        private $store;
+        private $message;
+        private $session;
+        private $taskCommentsInfo;
+
+        // All recipient properties
+        public $recipProps = [
+            PR_ENTRYID,
+            PR_DISPLAY_NAME,
+            PR_EMAIL_ADDRESS,
+            PR_RECIPIENT_ENTRYID,
+            PR_RECIPIENT_TYPE,
+            PR_SEND_INTERNET_ENCODING,
+            PR_SEND_RICH_INFO,
+            PR_RECIPIENT_DISPLAY_NAME,
+            PR_ADDRTYPE,
+            PR_DISPLAY_TYPE,
+            PR_RECIPIENT_TRACKSTATUS,
+            PR_RECIPIENT_TRACKSTATUS_TIME,
+            PR_RECIPIENT_FLAGS,
+            PR_ROWID,
+            PR_SEARCH_KEY,
+        ];
+
+        /* Constructor
 		 *
 		 * Constructs a TaskRequest object for the specified message. This can be either the task request
 		 * message itself (in the inbox) or the task in the tasks folder, depending on the action to be performed.
@@ -114,582 +114,582 @@ 
 		 * @param $message message MAPI Message to which the task request refers to (can be an email or a task)
 		 * @param $session session MAPI Session which is used to open tasks folders for delegated task requests or responses
 		 */
-		public function __construct($store, $message, $session) {
-			$this->store = $store;
-			$this->message = $message;
-			$this->session = $session;
-			$this->taskCommentsInfo = false;
-
-			$properties["owner"] = "PT_STRING8:PSETID_Task:0x811f";
-			$properties["updatecount"] = "PT_LONG:PSETID_Task:0x8112";
-			$properties["taskstate"] = "PT_LONG:PSETID_Task:0x8113";
-			$properties["taskmultrecips"] = "PT_LONG:PSETID_Task:0x8120";
-			$properties["taskupdates"] = "PT_BOOLEAN:PSETID_Task:0x811b";
-			$properties["tasksoc"] = "PT_BOOLEAN:PSETID_Task:0x8119";
-			$properties["taskhistory"] = "PT_LONG:PSETID_Task:0x811a";
-			$properties["taskmode"] = "PT_LONG:PSETID_Common:0x8518";
-			$properties["task_goid"] = "PT_BINARY:PSETID_Common:0x8519";
-			$properties["complete"] = "PT_BOOLEAN:PSETID_Common:0x811c";
-			$properties["task_assigned_time"] = "PT_SYSTIME:PSETID_Task:0x8115";
-			$properties["taskfcreator"] = "PT_BOOLEAN:PSETID_Task:0x0x811e";
-			$properties["tasklastuser"] = "PT_STRING8:PSETID_Task:0x8122";
-			$properties["tasklastdelegate"] = "PT_STRING8:PSETID_Task:0x8125";
-			$properties["taskaccepted"] = "PT_BOOLEAN:PSETID_Task:0x8108";
-			$properties["task_acceptance_state"] = "PT_LONG:PSETID_Task:0x812a";
-			$properties["ownership"] = "PT_LONG:PSETID_Task:0x8129";
-
-			$properties["complete"] = "PT_BOOLEAN:PSETID_Task:0x811c";
-			$properties["datecompleted"] = "PT_SYSTIME:PSETID_Task:0x810f";
-			$properties["recurring"] = "PT_BOOLEAN:PSETID_Task:0x8126";
-			$properties["startdate"] = "PT_SYSTIME:PSETID_Task:0x8104";
-			$properties["duedate"] = "PT_SYSTIME:PSETID_Task:0x8105";
-			$properties["status"] = "PT_LONG:PSETID_Task:0x8101";
-			$properties["percent_complete"] = "PT_DOUBLE:PSETID_Task:0x8102";
-			$properties["totalwork"] = "PT_LONG:PSETID_Task:0x8111";
-			$properties["actualwork"] = "PT_LONG:PSETID_Task:0x8110";
-			$properties["categories"] = "PT_MV_STRING8:PS_PUBLIC_STRINGS:Keywords";
-			$properties["companies"] = "PT_MV_STRING8:PSETID_Common:0x8539";
-			$properties["mileage"] = "PT_STRING8:PSETID_Common:0x8534";
-			$properties["billinginformation"] = "PT_STRING8:PSETID_Common:0x8535";
-
-			$this->props = getPropIdsFromStrings($store, $properties);
-		}
-
-		// General functions
-
-		/**
-		 * Returns TRUE if the message pointed to is an incoming task request and should
-		 * therefore be replied to with doAccept or doDecline().
-		 *
-		 * @param string $messageClass message class to use for checking
-		 *
-		 * @return bool returns true if this is a task request else false
-		 */
-		public function isTaskRequest($messageClass = false) {
-			if ($messageClass === false) {
-				$props = mapi_getprops($this->message, [PR_MESSAGE_CLASS]);
-				$messageClass = isset($props[PR_MESSAGE_CLASS]) ? $props[PR_MESSAGE_CLASS] : false;
-			}
-
-			if ($messageClass !== false && $messageClass === "IPM.TaskRequest") {
-				return true;
-			}
-
-			return false;
-		}
-
-		/**
-		 * Returns TRUE if the message pointed to is a returning task request response.
-		 *
-		 * @param string $messageClass message class to use for checking
-		 *
-		 * @return bool returns true if this is a task request else false
-		 */
-		public function isTaskRequestResponse($messageClass = false) {
-			if ($messageClass === false) {
-				$props = mapi_getprops($this->message, [PR_MESSAGE_CLASS]);
-				$messageClass = isset($props[PR_MESSAGE_CLASS]) ? $props[PR_MESSAGE_CLASS] : false;
-			}
-
-			if ($messageClass !== false && strpos($messageClass, "IPM.TaskRequest.") === 0) {
-				return true;
-			}
-
-			return false;
-		}
-
-		/**
-		 * Returns TRUE if the message pointed to is an incoming task request/response.
-		 *
-		 * @param array $props The MAPI properties to check message is an incoming task request/response
-		 *
-		 * @return bool Returns true if this is an incoming task request/response. else false.
-		 */
-		public function isReceivedItem($props) {
-			return isset($props[PR_MESSAGE_TO_ME]) ? $props[PR_MESSAGE_TO_ME] : false;
-		}
-
-		/**
-		 * Gets the task associated with an IPM.TaskRequest message.
-		 *
-		 * If the task does not exist yet, it is created, using the attachment object in the
-		 * task request item.
-		 *
-		 * @param bool $create false to find the associated task in user's task folder. true to
-		 *                     create task in user's task folder if task is not exist in task folder.
-		 *
-		 * @return false|MAPIMessage Return associated task of task request else false
-		 */
-		public function getAssociatedTask($create) {
-			$props = mapi_getprops($this->message, [PR_MESSAGE_CLASS, $this->props['task_goid']]);
-
-			if ($props[PR_MESSAGE_CLASS] == "IPM.Task") {
-				// Message itself is task, so return that
-				return $this->message;
-			}
-
-			$taskFolder = $this->getDefaultTasksFolder();
-			$goid = $props[$this->props['task_goid']];
-
-			// Find the task by looking for the task_goid
-			$restriction = [
-				RES_PROPERTY,
-				[
-					RELOP => RELOP_EQ,
-					ULPROPTAG => $this->props['task_goid'],
-					VALUE => $goid,
-				],
-			];
-
-			$contents = mapi_folder_getcontentstable($taskFolder);
-
-			$rows = mapi_table_queryallrows($contents, [PR_ENTRYID], $restriction);
-
-			if (empty($rows)) {
-				// None found, create one if possible
-				if (!$create) {
-					return false;
-				}
-
-				$task = mapi_folder_createmessage($taskFolder);
-
-				$sub = $this->getEmbeddedTask($this->message);
-				mapi_copyto($sub, [], [$this->props['categories']], $task);
-
-				$senderProps = [
-					PR_SENT_REPRESENTING_NAME,
-					PR_SENT_REPRESENTING_EMAIL_ADDRESS,
-					PR_SENT_REPRESENTING_ENTRYID,
-					PR_SENT_REPRESENTING_ADDRTYPE,
-					PR_SENT_REPRESENTING_SEARCH_KEY,
-					PR_SENDER_NAME,
-					PR_SENDER_EMAIL_ADDRESS,
-					PR_SENDER_ENTRYID,
-					PR_SENDER_ADDRTYPE,
-					PR_SENDER_SEARCH_KEY, ];
-
-				// Copy sender information from the e-mail
-				$props = mapi_getprops($this->message, $senderProps);
-				mapi_setprops($task, $props);
-			}
-			else {
-				// If there are multiple, just use the first
-				$entryid = $rows[0][PR_ENTRYID];
-
-				$store = $this->getTaskFolderStore();
-				$task = mapi_msgstore_openentry($store, $entryid);
-			}
-
-			return $task;
-		}
-
-		/**
-		 * Function which checks that if we have received a task request/response
-		 * for an already updated task in task folder.
-		 *
-		 * @return bool true if task request is updated later
-		 */
-		public function isTaskRequestUpdated() {
-			$props = mapi_getprops($this->message, [PR_MESSAGE_CLASS, $this->props['task_goid'], $this->props['updatecount']]);
-			$result = false;
-			$associatedTask = $this->getAssociatedTask(false);
-			if ($this->isTaskRequest($props[PR_MESSAGE_CLASS])) {
-				if ($associatedTask) {
-					return true;
-				}
-				$folder = $this->getDefaultTasksFolder();
-				$goid = $props[$this->props['task_goid']];
-
-				// Find the task by looking for the task_goid
-				$restriction = [RES_PROPERTY, [
-					RELOP => RELOP_EQ,
-					ULPROPTAG => $this->props['task_goid'],
-					VALUE => $goid, ],
-				];
-
-				$table = mapi_folder_getcontentstable($folder, MAPI_DEFERRED_ERRORS | SHOW_SOFT_DELETES);
-				$softDeletedItems = mapi_table_queryallrows($table, [PR_ENTRYID], $restriction);
-				if (!empty($softDeletedItems)) {
-					return true;
-				}
-			}
-
-			if ($associatedTask !== false) {
-				$taskItemProps = mapi_getprops($associatedTask, [$this->props['updatecount']]);
-				/*
+        public function __construct($store, $message, $session) {
+            $this->store = $store;
+            $this->message = $message;
+            $this->session = $session;
+            $this->taskCommentsInfo = false;
+
+            $properties["owner"] = "PT_STRING8:PSETID_Task:0x811f";
+            $properties["updatecount"] = "PT_LONG:PSETID_Task:0x8112";
+            $properties["taskstate"] = "PT_LONG:PSETID_Task:0x8113";
+            $properties["taskmultrecips"] = "PT_LONG:PSETID_Task:0x8120";
+            $properties["taskupdates"] = "PT_BOOLEAN:PSETID_Task:0x811b";
+            $properties["tasksoc"] = "PT_BOOLEAN:PSETID_Task:0x8119";
+            $properties["taskhistory"] = "PT_LONG:PSETID_Task:0x811a";
+            $properties["taskmode"] = "PT_LONG:PSETID_Common:0x8518";
+            $properties["task_goid"] = "PT_BINARY:PSETID_Common:0x8519";
+            $properties["complete"] = "PT_BOOLEAN:PSETID_Common:0x811c";
+            $properties["task_assigned_time"] = "PT_SYSTIME:PSETID_Task:0x8115";
+            $properties["taskfcreator"] = "PT_BOOLEAN:PSETID_Task:0x0x811e";
+            $properties["tasklastuser"] = "PT_STRING8:PSETID_Task:0x8122";
+            $properties["tasklastdelegate"] = "PT_STRING8:PSETID_Task:0x8125";
+            $properties["taskaccepted"] = "PT_BOOLEAN:PSETID_Task:0x8108";
+            $properties["task_acceptance_state"] = "PT_LONG:PSETID_Task:0x812a";
+            $properties["ownership"] = "PT_LONG:PSETID_Task:0x8129";
+
+            $properties["complete"] = "PT_BOOLEAN:PSETID_Task:0x811c";
+            $properties["datecompleted"] = "PT_SYSTIME:PSETID_Task:0x810f";
+            $properties["recurring"] = "PT_BOOLEAN:PSETID_Task:0x8126";
+            $properties["startdate"] = "PT_SYSTIME:PSETID_Task:0x8104";
+            $properties["duedate"] = "PT_SYSTIME:PSETID_Task:0x8105";
+            $properties["status"] = "PT_LONG:PSETID_Task:0x8101";
+            $properties["percent_complete"] = "PT_DOUBLE:PSETID_Task:0x8102";
+            $properties["totalwork"] = "PT_LONG:PSETID_Task:0x8111";
+            $properties["actualwork"] = "PT_LONG:PSETID_Task:0x8110";
+            $properties["categories"] = "PT_MV_STRING8:PS_PUBLIC_STRINGS:Keywords";
+            $properties["companies"] = "PT_MV_STRING8:PSETID_Common:0x8539";
+            $properties["mileage"] = "PT_STRING8:PSETID_Common:0x8534";
+            $properties["billinginformation"] = "PT_STRING8:PSETID_Common:0x8535";
+
+            $this->props = getPropIdsFromStrings($store, $properties);
+        }
+
+        // General functions
+
+        /**
+         * Returns TRUE if the message pointed to is an incoming task request and should
+         * therefore be replied to with doAccept or doDecline().
+         *
+         * @param string $messageClass message class to use for checking
+         *
+         * @return bool returns true if this is a task request else false
+         */
+        public function isTaskRequest($messageClass = false) {
+            if ($messageClass === false) {
+                $props = mapi_getprops($this->message, [PR_MESSAGE_CLASS]);
+                $messageClass = isset($props[PR_MESSAGE_CLASS]) ? $props[PR_MESSAGE_CLASS] : false;
+            }
+
+            if ($messageClass !== false && $messageClass === "IPM.TaskRequest") {
+                return true;
+            }
+
+            return false;
+        }
+
+        /**
+         * Returns TRUE if the message pointed to is a returning task request response.
+         *
+         * @param string $messageClass message class to use for checking
+         *
+         * @return bool returns true if this is a task request else false
+         */
+        public function isTaskRequestResponse($messageClass = false) {
+            if ($messageClass === false) {
+                $props = mapi_getprops($this->message, [PR_MESSAGE_CLASS]);
+                $messageClass = isset($props[PR_MESSAGE_CLASS]) ? $props[PR_MESSAGE_CLASS] : false;
+            }
+
+            if ($messageClass !== false && strpos($messageClass, "IPM.TaskRequest.") === 0) {
+                return true;
+            }
+
+            return false;
+        }
+
+        /**
+         * Returns TRUE if the message pointed to is an incoming task request/response.
+         *
+         * @param array $props The MAPI properties to check message is an incoming task request/response
+         *
+         * @return bool Returns true if this is an incoming task request/response. else false.
+         */
+        public function isReceivedItem($props) {
+            return isset($props[PR_MESSAGE_TO_ME]) ? $props[PR_MESSAGE_TO_ME] : false;
+        }
+
+        /**
+         * Gets the task associated with an IPM.TaskRequest message.
+         *
+         * If the task does not exist yet, it is created, using the attachment object in the
+         * task request item.
+         *
+         * @param bool $create false to find the associated task in user's task folder. true to
+         *                     create task in user's task folder if task is not exist in task folder.
+         *
+         * @return false|MAPIMessage Return associated task of task request else false
+         */
+        public function getAssociatedTask($create) {
+            $props = mapi_getprops($this->message, [PR_MESSAGE_CLASS, $this->props['task_goid']]);
+
+            if ($props[PR_MESSAGE_CLASS] == "IPM.Task") {
+                // Message itself is task, so return that
+                return $this->message;
+            }
+
+            $taskFolder = $this->getDefaultTasksFolder();
+            $goid = $props[$this->props['task_goid']];
+
+            // Find the task by looking for the task_goid
+            $restriction = [
+                RES_PROPERTY,
+                [
+                    RELOP => RELOP_EQ,
+                    ULPROPTAG => $this->props['task_goid'],
+                    VALUE => $goid,
+                ],
+            ];
+
+            $contents = mapi_folder_getcontentstable($taskFolder);
+
+            $rows = mapi_table_queryallrows($contents, [PR_ENTRYID], $restriction);
+
+            if (empty($rows)) {
+                // None found, create one if possible
+                if (!$create) {
+                    return false;
+                }
+
+                $task = mapi_folder_createmessage($taskFolder);
+
+                $sub = $this->getEmbeddedTask($this->message);
+                mapi_copyto($sub, [], [$this->props['categories']], $task);
+
+                $senderProps = [
+                    PR_SENT_REPRESENTING_NAME,
+                    PR_SENT_REPRESENTING_EMAIL_ADDRESS,
+                    PR_SENT_REPRESENTING_ENTRYID,
+                    PR_SENT_REPRESENTING_ADDRTYPE,
+                    PR_SENT_REPRESENTING_SEARCH_KEY,
+                    PR_SENDER_NAME,
+                    PR_SENDER_EMAIL_ADDRESS,
+                    PR_SENDER_ENTRYID,
+                    PR_SENDER_ADDRTYPE,
+                    PR_SENDER_SEARCH_KEY, ];
+
+                // Copy sender information from the e-mail
+                $props = mapi_getprops($this->message, $senderProps);
+                mapi_setprops($task, $props);
+            }
+            else {
+                // If there are multiple, just use the first
+                $entryid = $rows[0][PR_ENTRYID];
+
+                $store = $this->getTaskFolderStore();
+                $task = mapi_msgstore_openentry($store, $entryid);
+            }
+
+            return $task;
+        }
+
+        /**
+         * Function which checks that if we have received a task request/response
+         * for an already updated task in task folder.
+         *
+         * @return bool true if task request is updated later
+         */
+        public function isTaskRequestUpdated() {
+            $props = mapi_getprops($this->message, [PR_MESSAGE_CLASS, $this->props['task_goid'], $this->props['updatecount']]);
+            $result = false;
+            $associatedTask = $this->getAssociatedTask(false);
+            if ($this->isTaskRequest($props[PR_MESSAGE_CLASS])) {
+                if ($associatedTask) {
+                    return true;
+                }
+                $folder = $this->getDefaultTasksFolder();
+                $goid = $props[$this->props['task_goid']];
+
+                // Find the task by looking for the task_goid
+                $restriction = [RES_PROPERTY, [
+                    RELOP => RELOP_EQ,
+                    ULPROPTAG => $this->props['task_goid'],
+                    VALUE => $goid, ],
+                ];
+
+                $table = mapi_folder_getcontentstable($folder, MAPI_DEFERRED_ERRORS | SHOW_SOFT_DELETES);
+                $softDeletedItems = mapi_table_queryallrows($table, [PR_ENTRYID], $restriction);
+                if (!empty($softDeletedItems)) {
+                    return true;
+                }
+            }
+
+            if ($associatedTask !== false) {
+                $taskItemProps = mapi_getprops($associatedTask, [$this->props['updatecount']]);
+                /*
 				 * if(message_counter < task_counter) task object is newer then task response (task is updated)
 				 * if(message_counter >= task_counter) task is not updated, do normal processing
 				 */
-				if (isset($taskItemProps[$this->props['updatecount']], $props[$this->props['updatecount']])) {
-					if ($props[$this->props['updatecount']] < $taskItemProps[$this->props['updatecount']]) {
-						$result = true;
-					}
-				}
-			}
-
-			return $result;
-		}
-
-		// Organizer functions (called by the organizer)
-
-		/**
-		 * Processes a task request response, which can be any of the following:
-		 * - Task accept (task history is marked as accepted)
-		 * - Task decline (task history is marked as declined)
-		 * - Task update (updates completion %, etc).
-		 */
-		public function processTaskResponse() {
-			$messageProps = mapi_getprops($this->message, [PR_PROCESSED, $this->props["taskupdates"], PR_MESSAGE_TO_ME]);
-			if (isset($messageProps[PR_PROCESSED]) && $messageProps[PR_PROCESSED]) {
-				return true;
-			}
-			mapi_setprops($this->message, [PR_PROCESSED => true]);
-			mapi_savechanges($this->message);
-
-			// Get the embedded task information.
-			$sub = $this->getEmbeddedTask($this->message);
-
-			// If task is updated in task folder then we don't need to process
-			// old response
-			if ($this->isTaskRequestUpdated()) {
-				return true;
-			}
-
-			$isReceivedItem = $this->isReceivedItem($messageProps);
-
-			$isCreateAssociatedTask = false;
-			$isAllowUpdateAssociatedTask = $messageProps[$this->props["taskupdates"]];
-			$props = mapi_getprops($this->message, [PR_MESSAGE_CLASS]);
-			// Set correct taskmode and taskhistory depending on response type
-			switch ($props[PR_MESSAGE_CLASS]) {
-				case 'IPM.TaskRequest.Accept':
-					$taskHistory = thAccepted;
-					$taskState = $isReceivedItem ? tdsACC : tdsOWN;
-					$taskOwner = $isReceivedItem ? olDelegatedTask : olOwnTask;
-					$taskAcceptanceState = $isReceivedItem ? olTaskDelegationAccepted : olTaskNotDelegated;
-
-					break;
-
-				case 'IPM.TaskRequest.Decline':
-					$isCreateAssociatedTask = $isReceivedItem;
-					$isAllowUpdateAssociatedTask = $isReceivedItem;
-					$taskHistory = thDeclined;
-					$taskState = $isReceivedItem ? tdsDEC : tdsACC;
-					$taskOwner = $isReceivedItem ? olOwnTask : olDelegatedTask;
-					$taskAcceptanceState = $isReceivedItem ? olTaskDelegationDeclined : olTaskDelegationUnknown;
-
-					break;
-
-				case 'IPM.TaskRequest.Update':
-				case 'IPM.TaskRequest.Complete':
-					$taskHistory = thUpdated;
-					$taskState = $isReceivedItem ? tdsACC : tdsOWN;
-					$taskAcceptanceState = olTaskNotDelegated;
-					$taskOwner = $isReceivedItem ? olDelegatedTask : olOwnTask;
-
-					break;
-			}
-
-			$props = [
-				$this->props['taskhistory'] => $taskHistory,
-				$this->props['taskstate'] => $taskState,
-				$this->props['task_acceptance_state'] => $taskAcceptanceState,
-				$this->props['ownership'] => $taskOwner,
-			];
-
-			// Get the task for this response
-			$task = $this->getAssociatedTask($isCreateAssociatedTask);
-			if ($task && $isAllowUpdateAssociatedTask) {
-				// To avoid duplication of attachments in associated task. we simple remove the
-				// all attachments from associated task.
-				$taskAttachTable = mapi_message_getattachmenttable($task);
-				$taskAttachments = mapi_table_queryallrows($taskAttachTable, [PR_ATTACH_NUM]);
-				foreach ($taskAttachments as $taskAttach) {
-					mapi_message_deleteattach($task, $taskAttach[PR_ATTACH_NUM]);
-				}
-
-				$ignoreProps = [
-					$this->props['taskstate'],
-					$this->props['taskhistory'],
-					$this->props['taskmode'],
-					$this->props['taskfcreator'],
-				];
-				// Ignore PR_ICON_INDEX when task request response
-				// is not received item.
-				if ($isReceivedItem === false) {
-					$ignoreProps[] = PR_ICON_INDEX;
-				}
-
-				// We copy all properties except taskstate, taskhistory, taskmode and taskfcreator properties
-				// from $sub message to $task even also we copy all attachments from $sub to $task message.
-				mapi_copyto($sub, [], $ignoreProps, $task);
-				$senderProps = mapi_getprops($this->message, [
-					PR_SENDER_NAME,
-					PR_SENDER_EMAIL_ADDRESS,
-					PR_SENDER_ENTRYID,
-					PR_SENDER_ADDRTYPE,
-					PR_SENDER_SEARCH_KEY,
-					PR_MESSAGE_DELIVERY_TIME,
-					PR_SENT_REPRESENTING_NAME,
-					PR_SENT_REPRESENTING_EMAIL_ADDRESS,
-					PR_SENT_REPRESENTING_ADDRTYPE,
-					PR_SENT_REPRESENTING_ENTRYID,
-					PR_SENT_REPRESENTING_SEARCH_KEY, ]);
-
-				mapi_setprops($task, $senderProps);
-
-				// Update taskstate and task history (last action done by the assignee)
-				mapi_setprops($task, $props);
-
-				mapi_savechanges($task);
-			}
-
-			mapi_setprops($this->message, $props);
-			mapi_savechanges($this->message);
-
-			if ($isReceivedItem) {
-				$this->updateSentTaskRequest();
-			}
-
-			return true;
-		}
-
-		/**
-		 * Update the sent task request in sent items folder.
-		 *
-		 * @return bool
-		 */
-		public function updateSentTaskRequest() {
-			$props = mapi_getprops($this->message, [
-				$this->props['taskhistory'],
-				$this->props["taskstate"],
-				$this->props["ownership"],
-				$this->props['task_goid'],
-				$this->props['task_acceptance_state'],
-				$this->props["tasklastuser"],
-				$this->props["tasklastdelegate"], ]);
-
-			$store = $this->getDefaultStore();
-			$storeProps = mapi_getprops($store, [PR_IPM_SENTMAIL_ENTRYID]);
-
-			$sentFolder = mapi_msgstore_openentry($store, $storeProps[PR_IPM_SENTMAIL_ENTRYID]);
-			if (!$sentFolder) {
-				return false;
-			}
-
-			// Find the task by looking for the task_goid
-			$restriction = [
-				RES_PROPERTY, [
-					RELOP => RELOP_EQ,
-					ULPROPTAG => $this->props['task_goid'],
-					VALUE => $props[$this->props['task_goid']],
-				],
-			];
-
-			$contentsTable = mapi_folder_getcontentstable($sentFolder);
-
-			$rows = mapi_table_queryallrows($contentsTable, [PR_ENTRYID], $restriction);
-
-			if (!empty($rows)) {
-				foreach ($rows as $row) {
-					$sentTaskRequest = mapi_msgstore_openentry($store, $row[PR_ENTRYID]);
-					mapi_setprops($sentTaskRequest, $props);
-					mapi_setprops($sentTaskRequest, [PR_PROCESSED => true]);
-					mapi_savechanges($sentTaskRequest);
-				}
-			}
-
-			return true;
-		}
-
-		/* Create a new message in the current user's outbox and submit it
+                if (isset($taskItemProps[$this->props['updatecount']], $props[$this->props['updatecount']])) {
+                    if ($props[$this->props['updatecount']] < $taskItemProps[$this->props['updatecount']]) {
+                        $result = true;
+                    }
+                }
+            }
+
+            return $result;
+        }
+
+        // Organizer functions (called by the organizer)
+
+        /**
+         * Processes a task request response, which can be any of the following:
+         * - Task accept (task history is marked as accepted)
+         * - Task decline (task history is marked as declined)
+         * - Task update (updates completion %, etc).
+         */
+        public function processTaskResponse() {
+            $messageProps = mapi_getprops($this->message, [PR_PROCESSED, $this->props["taskupdates"], PR_MESSAGE_TO_ME]);
+            if (isset($messageProps[PR_PROCESSED]) && $messageProps[PR_PROCESSED]) {
+                return true;
+            }
+            mapi_setprops($this->message, [PR_PROCESSED => true]);
+            mapi_savechanges($this->message);
+
+            // Get the embedded task information.
+            $sub = $this->getEmbeddedTask($this->message);
+
+            // If task is updated in task folder then we don't need to process
+            // old response
+            if ($this->isTaskRequestUpdated()) {
+                return true;
+            }
+
+            $isReceivedItem = $this->isReceivedItem($messageProps);
+
+            $isCreateAssociatedTask = false;
+            $isAllowUpdateAssociatedTask = $messageProps[$this->props["taskupdates"]];
+            $props = mapi_getprops($this->message, [PR_MESSAGE_CLASS]);
+            // Set correct taskmode and taskhistory depending on response type
+            switch ($props[PR_MESSAGE_CLASS]) {
+                case 'IPM.TaskRequest.Accept':
+                    $taskHistory = thAccepted;
+                    $taskState = $isReceivedItem ? tdsACC : tdsOWN;
+                    $taskOwner = $isReceivedItem ? olDelegatedTask : olOwnTask;
+                    $taskAcceptanceState = $isReceivedItem ? olTaskDelegationAccepted : olTaskNotDelegated;
+
+                    break;
+
+                case 'IPM.TaskRequest.Decline':
+                    $isCreateAssociatedTask = $isReceivedItem;
+                    $isAllowUpdateAssociatedTask = $isReceivedItem;
+                    $taskHistory = thDeclined;
+                    $taskState = $isReceivedItem ? tdsDEC : tdsACC;
+                    $taskOwner = $isReceivedItem ? olOwnTask : olDelegatedTask;
+                    $taskAcceptanceState = $isReceivedItem ? olTaskDelegationDeclined : olTaskDelegationUnknown;
+
+                    break;
+
+                case 'IPM.TaskRequest.Update':
+                case 'IPM.TaskRequest.Complete':
+                    $taskHistory = thUpdated;
+                    $taskState = $isReceivedItem ? tdsACC : tdsOWN;
+                    $taskAcceptanceState = olTaskNotDelegated;
+                    $taskOwner = $isReceivedItem ? olDelegatedTask : olOwnTask;
+
+                    break;
+            }
+
+            $props = [
+                $this->props['taskhistory'] => $taskHistory,
+                $this->props['taskstate'] => $taskState,
+                $this->props['task_acceptance_state'] => $taskAcceptanceState,
+                $this->props['ownership'] => $taskOwner,
+            ];
+
+            // Get the task for this response
+            $task = $this->getAssociatedTask($isCreateAssociatedTask);
+            if ($task && $isAllowUpdateAssociatedTask) {
+                // To avoid duplication of attachments in associated task. we simple remove the
+                // all attachments from associated task.
+                $taskAttachTable = mapi_message_getattachmenttable($task);
+                $taskAttachments = mapi_table_queryallrows($taskAttachTable, [PR_ATTACH_NUM]);
+                foreach ($taskAttachments as $taskAttach) {
+                    mapi_message_deleteattach($task, $taskAttach[PR_ATTACH_NUM]);
+                }
+
+                $ignoreProps = [
+                    $this->props['taskstate'],
+                    $this->props['taskhistory'],
+                    $this->props['taskmode'],
+                    $this->props['taskfcreator'],
+                ];
+                // Ignore PR_ICON_INDEX when task request response
+                // is not received item.
+                if ($isReceivedItem === false) {
+                    $ignoreProps[] = PR_ICON_INDEX;
+                }
+
+                // We copy all properties except taskstate, taskhistory, taskmode and taskfcreator properties
+                // from $sub message to $task even also we copy all attachments from $sub to $task message.
+                mapi_copyto($sub, [], $ignoreProps, $task);
+                $senderProps = mapi_getprops($this->message, [
+                    PR_SENDER_NAME,
+                    PR_SENDER_EMAIL_ADDRESS,
+                    PR_SENDER_ENTRYID,
+                    PR_SENDER_ADDRTYPE,
+                    PR_SENDER_SEARCH_KEY,
+                    PR_MESSAGE_DELIVERY_TIME,
+                    PR_SENT_REPRESENTING_NAME,
+                    PR_SENT_REPRESENTING_EMAIL_ADDRESS,
+                    PR_SENT_REPRESENTING_ADDRTYPE,
+                    PR_SENT_REPRESENTING_ENTRYID,
+                    PR_SENT_REPRESENTING_SEARCH_KEY, ]);
+
+                mapi_setprops($task, $senderProps);
+
+                // Update taskstate and task history (last action done by the assignee)
+                mapi_setprops($task, $props);
+
+                mapi_savechanges($task);
+            }
+
+            mapi_setprops($this->message, $props);
+            mapi_savechanges($this->message);
+
+            if ($isReceivedItem) {
+                $this->updateSentTaskRequest();
+            }
+
+            return true;
+        }
+
+        /**
+         * Update the sent task request in sent items folder.
+         *
+         * @return bool
+         */
+        public function updateSentTaskRequest() {
+            $props = mapi_getprops($this->message, [
+                $this->props['taskhistory'],
+                $this->props["taskstate"],
+                $this->props["ownership"],
+                $this->props['task_goid'],
+                $this->props['task_acceptance_state'],
+                $this->props["tasklastuser"],
+                $this->props["tasklastdelegate"], ]);
+
+            $store = $this->getDefaultStore();
+            $storeProps = mapi_getprops($store, [PR_IPM_SENTMAIL_ENTRYID]);
+
+            $sentFolder = mapi_msgstore_openentry($store, $storeProps[PR_IPM_SENTMAIL_ENTRYID]);
+            if (!$sentFolder) {
+                return false;
+            }
+
+            // Find the task by looking for the task_goid
+            $restriction = [
+                RES_PROPERTY, [
+                    RELOP => RELOP_EQ,
+                    ULPROPTAG => $this->props['task_goid'],
+                    VALUE => $props[$this->props['task_goid']],
+                ],
+            ];
+
+            $contentsTable = mapi_folder_getcontentstable($sentFolder);
+
+            $rows = mapi_table_queryallrows($contentsTable, [PR_ENTRYID], $restriction);
+
+            if (!empty($rows)) {
+                foreach ($rows as $row) {
+                    $sentTaskRequest = mapi_msgstore_openentry($store, $row[PR_ENTRYID]);
+                    mapi_setprops($sentTaskRequest, $props);
+                    mapi_setprops($sentTaskRequest, [PR_PROCESSED => true]);
+                    mapi_savechanges($sentTaskRequest);
+                }
+            }
+
+            return true;
+        }
+
+        /* Create a new message in the current user's outbox and submit it
 		 *
 		 * Takes the task passed in the constructor as the task to be sent; recipient should
 		 * be pre-existing. The task request will be sent to all recipients.
 		 */
-		public function sendTaskRequest($prefix) {
-			// Generate a TaskGlobalObjectId
-			$taskid = $this->createTGOID();
-			$messageprops = mapi_getprops($this->message, [PR_SUBJECT]);
-
-			// Set properties on Task Request
-			mapi_setprops($this->message, [
-				$this->props['task_goid'] => $taskid, /* our new task_goid */
-				$this->props['taskstate'] => tdsACC,         /* state for our outgoing request */
-				$this->props['taskmode'] => tdmtNothing,     /* we're not sending a change */
-				$this->props['updatecount'] => 2,            /* version 2 (no idea) */
-				$this->props['task_acceptance_state'] => olTaskDelegationUnknown, /* no reply yet */
-				$this->props['ownership'] => olDelegatedTask, /* Task has been assigned */
-				$this->props['taskhistory'] => thAssigned,    /* Task has been assigned */
-				PR_CONVERSATION_TOPIC => $messageprops[PR_SUBJECT],
-				PR_ICON_INDEX => ICON_TASK_ASSIGNER,         /* Task request icon */
-			]);
-			$this->setLastUser();
-			$this->setOwnerForAssignor();
-			mapi_savechanges($this->message);
-
-			// Create outgoing task request message
-			$outgoing = $this->createOutgoingMessage();
-
-			// No need to copy PR_ICON_INDEX and  PR_SENT_* information in to outgoing message.
-			$ignoreProps = [PR_ICON_INDEX, PR_SENT_REPRESENTING_NAME, PR_SENT_REPRESENTING_EMAIL_ADDRESS, PR_SENT_REPRESENTING_ADDRTYPE, PR_SENT_REPRESENTING_ENTRYID, PR_SENT_REPRESENTING_SEARCH_KEY];
-			mapi_copyto($this->message, [], $ignoreProps, $outgoing);
-
-			// Make it a task request, and put it in sent items after it is sent
-			mapi_setprops($outgoing, [
-				PR_MESSAGE_CLASS => "IPM.TaskRequest",         /* class is task request */
-				$this->props['taskstate'] => tdsOWN,         /* for the recipient he is the task owner */
-				$this->props['taskmode'] => tdmtTaskReq,    /* for the recipient it's a request */
-				$this->props['updatecount'] => 1,            /* version 2 is in the attachment */
-				PR_SUBJECT_PREFIX => $prefix,
-				PR_SUBJECT => $prefix . $messageprops[PR_SUBJECT],
-			]);
-
-			$attach = mapi_message_createattach($outgoing);
-			mapi_setprops($attach, [
-				PR_ATTACH_METHOD => ATTACH_EMBEDDED_MSG,
-				PR_ATTACHMENT_HIDDEN => true,
-				PR_DISPLAY_NAME => $messageprops[PR_SUBJECT], ]);
-
-			$sub = mapi_attach_openproperty($attach, PR_ATTACH_DATA_OBJ, IID_IMessage, 0, MAPI_MODIFY | MAPI_CREATE);
-
-			mapi_copyto($this->message, [], [], $sub);
-			mapi_savechanges($sub);
-
-			mapi_savechanges($attach);
-
-			mapi_savechanges($outgoing);
-			mapi_message_submitmessage($outgoing);
-
-			return true;
-		}
-
-		// Assignee functions (called by the assignee)
-
-		/* Update task version counter
+        public function sendTaskRequest($prefix) {
+            // Generate a TaskGlobalObjectId
+            $taskid = $this->createTGOID();
+            $messageprops = mapi_getprops($this->message, [PR_SUBJECT]);
+
+            // Set properties on Task Request
+            mapi_setprops($this->message, [
+                $this->props['task_goid'] => $taskid, /* our new task_goid */
+                $this->props['taskstate'] => tdsACC,         /* state for our outgoing request */
+                $this->props['taskmode'] => tdmtNothing,     /* we're not sending a change */
+                $this->props['updatecount'] => 2,            /* version 2 (no idea) */
+                $this->props['task_acceptance_state'] => olTaskDelegationUnknown, /* no reply yet */
+                $this->props['ownership'] => olDelegatedTask, /* Task has been assigned */
+                $this->props['taskhistory'] => thAssigned,    /* Task has been assigned */
+                PR_CONVERSATION_TOPIC => $messageprops[PR_SUBJECT],
+                PR_ICON_INDEX => ICON_TASK_ASSIGNER,         /* Task request icon */
+            ]);
+            $this->setLastUser();
+            $this->setOwnerForAssignor();
+            mapi_savechanges($this->message);
+
+            // Create outgoing task request message
+            $outgoing = $this->createOutgoingMessage();
+
+            // No need to copy PR_ICON_INDEX and  PR_SENT_* information in to outgoing message.
+            $ignoreProps = [PR_ICON_INDEX, PR_SENT_REPRESENTING_NAME, PR_SENT_REPRESENTING_EMAIL_ADDRESS, PR_SENT_REPRESENTING_ADDRTYPE, PR_SENT_REPRESENTING_ENTRYID, PR_SENT_REPRESENTING_SEARCH_KEY];
+            mapi_copyto($this->message, [], $ignoreProps, $outgoing);
+
+            // Make it a task request, and put it in sent items after it is sent
+            mapi_setprops($outgoing, [
+                PR_MESSAGE_CLASS => "IPM.TaskRequest",         /* class is task request */
+                $this->props['taskstate'] => tdsOWN,         /* for the recipient he is the task owner */
+                $this->props['taskmode'] => tdmtTaskReq,    /* for the recipient it's a request */
+                $this->props['updatecount'] => 1,            /* version 2 is in the attachment */
+                PR_SUBJECT_PREFIX => $prefix,
+                PR_SUBJECT => $prefix . $messageprops[PR_SUBJECT],
+            ]);
+
+            $attach = mapi_message_createattach($outgoing);
+            mapi_setprops($attach, [
+                PR_ATTACH_METHOD => ATTACH_EMBEDDED_MSG,
+                PR_ATTACHMENT_HIDDEN => true,
+                PR_DISPLAY_NAME => $messageprops[PR_SUBJECT], ]);
+
+            $sub = mapi_attach_openproperty($attach, PR_ATTACH_DATA_OBJ, IID_IMessage, 0, MAPI_MODIFY | MAPI_CREATE);
+
+            mapi_copyto($this->message, [], [], $sub);
+            mapi_savechanges($sub);
+
+            mapi_savechanges($attach);
+
+            mapi_savechanges($outgoing);
+            mapi_message_submitmessage($outgoing);
+
+            return true;
+        }
+
+        // Assignee functions (called by the assignee)
+
+        /* Update task version counter
 		 *
 		 * Must be called before each update to increase counter
 		 */
-		public function updateTaskRequest() {
-			$messageprops = mapi_getprops($this->message, [$this->props['updatecount']]);
+        public function updateTaskRequest() {
+            $messageprops = mapi_getprops($this->message, [$this->props['updatecount']]);
 
-			if (isset($messageprops)) {
-				++$messageprops[$this->props['updatecount']];
-			}
-			else {
-				$messageprops[$this->props['updatecount']] = 1;
-			}
+            if (isset($messageprops)) {
+                ++$messageprops[$this->props['updatecount']];
+            }
+            else {
+                $messageprops[$this->props['updatecount']] = 1;
+            }
 
-			mapi_setprops($this->message, $messageprops);
-		}
+            mapi_setprops($this->message, $messageprops);
+        }
 
-		/* Process a task request
+        /* Process a task request
 		 *
 		 * Message passed should be an IPM.TaskRequest message. The task request is then processed to create
 		 * the task in the tasks folder if needed.
 		 */
-		public function processTaskRequest() {
-			if (!$this->isTaskRequest()) {
-				return false;
-			}
-			$messageProps = mapi_getprops($this->message, [PR_PROCESSED, $this->props["taskupdates"], PR_MESSAGE_TO_ME]);
-			if (isset($messageProps[PR_PROCESSED]) && $messageProps[PR_PROCESSED]) {
-				return true;
-			}
-
-			// if task is updated in task folder then we don't need to process
-			// old request.
-			if ($this->isTaskRequestUpdated()) {
-				return true;
-			}
-
-			$isReceivedItem = $this->isReceivedItem($messageProps);
-
-			$props = [];
-			$props[PR_PROCESSED] = true;
-			$props[$this->props["taskstate"]] = $isReceivedItem ? tdsOWN : tdsACC;
-			$props[$this->props["ownership"]] = $isReceivedItem ? olOwnTask : olDelegatedTask;
-
-			mapi_setprops($this->message, $props);
-			mapi_savechanges($this->message);
-
-			// Don't create associated task in task folder if "taskupdates" is not true.
-			if (!$isReceivedItem && !$messageProps[$this->props["taskupdates"]]) {
-				return true;
-			}
-			// create an associated task in task folder while
-			// reading/loading task request on client side.
-			$task = $this->getAssociatedTask(true);
-			$taskProps = mapi_getprops($task, [$this->props['taskmultrecips']]);
-			$taskProps[$this->props["taskstate"]] = $isReceivedItem ? tdsOWN : tdsACC;
-			$taskProps[$this->props["taskhistory"]] = thAssigned;
-			$taskProps[$this->props["taskmode"]] = tdmtNothing;
-			$taskProps[$this->props["taskaccepted"]] = false;
-			$taskProps[$this->props["taskfcreator"]] = false;
-			$taskProps[$this->props["ownership"]] = $isReceivedItem ? olOwnTask : olDelegatedTask;
-			$taskProps[$this->props["task_acceptance_state"]] = olTaskNotDelegated;
-			$taskProps[PR_ICON_INDEX] = ICON_TASK_ASSIGNEE;
-
-			mapi_setprops($task, $taskProps);
-			$this->setAssignorInRecipients($task);
-
-			mapi_savechanges($task);
-
-			return true;
-		}
-
-		/**
-		 * Accept a task request and send the response.
-		 *
-		 * Message passed should be an IPM.Task (eg the task from getAssociatedTask())
-		 *
-		 * Copies the task to the user's task folder, sets it to accepted, and sends the acceptation
-		 * message back to the organizer. The caller is responsible for removing the message.
-		 *
-		 * @return entryid EntryID of the accepted task
-		 */
-		public function doAccept() {
-			$prefix = _("Task Accepted:") . " ";
-			$messageProps = mapi_getprops($this->message, [PR_MESSAGE_CLASS, $this->props['taskstate']]);
-
-			if (!isset($messageProps[$this->props['taskstate']]) || $messageProps[$this->props['taskstate']] != tdsOWN) {
-				// Can only accept assignee task
-				return false;
-			}
-
-			$this->setLastUser();
-			$this->updateTaskRequest();
-
-			$props = [
-				$this->props['taskhistory'] => thAccepted,
-				$this->props['task_assigned_time'] => time(),
-				$this->props['taskaccepted'] => true,
-				$this->props['task_acceptance_state'] => olTaskNotDelegated, ];
-
-			// Message is TaskRequest then update the associated task as well.
-			if ($this->isTaskRequest($messageProps[PR_MESSAGE_CLASS])) {
-				$task = $this->getAssociatedTask(false);
-				if ($task) {
-					mapi_setprops($task, $props);
-					mapi_savechanges($task);
-				}
-			}
-
-			// Set as accepted
-			mapi_setprops($this->message, $props);
-
-			// As we copy the all properties from received message we need to remove following
-			// properties from accept response.
-			mapi_deleteprops($this->message, [PR_MESSAGE_RECIP_ME, PR_MESSAGE_TO_ME, PR_MESSAGE_CC_ME, PR_PROCESSED]);
-
-			mapi_savechanges($this->message);
-
-			$this->sendResponse(tdmtTaskAcc, $prefix);
-
-			return $this->deleteReceivedTR();
-		}
-
-		/* Decline a task request and send the response.
+        public function processTaskRequest() {
+            if (!$this->isTaskRequest()) {
+                return false;
+            }
+            $messageProps = mapi_getprops($this->message, [PR_PROCESSED, $this->props["taskupdates"], PR_MESSAGE_TO_ME]);
+            if (isset($messageProps[PR_PROCESSED]) && $messageProps[PR_PROCESSED]) {
+                return true;
+            }
+
+            // if task is updated in task folder then we don't need to process
+            // old request.
+            if ($this->isTaskRequestUpdated()) {
+                return true;
+            }
+
+            $isReceivedItem = $this->isReceivedItem($messageProps);
+
+            $props = [];
+            $props[PR_PROCESSED] = true;
+            $props[$this->props["taskstate"]] = $isReceivedItem ? tdsOWN : tdsACC;
+            $props[$this->props["ownership"]] = $isReceivedItem ? olOwnTask : olDelegatedTask;
+
+            mapi_setprops($this->message, $props);
+            mapi_savechanges($this->message);
+
+            // Don't create associated task in task folder if "taskupdates" is not true.
+            if (!$isReceivedItem && !$messageProps[$this->props["taskupdates"]]) {
+                return true;
+            }
+            // create an associated task in task folder while
+            // reading/loading task request on client side.
+            $task = $this->getAssociatedTask(true);
+            $taskProps = mapi_getprops($task, [$this->props['taskmultrecips']]);
+            $taskProps[$this->props["taskstate"]] = $isReceivedItem ? tdsOWN : tdsACC;
+            $taskProps[$this->props["taskhistory"]] = thAssigned;
+            $taskProps[$this->props["taskmode"]] = tdmtNothing;
+            $taskProps[$this->props["taskaccepted"]] = false;
+            $taskProps[$this->props["taskfcreator"]] = false;
+            $taskProps[$this->props["ownership"]] = $isReceivedItem ? olOwnTask : olDelegatedTask;
+            $taskProps[$this->props["task_acceptance_state"]] = olTaskNotDelegated;
+            $taskProps[PR_ICON_INDEX] = ICON_TASK_ASSIGNEE;
+
+            mapi_setprops($task, $taskProps);
+            $this->setAssignorInRecipients($task);
+
+            mapi_savechanges($task);
+
+            return true;
+        }
+
+        /**
+         * Accept a task request and send the response.
+         *
+         * Message passed should be an IPM.Task (eg the task from getAssociatedTask())
+         *
+         * Copies the task to the user's task folder, sets it to accepted, and sends the acceptation
+         * message back to the organizer. The caller is responsible for removing the message.
+         *
+         * @return entryid EntryID of the accepted task
+         */
+        public function doAccept() {
+            $prefix = _("Task Accepted:") . " ";
+            $messageProps = mapi_getprops($this->message, [PR_MESSAGE_CLASS, $this->props['taskstate']]);
+
+            if (!isset($messageProps[$this->props['taskstate']]) || $messageProps[$this->props['taskstate']] != tdsOWN) {
+                // Can only accept assignee task
+                return false;
+            }
+
+            $this->setLastUser();
+            $this->updateTaskRequest();
+
+            $props = [
+                $this->props['taskhistory'] => thAccepted,
+                $this->props['task_assigned_time'] => time(),
+                $this->props['taskaccepted'] => true,
+                $this->props['task_acceptance_state'] => olTaskNotDelegated, ];
+
+            // Message is TaskRequest then update the associated task as well.
+            if ($this->isTaskRequest($messageProps[PR_MESSAGE_CLASS])) {
+                $task = $this->getAssociatedTask(false);
+                if ($task) {
+                    mapi_setprops($task, $props);
+                    mapi_savechanges($task);
+                }
+            }
+
+            // Set as accepted
+            mapi_setprops($this->message, $props);
+
+            // As we copy the all properties from received message we need to remove following
+            // properties from accept response.
+            mapi_deleteprops($this->message, [PR_MESSAGE_RECIP_ME, PR_MESSAGE_TO_ME, PR_MESSAGE_CC_ME, PR_PROCESSED]);
+
+            mapi_savechanges($this->message);
+
+            $this->sendResponse(tdmtTaskAcc, $prefix);
+
+            return $this->deleteReceivedTR();
+        }
+
+        /* Decline a task request and send the response.
 		 *
 		 * Passed message must be a task request message, ie isTaskRequest() must return TRUE.
 		 *
@@ -697,591 +697,591 @@ 
 		 *
 		 * @return boolean TRUE on success, FALSE on failure
 		 */
-		public function doDecline() {
-			$prefix = _("Task Declined:") . " ";
-			$messageProps = mapi_getprops($this->message, [$this->props['taskstate']]);
-
-			if (!isset($messageProps[$this->props['taskstate']]) || $messageProps[$this->props['taskstate']] != tdsOWN) {
-				return false; // Can only decline assignee task
-			}
-
-			$this->setLastUser();
-			$this->updateTaskRequest();
-
-			// Set as declined
-			mapi_setprops($this->message, [
-				$this->props['taskhistory'] => thDeclined,
-				$this->props['task_acceptance_state'] => olTaskDelegationDeclined,
-			]);
-			mapi_deleteprops($this->message, [PR_MESSAGE_RECIP_ME, PR_MESSAGE_TO_ME, PR_MESSAGE_CC_ME, PR_PROCESSED]);
-			mapi_savechanges($this->message);
-
-			$this->sendResponse(tdmtTaskDec, $prefix);
-
-			// Delete the associated task when task request is declined by the assignee.
-			$task = $this->getAssociatedTask(false);
-			if ($task) {
-				$taskFolder = $this->getDefaultTasksFolder();
-				$props = mapi_getprops($task, [PR_ENTRYID]);
-				mapi_folder_deletemessages($taskFolder, [$props[PR_ENTRYID]]);
-			}
-
-			return $this->deleteReceivedTR();
-		}
-
-		/**
-		 * Send an update of the task if requested, and send the Status-On-Completion report if complete and requested.
-		 *
-		 * If no updates were requested from the organizer, this function does nothing.
-		 *
-		 * @return bool TRUE if the update succeeded, FALSE otherwise
-		 */
-		public function doUpdate() {
-			$messageProps = mapi_getprops($this->message, [$this->props['taskstate'], PR_SUBJECT]);
-
-			if (!isset($messageProps[$this->props['taskstate']]) || $messageProps[$this->props['taskstate']] != tdsOWN) {
-				return false; // Can only update assignee task
-			}
-
-			$this->setLastUser();
-			$this->updateTaskRequest();
-
-			// Set as updated
-			mapi_setprops($this->message, [$this->props['taskhistory'] => thUpdated]);
-
-			mapi_savechanges($this->message);
-
-			$props = mapi_getprops($this->message, [$this->props['taskupdates'], $this->props['tasksoc'], $this->props['recurring'], $this->props['complete']]);
-			if (!$props[$this->props['complete']] && $props[$this->props['taskupdates']] && !(isset($props[$this->props['recurring']]) && $props[$this->props['recurring']])) {
-				$this->sendResponse(tdmtTaskUpd, _("Task Updated:") . " ");
-			}
-			elseif ($props[$this->props['complete']]) {
-				$this->sendResponse(tdmtTaskUpd, _("Task Completed:") . " ");
-			}
-
-			return true;
-		}
-
-		/**
-		 * Get the store associated with the task.
-		 *
-		 * Normally this will just open the store that the processed message is in. However, if the message is opened
-		 * by a delegate, this function opens the store that the message was delegated from.
-		 */
-		public function getTaskFolderStore() {
-			$ownerentryid = false;
-
-			$rcvdprops = mapi_getprops($this->message, [PR_RCVD_REPRESENTING_ENTRYID]);
-			if (isset($rcvdprops[PR_RCVD_REPRESENTING_ENTRYID])) {
-				$ownerentryid = $rcvdprops;
-			}
-
-			if (!$ownerentryid) {
-				$store = $this->store;
-			}
-			else {
-				$ab = mapi_openaddressbook($this->session);
-				if (!$ab) {
-					return false;
-				}
-
-				$mailuser = mapi_ab_openentry($ab, $ownerentryid);
-				if (!$mailuser) {
-					return false;
-				}
-
-				$mailuserprops = mapi_getprops($mailuser, [PR_EMAIL_ADDRESS]);
-				if (!isset($mailuserprops[PR_EMAIL_ADDRESS])) {
-					return false;
-				}
-
-				$storeid = mapi_msgstore_createentryid($this->store, $mailuserprops[PR_EMAIL_ADDRESS]);
-
-				$store = mapi_openmsgstore($this->session, $storeid);
-			}
-
-			return $store;
-		}
-
-		/**
-		 * Open the default task folder for the current user, or the specified user if passed.
-		 */
-		public function getDefaultTasksFolder() {
-			$store = $this->getTaskFolderStore();
-
-			$inbox = mapi_msgstore_getreceivefolder($store);
-			$inboxprops = mapi_getprops($inbox, [PR_IPM_TASK_ENTRYID]);
-			if (!isset($inboxprops[PR_IPM_TASK_ENTRYID])) {
-				return false;
-			}
-
-			return mapi_msgstore_openentry($store, $inboxprops[PR_IPM_TASK_ENTRYID]);
-		}
-
-		/**
-		 * Function prepare the sent representing properties from given MAPI store.
-		 *
-		 * @param $store MAPI store object
-		 *
-		 * @return array|bool if store is not mail box owner entryid then
-		 *                    return false else prepare the sent representing props and return it
-		 */
-		public function getSentReprProps($store) {
-			$storeprops = mapi_getprops($store, [PR_MAILBOX_OWNER_ENTRYID]);
-			if (!isset($storeprops[PR_MAILBOX_OWNER_ENTRYID])) {
-				return false;
-			}
-
-			$ab = mapi_openaddressbook($this->session);
-			$mailuser = mapi_ab_openentry($ab, $storeprops[PR_MAILBOX_OWNER_ENTRYID]);
-			$mailuserprops = mapi_getprops($mailuser, [PR_ADDRTYPE, PR_EMAIL_ADDRESS, PR_DISPLAY_NAME, PR_SEARCH_KEY, PR_ENTRYID]);
-
-			$props = [];
-			$props[PR_SENT_REPRESENTING_ADDRTYPE] = $mailuserprops[PR_ADDRTYPE];
-			$props[PR_SENT_REPRESENTING_EMAIL_ADDRESS] = $mailuserprops[PR_EMAIL_ADDRESS];
-			$props[PR_SENT_REPRESENTING_NAME] = $mailuserprops[PR_DISPLAY_NAME];
-			$props[PR_SENT_REPRESENTING_SEARCH_KEY] = $mailuserprops[PR_SEARCH_KEY];
-			$props[PR_SENT_REPRESENTING_ENTRYID] = $mailuserprops[PR_ENTRYID];
-
-			return $props;
-		}
-
-		/**
-		 * Creates an outgoing message based on the passed message - will set delegate information
-		 * and sent mail folder.
-		 */
-		public function createOutgoingMessage() {
-			// Open our default store for this user (that's the only store we can submit in)
-			$store = $this->getDefaultStore();
-			$storeprops = mapi_getprops($store, [PR_IPM_OUTBOX_ENTRYID, PR_IPM_SENTMAIL_ENTRYID]);
-
-			$outbox = mapi_msgstore_openentry($store, $storeprops[PR_IPM_OUTBOX_ENTRYID]);
-			if (!$outbox) {
-				return false;
-			}
-
-			$outgoing = mapi_folder_createmessage($outbox);
-			if (!$outgoing) {
-				return false;
-			}
-
-			// Set SENT_REPRESENTING in case we're sending as a delegate
-			$ownerstore = $this->getTaskFolderStore();
-			$sentreprprops = $this->getSentReprProps($ownerstore);
-			mapi_setprops($outgoing, $sentreprprops);
-
-			mapi_setprops($outgoing, [PR_SENTMAIL_ENTRYID => $storeprops[PR_IPM_SENTMAIL_ENTRYID]]);
-
-			return $outgoing;
-		}
-
-		/**
-		 * Send a response message (from assignee back to organizer).
-		 *
-		 * @param $type int Type of response (tdmtTaskAcc, tdmtTaskDec, tdmtTaskUpd);
-		 * @param mixed $prefix
-		 *
-		 * @return bool TRUE on success
-		 */
-		public function sendResponse($type, $prefix) {
-			// Create a message in our outbox
-			$outgoing = $this->createOutgoingMessage();
-			$messageprops = mapi_getprops($this->message, [PR_CONVERSATION_TOPIC, PR_MESSAGE_CLASS, $this->props['complete']]);
-
-			$attach = mapi_message_createattach($outgoing);
-			mapi_setprops($attach, [PR_ATTACH_METHOD => ATTACH_EMBEDDED_MSG, PR_DISPLAY_NAME => $messageprops[PR_CONVERSATION_TOPIC], PR_ATTACHMENT_HIDDEN => true]);
-			$sub = mapi_attach_openproperty($attach, PR_ATTACH_DATA_OBJ, IID_IMessage, 0, MAPI_CREATE | MAPI_MODIFY);
-
-			$message = !$this->isTaskRequest() ? $this->message : $this->getAssociatedTask(false);
-
-			$ignoreProps = [PR_ICON_INDEX, $this->props["categories"], PR_SENT_REPRESENTING_NAME, PR_SENT_REPRESENTING_EMAIL_ADDRESS, PR_SENT_REPRESENTING_ADDRTYPE, PR_SENT_REPRESENTING_ENTRYID, PR_SENT_REPRESENTING_SEARCH_KEY];
-
-			mapi_copyto($message, [], $ignoreProps, $outgoing);
-			mapi_copyto($message, [], [], $sub);
-
-			if (!$this->setRecipientsForResponse($outgoing, $type)) {
-				return false;
-			}
-
-			$props = [];
-
-			switch ($type) {
-				case tdmtTaskAcc:
-					$props[PR_MESSAGE_CLASS] = "IPM.TaskRequest.Accept";
-					mapi_setprops($sub, [PR_ICON_INDEX => ICON_TASK_ASSIGNER]);
-
-					break;
-
-				case tdmtTaskDec:
-					$props[PR_MESSAGE_CLASS] = "IPM.TaskRequest.Decline";
-					mapi_setprops($sub, [PR_ICON_INDEX => ICON_TASK_DECLINE]);
-
-					break;
-
-				case tdmtTaskUpd:
-					mapi_setprops($sub, [PR_ICON_INDEX => ICON_TASK_ASSIGNER]);
-					if ($messageprops[$this->props['complete']]) {
-						$props[PR_MESSAGE_CLASS] = "IPM.TaskRequest.Complete";
-					}
-					else {
-						$props[PR_MESSAGE_CLASS] = "IPM.TaskRequest.Update";
-					}
-
-					break;
-			}
-
-			mapi_savechanges($sub);
-			mapi_savechanges($attach);
-
-			$props[PR_SUBJECT] = $prefix . $messageprops[PR_CONVERSATION_TOPIC];
-			$props[$this->props['taskmode']] = $type;
-			$props[$this->props['task_assigned_time']] = time();
-
-			mapi_setprops($outgoing, $props);
-
-			// taskCommentsInfo contains some comments which added by assignee while
-			// edit response before sending task response.
-			if ($this->taskCommentsInfo) {
-				$comments = $this->getTaskCommentsInfo();
-				$stream = mapi_openproperty($outgoing, PR_BODY, IID_IStream, STGM_TRANSACTED, MAPI_CREATE | MAPI_MODIFY);
-				mapi_stream_setsize($stream, strlen($comments));
-				mapi_stream_write($stream, $comments);
-				mapi_stream_commit($stream);
-			}
-
-			mapi_savechanges($outgoing);
-			mapi_message_submitmessage($outgoing);
-
-			return true;
-		}
-
-		public function getDefaultStore() {
-			$table = mapi_getmsgstorestable($this->session);
-			$rows = mapi_table_queryallrows($table, [PR_DEFAULT_STORE, PR_ENTRYID]);
-
-			foreach ($rows as $row) {
-				if ($row[PR_DEFAULT_STORE]) {
-					return mapi_openmsgstore($this->session, $row[PR_ENTRYID]);
-				}
-			}
-
-			return false;
-		}
-
-		/**
-		 * Creates a new TaskGlobalObjId.
-		 *
-		 * Just 16 bytes of random data
-		 */
-		public function createTGOID() {
-			$goid = "";
-			for ($i = 0; $i < 16; ++$i) {
-				$goid .= chr(rand(0, 255));
-			}
-
-			return $goid;
-		}
-
-		/**
-		 * Function used to get the embedded task of task request. Which further used to
-		 * Create/Update associated task of assigner/assignee.
-		 *
-		 * @param object $message which contains embedded task
-		 *
-		 * @return false|object $task if found embedded task else false
-		 */
-		public function getEmbeddedTask($message) {
-			$task = false;
-			$goid = mapi_getprops($message, [$this->props["task_goid"]]);
-			$attachmentTable = mapi_message_getattachmenttable($message);
-			$restriction = [
-				RES_PROPERTY,
-				[
-					RELOP => RELOP_EQ,
-					ULPROPTAG => PR_ATTACH_METHOD,
-					VALUE => ATTACH_EMBEDDED_MSG, ],
-			];
-			$rows = mapi_table_queryallrows($attachmentTable, [PR_ATTACH_NUM], $restriction);
-
-			if (empty($rows)) {
-				return $task;
-			}
-
-			foreach ($rows as $row) {
-				try {
-					$attach = mapi_message_openattach($message, $row[PR_ATTACH_NUM]);
-					$task = mapi_attach_openobj($attach);
-				}
-				catch (MAPIException $e) {
-					continue;
-				}
-
-				$taskGoid = mapi_getprops($task, [$this->props["task_goid"]]);
-				if ($goid[$this->props["task_goid"]] === $taskGoid[$this->props["task_goid"]]) {
-					mapi_setprops($attach, [PR_ATTACHMENT_HIDDEN => true]);
-					mapi_savechanges($attach);
-					mapi_savechanges($message);
-
-					break;
-				}
-			}
-
-			return $task;
-		}
-
-		/**
-		 * Function was used to set the user name who has last used this task also it was
-		 * update the  tasklastdelegate and task_assigned_time.
-		 */
-		public function setLastUser() {
-			$delegatestore = $this->getDefaultStore();
-			$taskstore = $this->getTaskFolderStore();
-
-			$delegateprops = mapi_getprops($delegatestore, [PR_MAILBOX_OWNER_NAME]);
-			$taskprops = mapi_getprops($taskstore, [PR_MAILBOX_OWNER_NAME]);
-
-			// The owner of the task
-			$username = $delegateprops[PR_MAILBOX_OWNER_NAME];
-			// This is me (the one calling the script)
-			$delegate = $taskprops[PR_MAILBOX_OWNER_NAME];
-
-			if ($this->isTaskRequest()) {
-				$task = $this->getAssociatedTask(false);
-				mapi_setprops($task, [$this->props["tasklastuser"] => $username, $this->props["tasklastdelegate"] => $delegate, $this->props['task_assigned_time'] => time()]);
-				mapi_savechanges($task);
-			}
-			mapi_setprops($this->message, [$this->props["tasklastuser"] => $username, $this->props["tasklastdelegate"] => $delegate, $this->props['task_assigned_time'] => time()]);
-		}
-
-		/**
-		 * Assignee becomes the owner when a user/assignor assigns any task to someone. Also there can be more than one assignee.
-		 * This function sets assignee as owner in the assignor's copy of task.
-		 */
-		public function setOwnerForAssignor() {
-			$recipTable = mapi_message_getrecipienttable($this->message);
-			$recips = mapi_table_queryallrows($recipTable, [PR_DISPLAY_NAME]);
-
-			if (!empty($recips)) {
-				$owner = [];
-				foreach ($recips as $value) {
-					$owner[] = $value[PR_DISPLAY_NAME];
-				}
-
-				$props = [$this->props['owner'] => implode("; ", $owner)];
-				mapi_setprops($this->message, $props);
-			}
-		}
-
-		/**
-		 * Sets assignor as recipients in assignee's copy of task.
-		 *
-		 * If assignor has requested task updates then the assignor is added as recipient type MAPI_CC.
-		 *
-		 * Also if assignor has request SOC then the assignor is also add as recipient type MAPI_BCC
-		 *
-		 * @param $task message MAPI message which assignee's copy of task
-		 */
-		public function setAssignorInRecipients($task) {
-			$recipTable = mapi_message_getrecipienttable($task);
-
-			// Delete all MAPI_TO recipients
-			$recips = mapi_table_queryallrows($recipTable, [PR_ROWID], [
-				RES_PROPERTY,
-				[
-					RELOP => RELOP_EQ,
-					ULPROPTAG => PR_RECIPIENT_TYPE,
-					VALUE => MAPI_TO,
-				], ]);
-			foreach ($recips as $recip) {
-				mapi_message_modifyrecipients($task, MODRECIP_REMOVE, [$recip]);
-			}
-
-			$recips = [];
-			$taskReqProps = mapi_getprops($this->message, [PR_SENT_REPRESENTING_NAME, PR_SENT_REPRESENTING_EMAIL_ADDRESS, PR_SENT_REPRESENTING_ENTRYID, PR_SENT_REPRESENTING_ADDRTYPE, PR_SENT_REPRESENTING_SEARCH_KEY]);
-			$associatedTaskProps = mapi_getprops($task, [$this->props['taskupdates'], $this->props['tasksoc'], $this->props['taskmultrecips']]);
-
-			// Build assignor info
-			$assignor = [
-				PR_ENTRYID => $taskReqProps[PR_SENT_REPRESENTING_ENTRYID],
-				PR_DISPLAY_NAME => $taskReqProps[PR_SENT_REPRESENTING_NAME],
-				PR_EMAIL_ADDRESS => $taskReqProps[PR_SENT_REPRESENTING_EMAIL_ADDRESS],
-				PR_RECIPIENT_DISPLAY_NAME => $taskReqProps[PR_SENT_REPRESENTING_NAME],
-				PR_ADDRTYPE => empty($taskReqProps[PR_SENT_REPRESENTING_ADDRTYPE]) ? 'SMTP' : $taskReqProps[PR_SENT_REPRESENTING_ADDRTYPE],
-				PR_RECIPIENT_FLAGS => recipSendable,
-				PR_SEARCH_KEY => $taskReqProps[PR_SENT_REPRESENTING_SEARCH_KEY],
-			];
-
-			// Assignor has requested task updates, so set him/her as MAPI_CC in recipienttable.
-			if ((isset($associatedTaskProps[$this->props['taskupdates']]) && $associatedTaskProps[$this->props['taskupdates']]) &&
-				!(isset($associatedTaskProps[$this->props['taskmultrecips']]) && $associatedTaskProps[$this->props['taskmultrecips']] == tmrReceived)) {
-				$assignor[PR_RECIPIENT_TYPE] = MAPI_CC;
-				$recips[] = $assignor;
-			}
-
-			// Assignor wants to receive an email report when task is mark as 'Complete', so in recipients as MAPI_BCC
-			if ($associatedTaskProps[$this->props['tasksoc']]) {
-				$assignor[PR_RECIPIENT_TYPE] = MAPI_BCC;
-				$recips[] = $assignor;
-			}
-
-			if (!empty($recips)) {
-				mapi_message_modifyrecipients($task, MODRECIP_ADD, $recips);
-			}
-		}
-
-		/**
-		 * Deletes incoming task request from Inbox.
-		 *
-		 * @returns array returns PR_ENTRYID, PR_STORE_ENTRYID and PR_PARENT_ENTRYID of the deleted task request
-		 */
-		public function deleteReceivedTR() {
-			$store = $this->getTaskFolderStore();
-			$storeType = mapi_getprops($store, [PR_MDB_PROVIDER]);
-			if ($storeType[PR_MDB_PROVIDER] === ZARAFA_STORE_PUBLIC_GUID) {
-				$store = $this->getDefaultStore();
-			}
-			$inbox = mapi_msgstore_getreceivefolder($store);
-
-			$storeProps = mapi_getprops($store, [PR_IPM_WASTEBASKET_ENTRYID]);
-			$props = mapi_getprops($this->message, [$this->props['task_goid']]);
-			$goid = $props[$this->props['task_goid']];
-
-			// Find the task by looking for the task_goid
-			$restriction = [
-				RES_PROPERTY,
-				[
-					RELOP => RELOP_EQ,
-					ULPROPTAG => $this->props['task_goid'],
-					VALUE => $goid, ],
-			];
-
-			$contents = mapi_folder_getcontentstable($inbox);
-
-			$rows = mapi_table_queryallrows($contents, [PR_ENTRYID, PR_PARENT_ENTRYID, PR_STORE_ENTRYID], $restriction);
-
-			if (!empty($rows)) {
-				// If there are multiple, just use the first
-				$entryid = $rows[0][PR_ENTRYID];
-				$wastebasket = mapi_msgstore_openentry($store, $storeProps[PR_IPM_WASTEBASKET_ENTRYID]);
-				mapi_folder_copymessages($inbox, [$entryid], $wastebasket, MESSAGE_MOVE);
-
-				return [PR_ENTRYID => $entryid, PR_PARENT_ENTRYID => $rows[0][PR_PARENT_ENTRYID], PR_STORE_ENTRYID => $rows[0][PR_STORE_ENTRYID]];
-			}
-
-			return false;
-		}
-
-		/**
-		 * Sets recipients for the outgoing message according to type of the response.
-		 *
-		 * If it is a task update, then only recipient type MAPI_CC are taken from the task message.
-		 *
-		 * If it is accept/decline response, then PR_SENT_REPRESENTATING_XXXX are taken as recipient.
-		 *
-		 *@param $outgoing MAPI_message outgoing mapi message
-		 *@param $responseType String response type
-		 */
-		public function setRecipientsForResponse($outgoing, $responseType) {
-			// Clear recipients from outgoing msg
-			$this->deleteAllRecipients($outgoing);
-
-			// If it is a task update then get MAPI_CC recipients which are assignors who has asked for task update.
-			if ($responseType == tdmtTaskUpd) {
-				$props = mapi_getprops($this->message, [$this->props['complete']]);
-				$isComplete = $props[$this->props['complete']];
-
-				$recipTable = mapi_message_getrecipienttable($this->message);
-				$recips = mapi_table_queryallrows($recipTable, $this->recipProps, [
-					RES_PROPERTY,
-					[
-						RELOP => RELOP_EQ,
-						ULPROPTAG => PR_RECIPIENT_TYPE,
-						VALUE => ($isComplete ? MAPI_BCC : MAPI_CC),
-					],
-				]);
-
-				// No recipients found, return error
-				if (empty($recips)) {
-					return false;
-				}
-
-				foreach ($recips as $recip) {
-					$recip[PR_RECIPIENT_TYPE] = MAPI_TO;    // Change recipient type to MAPI_TO
-					mapi_message_modifyrecipients($outgoing, MODRECIP_ADD, [$recip]);
-				}
-
-				return true;
-			}
-
-			$orgprops = mapi_getprops($this->message, [PR_SENT_REPRESENTING_NAME, PR_SENT_REPRESENTING_EMAIL_ADDRESS, PR_SENT_REPRESENTING_ADDRTYPE, PR_SENT_REPRESENTING_ENTRYID, PR_SUBJECT]);
-			$recip = [
-				PR_DISPLAY_NAME => $orgprops[PR_SENT_REPRESENTING_NAME],
-				PR_EMAIL_ADDRESS => $orgprops[PR_SENT_REPRESENTING_EMAIL_ADDRESS],
-				PR_ADDRTYPE => $orgprops[PR_SENT_REPRESENTING_ADDRTYPE],
-				PR_ENTRYID => $orgprops[PR_SENT_REPRESENTING_ENTRYID],
-				PR_RECIPIENT_TYPE => MAPI_TO, ];
-
-			mapi_message_modifyrecipients($outgoing, MODRECIP_ADD, [$recip]);
-
-			return true;
-		}
-
-		/**
-		 * Deletes all recipients from given message object.
-		 *
-		 * @param $message MAPI message from which recipients are to be removed
-		 */
-		public function deleteAllRecipients($message) {
-			$recipTable = mapi_message_getrecipienttable($message);
-			$recipRows = mapi_table_queryallrows($recipTable, [PR_ROWID]);
-
-			foreach ($recipRows as $recipient) {
-				mapi_message_modifyrecipients($message, MODRECIP_REMOVE, [$recipient]);
-			}
-		}
-
-		/**
-		 * Function used to mark the record to complete and send complete update
-		 * notification to assigner.
-		 *
-		 * @return bool TRUE if the update succeeded, FALSE otherwise
-		 */
-		public function sendCompleteUpdate() {
-			$messageprops = mapi_getprops($this->message, [$this->props['taskstate']]);
-
-			if (!isset($messageprops[$this->props['taskstate']]) || $messageprops[$this->props['taskstate']] != tdsOWN) {
-				return false; // Can only decline assignee task
-			}
-
-			mapi_setprops(
-				$this->message,
-				[
-					$this->props['complete'] => true,
-					$this->props['datecompleted'] => time(),
-					$this->props['status'] => 2,
-					$this->props['percent_complete'] => 1, ]
-			);
-
-			return $this->doUpdate();
-		}
-
-		/**
-		 * Function returns extra info about task request comments along with message body
-		 * which will be included in body while sending task request/response.
-		 *
-		 * @return string info about task request comments along with message body
-		 */
-		public function getTaskCommentsInfo() {
-			return $this->taskCommentsInfo;
-		}
-
-		/**
-		 * Function sets extra info about task request comments along with message body
-		 * which will be included in body while sending task request/response.
-		 *
-		 * @param string $taskCommentsInfo info about task request comments along with message body
-		 */
-		public function setTaskCommentsInfo($taskCommentsInfo) {
-			$this->taskCommentsInfo = $taskCommentsInfo;
-		}
-	}
+        public function doDecline() {
+            $prefix = _("Task Declined:") . " ";
+            $messageProps = mapi_getprops($this->message, [$this->props['taskstate']]);
+
+            if (!isset($messageProps[$this->props['taskstate']]) || $messageProps[$this->props['taskstate']] != tdsOWN) {
+                return false; // Can only decline assignee task
+            }
+
+            $this->setLastUser();
+            $this->updateTaskRequest();
+
+            // Set as declined
+            mapi_setprops($this->message, [
+                $this->props['taskhistory'] => thDeclined,
+                $this->props['task_acceptance_state'] => olTaskDelegationDeclined,
+            ]);
+            mapi_deleteprops($this->message, [PR_MESSAGE_RECIP_ME, PR_MESSAGE_TO_ME, PR_MESSAGE_CC_ME, PR_PROCESSED]);
+            mapi_savechanges($this->message);
+
+            $this->sendResponse(tdmtTaskDec, $prefix);
+
+            // Delete the associated task when task request is declined by the assignee.
+            $task = $this->getAssociatedTask(false);
+            if ($task) {
+                $taskFolder = $this->getDefaultTasksFolder();
+                $props = mapi_getprops($task, [PR_ENTRYID]);
+                mapi_folder_deletemessages($taskFolder, [$props[PR_ENTRYID]]);
+            }
+
+            return $this->deleteReceivedTR();
+        }
+
+        /**
+         * Send an update of the task if requested, and send the Status-On-Completion report if complete and requested.
+         *
+         * If no updates were requested from the organizer, this function does nothing.
+         *
+         * @return bool TRUE if the update succeeded, FALSE otherwise
+         */
+        public function doUpdate() {
+            $messageProps = mapi_getprops($this->message, [$this->props['taskstate'], PR_SUBJECT]);
+
+            if (!isset($messageProps[$this->props['taskstate']]) || $messageProps[$this->props['taskstate']] != tdsOWN) {
+                return false; // Can only update assignee task
+            }
+
+            $this->setLastUser();
+            $this->updateTaskRequest();
+
+            // Set as updated
+            mapi_setprops($this->message, [$this->props['taskhistory'] => thUpdated]);
+
+            mapi_savechanges($this->message);
+
+            $props = mapi_getprops($this->message, [$this->props['taskupdates'], $this->props['tasksoc'], $this->props['recurring'], $this->props['complete']]);
+            if (!$props[$this->props['complete']] && $props[$this->props['taskupdates']] && !(isset($props[$this->props['recurring']]) && $props[$this->props['recurring']])) {
+                $this->sendResponse(tdmtTaskUpd, _("Task Updated:") . " ");
+            }
+            elseif ($props[$this->props['complete']]) {
+                $this->sendResponse(tdmtTaskUpd, _("Task Completed:") . " ");
+            }
+
+            return true;
+        }
+
+        /**
+         * Get the store associated with the task.
+         *
+         * Normally this will just open the store that the processed message is in. However, if the message is opened
+         * by a delegate, this function opens the store that the message was delegated from.
+         */
+        public function getTaskFolderStore() {
+            $ownerentryid = false;
+
+            $rcvdprops = mapi_getprops($this->message, [PR_RCVD_REPRESENTING_ENTRYID]);
+            if (isset($rcvdprops[PR_RCVD_REPRESENTING_ENTRYID])) {
+                $ownerentryid = $rcvdprops;
+            }
+
+            if (!$ownerentryid) {
+                $store = $this->store;
+            }
+            else {
+                $ab = mapi_openaddressbook($this->session);
+                if (!$ab) {
+                    return false;
+                }
+
+                $mailuser = mapi_ab_openentry($ab, $ownerentryid);
+                if (!$mailuser) {
+                    return false;
+                }
+
+                $mailuserprops = mapi_getprops($mailuser, [PR_EMAIL_ADDRESS]);
+                if (!isset($mailuserprops[PR_EMAIL_ADDRESS])) {
+                    return false;
+                }
+
+                $storeid = mapi_msgstore_createentryid($this->store, $mailuserprops[PR_EMAIL_ADDRESS]);
+
+                $store = mapi_openmsgstore($this->session, $storeid);
+            }
+
+            return $store;
+        }
+
+        /**
+         * Open the default task folder for the current user, or the specified user if passed.
+         */
+        public function getDefaultTasksFolder() {
+            $store = $this->getTaskFolderStore();
+
+            $inbox = mapi_msgstore_getreceivefolder($store);
+            $inboxprops = mapi_getprops($inbox, [PR_IPM_TASK_ENTRYID]);
+            if (!isset($inboxprops[PR_IPM_TASK_ENTRYID])) {
+                return false;
+            }
+
+            return mapi_msgstore_openentry($store, $inboxprops[PR_IPM_TASK_ENTRYID]);
+        }
+
+        /**
+         * Function prepare the sent representing properties from given MAPI store.
+         *
+         * @param $store MAPI store object
+         *
+         * @return array|bool if store is not mail box owner entryid then
+         *                    return false else prepare the sent representing props and return it
+         */
+        public function getSentReprProps($store) {
+            $storeprops = mapi_getprops($store, [PR_MAILBOX_OWNER_ENTRYID]);
+            if (!isset($storeprops[PR_MAILBOX_OWNER_ENTRYID])) {
+                return false;
+            }
+
+            $ab = mapi_openaddressbook($this->session);
+            $mailuser = mapi_ab_openentry($ab, $storeprops[PR_MAILBOX_OWNER_ENTRYID]);
+            $mailuserprops = mapi_getprops($mailuser, [PR_ADDRTYPE, PR_EMAIL_ADDRESS, PR_DISPLAY_NAME, PR_SEARCH_KEY, PR_ENTRYID]);
+
+            $props = [];
+            $props[PR_SENT_REPRESENTING_ADDRTYPE] = $mailuserprops[PR_ADDRTYPE];
+            $props[PR_SENT_REPRESENTING_EMAIL_ADDRESS] = $mailuserprops[PR_EMAIL_ADDRESS];
+            $props[PR_SENT_REPRESENTING_NAME] = $mailuserprops[PR_DISPLAY_NAME];
+            $props[PR_SENT_REPRESENTING_SEARCH_KEY] = $mailuserprops[PR_SEARCH_KEY];
+            $props[PR_SENT_REPRESENTING_ENTRYID] = $mailuserprops[PR_ENTRYID];
+
+            return $props;
+        }
+
+        /**
+         * Creates an outgoing message based on the passed message - will set delegate information
+         * and sent mail folder.
+         */
+        public function createOutgoingMessage() {
+            // Open our default store for this user (that's the only store we can submit in)
+            $store = $this->getDefaultStore();
+            $storeprops = mapi_getprops($store, [PR_IPM_OUTBOX_ENTRYID, PR_IPM_SENTMAIL_ENTRYID]);
+
+            $outbox = mapi_msgstore_openentry($store, $storeprops[PR_IPM_OUTBOX_ENTRYID]);
+            if (!$outbox) {
+                return false;
+            }
+
+            $outgoing = mapi_folder_createmessage($outbox);
+            if (!$outgoing) {
+                return false;
+            }
+
+            // Set SENT_REPRESENTING in case we're sending as a delegate
+            $ownerstore = $this->getTaskFolderStore();
+            $sentreprprops = $this->getSentReprProps($ownerstore);
+            mapi_setprops($outgoing, $sentreprprops);
+
+            mapi_setprops($outgoing, [PR_SENTMAIL_ENTRYID => $storeprops[PR_IPM_SENTMAIL_ENTRYID]]);
+
+            return $outgoing;
+        }
+
+        /**
+         * Send a response message (from assignee back to organizer).
+         *
+         * @param $type int Type of response (tdmtTaskAcc, tdmtTaskDec, tdmtTaskUpd);
+         * @param mixed $prefix
+         *
+         * @return bool TRUE on success
+         */
+        public function sendResponse($type, $prefix) {
+            // Create a message in our outbox
+            $outgoing = $this->createOutgoingMessage();
+            $messageprops = mapi_getprops($this->message, [PR_CONVERSATION_TOPIC, PR_MESSAGE_CLASS, $this->props['complete']]);
+
+            $attach = mapi_message_createattach($outgoing);
+            mapi_setprops($attach, [PR_ATTACH_METHOD => ATTACH_EMBEDDED_MSG, PR_DISPLAY_NAME => $messageprops[PR_CONVERSATION_TOPIC], PR_ATTACHMENT_HIDDEN => true]);
+            $sub = mapi_attach_openproperty($attach, PR_ATTACH_DATA_OBJ, IID_IMessage, 0, MAPI_CREATE | MAPI_MODIFY);
+
+            $message = !$this->isTaskRequest() ? $this->message : $this->getAssociatedTask(false);
+
+            $ignoreProps = [PR_ICON_INDEX, $this->props["categories"], PR_SENT_REPRESENTING_NAME, PR_SENT_REPRESENTING_EMAIL_ADDRESS, PR_SENT_REPRESENTING_ADDRTYPE, PR_SENT_REPRESENTING_ENTRYID, PR_SENT_REPRESENTING_SEARCH_KEY];
+
+            mapi_copyto($message, [], $ignoreProps, $outgoing);
+            mapi_copyto($message, [], [], $sub);
+
+            if (!$this->setRecipientsForResponse($outgoing, $type)) {
+                return false;
+            }
+
+            $props = [];
+
+            switch ($type) {
+                case tdmtTaskAcc:
+                    $props[PR_MESSAGE_CLASS] = "IPM.TaskRequest.Accept";
+                    mapi_setprops($sub, [PR_ICON_INDEX => ICON_TASK_ASSIGNER]);
+
+                    break;
+
+                case tdmtTaskDec:
+                    $props[PR_MESSAGE_CLASS] = "IPM.TaskRequest.Decline";
+                    mapi_setprops($sub, [PR_ICON_INDEX => ICON_TASK_DECLINE]);
+
+                    break;
+
+                case tdmtTaskUpd:
+                    mapi_setprops($sub, [PR_ICON_INDEX => ICON_TASK_ASSIGNER]);
+                    if ($messageprops[$this->props['complete']]) {
+                        $props[PR_MESSAGE_CLASS] = "IPM.TaskRequest.Complete";
+                    }
+                    else {
+                        $props[PR_MESSAGE_CLASS] = "IPM.TaskRequest.Update";
+                    }
+
+                    break;
+            }
+
+            mapi_savechanges($sub);
+            mapi_savechanges($attach);
+
+            $props[PR_SUBJECT] = $prefix . $messageprops[PR_CONVERSATION_TOPIC];
+            $props[$this->props['taskmode']] = $type;
+            $props[$this->props['task_assigned_time']] = time();
+
+            mapi_setprops($outgoing, $props);
+
+            // taskCommentsInfo contains some comments which added by assignee while
+            // edit response before sending task response.
+            if ($this->taskCommentsInfo) {
+                $comments = $this->getTaskCommentsInfo();
+                $stream = mapi_openproperty($outgoing, PR_BODY, IID_IStream, STGM_TRANSACTED, MAPI_CREATE | MAPI_MODIFY);
+                mapi_stream_setsize($stream, strlen($comments));
+                mapi_stream_write($stream, $comments);
+                mapi_stream_commit($stream);
+            }
+
+            mapi_savechanges($outgoing);
+            mapi_message_submitmessage($outgoing);
+
+            return true;
+        }
+
+        public function getDefaultStore() {
+            $table = mapi_getmsgstorestable($this->session);
+            $rows = mapi_table_queryallrows($table, [PR_DEFAULT_STORE, PR_ENTRYID]);
+
+            foreach ($rows as $row) {
+                if ($row[PR_DEFAULT_STORE]) {
+                    return mapi_openmsgstore($this->session, $row[PR_ENTRYID]);
+                }
+            }
+
+            return false;
+        }
+
+        /**
+         * Creates a new TaskGlobalObjId.
+         *
+         * Just 16 bytes of random data
+         */
+        public function createTGOID() {
+            $goid = "";
+            for ($i = 0; $i < 16; ++$i) {
+                $goid .= chr(rand(0, 255));
+            }
+
+            return $goid;
+        }
+
+        /**
+         * Function used to get the embedded task of task request. Which further used to
+         * Create/Update associated task of assigner/assignee.
+         *
+         * @param object $message which contains embedded task
+         *
+         * @return false|object $task if found embedded task else false
+         */
+        public function getEmbeddedTask($message) {
+            $task = false;
+            $goid = mapi_getprops($message, [$this->props["task_goid"]]);
+            $attachmentTable = mapi_message_getattachmenttable($message);
+            $restriction = [
+                RES_PROPERTY,
+                [
+                    RELOP => RELOP_EQ,
+                    ULPROPTAG => PR_ATTACH_METHOD,
+                    VALUE => ATTACH_EMBEDDED_MSG, ],
+            ];
+            $rows = mapi_table_queryallrows($attachmentTable, [PR_ATTACH_NUM], $restriction);
+
+            if (empty($rows)) {
+                return $task;
+            }
+
+            foreach ($rows as $row) {
+                try {
+                    $attach = mapi_message_openattach($message, $row[PR_ATTACH_NUM]);
+                    $task = mapi_attach_openobj($attach);
+                }
+                catch (MAPIException $e) {
+                    continue;
+                }
+
+                $taskGoid = mapi_getprops($task, [$this->props["task_goid"]]);
+                if ($goid[$this->props["task_goid"]] === $taskGoid[$this->props["task_goid"]]) {
+                    mapi_setprops($attach, [PR_ATTACHMENT_HIDDEN => true]);
+                    mapi_savechanges($attach);
+                    mapi_savechanges($message);
+
+                    break;
+                }
+            }
+
+            return $task;
+        }
+
+        /**
+         * Function was used to set the user name who has last used this task also it was
+         * update the  tasklastdelegate and task_assigned_time.
+         */
+        public function setLastUser() {
+            $delegatestore = $this->getDefaultStore();
+            $taskstore = $this->getTaskFolderStore();
+
+            $delegateprops = mapi_getprops($delegatestore, [PR_MAILBOX_OWNER_NAME]);
+            $taskprops = mapi_getprops($taskstore, [PR_MAILBOX_OWNER_NAME]);
+
+            // The owner of the task
+            $username = $delegateprops[PR_MAILBOX_OWNER_NAME];
+            // This is me (the one calling the script)
+            $delegate = $taskprops[PR_MAILBOX_OWNER_NAME];
+
+            if ($this->isTaskRequest()) {
+                $task = $this->getAssociatedTask(false);
+                mapi_setprops($task, [$this->props["tasklastuser"] => $username, $this->props["tasklastdelegate"] => $delegate, $this->props['task_assigned_time'] => time()]);
+                mapi_savechanges($task);
+            }
+            mapi_setprops($this->message, [$this->props["tasklastuser"] => $username, $this->props["tasklastdelegate"] => $delegate, $this->props['task_assigned_time'] => time()]);
+        }
+
+        /**
+         * Assignee becomes the owner when a user/assignor assigns any task to someone. Also there can be more than one assignee.
+         * This function sets assignee as owner in the assignor's copy of task.
+         */
+        public function setOwnerForAssignor() {
+            $recipTable = mapi_message_getrecipienttable($this->message);
+            $recips = mapi_table_queryallrows($recipTable, [PR_DISPLAY_NAME]);
+
+            if (!empty($recips)) {
+                $owner = [];
+                foreach ($recips as $value) {
+                    $owner[] = $value[PR_DISPLAY_NAME];
+                }
+
+                $props = [$this->props['owner'] => implode("; ", $owner)];
+                mapi_setprops($this->message, $props);
+            }
+        }
+
+        /**
+         * Sets assignor as recipients in assignee's copy of task.
+         *
+         * If assignor has requested task updates then the assignor is added as recipient type MAPI_CC.
+         *
+         * Also if assignor has request SOC then the assignor is also add as recipient type MAPI_BCC
+         *
+         * @param $task message MAPI message which assignee's copy of task
+         */
+        public function setAssignorInRecipients($task) {
+            $recipTable = mapi_message_getrecipienttable($task);
+
+            // Delete all MAPI_TO recipients
+            $recips = mapi_table_queryallrows($recipTable, [PR_ROWID], [
+                RES_PROPERTY,
+                [
+                    RELOP => RELOP_EQ,
+                    ULPROPTAG => PR_RECIPIENT_TYPE,
+                    VALUE => MAPI_TO,
+                ], ]);
+            foreach ($recips as $recip) {
+                mapi_message_modifyrecipients($task, MODRECIP_REMOVE, [$recip]);
+            }
+
+            $recips = [];
+            $taskReqProps = mapi_getprops($this->message, [PR_SENT_REPRESENTING_NAME, PR_SENT_REPRESENTING_EMAIL_ADDRESS, PR_SENT_REPRESENTING_ENTRYID, PR_SENT_REPRESENTING_ADDRTYPE, PR_SENT_REPRESENTING_SEARCH_KEY]);
+            $associatedTaskProps = mapi_getprops($task, [$this->props['taskupdates'], $this->props['tasksoc'], $this->props['taskmultrecips']]);
+
+            // Build assignor info
+            $assignor = [
+                PR_ENTRYID => $taskReqProps[PR_SENT_REPRESENTING_ENTRYID],
+                PR_DISPLAY_NAME => $taskReqProps[PR_SENT_REPRESENTING_NAME],
+                PR_EMAIL_ADDRESS => $taskReqProps[PR_SENT_REPRESENTING_EMAIL_ADDRESS],
+                PR_RECIPIENT_DISPLAY_NAME => $taskReqProps[PR_SENT_REPRESENTING_NAME],
+                PR_ADDRTYPE => empty($taskReqProps[PR_SENT_REPRESENTING_ADDRTYPE]) ? 'SMTP' : $taskReqProps[PR_SENT_REPRESENTING_ADDRTYPE],
+                PR_RECIPIENT_FLAGS => recipSendable,
+                PR_SEARCH_KEY => $taskReqProps[PR_SENT_REPRESENTING_SEARCH_KEY],
+            ];
+
+            // Assignor has requested task updates, so set him/her as MAPI_CC in recipienttable.
+            if ((isset($associatedTaskProps[$this->props['taskupdates']]) && $associatedTaskProps[$this->props['taskupdates']]) &&
+                !(isset($associatedTaskProps[$this->props['taskmultrecips']]) && $associatedTaskProps[$this->props['taskmultrecips']] == tmrReceived)) {
+                $assignor[PR_RECIPIENT_TYPE] = MAPI_CC;
+                $recips[] = $assignor;
+            }
+
+            // Assignor wants to receive an email report when task is mark as 'Complete', so in recipients as MAPI_BCC
+            if ($associatedTaskProps[$this->props['tasksoc']]) {
+                $assignor[PR_RECIPIENT_TYPE] = MAPI_BCC;
+                $recips[] = $assignor;
+            }
+
+            if (!empty($recips)) {
+                mapi_message_modifyrecipients($task, MODRECIP_ADD, $recips);
+            }
+        }
+
+        /**
+         * Deletes incoming task request from Inbox.
+         *
+         * @returns array returns PR_ENTRYID, PR_STORE_ENTRYID and PR_PARENT_ENTRYID of the deleted task request
+         */
+        public function deleteReceivedTR() {
+            $store = $this->getTaskFolderStore();
+            $storeType = mapi_getprops($store, [PR_MDB_PROVIDER]);
+            if ($storeType[PR_MDB_PROVIDER] === ZARAFA_STORE_PUBLIC_GUID) {
+                $store = $this->getDefaultStore();
+            }
+            $inbox = mapi_msgstore_getreceivefolder($store);
+
+            $storeProps = mapi_getprops($store, [PR_IPM_WASTEBASKET_ENTRYID]);
+            $props = mapi_getprops($this->message, [$this->props['task_goid']]);
+            $goid = $props[$this->props['task_goid']];
+
+            // Find the task by looking for the task_goid
+            $restriction = [
+                RES_PROPERTY,
+                [
+                    RELOP => RELOP_EQ,
+                    ULPROPTAG => $this->props['task_goid'],
+                    VALUE => $goid, ],
+            ];
+
+            $contents = mapi_folder_getcontentstable($inbox);
+
+            $rows = mapi_table_queryallrows($contents, [PR_ENTRYID, PR_PARENT_ENTRYID, PR_STORE_ENTRYID], $restriction);
+
+            if (!empty($rows)) {
+                // If there are multiple, just use the first
+                $entryid = $rows[0][PR_ENTRYID];
+                $wastebasket = mapi_msgstore_openentry($store, $storeProps[PR_IPM_WASTEBASKET_ENTRYID]);
+                mapi_folder_copymessages($inbox, [$entryid], $wastebasket, MESSAGE_MOVE);
+
+                return [PR_ENTRYID => $entryid, PR_PARENT_ENTRYID => $rows[0][PR_PARENT_ENTRYID], PR_STORE_ENTRYID => $rows[0][PR_STORE_ENTRYID]];
+            }
+
+            return false;
+        }
+
+        /**
+         * Sets recipients for the outgoing message according to type of the response.
+         *
+         * If it is a task update, then only recipient type MAPI_CC are taken from the task message.
+         *
+         * If it is accept/decline response, then PR_SENT_REPRESENTATING_XXXX are taken as recipient.
+         *
+         *@param $outgoing MAPI_message outgoing mapi message
+         *@param $responseType String response type
+         */
+        public function setRecipientsForResponse($outgoing, $responseType) {
+            // Clear recipients from outgoing msg
+            $this->deleteAllRecipients($outgoing);
+
+            // If it is a task update then get MAPI_CC recipients which are assignors who has asked for task update.
+            if ($responseType == tdmtTaskUpd) {
+                $props = mapi_getprops($this->message, [$this->props['complete']]);
+                $isComplete = $props[$this->props['complete']];
+
+                $recipTable = mapi_message_getrecipienttable($this->message);
+                $recips = mapi_table_queryallrows($recipTable, $this->recipProps, [
+                    RES_PROPERTY,
+                    [
+                        RELOP => RELOP_EQ,
+                        ULPROPTAG => PR_RECIPIENT_TYPE,
+                        VALUE => ($isComplete ? MAPI_BCC : MAPI_CC),
+                    ],
+                ]);
+
+                // No recipients found, return error
+                if (empty($recips)) {
+                    return false;
+                }
+
+                foreach ($recips as $recip) {
+                    $recip[PR_RECIPIENT_TYPE] = MAPI_TO;    // Change recipient type to MAPI_TO
+                    mapi_message_modifyrecipients($outgoing, MODRECIP_ADD, [$recip]);
+                }
+
+                return true;
+            }
+
+            $orgprops = mapi_getprops($this->message, [PR_SENT_REPRESENTING_NAME, PR_SENT_REPRESENTING_EMAIL_ADDRESS, PR_SENT_REPRESENTING_ADDRTYPE, PR_SENT_REPRESENTING_ENTRYID, PR_SUBJECT]);
+            $recip = [
+                PR_DISPLAY_NAME => $orgprops[PR_SENT_REPRESENTING_NAME],
+                PR_EMAIL_ADDRESS => $orgprops[PR_SENT_REPRESENTING_EMAIL_ADDRESS],
+                PR_ADDRTYPE => $orgprops[PR_SENT_REPRESENTING_ADDRTYPE],
+                PR_ENTRYID => $orgprops[PR_SENT_REPRESENTING_ENTRYID],
+                PR_RECIPIENT_TYPE => MAPI_TO, ];
+
+            mapi_message_modifyrecipients($outgoing, MODRECIP_ADD, [$recip]);
+
+            return true;
+        }
+
+        /**
+         * Deletes all recipients from given message object.
+         *
+         * @param $message MAPI message from which recipients are to be removed
+         */
+        public function deleteAllRecipients($message) {
+            $recipTable = mapi_message_getrecipienttable($message);
+            $recipRows = mapi_table_queryallrows($recipTable, [PR_ROWID]);
+
+            foreach ($recipRows as $recipient) {
+                mapi_message_modifyrecipients($message, MODRECIP_REMOVE, [$recipient]);
+            }
+        }
+
+        /**
+         * Function used to mark the record to complete and send complete update
+         * notification to assigner.
+         *
+         * @return bool TRUE if the update succeeded, FALSE otherwise
+         */
+        public function sendCompleteUpdate() {
+            $messageprops = mapi_getprops($this->message, [$this->props['taskstate']]);
+
+            if (!isset($messageprops[$this->props['taskstate']]) || $messageprops[$this->props['taskstate']] != tdsOWN) {
+                return false; // Can only decline assignee task
+            }
+
+            mapi_setprops(
+                $this->message,
+                [
+                    $this->props['complete'] => true,
+                    $this->props['datecompleted'] => time(),
+                    $this->props['status'] => 2,
+                    $this->props['percent_complete'] => 1, ]
+            );
+
+            return $this->doUpdate();
+        }
+
+        /**
+         * Function returns extra info about task request comments along with message body
+         * which will be included in body while sending task request/response.
+         *
+         * @return string info about task request comments along with message body
+         */
+        public function getTaskCommentsInfo() {
+            return $this->taskCommentsInfo;
+        }
+
+        /**
+         * Function sets extra info about task request comments along with message body
+         * which will be included in body while sending task request/response.
+         *
+         * @param string $taskCommentsInfo info about task request comments along with message body
+         */
+        public function setTaskCommentsInfo($taskCommentsInfo) {
+            $this->taskCommentsInfo = $taskCommentsInfo;
+        }
+    }

Spacing +39 added lines, -39 removed lines

@@ -23,12 +23,12 @@ 
 	 * carried in the IPM.TaskRequest item (although this information seems
 	 * redundant due to that information already being available in PR_MESSAGE_CLASS).
 	 */
-	define('tdmtNothing', 0);            // Value in IPM.Task items
-	define('tdmtTaskReq', 1);            // Assigner -> Assignee
-	define('tdmtTaskAcc', 2);            // Assignee -> Assigner
-	define('tdmtTaskDec', 3);            // Assignee -> Assigner
-	define('tdmtTaskUpd', 4);            // Assignee -> Assigner
-	define('tdmtTaskSELF', 5);            // Assigner -> Assigner (?)
+	define('tdmtNothing', 0); // Value in IPM.Task items
+	define('tdmtTaskReq', 1); // Assigner -> Assignee
+	define('tdmtTaskAcc', 2); // Assignee -> Assigner
+	define('tdmtTaskDec', 3); // Assignee -> Assigner
+	define('tdmtTaskUpd', 4); // Assignee -> Assigner
+	define('tdmtTaskSELF', 5); // Assigner -> Assigner (?)
 
 	/* The TaskHistory is used to show the last action on the task
 	 * on both the assigner and the assignee's side.
@@ -38,22 +38,22 @@ 
 	 * the format 'Accepted by <user> on 01-01-2010 11:00'.
 	 */
 	define('thNone', 0);
-	define('thAccepted', 1);            // Set by assignee
-	define('thDeclined', 2);            // Set by assignee
-	define('thUpdated', 3);                // Set by assignee
+	define('thAccepted', 1); // Set by assignee
+	define('thDeclined', 2); // Set by assignee
+	define('thUpdated', 3); // Set by assignee
 	define('thDueDateChanged', 4);
-	define('thAssigned', 5);            // Set by assigner
+	define('thAssigned', 5); // Set by assigner
 
 	/* The TaskState value is used to differentiate the version of a task
 	 * in the assigner's folder and the version in the
 	 * assignee's folder. The buttons shown depend on this and
 	 * the 'taskaccepted' boolean (for the assignee)
 	 */
-	define('tdsNOM', 0);        // Got a response to a deleted task, and re-created the task for the assigner
-	define('tdsOWNNEW', 1);        // Not assigned
-	define('tdsOWN', 2);        // Assignee version
-	define('tdsACC', 3);        // Assigner version
-	define('tdsDEC', 4);        // Assigner version, but assignee declined
+	define('tdsNOM', 0); // Got a response to a deleted task, and re-created the task for the assigner
+	define('tdsOWNNEW', 1); // Not assigned
+	define('tdsOWN', 2); // Assignee version
+	define('tdsACC', 3); // Assigner version
+	define('tdsDEC', 4); // Assigner version, but assignee declined
 
 	/* The TaskAcceptanceState is used for the assigner to indicate state */
 	define('olTaskNotDelegated', 0);
@@ -63,13 +63,13 @@ 
 
 	/* The task ownership indicates the role of the current user relative to the task. */
 	define('olNewTask', 0);
-	define('olDelegatedTask', 1);    // Task has been assigned
-	define('olOwnTask', 2);            // Task owned
+	define('olDelegatedTask', 1); // Task has been assigned
+	define('olOwnTask', 2); // Task owned
 
 	/* taskmultrecips indicates whether the task request sent or received has multiple assignees or not. */
 	define('tmrNone', 0);
-	define('tmrSent', 1);        // Task has been sent to multiple assignee
-	define('tmrReceived', 2);    // Task Request received has multiple assignee
+	define('tmrSent', 1); // Task has been sent to multiple assignee
+	define('tmrReceived', 2); // Task Request received has multiple assignee
 
 	// Task icon index.
 	define('ICON_TASK_ASSIGNEE', 0x00000502);
@@ -307,7 +307,7 @@ 
 					VALUE => $goid, ],
 				];
 
-				$table = mapi_folder_getcontentstable($folder, MAPI_DEFERRED_ERRORS | SHOW_SOFT_DELETES);
+				$table = mapi_folder_getcontentstable($folder, MAPI_DEFERRED_ERRORS|SHOW_SOFT_DELETES);
 				$softDeletedItems = mapi_table_queryallrows($table, [PR_ENTRYID], $restriction);
 				if (!empty($softDeletedItems)) {
 					return true;
@@ -515,14 +515,14 @@ 
 			// Set properties on Task Request
 			mapi_setprops($this->message, [
 				$this->props['task_goid'] => $taskid, /* our new task_goid */
-				$this->props['taskstate'] => tdsACC,         /* state for our outgoing request */
-				$this->props['taskmode'] => tdmtNothing,     /* we're not sending a change */
-				$this->props['updatecount'] => 2,            /* version 2 (no idea) */
+				$this->props['taskstate'] => tdsACC, /* state for our outgoing request */
+				$this->props['taskmode'] => tdmtNothing, /* we're not sending a change */
+				$this->props['updatecount'] => 2, /* version 2 (no idea) */
 				$this->props['task_acceptance_state'] => olTaskDelegationUnknown, /* no reply yet */
 				$this->props['ownership'] => olDelegatedTask, /* Task has been assigned */
-				$this->props['taskhistory'] => thAssigned,    /* Task has been assigned */
+				$this->props['taskhistory'] => thAssigned, /* Task has been assigned */
 				PR_CONVERSATION_TOPIC => $messageprops[PR_SUBJECT],
-				PR_ICON_INDEX => ICON_TASK_ASSIGNER,         /* Task request icon */
+				PR_ICON_INDEX => ICON_TASK_ASSIGNER, /* Task request icon */
 			]);
 			$this->setLastUser();
 			$this->setOwnerForAssignor();
@@ -537,12 +537,12 @@ 
 
 			// Make it a task request, and put it in sent items after it is sent
 			mapi_setprops($outgoing, [
-				PR_MESSAGE_CLASS => "IPM.TaskRequest",         /* class is task request */
-				$this->props['taskstate'] => tdsOWN,         /* for the recipient he is the task owner */
-				$this->props['taskmode'] => tdmtTaskReq,    /* for the recipient it's a request */
-				$this->props['updatecount'] => 1,            /* version 2 is in the attachment */
+				PR_MESSAGE_CLASS => "IPM.TaskRequest", /* class is task request */
+				$this->props['taskstate'] => tdsOWN, /* for the recipient he is the task owner */
+				$this->props['taskmode'] => tdmtTaskReq, /* for the recipient it's a request */
+				$this->props['updatecount'] => 1, /* version 2 is in the attachment */
 				PR_SUBJECT_PREFIX => $prefix,
-				PR_SUBJECT => $prefix . $messageprops[PR_SUBJECT],
+				PR_SUBJECT => $prefix.$messageprops[PR_SUBJECT],
 			]);
 
 			$attach = mapi_message_createattach($outgoing);
@@ -551,7 +551,7 @@ 
 				PR_ATTACHMENT_HIDDEN => true,
 				PR_DISPLAY_NAME => $messageprops[PR_SUBJECT], ]);
 
-			$sub = mapi_attach_openproperty($attach, PR_ATTACH_DATA_OBJ, IID_IMessage, 0, MAPI_MODIFY | MAPI_CREATE);
+			$sub = mapi_attach_openproperty($attach, PR_ATTACH_DATA_OBJ, IID_IMessage, 0, MAPI_MODIFY|MAPI_CREATE);
 
 			mapi_copyto($this->message, [], [], $sub);
 			mapi_savechanges($sub);
@@ -649,7 +649,7 @@ 
 		 * @return entryid EntryID of the accepted task
 		 */
 		public function doAccept() {
-			$prefix = _("Task Accepted:") . " ";
+			$prefix = _("Task Accepted:")." ";
 			$messageProps = mapi_getprops($this->message, [PR_MESSAGE_CLASS, $this->props['taskstate']]);
 
 			if (!isset($messageProps[$this->props['taskstate']]) || $messageProps[$this->props['taskstate']] != tdsOWN) {
@@ -698,7 +698,7 @@ 
 		 * @return boolean TRUE on success, FALSE on failure
 		 */
 		public function doDecline() {
-			$prefix = _("Task Declined:") . " ";
+			$prefix = _("Task Declined:")." ";
 			$messageProps = mapi_getprops($this->message, [$this->props['taskstate']]);
 
 			if (!isset($messageProps[$this->props['taskstate']]) || $messageProps[$this->props['taskstate']] != tdsOWN) {
@@ -753,10 +753,10 @@ 
 
 			$props = mapi_getprops($this->message, [$this->props['taskupdates'], $this->props['tasksoc'], $this->props['recurring'], $this->props['complete']]);
 			if (!$props[$this->props['complete']] && $props[$this->props['taskupdates']] && !(isset($props[$this->props['recurring']]) && $props[$this->props['recurring']])) {
-				$this->sendResponse(tdmtTaskUpd, _("Task Updated:") . " ");
+				$this->sendResponse(tdmtTaskUpd, _("Task Updated:")." ");
 			}
 			elseif ($props[$this->props['complete']]) {
-				$this->sendResponse(tdmtTaskUpd, _("Task Completed:") . " ");
+				$this->sendResponse(tdmtTaskUpd, _("Task Completed:")." ");
 			}
 
 			return true;
@@ -890,7 +890,7 @@ 
 
 			$attach = mapi_message_createattach($outgoing);
 			mapi_setprops($attach, [PR_ATTACH_METHOD => ATTACH_EMBEDDED_MSG, PR_DISPLAY_NAME => $messageprops[PR_CONVERSATION_TOPIC], PR_ATTACHMENT_HIDDEN => true]);
-			$sub = mapi_attach_openproperty($attach, PR_ATTACH_DATA_OBJ, IID_IMessage, 0, MAPI_CREATE | MAPI_MODIFY);
+			$sub = mapi_attach_openproperty($attach, PR_ATTACH_DATA_OBJ, IID_IMessage, 0, MAPI_CREATE|MAPI_MODIFY);
 
 			$message = !$this->isTaskRequest() ? $this->message : $this->getAssociatedTask(false);
 
@@ -933,7 +933,7 @@ 
 			mapi_savechanges($sub);
 			mapi_savechanges($attach);
 
-			$props[PR_SUBJECT] = $prefix . $messageprops[PR_CONVERSATION_TOPIC];
+			$props[PR_SUBJECT] = $prefix.$messageprops[PR_CONVERSATION_TOPIC];
 			$props[$this->props['taskmode']] = $type;
 			$props[$this->props['task_assigned_time']] = time();
 
@@ -943,7 +943,7 @@ 
 			// edit response before sending task response.
 			if ($this->taskCommentsInfo) {
 				$comments = $this->getTaskCommentsInfo();
-				$stream = mapi_openproperty($outgoing, PR_BODY, IID_IStream, STGM_TRANSACTED, MAPI_CREATE | MAPI_MODIFY);
+				$stream = mapi_openproperty($outgoing, PR_BODY, IID_IStream, STGM_TRANSACTED, MAPI_CREATE|MAPI_MODIFY);
 				mapi_stream_setsize($stream, strlen($comments));
 				mapi_stream_write($stream, $comments);
 				mapi_stream_commit($stream);
@@ -1206,7 +1206,7 @@ 
 				}
 
 				foreach ($recips as $recip) {
-					$recip[PR_RECIPIENT_TYPE] = MAPI_TO;    // Change recipient type to MAPI_TO
+					$recip[PR_RECIPIENT_TYPE] = MAPI_TO; // Change recipient type to MAPI_TO
 					mapi_message_modifyrecipients($outgoing, MODRECIP_ADD, [$recip]);
 				}
 

Braces +6 added lines, -12 removed lines

@@ -271,8 +271,7 @@ 
 				// Copy sender information from the e-mail
 				$props = mapi_getprops($this->message, $senderProps);
 				mapi_setprops($task, $props);
-			}
-			else {
+			} else {
 				// If there are multiple, just use the first
 				$entryid = $rows[0][PR_ENTRYID];
 
@@ -575,8 +574,7 @@ 
 
 			if (isset($messageprops)) {
 				++$messageprops[$this->props['updatecount']];
-			}
-			else {
+			} else {
 				$messageprops[$this->props['updatecount']] = 1;
 			}
 
@@ -754,8 +752,7 @@ 
 			$props = mapi_getprops($this->message, [$this->props['taskupdates'], $this->props['tasksoc'], $this->props['recurring'], $this->props['complete']]);
 			if (!$props[$this->props['complete']] && $props[$this->props['taskupdates']] && !(isset($props[$this->props['recurring']]) && $props[$this->props['recurring']])) {
 				$this->sendResponse(tdmtTaskUpd, _("Task Updated:") . " ");
-			}
-			elseif ($props[$this->props['complete']]) {
+			} elseif ($props[$this->props['complete']]) {
 				$this->sendResponse(tdmtTaskUpd, _("Task Completed:") . " ");
 			}
 
@@ -778,8 +775,7 @@ 
 
 			if (!$ownerentryid) {
 				$store = $this->store;
-			}
-			else {
+			} else {
 				$ab = mapi_openaddressbook($this->session);
 				if (!$ab) {
 					return false;
@@ -922,8 +918,7 @@ 
 					mapi_setprops($sub, [PR_ICON_INDEX => ICON_TASK_ASSIGNER]);
 					if ($messageprops[$this->props['complete']]) {
 						$props[PR_MESSAGE_CLASS] = "IPM.TaskRequest.Complete";
-					}
-					else {
+					} else {
 						$props[PR_MESSAGE_CLASS] = "IPM.TaskRequest.Update";
 					}
 
@@ -1011,8 +1006,7 @@ 
 				try {
 					$attach = mapi_message_openattach($message, $row[PR_ATTACH_NUM]);
 					$task = mapi_attach_openobj($attach);
-				}
-				catch (MAPIException $e) {
+				} catch (MAPIException $e) {
 					continue;
 				}
 

grommunio-sync-top.php

Indentation +759 added lines, -759 removed lines

@@ -11,7 +11,7 @@ 
 
 require_once 'vendor/autoload.php';
 if (!defined('GSYNC_CONFIG')) {
-	define('GSYNC_CONFIG', 'config.php');
+    define('GSYNC_CONFIG', 'config.php');
 }
 
 include_once GSYNC_CONFIG;
@@ -19,777 +19,777 @@ 
 /*
  * MAIN
  */
-	declare(ticks=1);
-	define('BASE_PATH_CLI', dirname(__FILE__) . "/");
-	set_include_path(get_include_path() . PATH_SEPARATOR . BASE_PATH_CLI);
+    declare(ticks=1);
+    define('BASE_PATH_CLI', dirname(__FILE__) . "/");
+    set_include_path(get_include_path() . PATH_SEPARATOR . BASE_PATH_CLI);
 
-	if (!defined('GSYNC_CONFIG')) {
-		define('GSYNC_CONFIG', BASE_PATH_CLI . 'config.php');
-	}
+    if (!defined('GSYNC_CONFIG')) {
+        define('GSYNC_CONFIG', BASE_PATH_CLI . 'config.php');
+    }
 
-	include_once GSYNC_CONFIG;
+    include_once GSYNC_CONFIG;
 
-	try {
-		GSync::CheckConfig();
-		if (!function_exists("pcntl_signal")) {
-			throw new FatalException("Function pcntl_signal() is not available. Please install package 'php5-pcntl' (or similar) on your system.");
-		}
+    try {
+        GSync::CheckConfig();
+        if (!function_exists("pcntl_signal")) {
+            throw new FatalException("Function pcntl_signal() is not available. Please install package 'php5-pcntl' (or similar) on your system.");
+        }
 
-		if (php_sapi_name() != "cli") {
-			throw new FatalException("This script can only be called from the CLI.");
-		}
+        if (php_sapi_name() != "cli") {
+            throw new FatalException("This script can only be called from the CLI.");
+        }
 
-		$zpt = new GSyncTop();
+        $zpt = new GSyncTop();
 
-		// check if help was requested from CLI
-		if (in_array('-h', $argv) || in_array('--help', $argv)) {
-			echo $zpt->UsageInstructions();
+        // check if help was requested from CLI
+        if (in_array('-h', $argv) || in_array('--help', $argv)) {
+            echo $zpt->UsageInstructions();
 
-			exit(0);
-		}
+            exit(0);
+        }
 
-		if ($zpt->IsAvailable()) {
-			pcntl_signal(SIGINT, [$zpt, "SignalHandler"]);
-			$zpt->run();
-			$zpt->scrClear();
-			system("stty sane");
-		}
-		else {
-			echo "grommunio-sync interprocess communication (IPC) is not available or TopCollector is disabled.\n";
-		}
-	}
-	catch (GSyncException $zpe) {
-		fwrite(STDERR, get_class($zpe) . ": " . $zpe->getMessage() . "\n");
+        if ($zpt->IsAvailable()) {
+            pcntl_signal(SIGINT, [$zpt, "SignalHandler"]);
+            $zpt->run();
+            $zpt->scrClear();
+            system("stty sane");
+        }
+        else {
+            echo "grommunio-sync interprocess communication (IPC) is not available or TopCollector is disabled.\n";
+        }
+    }
+    catch (GSyncException $zpe) {
+        fwrite(STDERR, get_class($zpe) . ": " . $zpe->getMessage() . "\n");
 
-		exit(1);
-	}
+        exit(1);
+    }
 
-	echo "terminated\n";
+    echo "terminated\n";
 
 /*
  * grommunio-sync-top
  */
 class GSyncTop {
-	// show options
-	public const SHOW_DEFAULT = 0;
-	public const SHOW_ACTIVE_ONLY = 1;
-	public const SHOW_UNKNOWN_ONLY = 2;
-	public const SHOW_TERM_DEFAULT_TIME = 5; // 5 secs
-
-	private $topCollector;
-	private $starttime;
-	private $action;
-	private $filter;
-	private $status;
-	private $statusexpire;
-	private $wide;
-	private $wasEnabled;
-	private $terminate;
-	private $scrSize;
-	private $pingInterval;
-	private $showPush;
-	private $showTermSec;
-
-	private $linesActive = [];
-	private $linesOpen = [];
-	private $linesUnknown = [];
-	private $linesTerm = [];
-	private $pushConn = 0;
-	private $activeConn = [];
-	private $activeHosts = [];
-	private $activeUsers = [];
-	private $activeDevices = [];
-
-	/**
-	 * Constructor.
-	 */
-	public function __construct() {
-		$this->starttime = time();
-		$this->currenttime = time();
-		$this->action = "";
-		$this->filter = false;
-		$this->status = false;
-		$this->statusexpire = 0;
-		$this->helpexpire = 0;
-		$this->doingTail = false;
-		$this->wide = false;
-		$this->terminate = false;
-		$this->showPush = true;
-		$this->showOption = self::SHOW_DEFAULT;
-		$this->showTermSec = self::SHOW_TERM_DEFAULT_TIME;
-		$this->scrSize = ['width' => 80, 'height' => 24];
-		$this->pingInterval = (defined('PING_INTERVAL') && PING_INTERVAL > 0) ? PING_INTERVAL : 12;
-
-		// get a TopCollector
-		$this->topCollector = new TopCollector();
-	}
-
-	/**
-	 * Requests data from the running grommunio-sync processes.
-	 *
-	 * @return
-	 */
-	private function initialize() {
-		// request feedback from active processes
-		$this->wasEnabled = $this->topCollector->CollectData();
-
-		// remove obsolete data
-		$this->topCollector->ClearLatest(true);
-
-		// start with default colours
-		$this->scrDefaultColors();
-	}
-
-	/**
-	 * Main loop of grommunio-sync-top
-	 * Runs until termination is requested.
-	 *
-	 * @return
-	 */
-	public function run() {
-		$this->initialize();
-
-		do {
-			$this->currenttime = time();
-
-			// see if shared memory is active
-			if (!$this->IsAvailable()) {
-				$this->terminate = true;
-			}
-
-			// active processes should continue sending data
-			$this->topCollector->CollectData();
-
-			// get and process data from processes
-			$this->topCollector->ClearLatest();
-			$topdata = $this->topCollector->ReadLatest();
-			$this->processData($topdata);
-
-			// clear screen
-			$this->scrClear();
-
-			// check if screen size changed
-			$s = $this->scrGetSize();
-			if ($this->scrSize['width'] != $s['width']) {
-				if ($s['width'] > 180) {
-					$this->wide = true;
-				}
-				else {
-					$this->wide = false;
-				}
-			}
-			$this->scrSize = $s;
-
-			// print overview
-			$this->scrOverview();
-
-			// wait for user input
-			$this->readLineProcess();
-		}
-		while ($this->terminate != true);
-	}
-
-	/**
-	 * Indicates if TopCollector is available collecting data.
-	 *
-	 * @return bool
-	 */
-	public function IsAvailable() {
-		if (defined('TOPCOLLECTOR_DISABLED') && constant('TOPCOLLECTOR_DISABLED') === true) {
-			return false;
-		}
-
-		return $this->topCollector->IsActive();
-	}
-
-	/**
-	 * Processes data written by the running processes.
-	 *
-	 * @param array $data
-	 *
-	 * @return
-	 */
-	private function processData($data) {
-		$this->linesActive = [];
-		$this->linesOpen = [];
-		$this->linesUnknown = [];
-		$this->linesTerm = [];
-		$this->pushConn = 0;
-		$this->activeConn = [];
-		$this->activeHosts = [];
-		$this->activeUsers = [];
-		$this->activeDevices = [];
-
-		if (!is_array($data)) {
-			return;
-		}
-
-		foreach ($data as $devid => $users) {
-			foreach ($users as $user => $pids) {
-				foreach ($pids as $pid => $line) {
-					if (!is_array($line)) {
-						continue;
-					}
-
-					$line['command'] = Utils::GetCommandFromCode($line['command']);
-
-					if ($line["ended"] == 0) {
-						$this->activeDevices[$devid] = 1;
-						$this->activeUsers[$user] = 1;
-						$this->activeConn[$pid] = 1;
-						$this->activeHosts[$line['ip']] = 1;
-
-						$line["time"] = $this->currenttime - $line['start'];
-						if ($line['push'] === true) {
-							++$this->pushConn;
-						}
-
-						// ignore push connections
-						if ($line['push'] === true && !$this->showPush) {
-							continue;
-						}
-
-						if ($this->filter !== false) {
-							$f = $this->filter;
-							if (!($line["pid"] == $f || $line["ip"] == $f || strtolower($line['command']) == strtolower($f) || preg_match("/.*?{$f}.*?/i", $line['user']) ||
-								preg_match("/.*?{$f}.*?/i", $line['devagent']) || preg_match("/.*?{$f}.*?/i", $line['devid']) || preg_match("/.*?{$f}.*?/i", $line['addinfo']))) {
-								continue;
-							}
-						}
-
-						$lastUpdate = $this->currenttime - $line["update"];
-						if ($this->currenttime - $line["update"] < 2) {
-							$this->linesActive[$line["update"] . $line["pid"]] = $line;
-						}
-						elseif (($line['push'] === true && $lastUpdate > ($this->pingInterval + 2)) || ($line['push'] !== true && $lastUpdate > 4)) {
-							$this->linesUnknown[$line["update"] . $line["pid"]] = $line;
-						}
-						else {
-							$this->linesOpen[$line["update"] . $line["pid"]] = $line;
-						}
-					}
-					else {
-						// do not show terminated + expired connections
-						if ($this->currenttime > $line['ended'] + $this->showTermSec) {
-							continue;
-						}
-
-						if ($this->filter !== false) {
-							$f = $this->filter;
-							if (
-									!(
-										$line['pid'] == $f ||
-										$line['ip'] == $f ||
-										strtolower($line['command']) == strtolower($f) ||
-										preg_match("/.*?{$f}.*?/i", $line['user']) ||
-										preg_match("/.*?{$f}.*?/i", $line['devagent']) ||
-										preg_match("/.*?{$f}.*?/i", $line['devid']) ||
-										preg_match("/.*?{$f}.*?/i", $line['addinfo'])
-									)) {
-								continue;
-							}
-						}
-
-						$line['time'] = $line['ended'] - $line['start'];
-						$this->linesTerm[$line['update'] . $line['pid']] = $line;
-					}
-				}
-			}
-		}
-
-		// sort by execution time
-		krsort($this->linesActive);
-		krsort($this->linesOpen);
-		krsort($this->linesUnknown);
-		krsort($this->linesTerm);
-	}
-
-	/**
-	 * Prints data to the terminal.
-	 *
-	 * @return
-	 */
-	private function scrOverview() {
-		$linesAvail = $this->scrSize['height'] - 8;
-		$lc = 1;
-		$this->scrPrintAt($lc, 0, "\033[1mgrommunio-sync-top live statistics\033[0m\t\t\t\t\t" . @strftime("%d/%m/%Y %T") . "\n");
-		++$lc;
-
-		$this->scrPrintAt($lc, 0, sprintf("Open connections: %d\t\t\t\tUsers:\t %d\tgrommunio-sync:   %s ", count($this->activeConn), count($this->activeUsers), $this->getVersion()));
-		++$lc;
-		$this->scrPrintAt($lc, 0, sprintf("Push connections: %d\t\t\t\tDevices: %d\tPHP-MAPI: %s", $this->pushConn, count($this->activeDevices), phpversion("mapi")));
-		++$lc;
-		$this->scrPrintAt($lc, 0, sprintf("                                                Hosts:\t %d", count($this->activeHosts)));
-		++$lc;
-		++$lc;
-
-		$this->scrPrintAt($lc, 0, "\033[4m" . $this->getLine(['pid' => 'PID', 'ip' => 'IP', 'user' => 'USER', 'command' => 'COMMAND', 'time' => 'TIME', 'devagent' => 'AGENT', 'devid' => 'DEVID', 'addinfo' => 'Additional Information']) . str_repeat(" ", 20) . "\033[0m");
-		++$lc;
-
-		// print help text if requested
-		$hl = 0;
-		if ($this->helpexpire > $this->currenttime) {
-			$help = $this->scrHelp();
-			$linesAvail -= count($help);
-			$hl = $this->scrSize['height'] - count($help) - 1;
-			foreach ($help as $h) {
-				$this->scrPrintAt($hl, 0, $h);
-				++$hl;
-			}
-		}
-
-		$toPrintActive = $linesAvail;
-		$toPrintOpen = $linesAvail;
-		$toPrintUnknown = $linesAvail;
-		$toPrintTerm = $linesAvail;
-
-		// default view: show all unknown, no terminated and half active+open
-		if (count($this->linesActive) + count($this->linesOpen) + count($this->linesUnknown) > $linesAvail) {
-			$toPrintUnknown = count($this->linesUnknown);
-			$toPrintActive = count($this->linesActive);
-			$toPrintOpen = $linesAvail - $toPrintUnknown - $toPrintActive;
-			$toPrintTerm = 0;
-		}
-
-		if ($this->showOption == self::SHOW_ACTIVE_ONLY) {
-			$toPrintActive = $linesAvail;
-			$toPrintOpen = 0;
-			$toPrintUnknown = 0;
-			$toPrintTerm = 0;
-		}
-
-		if ($this->showOption == self::SHOW_UNKNOWN_ONLY) {
-			$toPrintActive = 0;
-			$toPrintOpen = 0;
-			$toPrintUnknown = $linesAvail;
-			$toPrintTerm = 0;
-		}
-
-		$linesprinted = 0;
-		foreach ($this->linesActive as $time => $l) {
-			if ($linesprinted >= $toPrintActive) {
-				break;
-			}
-
-			$this->scrPrintAt($lc, 0, "\033[01m" . $this->getLine($l) . "\033[0m");
-			++$lc;
-			++$linesprinted;
-		}
-
-		$linesprinted = 0;
-		foreach ($this->linesOpen as $time => $l) {
-			if ($linesprinted >= $toPrintOpen) {
-				break;
-			}
-
-			$this->scrPrintAt($lc, 0, $this->getLine($l));
-			++$lc;
-			++$linesprinted;
-		}
-
-		$linesprinted = 0;
-		foreach ($this->linesUnknown as $time => $l) {
-			if ($linesprinted >= $toPrintUnknown) {
-				break;
-			}
-
-			$color = "0;31m";
-			if ($l['push'] == false && $time - $l["start"] > 30) {
-				$color = "1;31m";
-			}
-			$this->scrPrintAt($lc, 0, "\033[0" . $color . $this->getLine($l) . "\033[0m");
-			++$lc;
-			++$linesprinted;
-		}
-
-		if ($toPrintTerm > 0) {
-			$toPrintTerm = $linesAvail - $lc + 6;
-		}
-
-		$linesprinted = 0;
-		foreach ($this->linesTerm as $time => $l) {
-			if ($linesprinted >= $toPrintTerm) {
-				break;
-			}
-
-			$this->scrPrintAt($lc, 0, "\033[01;30m" . $this->getLine($l) . "\033[0m");
-			++$lc;
-			++$linesprinted;
-		}
-
-		// add the lines used when displaying the help text
-		$lc += $hl;
-		$this->scrPrintAt($lc, 0, "\033[K");
-		++$lc;
-		$this->scrPrintAt($lc, 0, "Colorscheme: \033[01mActive  \033[0mOpen  \033[01;31mUnknown  \033[01;30mTerminated\033[0m");
-
-		// remove old status
-		if ($this->statusexpire < $this->currenttime) {
-			$this->status = false;
-		}
-
-		// show request information and help command
-		if ($this->starttime + 6 > $this->currenttime) {
-			$this->status = sprintf("Requesting information (takes up to %dsecs)", $this->pingInterval) . str_repeat(".", ($this->currenttime - $this->starttime)) . "  type \033[01;31mh\033[00;31m or \033[01;31mhelp\033[00;31m for usage instructions";
-			$this->statusexpire = $this->currenttime + 1;
-		}
-
-		$str = "";
-		if (!$this->showPush) {
-			$str .= "\033[00;32mPush: \033[01;32mNo\033[0m   ";
-		}
-
-		if ($this->showOption == self::SHOW_ACTIVE_ONLY) {
-			$str .= "\033[01;32mActive only\033[0m   ";
-		}
-
-		if ($this->showOption == self::SHOW_UNKNOWN_ONLY) {
-			$str .= "\033[01;32mUnknown only\033[0m   ";
-		}
-
-		if ($this->showTermSec != self::SHOW_TERM_DEFAULT_TIME) {
-			$str .= "\033[01;32mTerminated: " . $this->showTermSec . "s\033[0m   ";
-		}
-
-		if ($this->filter !== false || ($this->status !== false && $this->statusexpire > $this->currenttime)) {
-			// print filter in green
-			if ($this->filter !== false) {
-				$str .= "\033[00;32mFilter: \033[01;32m{$this->filter}\033[0m   ";
-			}
-			// print status in red
-			if ($this->status !== false) {
-				$str .= "\033[00;31m{$this->status}\033[0m";
-			}
-		}
-		$this->scrPrintAt(5, 0, $str);
-
-		$this->scrPrintAt(4, 0, "Action: \033[01m" . $this->action . "\033[0m");
-	}
-
-	/**
-	 * Waits for a keystroke and processes the requested command.
-	 *
-	 * @return
-	 */
-	private function readLineProcess() {
-		$ans = explode("^^", `bash -c "read -n 1 -t 1 ANS ; echo \\\$?^^\\\$ANS;"`);
-
-		if ($ans[0] < 128) {
-			if (isset($ans[1]) && bin2hex(trim($ans[1])) == "7f") {
-				$this->action = substr($this->action, 0, -1);
-			}
-
-			if (isset($ans[1]) && $ans[1] != "") {
-				$this->action .= trim(preg_replace("/[^A-Za-z0-9:]/", "", $ans[1]));
-			}
-
-			if (bin2hex($ans[0]) == "30" && bin2hex($ans[1]) == "0a") {
-				$cmds = explode(':', $this->action);
-				if ($cmds[0] == "quit" || $cmds[0] == "q" || (isset($cmds[1]) && $cmds[0] == "" && $cmds[1] == "q")) {
-					$this->topCollector->CollectData(true);
-					$this->topCollector->ClearLatest(true);
-
-					$this->terminate = true;
-				}
-				elseif ($cmds[0] == "clear") {
-					$this->topCollector->ClearLatest(true);
-					$this->topCollector->CollectData(true);
-					$this->topCollector->ReInitIPC();
-				}
-				elseif ($cmds[0] == "filter" || $cmds[0] == "f") {
-					if (!isset($cmds[1]) || $cmds[1] == "") {
-						$this->filter = false;
-						$this->status = "No filter";
-						$this->statusexpire = $this->currenttime + 5;
-					}
-					else {
-						$this->filter = $cmds[1];
-						$this->status = false;
-					}
-				}
-				elseif ($cmds[0] == "option" || $cmds[0] == "o") {
-					if (!isset($cmds[1]) || $cmds[1] == "") {
-						$this->status = "Option value needs to be specified. See 'help' or 'h' for instructions";
-						$this->statusexpire = $this->currenttime + 5;
-					}
-					elseif ($cmds[1] == "p" || $cmds[1] == "push" || $cmds[1] == "ping") {
-						$this->showPush = !$this->showPush;
-					}
-					elseif ($cmds[1] == "a" || $cmds[1] == "active") {
-						$this->showOption = self::SHOW_ACTIVE_ONLY;
-					}
-					elseif ($cmds[1] == "u" || $cmds[1] == "unknown") {
-						$this->showOption = self::SHOW_UNKNOWN_ONLY;
-					}
-					elseif ($cmds[1] == "d" || $cmds[1] == "default") {
-						$this->showOption = self::SHOW_DEFAULT;
-						$this->showTermSec = self::SHOW_TERM_DEFAULT_TIME;
-						$this->showPush = true;
-					}
-					elseif (is_numeric($cmds[1])) {
-						$this->showTermSec = $cmds[1];
-					}
-					else {
-						$this->status = sprintf("Option '%s' unknown", $cmds[1]);
-						$this->statusexpire = $this->currenttime + 5;
-					}
-				}
-				elseif ($cmds[0] == "reset" || $cmds[0] == "r") {
-					$this->filter = false;
-					$this->wide = false;
-					$this->helpexpire = 0;
-					$this->status = "reset";
-					$this->statusexpire = $this->currenttime + 2;
-				}
-				// enable/disable wide view
-				elseif ($cmds[0] == "wide" || $cmds[0] == "w") {
-					$this->wide = !$this->wide;
-					$this->status = ($this->wide) ? "w i d e  view" : "normal view";
-					$this->statusexpire = $this->currenttime + 2;
-				}
-				elseif ($cmds[0] == "help" || $cmds[0] == "h") {
-					$this->helpexpire = $this->currenttime + 20;
-				}
-				// grep the log file
-				elseif (($cmds[0] == "log" || $cmds[0] == "l") && isset($cmds[1])) {
-					if (!file_exists(LOGFILE)) {
-						$this->status = "Logfile can not be found: " . LOGFILE;
-					}
-					else {
-						system('bash -c "fgrep -a ' . escapeshellarg($cmds[1]) . ' ' . LOGFILE . ' | less +G" > `tty`');
-						$this->status = "Returning from log, updating data";
-					}
-					$this->statusexpire = time() + 5; // it might be much "later" now
-				}
-				// tail the log file
-				elseif (($cmds[0] == "tail" || $cmds[0] == "t")) {
-					if (!file_exists(LOGFILE)) {
-						$this->status = "Logfile can not be found: " . LOGFILE;
-					}
-					else {
-						$this->doingTail = true;
-						$this->scrClear();
-						$this->scrPrintAt(1, 0, $this->scrAsBold("Press CTRL+C to return to grommunio-sync-top\n\n"));
-						$secondary = "";
-						if (isset($cmds[1])) {
-							$secondary = " -n 200 | grep " . escapeshellarg($cmds[1]);
-						}
-						system('bash -c "tail -f ' . LOGFILE . $secondary . '" > `tty`');
-						$this->doingTail = false;
-						$this->status = "Returning from tail, updating data";
-					}
-					$this->statusexpire = time() + 5; // it might be much "later" now
-				}
-				// tail the error log file
-				elseif (($cmds[0] == "error" || $cmds[0] == "e")) {
-					if (!file_exists(LOGERRORFILE)) {
-						$this->status = "Error logfile can not be found: " . LOGERRORFILE;
-					}
-					else {
-						$this->doingTail = true;
-						$this->scrClear();
-						$this->scrPrintAt(1, 0, $this->scrAsBold("Press CTRL+C to return to grommunio-sync-top\n\n"));
-						$secondary = "";
-						if (isset($cmds[1])) {
-							$secondary = " -n 200 | grep " . escapeshellarg($cmds[1]);
-						}
-						system('bash -c "tail -f ' . LOGERRORFILE . $secondary . '" > `tty`');
-						$this->doingTail = false;
-						$this->status = "Returning from tail, updating data";
-					}
-					$this->statusexpire = time() + 5; // it might be much "later" now
-				}
-				elseif ($cmds[0] != "") {
-					$this->status = sprintf("Command '%s' unknown", $cmds[0]);
-					$this->statusexpire = $this->currenttime + 8;
-				}
-				$this->action = "";
-			}
-		}
-	}
-
-	/**
-	 * Signal handler function.
-	 *
-	 * @param int $signo signal number
-	 *
-	 * @return
-	 */
-	public function SignalHandler($signo) {
-		// don't terminate if the signal was sent by terminating tail
-		if (!$this->doingTail) {
-			$this->topCollector->CollectData(true);
-			$this->topCollector->ClearLatest(true);
-			$this->terminate = true;
-		}
-	}
-
-	/**
-	 * Returns usage instructions.
-	 *
-	 * @return string
-	 */
-	public function UsageInstructions() {
-		$help = "Usage:\n\tgrommunio-sync-top.php\n\n" .
-				"  grommunio-sync-top is a live top-like overview of what grommunio-sync is doing. It does not have specific command line options.\n\n" .
-				"  When grommunio-sync-top is running you can specify certain actions and options which can be executed (listed below).\n" .
-				"  This help information can also be shown inside grommunio-sync-top by hitting 'help' or 'h'.\n\n";
-		$scrhelp = $this->scrHelp();
-		unset($scrhelp[0]);
-
-		$help .= implode("\n", $scrhelp);
-		$help .= "\n\n";
-
-		return $help;
-	}
-
-	/**
-	 * Prints a 'help' text at the end of the page.
-	 *
-	 * @return array with help lines
-	 */
-	private function scrHelp() {
-		$h = [];
-		$secs = $this->helpexpire - $this->currenttime;
-		$h[] = "Actions supported by grommunio-sync-top (help page still displayed for " . $secs . "secs)";
-		$h[] = "  " . $this->scrAsBold("Action") . "\t\t" . $this->scrAsBold("Comment");
-		$h[] = "  " . $this->scrAsBold("h") . " or " . $this->scrAsBold("help") . "\t\tDisplays this information.";
-		$h[] = "  " . $this->scrAsBold("q") . ", " . $this->scrAsBold("quit") . " or " . $this->scrAsBold(":q") . "\t\tExits grommunio-sync-top.";
-		$h[] = "  " . $this->scrAsBold("w") . " or " . $this->scrAsBold("wide") . "\t\tTries not to truncate data. Automatically done if more than 180 columns available.";
-		$h[] = "  " . $this->scrAsBold("f:VAL") . " or " . $this->scrAsBold("filter:VAL") . "\tOnly display connections which contain VAL. This value is case-insensitive.";
-		$h[] = "  " . $this->scrAsBold("f:") . " or " . $this->scrAsBold("filter:") . "\t\tWithout a search word: resets the filter.";
-		$h[] = "  " . $this->scrAsBold("l:STR") . " or " . $this->scrAsBold("log:STR") . "\tIssues 'less +G' on the logfile, after grepping on the optional STR.";
-		$h[] = "  " . $this->scrAsBold("t:STR") . " or " . $this->scrAsBold("tail:STR") . "\tIssues 'tail -f' on the logfile, grepping for optional STR.";
-		$h[] = "  " . $this->scrAsBold("e:STR") . " or " . $this->scrAsBold("error:STR") . "\tIssues 'tail -f' on the error logfile, grepping for optional STR.";
-		$h[] = "  " . $this->scrAsBold("r") . " or " . $this->scrAsBold("reset") . "\t\tResets 'wide' or 'filter'.";
-		$h[] = "  " . $this->scrAsBold("o:") . " or " . $this->scrAsBold("option:") . "\t\tSets display options. Valid options specified below";
-		$h[] = "  " . $this->scrAsBold("  p") . " or " . $this->scrAsBold("push") . "\t\tLists/not lists active and open push connections.";
-		$h[] = "  " . $this->scrAsBold("  a") . " or " . $this->scrAsBold("action") . "\t\tLists only active connections.";
-		$h[] = "  " . $this->scrAsBold("  u") . " or " . $this->scrAsBold("unknown") . "\tLists only unknown connections.";
-		$h[] = "  " . $this->scrAsBold("  10") . " or " . $this->scrAsBold("20") . "\t\tLists terminated connections for 10 or 20 seconds. Any other number can be used.";
-		$h[] = "  " . $this->scrAsBold("  d") . " or " . $this->scrAsBold("default") . "\tUses default options";
-
-		return $h;
-	}
-
-	/**
-	 * Encapsulates string with different color escape characters.
-	 *
-	 * @param string $text
-	 *
-	 * @return string same text as bold
-	 */
-	private function scrAsBold($text) {
-		return "\033[01m" . $text . "\033[0m";
-	}
-
-	/**
-	 * Prints one line of precessed data.
-	 *
-	 * @param array $l line information
-	 *
-	 * @return string
-	 */
-	private function getLine($l) {
-		if ($this->wide === true) {
-			return sprintf("%s%s%s%s%s%s%s%s", $this->ptStr($l['pid'], 6), $this->ptStr($l['ip'], 16), $this->ptStr($l['user'], 24), $this->ptStr($l['command'], 16), $this->ptStr($this->sec2min($l['time']), 8), $this->ptStr($l['devagent'], 28), $this->ptStr($l['devid'], 33, true), $l['addinfo']);
-		}
-
-		return sprintf("%s%s%s%s%s%s%s%s", $this->ptStr($l['pid'], 6), $this->ptStr($l['ip'], 16), $this->ptStr($l['user'], 8), $this->ptStr($l['command'], 8), $this->ptStr($this->sec2min($l['time']), 6), $this->ptStr($l['devagent'], 20), $this->ptStr($l['devid'], 12, true), $l['addinfo']);
-	}
-
-	/**
-	 * Pads and trims string.
-	 *
-	 * @param string $str       to be trimmed/padded
-	 * @param int    $size      characters to be considered
-	 * @param bool   $cutmiddle (optional) indicates where to long information should
-	 *                          be trimmed of, false means at the end
-	 *
-	 * @return string
-	 */
-	private function ptStr($str, $size, $cutmiddle = false) {
-		if (strlen($str) < $size) {
-			return str_pad($str, $size);
-		}
-		if ($cutmiddle == true) {
-			$cut = ($size - 2) / 2;
-
-			return $this->ptStr(substr($str, 0, $cut) . ".." . substr($str, (-1) * ($cut - 1)), $size);
-		}
-
-		return substr($str, 0, $size - 3) . ".. ";
-	}
-
-	/**
-	 * Tries to discover the size of the current terminal.
-	 *
-	 * @return array 'width' and 'height' as keys
-	 */
-	private function scrGetSize() {
-		$tty = strtolower(exec('stty -a | fgrep columns'));
-		if (preg_match_all("/rows.([0-9]+);.columns.([0-9]+);/", $tty, $output) ||
-			preg_match_all("/([0-9]+).rows;.([0-9]+).columns;/", $tty, $output)) {
-			return ['width' => $output[2][0], 'height' => $output[1][0]];
-		}
-
-		return ['width' => 80, 'height' => 24];
-	}
-
-	/**
-	 * Returns the version of the current grommunio-sync installation.
-	 *
-	 * @return string
-	 */
-	private function getVersion() {
-		return GROMMUNIOSYNC_VERSION;
-	}
-
-	/**
-	 * Converts seconds in MM:SS.
-	 *
-	 * @param int $s seconds
-	 *
-	 * @return string
-	 */
-	private function sec2min($s) {
-		if (!is_int($s)) {
-			return $s;
-		}
-
-		return sprintf("%02.2d:%02.2d", floor($s / 60), $s % 60);
-	}
-
-	/**
-	 * Resets the default colors of the terminal.
-	 *
-	 * @return
-	 */
-	private function scrDefaultColors() {
-		echo "\033[0m";
-	}
-
-	/**
-	 * Clears screen of the terminal.
-	 *
-	 * @param array $data
-	 *
-	 * @return
-	 */
-	public function scrClear() {
-		echo "\033[2J";
-	}
-
-	/**
-	 * Prints a text at a specific screen/terminal coordinates.
-	 *
-	 * @param int    $row  row number
-	 * @param int    $col  column number
-	 * @param string $text to be printed
-	 *
-	 * @return
-	 */
-	private function scrPrintAt($row, $col, $text = "") {
-		echo "\033[" . $row . ";" . $col . "H" . $text;
-	}
+    // show options
+    public const SHOW_DEFAULT = 0;
+    public const SHOW_ACTIVE_ONLY = 1;
+    public const SHOW_UNKNOWN_ONLY = 2;
+    public const SHOW_TERM_DEFAULT_TIME = 5; // 5 secs
+
+    private $topCollector;
+    private $starttime;
+    private $action;
+    private $filter;
+    private $status;
+    private $statusexpire;
+    private $wide;
+    private $wasEnabled;
+    private $terminate;
+    private $scrSize;
+    private $pingInterval;
+    private $showPush;
+    private $showTermSec;
+
+    private $linesActive = [];
+    private $linesOpen = [];
+    private $linesUnknown = [];
+    private $linesTerm = [];
+    private $pushConn = 0;
+    private $activeConn = [];
+    private $activeHosts = [];
+    private $activeUsers = [];
+    private $activeDevices = [];
+
+    /**
+     * Constructor.
+     */
+    public function __construct() {
+        $this->starttime = time();
+        $this->currenttime = time();
+        $this->action = "";
+        $this->filter = false;
+        $this->status = false;
+        $this->statusexpire = 0;
+        $this->helpexpire = 0;
+        $this->doingTail = false;
+        $this->wide = false;
+        $this->terminate = false;
+        $this->showPush = true;
+        $this->showOption = self::SHOW_DEFAULT;
+        $this->showTermSec = self::SHOW_TERM_DEFAULT_TIME;
+        $this->scrSize = ['width' => 80, 'height' => 24];
+        $this->pingInterval = (defined('PING_INTERVAL') && PING_INTERVAL > 0) ? PING_INTERVAL : 12;
+
+        // get a TopCollector
+        $this->topCollector = new TopCollector();
+    }
+
+    /**
+     * Requests data from the running grommunio-sync processes.
+     *
+     * @return
+     */
+    private function initialize() {
+        // request feedback from active processes
+        $this->wasEnabled = $this->topCollector->CollectData();
+
+        // remove obsolete data
+        $this->topCollector->ClearLatest(true);
+
+        // start with default colours
+        $this->scrDefaultColors();
+    }
+
+    /**
+     * Main loop of grommunio-sync-top
+     * Runs until termination is requested.
+     *
+     * @return
+     */
+    public function run() {
+        $this->initialize();
+
+        do {
+            $this->currenttime = time();
+
+            // see if shared memory is active
+            if (!$this->IsAvailable()) {
+                $this->terminate = true;
+            }
+
+            // active processes should continue sending data
+            $this->topCollector->CollectData();
+
+            // get and process data from processes
+            $this->topCollector->ClearLatest();
+            $topdata = $this->topCollector->ReadLatest();
+            $this->processData($topdata);
+
+            // clear screen
+            $this->scrClear();
+
+            // check if screen size changed
+            $s = $this->scrGetSize();
+            if ($this->scrSize['width'] != $s['width']) {
+                if ($s['width'] > 180) {
+                    $this->wide = true;
+                }
+                else {
+                    $this->wide = false;
+                }
+            }
+            $this->scrSize = $s;
+
+            // print overview
+            $this->scrOverview();
+
+            // wait for user input
+            $this->readLineProcess();
+        }
+        while ($this->terminate != true);
+    }
+
+    /**
+     * Indicates if TopCollector is available collecting data.
+     *
+     * @return bool
+     */
+    public function IsAvailable() {
+        if (defined('TOPCOLLECTOR_DISABLED') && constant('TOPCOLLECTOR_DISABLED') === true) {
+            return false;
+        }
+
+        return $this->topCollector->IsActive();
+    }
+
+    /**
+     * Processes data written by the running processes.
+     *
+     * @param array $data
+     *
+     * @return
+     */
+    private function processData($data) {
+        $this->linesActive = [];
+        $this->linesOpen = [];
+        $this->linesUnknown = [];
+        $this->linesTerm = [];
+        $this->pushConn = 0;
+        $this->activeConn = [];
+        $this->activeHosts = [];
+        $this->activeUsers = [];
+        $this->activeDevices = [];
+
+        if (!is_array($data)) {
+            return;
+        }
+
+        foreach ($data as $devid => $users) {
+            foreach ($users as $user => $pids) {
+                foreach ($pids as $pid => $line) {
+                    if (!is_array($line)) {
+                        continue;
+                    }
+
+                    $line['command'] = Utils::GetCommandFromCode($line['command']);
+
+                    if ($line["ended"] == 0) {
+                        $this->activeDevices[$devid] = 1;
+                        $this->activeUsers[$user] = 1;
+                        $this->activeConn[$pid] = 1;
+                        $this->activeHosts[$line['ip']] = 1;
+
+                        $line["time"] = $this->currenttime - $line['start'];
+                        if ($line['push'] === true) {
+                            ++$this->pushConn;
+                        }
+
+                        // ignore push connections
+                        if ($line['push'] === true && !$this->showPush) {
+                            continue;
+                        }
+
+                        if ($this->filter !== false) {
+                            $f = $this->filter;
+                            if (!($line["pid"] == $f || $line["ip"] == $f || strtolower($line['command']) == strtolower($f) || preg_match("/.*?{$f}.*?/i", $line['user']) ||
+                                preg_match("/.*?{$f}.*?/i", $line['devagent']) || preg_match("/.*?{$f}.*?/i", $line['devid']) || preg_match("/.*?{$f}.*?/i", $line['addinfo']))) {
+                                continue;
+                            }
+                        }
+
+                        $lastUpdate = $this->currenttime - $line["update"];
+                        if ($this->currenttime - $line["update"] < 2) {
+                            $this->linesActive[$line["update"] . $line["pid"]] = $line;
+                        }
+                        elseif (($line['push'] === true && $lastUpdate > ($this->pingInterval + 2)) || ($line['push'] !== true && $lastUpdate > 4)) {
+                            $this->linesUnknown[$line["update"] . $line["pid"]] = $line;
+                        }
+                        else {
+                            $this->linesOpen[$line["update"] . $line["pid"]] = $line;
+                        }
+                    }
+                    else {
+                        // do not show terminated + expired connections
+                        if ($this->currenttime > $line['ended'] + $this->showTermSec) {
+                            continue;
+                        }
+
+                        if ($this->filter !== false) {
+                            $f = $this->filter;
+                            if (
+                                    !(
+                                        $line['pid'] == $f ||
+                                        $line['ip'] == $f ||
+                                        strtolower($line['command']) == strtolower($f) ||
+                                        preg_match("/.*?{$f}.*?/i", $line['user']) ||
+                                        preg_match("/.*?{$f}.*?/i", $line['devagent']) ||
+                                        preg_match("/.*?{$f}.*?/i", $line['devid']) ||
+                                        preg_match("/.*?{$f}.*?/i", $line['addinfo'])
+                                    )) {
+                                continue;
+                            }
+                        }
+
+                        $line['time'] = $line['ended'] - $line['start'];
+                        $this->linesTerm[$line['update'] . $line['pid']] = $line;
+                    }
+                }
+            }
+        }
+
+        // sort by execution time
+        krsort($this->linesActive);
+        krsort($this->linesOpen);
+        krsort($this->linesUnknown);
+        krsort($this->linesTerm);
+    }
+
+    /**
+     * Prints data to the terminal.
+     *
+     * @return
+     */
+    private function scrOverview() {
+        $linesAvail = $this->scrSize['height'] - 8;
+        $lc = 1;
+        $this->scrPrintAt($lc, 0, "\033[1mgrommunio-sync-top live statistics\033[0m\t\t\t\t\t" . @strftime("%d/%m/%Y %T") . "\n");
+        ++$lc;
+
+        $this->scrPrintAt($lc, 0, sprintf("Open connections: %d\t\t\t\tUsers:\t %d\tgrommunio-sync:   %s ", count($this->activeConn), count($this->activeUsers), $this->getVersion()));
+        ++$lc;
+        $this->scrPrintAt($lc, 0, sprintf("Push connections: %d\t\t\t\tDevices: %d\tPHP-MAPI: %s", $this->pushConn, count($this->activeDevices), phpversion("mapi")));
+        ++$lc;
+        $this->scrPrintAt($lc, 0, sprintf("                                                Hosts:\t %d", count($this->activeHosts)));
+        ++$lc;
+        ++$lc;
+
+        $this->scrPrintAt($lc, 0, "\033[4m" . $this->getLine(['pid' => 'PID', 'ip' => 'IP', 'user' => 'USER', 'command' => 'COMMAND', 'time' => 'TIME', 'devagent' => 'AGENT', 'devid' => 'DEVID', 'addinfo' => 'Additional Information']) . str_repeat(" ", 20) . "\033[0m");
+        ++$lc;
+
+        // print help text if requested
+        $hl = 0;
+        if ($this->helpexpire > $this->currenttime) {
+            $help = $this->scrHelp();
+            $linesAvail -= count($help);
+            $hl = $this->scrSize['height'] - count($help) - 1;
+            foreach ($help as $h) {
+                $this->scrPrintAt($hl, 0, $h);
+                ++$hl;
+            }
+        }
+
+        $toPrintActive = $linesAvail;
+        $toPrintOpen = $linesAvail;
+        $toPrintUnknown = $linesAvail;
+        $toPrintTerm = $linesAvail;
+
+        // default view: show all unknown, no terminated and half active+open
+        if (count($this->linesActive) + count($this->linesOpen) + count($this->linesUnknown) > $linesAvail) {
+            $toPrintUnknown = count($this->linesUnknown);
+            $toPrintActive = count($this->linesActive);
+            $toPrintOpen = $linesAvail - $toPrintUnknown - $toPrintActive;
+            $toPrintTerm = 0;
+        }
+
+        if ($this->showOption == self::SHOW_ACTIVE_ONLY) {
+            $toPrintActive = $linesAvail;
+            $toPrintOpen = 0;
+            $toPrintUnknown = 0;
+            $toPrintTerm = 0;
+        }
+
+        if ($this->showOption == self::SHOW_UNKNOWN_ONLY) {
+            $toPrintActive = 0;
+            $toPrintOpen = 0;
+            $toPrintUnknown = $linesAvail;
+            $toPrintTerm = 0;
+        }
+
+        $linesprinted = 0;
+        foreach ($this->linesActive as $time => $l) {
+            if ($linesprinted >= $toPrintActive) {
+                break;
+            }
+
+            $this->scrPrintAt($lc, 0, "\033[01m" . $this->getLine($l) . "\033[0m");
+            ++$lc;
+            ++$linesprinted;
+        }
+
+        $linesprinted = 0;
+        foreach ($this->linesOpen as $time => $l) {
+            if ($linesprinted >= $toPrintOpen) {
+                break;
+            }
+
+            $this->scrPrintAt($lc, 0, $this->getLine($l));
+            ++$lc;
+            ++$linesprinted;
+        }
+
+        $linesprinted = 0;
+        foreach ($this->linesUnknown as $time => $l) {
+            if ($linesprinted >= $toPrintUnknown) {
+                break;
+            }
+
+            $color = "0;31m";
+            if ($l['push'] == false && $time - $l["start"] > 30) {
+                $color = "1;31m";
+            }
+            $this->scrPrintAt($lc, 0, "\033[0" . $color . $this->getLine($l) . "\033[0m");
+            ++$lc;
+            ++$linesprinted;
+        }
+
+        if ($toPrintTerm > 0) {
+            $toPrintTerm = $linesAvail - $lc + 6;
+        }
+
+        $linesprinted = 0;
+        foreach ($this->linesTerm as $time => $l) {
+            if ($linesprinted >= $toPrintTerm) {
+                break;
+            }
+
+            $this->scrPrintAt($lc, 0, "\033[01;30m" . $this->getLine($l) . "\033[0m");
+            ++$lc;
+            ++$linesprinted;
+        }
+
+        // add the lines used when displaying the help text
+        $lc += $hl;
+        $this->scrPrintAt($lc, 0, "\033[K");
+        ++$lc;
+        $this->scrPrintAt($lc, 0, "Colorscheme: \033[01mActive  \033[0mOpen  \033[01;31mUnknown  \033[01;30mTerminated\033[0m");
+
+        // remove old status
+        if ($this->statusexpire < $this->currenttime) {
+            $this->status = false;
+        }
+
+        // show request information and help command
+        if ($this->starttime + 6 > $this->currenttime) {
+            $this->status = sprintf("Requesting information (takes up to %dsecs)", $this->pingInterval) . str_repeat(".", ($this->currenttime - $this->starttime)) . "  type \033[01;31mh\033[00;31m or \033[01;31mhelp\033[00;31m for usage instructions";
+            $this->statusexpire = $this->currenttime + 1;
+        }
+
+        $str = "";
+        if (!$this->showPush) {
+            $str .= "\033[00;32mPush: \033[01;32mNo\033[0m   ";
+        }
+
+        if ($this->showOption == self::SHOW_ACTIVE_ONLY) {
+            $str .= "\033[01;32mActive only\033[0m   ";
+        }
+
+        if ($this->showOption == self::SHOW_UNKNOWN_ONLY) {
+            $str .= "\033[01;32mUnknown only\033[0m   ";
+        }
+
+        if ($this->showTermSec != self::SHOW_TERM_DEFAULT_TIME) {
+            $str .= "\033[01;32mTerminated: " . $this->showTermSec . "s\033[0m   ";
+        }
+
+        if ($this->filter !== false || ($this->status !== false && $this->statusexpire > $this->currenttime)) {
+            // print filter in green
+            if ($this->filter !== false) {
+                $str .= "\033[00;32mFilter: \033[01;32m{$this->filter}\033[0m   ";
+            }
+            // print status in red
+            if ($this->status !== false) {
+                $str .= "\033[00;31m{$this->status}\033[0m";
+            }
+        }
+        $this->scrPrintAt(5, 0, $str);
+
+        $this->scrPrintAt(4, 0, "Action: \033[01m" . $this->action . "\033[0m");
+    }
+
+    /**
+     * Waits for a keystroke and processes the requested command.
+     *
+     * @return
+     */
+    private function readLineProcess() {
+        $ans = explode("^^", `bash -c "read -n 1 -t 1 ANS ; echo \\\$?^^\\\$ANS;"`);
+
+        if ($ans[0] < 128) {
+            if (isset($ans[1]) && bin2hex(trim($ans[1])) == "7f") {
+                $this->action = substr($this->action, 0, -1);
+            }
+
+            if (isset($ans[1]) && $ans[1] != "") {
+                $this->action .= trim(preg_replace("/[^A-Za-z0-9:]/", "", $ans[1]));
+            }
+
+            if (bin2hex($ans[0]) == "30" && bin2hex($ans[1]) == "0a") {
+                $cmds = explode(':', $this->action);
+                if ($cmds[0] == "quit" || $cmds[0] == "q" || (isset($cmds[1]) && $cmds[0] == "" && $cmds[1] == "q")) {
+                    $this->topCollector->CollectData(true);
+                    $this->topCollector->ClearLatest(true);
+
+                    $this->terminate = true;
+                }
+                elseif ($cmds[0] == "clear") {
+                    $this->topCollector->ClearLatest(true);
+                    $this->topCollector->CollectData(true);
+                    $this->topCollector->ReInitIPC();
+                }
+                elseif ($cmds[0] == "filter" || $cmds[0] == "f") {
+                    if (!isset($cmds[1]) || $cmds[1] == "") {
+                        $this->filter = false;
+                        $this->status = "No filter";
+                        $this->statusexpire = $this->currenttime + 5;
+                    }
+                    else {
+                        $this->filter = $cmds[1];
+                        $this->status = false;
+                    }
+                }
+                elseif ($cmds[0] == "option" || $cmds[0] == "o") {
+                    if (!isset($cmds[1]) || $cmds[1] == "") {
+                        $this->status = "Option value needs to be specified. See 'help' or 'h' for instructions";
+                        $this->statusexpire = $this->currenttime + 5;
+                    }
+                    elseif ($cmds[1] == "p" || $cmds[1] == "push" || $cmds[1] == "ping") {
+                        $this->showPush = !$this->showPush;
+                    }
+                    elseif ($cmds[1] == "a" || $cmds[1] == "active") {
+                        $this->showOption = self::SHOW_ACTIVE_ONLY;
+                    }
+                    elseif ($cmds[1] == "u" || $cmds[1] == "unknown") {
+                        $this->showOption = self::SHOW_UNKNOWN_ONLY;
+                    }
+                    elseif ($cmds[1] == "d" || $cmds[1] == "default") {
+                        $this->showOption = self::SHOW_DEFAULT;
+                        $this->showTermSec = self::SHOW_TERM_DEFAULT_TIME;
+                        $this->showPush = true;
+                    }
+                    elseif (is_numeric($cmds[1])) {
+                        $this->showTermSec = $cmds[1];
+                    }
+                    else {
+                        $this->status = sprintf("Option '%s' unknown", $cmds[1]);
+                        $this->statusexpire = $this->currenttime + 5;
+                    }
+                }
+                elseif ($cmds[0] == "reset" || $cmds[0] == "r") {
+                    $this->filter = false;
+                    $this->wide = false;
+                    $this->helpexpire = 0;
+                    $this->status = "reset";
+                    $this->statusexpire = $this->currenttime + 2;
+                }
+                // enable/disable wide view
+                elseif ($cmds[0] == "wide" || $cmds[0] == "w") {
+                    $this->wide = !$this->wide;
+                    $this->status = ($this->wide) ? "w i d e  view" : "normal view";
+                    $this->statusexpire = $this->currenttime + 2;
+                }
+                elseif ($cmds[0] == "help" || $cmds[0] == "h") {
+                    $this->helpexpire = $this->currenttime + 20;
+                }
+                // grep the log file
+                elseif (($cmds[0] == "log" || $cmds[0] == "l") && isset($cmds[1])) {
+                    if (!file_exists(LOGFILE)) {
+                        $this->status = "Logfile can not be found: " . LOGFILE;
+                    }
+                    else {
+                        system('bash -c "fgrep -a ' . escapeshellarg($cmds[1]) . ' ' . LOGFILE . ' | less +G" > `tty`');
+                        $this->status = "Returning from log, updating data";
+                    }
+                    $this->statusexpire = time() + 5; // it might be much "later" now
+                }
+                // tail the log file
+                elseif (($cmds[0] == "tail" || $cmds[0] == "t")) {
+                    if (!file_exists(LOGFILE)) {
+                        $this->status = "Logfile can not be found: " . LOGFILE;
+                    }
+                    else {
+                        $this->doingTail = true;
+                        $this->scrClear();
+                        $this->scrPrintAt(1, 0, $this->scrAsBold("Press CTRL+C to return to grommunio-sync-top\n\n"));
+                        $secondary = "";
+                        if (isset($cmds[1])) {
+                            $secondary = " -n 200 | grep " . escapeshellarg($cmds[1]);
+                        }
+                        system('bash -c "tail -f ' . LOGFILE . $secondary . '" > `tty`');
+                        $this->doingTail = false;
+                        $this->status = "Returning from tail, updating data";
+                    }
+                    $this->statusexpire = time() + 5; // it might be much "later" now
+                }
+                // tail the error log file
+                elseif (($cmds[0] == "error" || $cmds[0] == "e")) {
+                    if (!file_exists(LOGERRORFILE)) {
+                        $this->status = "Error logfile can not be found: " . LOGERRORFILE;
+                    }
+                    else {
+                        $this->doingTail = true;
+                        $this->scrClear();
+                        $this->scrPrintAt(1, 0, $this->scrAsBold("Press CTRL+C to return to grommunio-sync-top\n\n"));
+                        $secondary = "";
+                        if (isset($cmds[1])) {
+                            $secondary = " -n 200 | grep " . escapeshellarg($cmds[1]);
+                        }
+                        system('bash -c "tail -f ' . LOGERRORFILE . $secondary . '" > `tty`');
+                        $this->doingTail = false;
+                        $this->status = "Returning from tail, updating data";
+                    }
+                    $this->statusexpire = time() + 5; // it might be much "later" now
+                }
+                elseif ($cmds[0] != "") {
+                    $this->status = sprintf("Command '%s' unknown", $cmds[0]);
+                    $this->statusexpire = $this->currenttime + 8;
+                }
+                $this->action = "";
+            }
+        }
+    }
+
+    /**
+     * Signal handler function.
+     *
+     * @param int $signo signal number
+     *
+     * @return
+     */
+    public function SignalHandler($signo) {
+        // don't terminate if the signal was sent by terminating tail
+        if (!$this->doingTail) {
+            $this->topCollector->CollectData(true);
+            $this->topCollector->ClearLatest(true);
+            $this->terminate = true;
+        }
+    }
+
+    /**
+     * Returns usage instructions.
+     *
+     * @return string
+     */
+    public function UsageInstructions() {
+        $help = "Usage:\n\tgrommunio-sync-top.php\n\n" .
+                "  grommunio-sync-top is a live top-like overview of what grommunio-sync is doing. It does not have specific command line options.\n\n" .
+                "  When grommunio-sync-top is running you can specify certain actions and options which can be executed (listed below).\n" .
+                "  This help information can also be shown inside grommunio-sync-top by hitting 'help' or 'h'.\n\n";
+        $scrhelp = $this->scrHelp();
+        unset($scrhelp[0]);
+
+        $help .= implode("\n", $scrhelp);
+        $help .= "\n\n";
+
+        return $help;
+    }
+
+    /**
+     * Prints a 'help' text at the end of the page.
+     *
+     * @return array with help lines
+     */
+    private function scrHelp() {
+        $h = [];
+        $secs = $this->helpexpire - $this->currenttime;
+        $h[] = "Actions supported by grommunio-sync-top (help page still displayed for " . $secs . "secs)";
+        $h[] = "  " . $this->scrAsBold("Action") . "\t\t" . $this->scrAsBold("Comment");
+        $h[] = "  " . $this->scrAsBold("h") . " or " . $this->scrAsBold("help") . "\t\tDisplays this information.";
+        $h[] = "  " . $this->scrAsBold("q") . ", " . $this->scrAsBold("quit") . " or " . $this->scrAsBold(":q") . "\t\tExits grommunio-sync-top.";
+        $h[] = "  " . $this->scrAsBold("w") . " or " . $this->scrAsBold("wide") . "\t\tTries not to truncate data. Automatically done if more than 180 columns available.";
+        $h[] = "  " . $this->scrAsBold("f:VAL") . " or " . $this->scrAsBold("filter:VAL") . "\tOnly display connections which contain VAL. This value is case-insensitive.";
+        $h[] = "  " . $this->scrAsBold("f:") . " or " . $this->scrAsBold("filter:") . "\t\tWithout a search word: resets the filter.";
+        $h[] = "  " . $this->scrAsBold("l:STR") . " or " . $this->scrAsBold("log:STR") . "\tIssues 'less +G' on the logfile, after grepping on the optional STR.";
+        $h[] = "  " . $this->scrAsBold("t:STR") . " or " . $this->scrAsBold("tail:STR") . "\tIssues 'tail -f' on the logfile, grepping for optional STR.";
+        $h[] = "  " . $this->scrAsBold("e:STR") . " or " . $this->scrAsBold("error:STR") . "\tIssues 'tail -f' on the error logfile, grepping for optional STR.";
+        $h[] = "  " . $this->scrAsBold("r") . " or " . $this->scrAsBold("reset") . "\t\tResets 'wide' or 'filter'.";
+        $h[] = "  " . $this->scrAsBold("o:") . " or " . $this->scrAsBold("option:") . "\t\tSets display options. Valid options specified below";
+        $h[] = "  " . $this->scrAsBold("  p") . " or " . $this->scrAsBold("push") . "\t\tLists/not lists active and open push connections.";
+        $h[] = "  " . $this->scrAsBold("  a") . " or " . $this->scrAsBold("action") . "\t\tLists only active connections.";
+        $h[] = "  " . $this->scrAsBold("  u") . " or " . $this->scrAsBold("unknown") . "\tLists only unknown connections.";
+        $h[] = "  " . $this->scrAsBold("  10") . " or " . $this->scrAsBold("20") . "\t\tLists terminated connections for 10 or 20 seconds. Any other number can be used.";
+        $h[] = "  " . $this->scrAsBold("  d") . " or " . $this->scrAsBold("default") . "\tUses default options";
+
+        return $h;
+    }
+
+    /**
+     * Encapsulates string with different color escape characters.
+     *
+     * @param string $text
+     *
+     * @return string same text as bold
+     */
+    private function scrAsBold($text) {
+        return "\033[01m" . $text . "\033[0m";
+    }
+
+    /**
+     * Prints one line of precessed data.
+     *
+     * @param array $l line information
+     *
+     * @return string
+     */
+    private function getLine($l) {
+        if ($this->wide === true) {
+            return sprintf("%s%s%s%s%s%s%s%s", $this->ptStr($l['pid'], 6), $this->ptStr($l['ip'], 16), $this->ptStr($l['user'], 24), $this->ptStr($l['command'], 16), $this->ptStr($this->sec2min($l['time']), 8), $this->ptStr($l['devagent'], 28), $this->ptStr($l['devid'], 33, true), $l['addinfo']);
+        }
+
+        return sprintf("%s%s%s%s%s%s%s%s", $this->ptStr($l['pid'], 6), $this->ptStr($l['ip'], 16), $this->ptStr($l['user'], 8), $this->ptStr($l['command'], 8), $this->ptStr($this->sec2min($l['time']), 6), $this->ptStr($l['devagent'], 20), $this->ptStr($l['devid'], 12, true), $l['addinfo']);
+    }
+
+    /**
+     * Pads and trims string.
+     *
+     * @param string $str       to be trimmed/padded
+     * @param int    $size      characters to be considered
+     * @param bool   $cutmiddle (optional) indicates where to long information should
+     *                          be trimmed of, false means at the end
+     *
+     * @return string
+     */
+    private function ptStr($str, $size, $cutmiddle = false) {
+        if (strlen($str) < $size) {
+            return str_pad($str, $size);
+        }
+        if ($cutmiddle == true) {
+            $cut = ($size - 2) / 2;
+
+            return $this->ptStr(substr($str, 0, $cut) . ".." . substr($str, (-1) * ($cut - 1)), $size);
+        }
+
+        return substr($str, 0, $size - 3) . ".. ";
+    }
+
+    /**
+     * Tries to discover the size of the current terminal.
+     *
+     * @return array 'width' and 'height' as keys
+     */
+    private function scrGetSize() {
+        $tty = strtolower(exec('stty -a | fgrep columns'));
+        if (preg_match_all("/rows.([0-9]+);.columns.([0-9]+);/", $tty, $output) ||
+            preg_match_all("/([0-9]+).rows;.([0-9]+).columns;/", $tty, $output)) {
+            return ['width' => $output[2][0], 'height' => $output[1][0]];
+        }
+
+        return ['width' => 80, 'height' => 24];
+    }
+
+    /**
+     * Returns the version of the current grommunio-sync installation.
+     *
+     * @return string
+     */
+    private function getVersion() {
+        return GROMMUNIOSYNC_VERSION;
+    }
+
+    /**
+     * Converts seconds in MM:SS.
+     *
+     * @param int $s seconds
+     *
+     * @return string
+     */
+    private function sec2min($s) {
+        if (!is_int($s)) {
+            return $s;
+        }
+
+        return sprintf("%02.2d:%02.2d", floor($s / 60), $s % 60);
+    }
+
+    /**
+     * Resets the default colors of the terminal.
+     *
+     * @return
+     */
+    private function scrDefaultColors() {
+        echo "\033[0m";
+    }
+
+    /**
+     * Clears screen of the terminal.
+     *
+     * @param array $data
+     *
+     * @return
+     */
+    public function scrClear() {
+        echo "\033[2J";
+    }
+
+    /**
+     * Prints a text at a specific screen/terminal coordinates.
+     *
+     * @param int    $row  row number
+     * @param int    $col  column number
+     * @param string $text to be printed
+     *
+     * @return
+     */
+    private function scrPrintAt($row, $col, $text = "") {
+        echo "\033[" . $row . ";" . $col . "H" . $text;
+    }
 }

Spacing +48 added lines, -48 removed lines

@@ -20,11 +20,11 @@ 
  * MAIN
  */
 	declare(ticks=1);
-	define('BASE_PATH_CLI', dirname(__FILE__) . "/");
-	set_include_path(get_include_path() . PATH_SEPARATOR . BASE_PATH_CLI);
+	define('BASE_PATH_CLI', dirname(__FILE__)."/");
+	set_include_path(get_include_path().PATH_SEPARATOR.BASE_PATH_CLI);
 
 	if (!defined('GSYNC_CONFIG')) {
-		define('GSYNC_CONFIG', BASE_PATH_CLI . 'config.php');
+		define('GSYNC_CONFIG', BASE_PATH_CLI.'config.php');
 	}
 
 	include_once GSYNC_CONFIG;
@@ -59,7 +59,7 @@ 
 		}
 	}
 	catch (GSyncException $zpe) {
-		fwrite(STDERR, get_class($zpe) . ": " . $zpe->getMessage() . "\n");
+		fwrite(STDERR, get_class($zpe).": ".$zpe->getMessage()."\n");
 
 		exit(1);
 	}
@@ -259,13 +259,13 @@ 
 
 						$lastUpdate = $this->currenttime - $line["update"];
 						if ($this->currenttime - $line["update"] < 2) {
-							$this->linesActive[$line["update"] . $line["pid"]] = $line;
+							$this->linesActive[$line["update"].$line["pid"]] = $line;
 						}
 						elseif (($line['push'] === true && $lastUpdate > ($this->pingInterval + 2)) || ($line['push'] !== true && $lastUpdate > 4)) {
-							$this->linesUnknown[$line["update"] . $line["pid"]] = $line;
+							$this->linesUnknown[$line["update"].$line["pid"]] = $line;
 						}
 						else {
-							$this->linesOpen[$line["update"] . $line["pid"]] = $line;
+							$this->linesOpen[$line["update"].$line["pid"]] = $line;
 						}
 					}
 					else {
@@ -291,7 +291,7 @@ 
 						}
 
 						$line['time'] = $line['ended'] - $line['start'];
-						$this->linesTerm[$line['update'] . $line['pid']] = $line;
+						$this->linesTerm[$line['update'].$line['pid']] = $line;
 					}
 				}
 			}
@@ -312,7 +312,7 @@ 
 	private function scrOverview() {
 		$linesAvail = $this->scrSize['height'] - 8;
 		$lc = 1;
-		$this->scrPrintAt($lc, 0, "\033[1mgrommunio-sync-top live statistics\033[0m\t\t\t\t\t" . @strftime("%d/%m/%Y %T") . "\n");
+		$this->scrPrintAt($lc, 0, "\033[1mgrommunio-sync-top live statistics\033[0m\t\t\t\t\t".@strftime("%d/%m/%Y %T")."\n");
 		++$lc;
 
 		$this->scrPrintAt($lc, 0, sprintf("Open connections: %d\t\t\t\tUsers:\t %d\tgrommunio-sync:   %s ", count($this->activeConn), count($this->activeUsers), $this->getVersion()));
@@ -323,7 +323,7 @@ 
 		++$lc;
 		++$lc;
 
-		$this->scrPrintAt($lc, 0, "\033[4m" . $this->getLine(['pid' => 'PID', 'ip' => 'IP', 'user' => 'USER', 'command' => 'COMMAND', 'time' => 'TIME', 'devagent' => 'AGENT', 'devid' => 'DEVID', 'addinfo' => 'Additional Information']) . str_repeat(" ", 20) . "\033[0m");
+		$this->scrPrintAt($lc, 0, "\033[4m".$this->getLine(['pid' => 'PID', 'ip' => 'IP', 'user' => 'USER', 'command' => 'COMMAND', 'time' => 'TIME', 'devagent' => 'AGENT', 'devid' => 'DEVID', 'addinfo' => 'Additional Information']).str_repeat(" ", 20)."\033[0m");
 		++$lc;
 
 		// print help text if requested
@@ -371,7 +371,7 @@ 
 				break;
 			}
 
-			$this->scrPrintAt($lc, 0, "\033[01m" . $this->getLine($l) . "\033[0m");
+			$this->scrPrintAt($lc, 0, "\033[01m".$this->getLine($l)."\033[0m");
 			++$lc;
 			++$linesprinted;
 		}
@@ -397,7 +397,7 @@ 
 			if ($l['push'] == false && $time - $l["start"] > 30) {
 				$color = "1;31m";
 			}
-			$this->scrPrintAt($lc, 0, "\033[0" . $color . $this->getLine($l) . "\033[0m");
+			$this->scrPrintAt($lc, 0, "\033[0".$color.$this->getLine($l)."\033[0m");
 			++$lc;
 			++$linesprinted;
 		}
@@ -412,7 +412,7 @@ 
 				break;
 			}
 
-			$this->scrPrintAt($lc, 0, "\033[01;30m" . $this->getLine($l) . "\033[0m");
+			$this->scrPrintAt($lc, 0, "\033[01;30m".$this->getLine($l)."\033[0m");
 			++$lc;
 			++$linesprinted;
 		}
@@ -430,7 +430,7 @@ 
 
 		// show request information and help command
 		if ($this->starttime + 6 > $this->currenttime) {
-			$this->status = sprintf("Requesting information (takes up to %dsecs)", $this->pingInterval) . str_repeat(".", ($this->currenttime - $this->starttime)) . "  type \033[01;31mh\033[00;31m or \033[01;31mhelp\033[00;31m for usage instructions";
+			$this->status = sprintf("Requesting information (takes up to %dsecs)", $this->pingInterval).str_repeat(".", ($this->currenttime - $this->starttime))."  type \033[01;31mh\033[00;31m or \033[01;31mhelp\033[00;31m for usage instructions";
 			$this->statusexpire = $this->currenttime + 1;
 		}
 
@@ -448,7 +448,7 @@ 
 		}
 
 		if ($this->showTermSec != self::SHOW_TERM_DEFAULT_TIME) {
-			$str .= "\033[01;32mTerminated: " . $this->showTermSec . "s\033[0m   ";
+			$str .= "\033[01;32mTerminated: ".$this->showTermSec."s\033[0m   ";
 		}
 
 		if ($this->filter !== false || ($this->status !== false && $this->statusexpire > $this->currenttime)) {
@@ -463,7 +463,7 @@ 
 		}
 		$this->scrPrintAt(5, 0, $str);
 
-		$this->scrPrintAt(4, 0, "Action: \033[01m" . $this->action . "\033[0m");
+		$this->scrPrintAt(4, 0, "Action: \033[01m".$this->action."\033[0m");
 	}
 
 	/**
@@ -553,10 +553,10 @@ 
 				// grep the log file
 				elseif (($cmds[0] == "log" || $cmds[0] == "l") && isset($cmds[1])) {
 					if (!file_exists(LOGFILE)) {
-						$this->status = "Logfile can not be found: " . LOGFILE;
+						$this->status = "Logfile can not be found: ".LOGFILE;
 					}
 					else {
-						system('bash -c "fgrep -a ' . escapeshellarg($cmds[1]) . ' ' . LOGFILE . ' | less +G" > `tty`');
+						system('bash -c "fgrep -a '.escapeshellarg($cmds[1]).' '.LOGFILE.' | less +G" > `tty`');
 						$this->status = "Returning from log, updating data";
 					}
 					$this->statusexpire = time() + 5; // it might be much "later" now
@@ -564,7 +564,7 @@ 
 				// tail the log file
 				elseif (($cmds[0] == "tail" || $cmds[0] == "t")) {
 					if (!file_exists(LOGFILE)) {
-						$this->status = "Logfile can not be found: " . LOGFILE;
+						$this->status = "Logfile can not be found: ".LOGFILE;
 					}
 					else {
 						$this->doingTail = true;
@@ -572,9 +572,9 @@ 
 						$this->scrPrintAt(1, 0, $this->scrAsBold("Press CTRL+C to return to grommunio-sync-top\n\n"));
 						$secondary = "";
 						if (isset($cmds[1])) {
-							$secondary = " -n 200 | grep " . escapeshellarg($cmds[1]);
+							$secondary = " -n 200 | grep ".escapeshellarg($cmds[1]);
 						}
-						system('bash -c "tail -f ' . LOGFILE . $secondary . '" > `tty`');
+						system('bash -c "tail -f '.LOGFILE.$secondary.'" > `tty`');
 						$this->doingTail = false;
 						$this->status = "Returning from tail, updating data";
 					}
@@ -583,7 +583,7 @@ 
 				// tail the error log file
 				elseif (($cmds[0] == "error" || $cmds[0] == "e")) {
 					if (!file_exists(LOGERRORFILE)) {
-						$this->status = "Error logfile can not be found: " . LOGERRORFILE;
+						$this->status = "Error logfile can not be found: ".LOGERRORFILE;
 					}
 					else {
 						$this->doingTail = true;
@@ -591,9 +591,9 @@ 
 						$this->scrPrintAt(1, 0, $this->scrAsBold("Press CTRL+C to return to grommunio-sync-top\n\n"));
 						$secondary = "";
 						if (isset($cmds[1])) {
-							$secondary = " -n 200 | grep " . escapeshellarg($cmds[1]);
+							$secondary = " -n 200 | grep ".escapeshellarg($cmds[1]);
 						}
-						system('bash -c "tail -f ' . LOGERRORFILE . $secondary . '" > `tty`');
+						system('bash -c "tail -f '.LOGERRORFILE.$secondary.'" > `tty`');
 						$this->doingTail = false;
 						$this->status = "Returning from tail, updating data";
 					}
@@ -630,9 +630,9 @@ 
 	 * @return string
 	 */
 	public function UsageInstructions() {
-		$help = "Usage:\n\tgrommunio-sync-top.php\n\n" .
-				"  grommunio-sync-top is a live top-like overview of what grommunio-sync is doing. It does not have specific command line options.\n\n" .
-				"  When grommunio-sync-top is running you can specify certain actions and options which can be executed (listed below).\n" .
+		$help = "Usage:\n\tgrommunio-sync-top.php\n\n".
+				"  grommunio-sync-top is a live top-like overview of what grommunio-sync is doing. It does not have specific command line options.\n\n".
+				"  When grommunio-sync-top is running you can specify certain actions and options which can be executed (listed below).\n".
 				"  This help information can also be shown inside grommunio-sync-top by hitting 'help' or 'h'.\n\n";
 		$scrhelp = $this->scrHelp();
 		unset($scrhelp[0]);
@@ -651,23 +651,23 @@ 
 	private function scrHelp() {
 		$h = [];
 		$secs = $this->helpexpire - $this->currenttime;
-		$h[] = "Actions supported by grommunio-sync-top (help page still displayed for " . $secs . "secs)";
-		$h[] = "  " . $this->scrAsBold("Action") . "\t\t" . $this->scrAsBold("Comment");
-		$h[] = "  " . $this->scrAsBold("h") . " or " . $this->scrAsBold("help") . "\t\tDisplays this information.";
-		$h[] = "  " . $this->scrAsBold("q") . ", " . $this->scrAsBold("quit") . " or " . $this->scrAsBold(":q") . "\t\tExits grommunio-sync-top.";
-		$h[] = "  " . $this->scrAsBold("w") . " or " . $this->scrAsBold("wide") . "\t\tTries not to truncate data. Automatically done if more than 180 columns available.";
-		$h[] = "  " . $this->scrAsBold("f:VAL") . " or " . $this->scrAsBold("filter:VAL") . "\tOnly display connections which contain VAL. This value is case-insensitive.";
-		$h[] = "  " . $this->scrAsBold("f:") . " or " . $this->scrAsBold("filter:") . "\t\tWithout a search word: resets the filter.";
-		$h[] = "  " . $this->scrAsBold("l:STR") . " or " . $this->scrAsBold("log:STR") . "\tIssues 'less +G' on the logfile, after grepping on the optional STR.";
-		$h[] = "  " . $this->scrAsBold("t:STR") . " or " . $this->scrAsBold("tail:STR") . "\tIssues 'tail -f' on the logfile, grepping for optional STR.";
-		$h[] = "  " . $this->scrAsBold("e:STR") . " or " . $this->scrAsBold("error:STR") . "\tIssues 'tail -f' on the error logfile, grepping for optional STR.";
-		$h[] = "  " . $this->scrAsBold("r") . " or " . $this->scrAsBold("reset") . "\t\tResets 'wide' or 'filter'.";
-		$h[] = "  " . $this->scrAsBold("o:") . " or " . $this->scrAsBold("option:") . "\t\tSets display options. Valid options specified below";
-		$h[] = "  " . $this->scrAsBold("  p") . " or " . $this->scrAsBold("push") . "\t\tLists/not lists active and open push connections.";
-		$h[] = "  " . $this->scrAsBold("  a") . " or " . $this->scrAsBold("action") . "\t\tLists only active connections.";
-		$h[] = "  " . $this->scrAsBold("  u") . " or " . $this->scrAsBold("unknown") . "\tLists only unknown connections.";
-		$h[] = "  " . $this->scrAsBold("  10") . " or " . $this->scrAsBold("20") . "\t\tLists terminated connections for 10 or 20 seconds. Any other number can be used.";
-		$h[] = "  " . $this->scrAsBold("  d") . " or " . $this->scrAsBold("default") . "\tUses default options";
+		$h[] = "Actions supported by grommunio-sync-top (help page still displayed for ".$secs."secs)";
+		$h[] = "  ".$this->scrAsBold("Action")."\t\t".$this->scrAsBold("Comment");
+		$h[] = "  ".$this->scrAsBold("h")." or ".$this->scrAsBold("help")."\t\tDisplays this information.";
+		$h[] = "  ".$this->scrAsBold("q").", ".$this->scrAsBold("quit")." or ".$this->scrAsBold(":q")."\t\tExits grommunio-sync-top.";
+		$h[] = "  ".$this->scrAsBold("w")." or ".$this->scrAsBold("wide")."\t\tTries not to truncate data. Automatically done if more than 180 columns available.";
+		$h[] = "  ".$this->scrAsBold("f:VAL")." or ".$this->scrAsBold("filter:VAL")."\tOnly display connections which contain VAL. This value is case-insensitive.";
+		$h[] = "  ".$this->scrAsBold("f:")." or ".$this->scrAsBold("filter:")."\t\tWithout a search word: resets the filter.";
+		$h[] = "  ".$this->scrAsBold("l:STR")." or ".$this->scrAsBold("log:STR")."\tIssues 'less +G' on the logfile, after grepping on the optional STR.";
+		$h[] = "  ".$this->scrAsBold("t:STR")." or ".$this->scrAsBold("tail:STR")."\tIssues 'tail -f' on the logfile, grepping for optional STR.";
+		$h[] = "  ".$this->scrAsBold("e:STR")." or ".$this->scrAsBold("error:STR")."\tIssues 'tail -f' on the error logfile, grepping for optional STR.";
+		$h[] = "  ".$this->scrAsBold("r")." or ".$this->scrAsBold("reset")."\t\tResets 'wide' or 'filter'.";
+		$h[] = "  ".$this->scrAsBold("o:")." or ".$this->scrAsBold("option:")."\t\tSets display options. Valid options specified below";
+		$h[] = "  ".$this->scrAsBold("  p")." or ".$this->scrAsBold("push")."\t\tLists/not lists active and open push connections.";
+		$h[] = "  ".$this->scrAsBold("  a")." or ".$this->scrAsBold("action")."\t\tLists only active connections.";
+		$h[] = "  ".$this->scrAsBold("  u")." or ".$this->scrAsBold("unknown")."\tLists only unknown connections.";
+		$h[] = "  ".$this->scrAsBold("  10")." or ".$this->scrAsBold("20")."\t\tLists terminated connections for 10 or 20 seconds. Any other number can be used.";
+		$h[] = "  ".$this->scrAsBold("  d")." or ".$this->scrAsBold("default")."\tUses default options";
 
 		return $h;
 	}
@@ -680,7 +680,7 @@ 
 	 * @return string same text as bold
 	 */
 	private function scrAsBold($text) {
-		return "\033[01m" . $text . "\033[0m";
+		return "\033[01m".$text."\033[0m";
 	}
 
 	/**
@@ -715,10 +715,10 @@ 
 		if ($cutmiddle == true) {
 			$cut = ($size - 2) / 2;
 
-			return $this->ptStr(substr($str, 0, $cut) . ".." . substr($str, (-1) * ($cut - 1)), $size);
+			return $this->ptStr(substr($str, 0, $cut)."..".substr($str, (-1) * ($cut - 1)), $size);
 		}
 
-		return substr($str, 0, $size - 3) . ".. ";
+		return substr($str, 0, $size - 3).".. ";
 	}
 
 	/**
@@ -790,6 +790,6 @@ 
 	 * @return
 	 */
 	private function scrPrintAt($row, $col, $text = "") {
-		echo "\033[" . $row . ";" . $col . "H" . $text;
+		echo "\033[".$row.";".$col."H".$text;
 	}
 }

Braces +22 added lines, -44 removed lines

@@ -53,12 +53,10 @@ 
 			$zpt->run();
 			$zpt->scrClear();
 			system("stty sane");
-		}
-		else {
+		} else {
 			echo "grommunio-sync interprocess communication (IPC) is not available or TopCollector is disabled.\n";
 		}
-	}
-	catch (GSyncException $zpe) {
+	} catch (GSyncException $zpe) {
 		fwrite(STDERR, get_class($zpe) . ": " . $zpe->getMessage() . "\n");
 
 		exit(1);
@@ -173,8 +171,7 @@ 
 			if ($this->scrSize['width'] != $s['width']) {
 				if ($s['width'] > 180) {
 					$this->wide = true;
-				}
-				else {
+				} else {
 					$this->wide = false;
 				}
 			}
@@ -260,15 +257,12 @@ 
 						$lastUpdate = $this->currenttime - $line["update"];
 						if ($this->currenttime - $line["update"] < 2) {
 							$this->linesActive[$line["update"] . $line["pid"]] = $line;
-						}
-						elseif (($line['push'] === true && $lastUpdate > ($this->pingInterval + 2)) || ($line['push'] !== true && $lastUpdate > 4)) {
+						} elseif (($line['push'] === true && $lastUpdate > ($this->pingInterval + 2)) || ($line['push'] !== true && $lastUpdate > 4)) {
 							$this->linesUnknown[$line["update"] . $line["pid"]] = $line;
-						}
-						else {
+						} else {
 							$this->linesOpen[$line["update"] . $line["pid"]] = $line;
 						}
-					}
-					else {
+					} else {
 						// do not show terminated + expired connections
 						if ($this->currenttime > $line['ended'] + $this->showTermSec) {
 							continue;
@@ -490,51 +484,40 @@ 
 					$this->topCollector->ClearLatest(true);
 
 					$this->terminate = true;
-				}
-				elseif ($cmds[0] == "clear") {
+				} elseif ($cmds[0] == "clear") {
 					$this->topCollector->ClearLatest(true);
 					$this->topCollector->CollectData(true);
 					$this->topCollector->ReInitIPC();
-				}
-				elseif ($cmds[0] == "filter" || $cmds[0] == "f") {
+				} elseif ($cmds[0] == "filter" || $cmds[0] == "f") {
 					if (!isset($cmds[1]) || $cmds[1] == "") {
 						$this->filter = false;
 						$this->status = "No filter";
 						$this->statusexpire = $this->currenttime + 5;
-					}
-					else {
+					} else {
 						$this->filter = $cmds[1];
 						$this->status = false;
 					}
-				}
-				elseif ($cmds[0] == "option" || $cmds[0] == "o") {
+				} elseif ($cmds[0] == "option" || $cmds[0] == "o") {
 					if (!isset($cmds[1]) || $cmds[1] == "") {
 						$this->status = "Option value needs to be specified. See 'help' or 'h' for instructions";
 						$this->statusexpire = $this->currenttime + 5;
-					}
-					elseif ($cmds[1] == "p" || $cmds[1] == "push" || $cmds[1] == "ping") {
+					} elseif ($cmds[1] == "p" || $cmds[1] == "push" || $cmds[1] == "ping") {
 						$this->showPush = !$this->showPush;
-					}
-					elseif ($cmds[1] == "a" || $cmds[1] == "active") {
+					} elseif ($cmds[1] == "a" || $cmds[1] == "active") {
 						$this->showOption = self::SHOW_ACTIVE_ONLY;
-					}
-					elseif ($cmds[1] == "u" || $cmds[1] == "unknown") {
+					} elseif ($cmds[1] == "u" || $cmds[1] == "unknown") {
 						$this->showOption = self::SHOW_UNKNOWN_ONLY;
-					}
-					elseif ($cmds[1] == "d" || $cmds[1] == "default") {
+					} elseif ($cmds[1] == "d" || $cmds[1] == "default") {
 						$this->showOption = self::SHOW_DEFAULT;
 						$this->showTermSec = self::SHOW_TERM_DEFAULT_TIME;
 						$this->showPush = true;
-					}
-					elseif (is_numeric($cmds[1])) {
+					} elseif (is_numeric($cmds[1])) {
 						$this->showTermSec = $cmds[1];
-					}
-					else {
+					} else {
 						$this->status = sprintf("Option '%s' unknown", $cmds[1]);
 						$this->statusexpire = $this->currenttime + 5;
 					}
-				}
-				elseif ($cmds[0] == "reset" || $cmds[0] == "r") {
+				} elseif ($cmds[0] == "reset" || $cmds[0] == "r") {
 					$this->filter = false;
 					$this->wide = false;
 					$this->helpexpire = 0;
@@ -546,16 +529,14 @@ 
 					$this->wide = !$this->wide;
 					$this->status = ($this->wide) ? "w i d e  view" : "normal view";
 					$this->statusexpire = $this->currenttime + 2;
-				}
-				elseif ($cmds[0] == "help" || $cmds[0] == "h") {
+				} elseif ($cmds[0] == "help" || $cmds[0] == "h") {
 					$this->helpexpire = $this->currenttime + 20;
 				}
 				// grep the log file
 				elseif (($cmds[0] == "log" || $cmds[0] == "l") && isset($cmds[1])) {
 					if (!file_exists(LOGFILE)) {
 						$this->status = "Logfile can not be found: " . LOGFILE;
-					}
-					else {
+					} else {
 						system('bash -c "fgrep -a ' . escapeshellarg($cmds[1]) . ' ' . LOGFILE . ' | less +G" > `tty`');
 						$this->status = "Returning from log, updating data";
 					}
@@ -565,8 +546,7 @@ 
 				elseif (($cmds[0] == "tail" || $cmds[0] == "t")) {
 					if (!file_exists(LOGFILE)) {
 						$this->status = "Logfile can not be found: " . LOGFILE;
-					}
-					else {
+					} else {
 						$this->doingTail = true;
 						$this->scrClear();
 						$this->scrPrintAt(1, 0, $this->scrAsBold("Press CTRL+C to return to grommunio-sync-top\n\n"));
@@ -584,8 +564,7 @@ 
 				elseif (($cmds[0] == "error" || $cmds[0] == "e")) {
 					if (!file_exists(LOGERRORFILE)) {
 						$this->status = "Error logfile can not be found: " . LOGERRORFILE;
-					}
-					else {
+					} else {
 						$this->doingTail = true;
 						$this->scrClear();
 						$this->scrPrintAt(1, 0, $this->scrAsBold("Press CTRL+C to return to grommunio-sync-top\n\n"));
@@ -598,8 +577,7 @@ 
 						$this->status = "Returning from tail, updating data";
 					}
 					$this->statusexpire = time() + 5; // it might be much "later" now
-				}
-				elseif ($cmds[0] != "") {
+				} elseif ($cmds[0] != "") {
 					$this->status = sprintf("Command '%s' unknown", $cmds[0]);
 					$this->statusexpire = $this->currenttime + 8;
 				}

lib/request/settings.php

Indentation +212 added lines, -212 removed lines

@@ -8,216 +8,216 @@
  */
 
 class Settings extends RequestProcessor {
-	/**
-	 * Handles the Settings command.
-	 *
-	 * @param int $commandCode
-	 *
-	 * @return bool
-	 */
-	public function Handle($commandCode) {
-		if (!self::$decoder->getElementStartTag(SYNC_SETTINGS_SETTINGS)) {
-			return false;
-		}
-
-		// save the request parameters
-		$request = [];
-
-		// Loop through properties. Possible are:
-		// - Out of office
-		// - DevicePassword
-		// - DeviceInformation
-		// - UserInformation
-		// Each of them should only be once per request. Each property must be processed in order.
-		WBXMLDecoder::ResetInWhile("settingsMain");
-		while (WBXMLDecoder::InWhile("settingsMain")) {
-			$propertyName = "";
-			if (self::$decoder->getElementStartTag(SYNC_SETTINGS_OOF)) {
-				$propertyName = SYNC_SETTINGS_OOF;
-			}
-			if (self::$decoder->getElementStartTag(SYNC_SETTINGS_DEVICEPW)) {
-				$propertyName = SYNC_SETTINGS_DEVICEPW;
-			}
-			if (self::$decoder->getElementStartTag(SYNC_SETTINGS_DEVICEINFORMATION)) {
-				$propertyName = SYNC_SETTINGS_DEVICEINFORMATION;
-			}
-			if (self::$decoder->getElementStartTag(SYNC_SETTINGS_USERINFORMATION)) {
-				$propertyName = SYNC_SETTINGS_USERINFORMATION;
-			}
-			if (self::$decoder->getElementStartTag(SYNC_SETTINGS_RIGHTSMANAGEMENTINFORMATION)) {
-				$propertyName = SYNC_SETTINGS_RIGHTSMANAGEMENTINFORMATION;
-			}
-			// TODO - check if it is necessary
-			// no property name available - break
-			if (!$propertyName) {
-				break;
-			}
-
-			// the property name is followed by either get or set
-			if (self::$decoder->getElementStartTag(SYNC_SETTINGS_GET)) {
-				// get is available for OOF (AS 12), user information (AS 12) and rights management (AS 14.1)
-				switch ($propertyName) {
-					case SYNC_SETTINGS_OOF:
-						$oofGet = new SyncOOF();
-						$oofGet->Decode(self::$decoder);
-						if (!self::$decoder->getElementEndTag()) {
-							return false;
-						} // SYNC_SETTINGS_GET
-						break;
-
-					case SYNC_SETTINGS_USERINFORMATION:
-						$userInformation = new SyncUserInformation();
-						break;
-
-					case SYNC_SETTINGS_RIGHTSMANAGEMENTINFORMATION:
-						$rmTemplates = new SyncRightsManagementTemplates();
-						break;
-
-					default:
-						// TODO: a special status code needed?
-						SLog::Write(LOGLEVEL_WARN, sprintf("This property ('%s') is not allowed to use get in request", $propertyName));
-				}
-			}
-			elseif (self::$decoder->getElementStartTag(SYNC_SETTINGS_SET)) {
-				// set is available for OOF, device password and device information
-				switch ($propertyName) {
-					case SYNC_SETTINGS_OOF:
-						$oofSet = new SyncOOF();
-						$oofSet->Decode(self::$decoder);
-						// TODO check - do it after while(1) finished?
-						break;
-
-					case SYNC_SETTINGS_DEVICEPW:
-						// TODO device password
-						$devicepassword = new SyncDevicePassword();
-						$devicepassword->Decode(self::$decoder);
-						break;
-
-					case SYNC_SETTINGS_DEVICEINFORMATION:
-						$deviceinformation = new SyncDeviceInformation();
-						$deviceinformation->Decode(self::$decoder);
-						$deviceinformation->Status = SYNC_SETTINGSSTATUS_SUCCESS;
-						self::$deviceManager->SaveDeviceInformation($deviceinformation);
-						break;
-
-					default:
-						// TODO: a special status code needed?
-						SLog::Write(LOGLEVEL_WARN, sprintf("This property ('%s') is not allowed to use set in request", $propertyName));
-				}
-
-				if (!self::$decoder->getElementEndTag()) {
-					return false;
-				} // SYNC_SETTINGS_SET
-			}
-			else {
-				SLog::Write(LOGLEVEL_WARN, sprintf("Neither get nor set found for property '%s'", $propertyName));
-
-				return false;
-			}
-
-			if (!self::$decoder->getElementEndTag()) {
-				return false;
-			} // SYNC_SETTINGS_OOF or SYNC_SETTINGS_DEVICEPW or SYNC_SETTINGS_DEVICEINFORMATION or SYNC_SETTINGS_USERINFORMATION
-
-			// break if it reached the endtag
-			$e = self::$decoder->peek();
-			if ($e[EN_TYPE] == EN_TYPE_ENDTAG) {
-				self::$decoder->getElementEndTag(); // SYNC_SETTINGS_SETTINGS
-
-				break;
-			}
-		}
-
-		$status = SYNC_SETTINGSSTATUS_SUCCESS;
-
-		// TODO put it in try catch block
-		// TODO implement Settings in the backend
-		// TODO save device information in device manager
-		// TODO status handling
-		//        $data = self::$backend->Settings($request);
-
-		self::$encoder->startWBXML();
-		self::$encoder->startTag(SYNC_SETTINGS_SETTINGS);
-
-		self::$encoder->startTag(SYNC_SETTINGS_STATUS);
-		self::$encoder->content($status);
-		self::$encoder->endTag(); // SYNC_SETTINGS_STATUS
-
-		// get oof settings
-		if (isset($oofGet)) {
-			$oofGet = self::$backend->Settings($oofGet);
-			self::$encoder->startTag(SYNC_SETTINGS_OOF);
-			self::$encoder->startTag(SYNC_SETTINGS_STATUS);
-			self::$encoder->content($oofGet->Status);
-			self::$encoder->endTag(); // SYNC_SETTINGS_STATUS
-
-			self::$encoder->startTag(SYNC_SETTINGS_GET);
-			$oofGet->Encode(self::$encoder);
-			self::$encoder->endTag(); // SYNC_SETTINGS_GET
-				self::$encoder->endTag(); // SYNC_SETTINGS_OOF
-		}
-
-		// get user information
-		// TODO none email address found
-		if (isset($userInformation)) {
-			self::$backend->Settings($userInformation);
-			self::$encoder->startTag(SYNC_SETTINGS_USERINFORMATION);
-			self::$encoder->startTag(SYNC_SETTINGS_STATUS);
-			self::$encoder->content($userInformation->Status);
-			self::$encoder->endTag(); // SYNC_SETTINGS_STATUS
-
-			self::$encoder->startTag(SYNC_SETTINGS_GET);
-			$userInformation->Encode(self::$encoder);
-			self::$encoder->endTag(); // SYNC_SETTINGS_GET
-				self::$encoder->endTag(); // SYNC_SETTINGS_USERINFORMATION
-		}
-
-		// get rights management templates
-		if (isset($rmTemplates)) {
-			self::$backend->Settings($rmTemplates);
-			self::$encoder->startTag(SYNC_SETTINGS_RIGHTSMANAGEMENTINFORMATION);
-			self::$encoder->startTag(SYNC_SETTINGS_STATUS);
-			self::$encoder->content($rmTemplates->Status);
-			self::$encoder->endTag(); // SYNC_SETTINGS_STATUS
-
-			self::$encoder->startTag(SYNC_SETTINGS_GET);
-			$rmTemplates->Encode(self::$encoder);
-			self::$encoder->endTag(); // SYNC_SETTINGS_GET
-				self::$encoder->endTag(); // SYNC_SETTINGS_RIGHTSMANAGEMENTINFORMATION
-		}
-
-		// set out of office
-		if (isset($oofSet)) {
-			$oofSet = self::$backend->Settings($oofSet);
-			self::$encoder->startTag(SYNC_SETTINGS_OOF);
-			self::$encoder->startTag(SYNC_SETTINGS_STATUS);
-			self::$encoder->content($oofSet->Status);
-			self::$encoder->endTag(); // SYNC_SETTINGS_STATUS
-				self::$encoder->endTag(); // SYNC_SETTINGS_OOF
-		}
-
-		// set device passwort
-		if (isset($devicepassword)) {
-			self::$encoder->startTag(SYNC_SETTINGS_DEVICEPW);
-			self::$encoder->startTag(SYNC_SETTINGS_SET);
-			self::$encoder->startTag(SYNC_SETTINGS_STATUS);
-			self::$encoder->content($devicepassword->Status);
-			self::$encoder->endTag(); // SYNC_SETTINGS_STATUS
-					self::$encoder->endTag(); // SYNC_SETTINGS_SET
-				self::$encoder->endTag(); // SYNC_SETTINGS_DEVICEPW
-		}
-
-		// set device information
-		if (isset($deviceinformation)) {
-			self::$encoder->startTag(SYNC_SETTINGS_DEVICEINFORMATION);
-			self::$encoder->startTag(SYNC_SETTINGS_STATUS);
-			self::$encoder->content($deviceinformation->Status);
-			self::$encoder->endTag(); // SYNC_SETTINGS_STATUS
-				self::$encoder->endTag(); // SYNC_SETTINGS_DEVICEINFORMATION
-		}
-
-		self::$encoder->endTag(); // SYNC_SETTINGS_SETTINGS
-
-		return true;
-	}
+    /**
+     * Handles the Settings command.
+     *
+     * @param int $commandCode
+     *
+     * @return bool
+     */
+    public function Handle($commandCode) {
+        if (!self::$decoder->getElementStartTag(SYNC_SETTINGS_SETTINGS)) {
+            return false;
+        }
+
+        // save the request parameters
+        $request = [];
+
+        // Loop through properties. Possible are:
+        // - Out of office
+        // - DevicePassword
+        // - DeviceInformation
+        // - UserInformation
+        // Each of them should only be once per request. Each property must be processed in order.
+        WBXMLDecoder::ResetInWhile("settingsMain");
+        while (WBXMLDecoder::InWhile("settingsMain")) {
+            $propertyName = "";
+            if (self::$decoder->getElementStartTag(SYNC_SETTINGS_OOF)) {
+                $propertyName = SYNC_SETTINGS_OOF;
+            }
+            if (self::$decoder->getElementStartTag(SYNC_SETTINGS_DEVICEPW)) {
+                $propertyName = SYNC_SETTINGS_DEVICEPW;
+            }
+            if (self::$decoder->getElementStartTag(SYNC_SETTINGS_DEVICEINFORMATION)) {
+                $propertyName = SYNC_SETTINGS_DEVICEINFORMATION;
+            }
+            if (self::$decoder->getElementStartTag(SYNC_SETTINGS_USERINFORMATION)) {
+                $propertyName = SYNC_SETTINGS_USERINFORMATION;
+            }
+            if (self::$decoder->getElementStartTag(SYNC_SETTINGS_RIGHTSMANAGEMENTINFORMATION)) {
+                $propertyName = SYNC_SETTINGS_RIGHTSMANAGEMENTINFORMATION;
+            }
+            // TODO - check if it is necessary
+            // no property name available - break
+            if (!$propertyName) {
+                break;
+            }
+
+            // the property name is followed by either get or set
+            if (self::$decoder->getElementStartTag(SYNC_SETTINGS_GET)) {
+                // get is available for OOF (AS 12), user information (AS 12) and rights management (AS 14.1)
+                switch ($propertyName) {
+                    case SYNC_SETTINGS_OOF:
+                        $oofGet = new SyncOOF();
+                        $oofGet->Decode(self::$decoder);
+                        if (!self::$decoder->getElementEndTag()) {
+                            return false;
+                        } // SYNC_SETTINGS_GET
+                        break;
+
+                    case SYNC_SETTINGS_USERINFORMATION:
+                        $userInformation = new SyncUserInformation();
+                        break;
+
+                    case SYNC_SETTINGS_RIGHTSMANAGEMENTINFORMATION:
+                        $rmTemplates = new SyncRightsManagementTemplates();
+                        break;
+
+                    default:
+                        // TODO: a special status code needed?
+                        SLog::Write(LOGLEVEL_WARN, sprintf("This property ('%s') is not allowed to use get in request", $propertyName));
+                }
+            }
+            elseif (self::$decoder->getElementStartTag(SYNC_SETTINGS_SET)) {
+                // set is available for OOF, device password and device information
+                switch ($propertyName) {
+                    case SYNC_SETTINGS_OOF:
+                        $oofSet = new SyncOOF();
+                        $oofSet->Decode(self::$decoder);
+                        // TODO check - do it after while(1) finished?
+                        break;
+
+                    case SYNC_SETTINGS_DEVICEPW:
+                        // TODO device password
+                        $devicepassword = new SyncDevicePassword();
+                        $devicepassword->Decode(self::$decoder);
+                        break;
+
+                    case SYNC_SETTINGS_DEVICEINFORMATION:
+                        $deviceinformation = new SyncDeviceInformation();
+                        $deviceinformation->Decode(self::$decoder);
+                        $deviceinformation->Status = SYNC_SETTINGSSTATUS_SUCCESS;
+                        self::$deviceManager->SaveDeviceInformation($deviceinformation);
+                        break;
+
+                    default:
+                        // TODO: a special status code needed?
+                        SLog::Write(LOGLEVEL_WARN, sprintf("This property ('%s') is not allowed to use set in request", $propertyName));
+                }
+
+                if (!self::$decoder->getElementEndTag()) {
+                    return false;
+                } // SYNC_SETTINGS_SET
+            }
+            else {
+                SLog::Write(LOGLEVEL_WARN, sprintf("Neither get nor set found for property '%s'", $propertyName));
+
+                return false;
+            }
+
+            if (!self::$decoder->getElementEndTag()) {
+                return false;
+            } // SYNC_SETTINGS_OOF or SYNC_SETTINGS_DEVICEPW or SYNC_SETTINGS_DEVICEINFORMATION or SYNC_SETTINGS_USERINFORMATION
+
+            // break if it reached the endtag
+            $e = self::$decoder->peek();
+            if ($e[EN_TYPE] == EN_TYPE_ENDTAG) {
+                self::$decoder->getElementEndTag(); // SYNC_SETTINGS_SETTINGS
+
+                break;
+            }
+        }
+
+        $status = SYNC_SETTINGSSTATUS_SUCCESS;
+
+        // TODO put it in try catch block
+        // TODO implement Settings in the backend
+        // TODO save device information in device manager
+        // TODO status handling
+        //        $data = self::$backend->Settings($request);
+
+        self::$encoder->startWBXML();
+        self::$encoder->startTag(SYNC_SETTINGS_SETTINGS);
+
+        self::$encoder->startTag(SYNC_SETTINGS_STATUS);
+        self::$encoder->content($status);
+        self::$encoder->endTag(); // SYNC_SETTINGS_STATUS
+
+        // get oof settings
+        if (isset($oofGet)) {
+            $oofGet = self::$backend->Settings($oofGet);
+            self::$encoder->startTag(SYNC_SETTINGS_OOF);
+            self::$encoder->startTag(SYNC_SETTINGS_STATUS);
+            self::$encoder->content($oofGet->Status);
+            self::$encoder->endTag(); // SYNC_SETTINGS_STATUS
+
+            self::$encoder->startTag(SYNC_SETTINGS_GET);
+            $oofGet->Encode(self::$encoder);
+            self::$encoder->endTag(); // SYNC_SETTINGS_GET
+                self::$encoder->endTag(); // SYNC_SETTINGS_OOF
+        }
+
+        // get user information
+        // TODO none email address found
+        if (isset($userInformation)) {
+            self::$backend->Settings($userInformation);
+            self::$encoder->startTag(SYNC_SETTINGS_USERINFORMATION);
+            self::$encoder->startTag(SYNC_SETTINGS_STATUS);
+            self::$encoder->content($userInformation->Status);
+            self::$encoder->endTag(); // SYNC_SETTINGS_STATUS
+
+            self::$encoder->startTag(SYNC_SETTINGS_GET);
+            $userInformation->Encode(self::$encoder);
+            self::$encoder->endTag(); // SYNC_SETTINGS_GET
+                self::$encoder->endTag(); // SYNC_SETTINGS_USERINFORMATION
+        }
+
+        // get rights management templates
+        if (isset($rmTemplates)) {
+            self::$backend->Settings($rmTemplates);
+            self::$encoder->startTag(SYNC_SETTINGS_RIGHTSMANAGEMENTINFORMATION);
+            self::$encoder->startTag(SYNC_SETTINGS_STATUS);
+            self::$encoder->content($rmTemplates->Status);
+            self::$encoder->endTag(); // SYNC_SETTINGS_STATUS
+
+            self::$encoder->startTag(SYNC_SETTINGS_GET);
+            $rmTemplates->Encode(self::$encoder);
+            self::$encoder->endTag(); // SYNC_SETTINGS_GET
+                self::$encoder->endTag(); // SYNC_SETTINGS_RIGHTSMANAGEMENTINFORMATION
+        }
+
+        // set out of office
+        if (isset($oofSet)) {
+            $oofSet = self::$backend->Settings($oofSet);
+            self::$encoder->startTag(SYNC_SETTINGS_OOF);
+            self::$encoder->startTag(SYNC_SETTINGS_STATUS);
+            self::$encoder->content($oofSet->Status);
+            self::$encoder->endTag(); // SYNC_SETTINGS_STATUS
+                self::$encoder->endTag(); // SYNC_SETTINGS_OOF
+        }
+
+        // set device passwort
+        if (isset($devicepassword)) {
+            self::$encoder->startTag(SYNC_SETTINGS_DEVICEPW);
+            self::$encoder->startTag(SYNC_SETTINGS_SET);
+            self::$encoder->startTag(SYNC_SETTINGS_STATUS);
+            self::$encoder->content($devicepassword->Status);
+            self::$encoder->endTag(); // SYNC_SETTINGS_STATUS
+                    self::$encoder->endTag(); // SYNC_SETTINGS_SET
+                self::$encoder->endTag(); // SYNC_SETTINGS_DEVICEPW
+        }
+
+        // set device information
+        if (isset($deviceinformation)) {
+            self::$encoder->startTag(SYNC_SETTINGS_DEVICEINFORMATION);
+            self::$encoder->startTag(SYNC_SETTINGS_STATUS);
+            self::$encoder->content($deviceinformation->Status);
+            self::$encoder->endTag(); // SYNC_SETTINGS_STATUS
+                self::$encoder->endTag(); // SYNC_SETTINGS_DEVICEINFORMATION
+        }
+
+        self::$encoder->endTag(); // SYNC_SETTINGS_SETTINGS
+
+        return true;
+    }
 }

Braces +2 added lines, -4 removed lines

@@ -77,8 +77,7 @@ 
 						// TODO: a special status code needed?
 						SLog::Write(LOGLEVEL_WARN, sprintf("This property ('%s') is not allowed to use get in request", $propertyName));
 				}
-			}
-			elseif (self::$decoder->getElementStartTag(SYNC_SETTINGS_SET)) {
+			} elseif (self::$decoder->getElementStartTag(SYNC_SETTINGS_SET)) {
 				// set is available for OOF, device password and device information
 				switch ($propertyName) {
 					case SYNC_SETTINGS_OOF:
@@ -108,8 +107,7 @@ 
 				if (!self::$decoder->getElementEndTag()) {
 					return false;
 				} // SYNC_SETTINGS_SET
-			}
-			else {
+			} else {
 				SLog::Write(LOGLEVEL_WARN, sprintf("Neither get nor set found for property '%s'", $propertyName));
 
 				return false;

lib/request/gethierarchy.php

Indentation +30 added lines, -30 removed lines

@@ -8,37 +8,37 @@
  */
 
 class GetHierarchy extends RequestProcessor {
-	/**
-	 * Handles the GetHierarchy command
-	 * simply returns current hierarchy of all folders.
-	 *
-	 * @param int $commandCode
-	 *
-	 * @return bool
-	 */
-	public function Handle($commandCode) {
-		try {
-			$folders = self::$backend->GetHierarchy();
-			if (!$folders || empty($folders)) {
-				throw new StatusException("GetHierarchy() did not return any data.");
-			}
+    /**
+     * Handles the GetHierarchy command
+     * simply returns current hierarchy of all folders.
+     *
+     * @param int $commandCode
+     *
+     * @return bool
+     */
+    public function Handle($commandCode) {
+        try {
+            $folders = self::$backend->GetHierarchy();
+            if (!$folders || empty($folders)) {
+                throw new StatusException("GetHierarchy() did not return any data.");
+            }
 
-			// TODO execute $data->Check() to see if SyncObject is valid
-		}
-		catch (StatusException $ex) {
-			return false;
-		}
+            // TODO execute $data->Check() to see if SyncObject is valid
+        }
+        catch (StatusException $ex) {
+            return false;
+        }
 
-		self::$encoder->StartWBXML();
-		self::$encoder->startTag(SYNC_FOLDERHIERARCHY_FOLDERS);
-		foreach ($folders as $folder) {
-			self::$encoder->startTag(SYNC_FOLDERHIERARCHY_FOLDER);
-			$folder->Encode(self::$encoder);
-			self::$encoder->endTag();
-		}
-		self::$encoder->endTag();
+        self::$encoder->StartWBXML();
+        self::$encoder->startTag(SYNC_FOLDERHIERARCHY_FOLDERS);
+        foreach ($folders as $folder) {
+            self::$encoder->startTag(SYNC_FOLDERHIERARCHY_FOLDER);
+            $folder->Encode(self::$encoder);
+            self::$encoder->endTag();
+        }
+        self::$encoder->endTag();
 
-		// save hierarchy for upcoming syncing
-		return self::$deviceManager->InitializeFolderCache($folders);
-	}
+        // save hierarchy for upcoming syncing
+        return self::$deviceManager->InitializeFolderCache($folders);
+    }
 }

Braces +1 added lines, -2 removed lines

@@ -24,8 +24,7 @@
 			}
 
 			// TODO execute $data->Check() to see if SyncObject is valid
-		}
-		catch (StatusException $ex) {
+		} catch (StatusException $ex) {
 			return false;
 		}
 

lib/request/foldersync.php

Indentation +253 added lines, -253 removed lines

@@ -8,257 +8,257 @@
  */
 
 class FolderSync extends RequestProcessor {
-	/**
-	 * Handles the FolderSync command.
-	 *
-	 * @param int $commandCode
-	 *
-	 * @return bool
-	 */
-	public function Handle($commandCode) {
-		// Parse input
-		if (!self::$decoder->getElementStartTag(SYNC_FOLDERHIERARCHY_FOLDERSYNC)) {
-			return false;
-		}
-
-		if (!self::$decoder->getElementStartTag(SYNC_FOLDERHIERARCHY_SYNCKEY)) {
-			return false;
-		}
-
-		$synckey = self::$decoder->getElementContent();
-
-		if (!self::$decoder->getElementEndTag()) {
-			return false;
-		}
-
-		// every FolderSync with SyncKey 0 should return the supported AS version & command headers
-		if ($synckey == "0") {
-			self::$specialHeaders = [];
-			self::$specialHeaders[] = GSync::GetSupportedProtocolVersions();
-			self::$specialHeaders[] = GSync::GetSupportedCommands();
-		}
-
-		$status = SYNC_FSSTATUS_SUCCESS;
-		$newsynckey = $synckey;
-
-		try {
-			$syncstate = self::$deviceManager->GetStateManager()->GetSyncState($synckey);
-
-			// We will be saving the sync state under 'newsynckey'
-			$newsynckey = self::$deviceManager->GetStateManager()->GetNewSyncKey($synckey);
-
-			// there are no SyncParameters for the hierarchy, but we use it to save the latest synckeys
-			$spa = self::$deviceManager->GetStateManager()->GetSynchedFolderState(false);
-		}
-		catch (StateNotFoundException $snfex) {
-			$status = SYNC_FSSTATUS_SYNCKEYERROR;
-		}
-		catch (StateInvalidException $sive) {
-			$status = SYNC_FSSTATUS_SYNCKEYERROR;
-		}
-
-		// The ChangesWrapper caches all imports in-memory, so we can send a change count
-		// before sending the actual data.
-		// the HierarchyCache is notified and the changes from the PIM are transmitted to the actual backend
-		$changesMem = self::$deviceManager->GetHierarchyChangesWrapper();
-
-		// the hierarchyCache should now fully be initialized - check for changes in the additional folders
-		$changesMem->Config(GSync::GetAdditionalSyncFolders(false), ChangesMemoryWrapper::SYNCHRONIZING);
-
-		// reset to default store in backend
-		self::$backend->Setup(false);
-
-		// process incoming changes
-		if (self::$decoder->getElementStartTag(SYNC_FOLDERHIERARCHY_CHANGES)) {
-			// Ignore <Count> if present
-			if (self::$decoder->getElementStartTag(SYNC_FOLDERHIERARCHY_COUNT)) {
-				self::$decoder->getElementContent();
-				if (!self::$decoder->getElementEndTag()) {
-					return false;
-				}
-			}
-
-			// Process the changes (either <Add>, <Modify>, or <Remove>)
-			$element = self::$decoder->getElement();
-
-			if ($element[EN_TYPE] != EN_TYPE_STARTTAG) {
-				return false;
-			}
-
-			$importer = false;
-			WBXMLDecoder::ResetInWhile("folderSyncIncomingChange");
-			while (WBXMLDecoder::InWhile("folderSyncIncomingChange")) {
-				$folder = new SyncFolder();
-				if (!$folder->Decode(self::$decoder)) {
-					break;
-				}
-
-				// add the backendId to the SyncFolder object
-				$folder->BackendId = self::$deviceManager->GetBackendIdForFolderId($folder->serverid);
-
-				try {
-					if ($status == SYNC_FSSTATUS_SUCCESS && !$importer) {
-						// Configure the backends importer with last state
-						$importer = self::$backend->GetImporter();
-						$importer->Config($syncstate);
-						// the messages from the PIM will be forwarded to the backend
-						$changesMem->forwardImporter($importer);
-					}
-
-					if ($status == SYNC_FSSTATUS_SUCCESS) {
-						switch ($element[EN_TAG]) {
-							case SYNC_ADD:
-							case SYNC_MODIFY:
-								$serverid = $changesMem->ImportFolderChange($folder);
-								break;
-
-							case SYNC_REMOVE:
-								$serverid = $changesMem->ImportFolderDeletion($folder);
-								break;
-						}
-					}
-					else {
-						SLog::Write(LOGLEVEL_WARN, sprintf("Request->HandleFolderSync(): ignoring incoming folderchange for folder '%s' as status indicates problem.", $folder->displayname));
-						self::$topCollector->AnnounceInformation("Incoming change ignored", true);
-					}
-				}
-				catch (StatusException $stex) {
-					$status = $stex->getCode();
-				}
-			}
-
-			if (!self::$decoder->getElementEndTag()) {
-				return false;
-			}
-		}
-		// no incoming changes
-		else {
-			// check for a potential process loop like described in Issue ZP-5
-			if ($synckey != "0" && self::$deviceManager->IsHierarchyFullResyncRequired()) {
-				$status = SYNC_FSSTATUS_SYNCKEYERROR;
-				self::$deviceManager->AnnounceProcessStatus(false, $status);
-			}
-		}
-
-		if (!self::$decoder->getElementEndTag()) {
-			return false;
-		}
-
-		// We have processed incoming foldersync requests, now send the PIM
-		// our changes
-
-		// Output our WBXML reply now
-		self::$encoder->StartWBXML();
-
-		self::$encoder->startTag(SYNC_FOLDERHIERARCHY_FOLDERSYNC);
-
-		if ($status == SYNC_FSSTATUS_SUCCESS) {
-			try {
-				// do nothing if this is an invalid device id (like the 'validate' Androids internal client sends)
-				if (!Request::IsValidDeviceID()) {
-					throw new StatusException(sprintf("Request::IsValidDeviceID() indicated that '%s' is not a valid device id", Request::GetDeviceID()), SYNC_FSSTATUS_SERVERERROR);
-				}
-
-				// Changes from backend are sent to the MemImporter and processed for the HierarchyCache.
-				// The state which is saved is from the backend, as the MemImporter is only a proxy.
-				$exporter = self::$backend->GetExporter();
-
-				$exporter->Config($syncstate);
-				$exporter->InitializeExporter($changesMem);
-
-				// Stream all changes to the ImportExportChangesMem
-				$totalChanges = $exporter->GetChangeCount();
-				$exported = 0;
-				$partial = false;
-				while (is_array($exporter->Synchronize())) {
-					++$exported;
-
-					if (time() % 4) {
-						self::$topCollector->AnnounceInformation(sprintf("Exported %d from %d folders", $exported, $totalChanges));
-					}
-
-					// if partial sync is allowed, stop if this takes too long
-					if (USE_PARTIAL_FOLDERSYNC && Request::IsRequestTimeoutReached()) {
-						SLog::Write(LOGLEVEL_WARN, sprintf("Request->HandleFolderSync(): Exporting folders is too slow. In %d seconds only %d from %d changes were processed.", (time() - $_SERVER["REQUEST_TIME"]), $exported, $totalChanges));
-						self::$topCollector->AnnounceInformation(sprintf("Partial export of %d out of %d folders", $exported, $totalChanges), true);
-						self::$deviceManager->SetFolderSyncComplete(false);
-						$partial = true;
-
-						break;
-					}
-				}
-
-				// update the foldersync complete flag
-				if (USE_PARTIAL_FOLDERSYNC && $partial == false && self::$deviceManager->GetFolderSyncComplete() === false) {
-					// say that we are done with partial syncing
-					self::$deviceManager->SetFolderSyncComplete(true);
-					// reset the loop data to prevent any loop detection to kick in now
-					self::$deviceManager->ClearLoopDetectionData(Request::GetAuthUserString(), Request::GetDeviceID());
-					SLog::Write(LOGLEVEL_INFO, "Request->HandleFolderSync(): Chunked exporting of folders completed successfully");
-				}
-
-				// get the new state from the backend
-				$newsyncstate = (isset($exporter)) ? $exporter->GetState() : "";
-			}
-			catch (StatusException $stex) {
-				if ($stex->getCode() == SYNC_FSSTATUS_CODEUNKNOWN) {
-					$status = SYNC_FSSTATUS_SYNCKEYERROR;
-				}
-				else {
-					$status = $stex->getCode();
-				}
-			}
-		}
-
-		self::$encoder->startTag(SYNC_FOLDERHIERARCHY_STATUS);
-		self::$encoder->content($status);
-		self::$encoder->endTag();
-
-		if ($status == SYNC_FSSTATUS_SUCCESS) {
-			self::$encoder->startTag(SYNC_FOLDERHIERARCHY_SYNCKEY);
-			$synckey = ($changesMem->IsStateChanged()) ? $newsynckey : $synckey;
-			self::$encoder->content($synckey);
-			self::$encoder->endTag();
-
-			// Stream folders directly to the PDA
-			$streamimporter = new ImportChangesStream(self::$encoder, false);
-			$changesMem->InitializeExporter($streamimporter);
-			$changeCount = $changesMem->GetChangeCount();
-
-			self::$encoder->startTag(SYNC_FOLDERHIERARCHY_CHANGES);
-
-			self::$encoder->startTag(SYNC_FOLDERHIERARCHY_COUNT);
-			self::$encoder->content($changeCount);
-			self::$encoder->endTag();
-			while ($changesMem->Synchronize());
-
-			self::$encoder->endTag();
-			self::$topCollector->AnnounceInformation(sprintf("Outgoing %d folders", $changeCount), true);
-
-			if ($changeCount == 0) {
-				self::$deviceManager->CheckFolderData();
-			}
-			// everything fine, save the sync state for the next time
-			if ($synckey == $newsynckey) {
-				self::$deviceManager->GetStateManager()->SetSyncState($newsynckey, $newsyncstate);
-
-				// update SPA & save it
-				$spa->SetSyncKey($newsynckey);
-				$spa->SetFolderId(false);
-
-				// invalidate all pingable flags
-				SyncCollections::InvalidatePingableFlags();
-			}
-			// save the SyncParameters if it changed or the reference policy key is not set or different
-			if ($spa->IsDataChanged() || !$spa->HasReferencePolicyKey() || GSync::GetProvisioningManager()->ProvisioningRequired($spa->GetReferencePolicyKey(), true, false)) {
-				// saves the SPA (while updating the reference policy key)
-				$spa->SetLastSynctime(time());
-				self::$deviceManager->GetStateManager()->SetSynchedFolderState($spa);
-			}
-		}
-
-		self::$encoder->endTag();
-
-		return true;
-	}
+    /**
+     * Handles the FolderSync command.
+     *
+     * @param int $commandCode
+     *
+     * @return bool
+     */
+    public function Handle($commandCode) {
+        // Parse input
+        if (!self::$decoder->getElementStartTag(SYNC_FOLDERHIERARCHY_FOLDERSYNC)) {
+            return false;
+        }
+
+        if (!self::$decoder->getElementStartTag(SYNC_FOLDERHIERARCHY_SYNCKEY)) {
+            return false;
+        }
+
+        $synckey = self::$decoder->getElementContent();
+
+        if (!self::$decoder->getElementEndTag()) {
+            return false;
+        }
+
+        // every FolderSync with SyncKey 0 should return the supported AS version & command headers
+        if ($synckey == "0") {
+            self::$specialHeaders = [];
+            self::$specialHeaders[] = GSync::GetSupportedProtocolVersions();
+            self::$specialHeaders[] = GSync::GetSupportedCommands();
+        }
+
+        $status = SYNC_FSSTATUS_SUCCESS;
+        $newsynckey = $synckey;
+
+        try {
+            $syncstate = self::$deviceManager->GetStateManager()->GetSyncState($synckey);
+
+            // We will be saving the sync state under 'newsynckey'
+            $newsynckey = self::$deviceManager->GetStateManager()->GetNewSyncKey($synckey);
+
+            // there are no SyncParameters for the hierarchy, but we use it to save the latest synckeys
+            $spa = self::$deviceManager->GetStateManager()->GetSynchedFolderState(false);
+        }
+        catch (StateNotFoundException $snfex) {
+            $status = SYNC_FSSTATUS_SYNCKEYERROR;
+        }
+        catch (StateInvalidException $sive) {
+            $status = SYNC_FSSTATUS_SYNCKEYERROR;
+        }
+
+        // The ChangesWrapper caches all imports in-memory, so we can send a change count
+        // before sending the actual data.
+        // the HierarchyCache is notified and the changes from the PIM are transmitted to the actual backend
+        $changesMem = self::$deviceManager->GetHierarchyChangesWrapper();
+
+        // the hierarchyCache should now fully be initialized - check for changes in the additional folders
+        $changesMem->Config(GSync::GetAdditionalSyncFolders(false), ChangesMemoryWrapper::SYNCHRONIZING);
+
+        // reset to default store in backend
+        self::$backend->Setup(false);
+
+        // process incoming changes
+        if (self::$decoder->getElementStartTag(SYNC_FOLDERHIERARCHY_CHANGES)) {
+            // Ignore <Count> if present
+            if (self::$decoder->getElementStartTag(SYNC_FOLDERHIERARCHY_COUNT)) {
+                self::$decoder->getElementContent();
+                if (!self::$decoder->getElementEndTag()) {
+                    return false;
+                }
+            }
+
+            // Process the changes (either <Add>, <Modify>, or <Remove>)
+            $element = self::$decoder->getElement();
+
+            if ($element[EN_TYPE] != EN_TYPE_STARTTAG) {
+                return false;
+            }
+
+            $importer = false;
+            WBXMLDecoder::ResetInWhile("folderSyncIncomingChange");
+            while (WBXMLDecoder::InWhile("folderSyncIncomingChange")) {
+                $folder = new SyncFolder();
+                if (!$folder->Decode(self::$decoder)) {
+                    break;
+                }
+
+                // add the backendId to the SyncFolder object
+                $folder->BackendId = self::$deviceManager->GetBackendIdForFolderId($folder->serverid);
+
+                try {
+                    if ($status == SYNC_FSSTATUS_SUCCESS && !$importer) {
+                        // Configure the backends importer with last state
+                        $importer = self::$backend->GetImporter();
+                        $importer->Config($syncstate);
+                        // the messages from the PIM will be forwarded to the backend
+                        $changesMem->forwardImporter($importer);
+                    }
+
+                    if ($status == SYNC_FSSTATUS_SUCCESS) {
+                        switch ($element[EN_TAG]) {
+                            case SYNC_ADD:
+                            case SYNC_MODIFY:
+                                $serverid = $changesMem->ImportFolderChange($folder);
+                                break;
+
+                            case SYNC_REMOVE:
+                                $serverid = $changesMem->ImportFolderDeletion($folder);
+                                break;
+                        }
+                    }
+                    else {
+                        SLog::Write(LOGLEVEL_WARN, sprintf("Request->HandleFolderSync(): ignoring incoming folderchange for folder '%s' as status indicates problem.", $folder->displayname));
+                        self::$topCollector->AnnounceInformation("Incoming change ignored", true);
+                    }
+                }
+                catch (StatusException $stex) {
+                    $status = $stex->getCode();
+                }
+            }
+
+            if (!self::$decoder->getElementEndTag()) {
+                return false;
+            }
+        }
+        // no incoming changes
+        else {
+            // check for a potential process loop like described in Issue ZP-5
+            if ($synckey != "0" && self::$deviceManager->IsHierarchyFullResyncRequired()) {
+                $status = SYNC_FSSTATUS_SYNCKEYERROR;
+                self::$deviceManager->AnnounceProcessStatus(false, $status);
+            }
+        }
+
+        if (!self::$decoder->getElementEndTag()) {
+            return false;
+        }
+
+        // We have processed incoming foldersync requests, now send the PIM
+        // our changes
+
+        // Output our WBXML reply now
+        self::$encoder->StartWBXML();
+
+        self::$encoder->startTag(SYNC_FOLDERHIERARCHY_FOLDERSYNC);
+
+        if ($status == SYNC_FSSTATUS_SUCCESS) {
+            try {
+                // do nothing if this is an invalid device id (like the 'validate' Androids internal client sends)
+                if (!Request::IsValidDeviceID()) {
+                    throw new StatusException(sprintf("Request::IsValidDeviceID() indicated that '%s' is not a valid device id", Request::GetDeviceID()), SYNC_FSSTATUS_SERVERERROR);
+                }
+
+                // Changes from backend are sent to the MemImporter and processed for the HierarchyCache.
+                // The state which is saved is from the backend, as the MemImporter is only a proxy.
+                $exporter = self::$backend->GetExporter();
+
+                $exporter->Config($syncstate);
+                $exporter->InitializeExporter($changesMem);
+
+                // Stream all changes to the ImportExportChangesMem
+                $totalChanges = $exporter->GetChangeCount();
+                $exported = 0;
+                $partial = false;
+                while (is_array($exporter->Synchronize())) {
+                    ++$exported;
+
+                    if (time() % 4) {
+                        self::$topCollector->AnnounceInformation(sprintf("Exported %d from %d folders", $exported, $totalChanges));
+                    }
+
+                    // if partial sync is allowed, stop if this takes too long
+                    if (USE_PARTIAL_FOLDERSYNC && Request::IsRequestTimeoutReached()) {
+                        SLog::Write(LOGLEVEL_WARN, sprintf("Request->HandleFolderSync(): Exporting folders is too slow. In %d seconds only %d from %d changes were processed.", (time() - $_SERVER["REQUEST_TIME"]), $exported, $totalChanges));
+                        self::$topCollector->AnnounceInformation(sprintf("Partial export of %d out of %d folders", $exported, $totalChanges), true);
+                        self::$deviceManager->SetFolderSyncComplete(false);
+                        $partial = true;
+
+                        break;
+                    }
+                }
+
+                // update the foldersync complete flag
+                if (USE_PARTIAL_FOLDERSYNC && $partial == false && self::$deviceManager->GetFolderSyncComplete() === false) {
+                    // say that we are done with partial syncing
+                    self::$deviceManager->SetFolderSyncComplete(true);
+                    // reset the loop data to prevent any loop detection to kick in now
+                    self::$deviceManager->ClearLoopDetectionData(Request::GetAuthUserString(), Request::GetDeviceID());
+                    SLog::Write(LOGLEVEL_INFO, "Request->HandleFolderSync(): Chunked exporting of folders completed successfully");
+                }
+
+                // get the new state from the backend
+                $newsyncstate = (isset($exporter)) ? $exporter->GetState() : "";
+            }
+            catch (StatusException $stex) {
+                if ($stex->getCode() == SYNC_FSSTATUS_CODEUNKNOWN) {
+                    $status = SYNC_FSSTATUS_SYNCKEYERROR;
+                }
+                else {
+                    $status = $stex->getCode();
+                }
+            }
+        }
+
+        self::$encoder->startTag(SYNC_FOLDERHIERARCHY_STATUS);
+        self::$encoder->content($status);
+        self::$encoder->endTag();
+
+        if ($status == SYNC_FSSTATUS_SUCCESS) {
+            self::$encoder->startTag(SYNC_FOLDERHIERARCHY_SYNCKEY);
+            $synckey = ($changesMem->IsStateChanged()) ? $newsynckey : $synckey;
+            self::$encoder->content($synckey);
+            self::$encoder->endTag();
+
+            // Stream folders directly to the PDA
+            $streamimporter = new ImportChangesStream(self::$encoder, false);
+            $changesMem->InitializeExporter($streamimporter);
+            $changeCount = $changesMem->GetChangeCount();
+
+            self::$encoder->startTag(SYNC_FOLDERHIERARCHY_CHANGES);
+
+            self::$encoder->startTag(SYNC_FOLDERHIERARCHY_COUNT);
+            self::$encoder->content($changeCount);
+            self::$encoder->endTag();
+            while ($changesMem->Synchronize());
+
+            self::$encoder->endTag();
+            self::$topCollector->AnnounceInformation(sprintf("Outgoing %d folders", $changeCount), true);
+
+            if ($changeCount == 0) {
+                self::$deviceManager->CheckFolderData();
+            }
+            // everything fine, save the sync state for the next time
+            if ($synckey == $newsynckey) {
+                self::$deviceManager->GetStateManager()->SetSyncState($newsynckey, $newsyncstate);
+
+                // update SPA & save it
+                $spa->SetSyncKey($newsynckey);
+                $spa->SetFolderId(false);
+
+                // invalidate all pingable flags
+                SyncCollections::InvalidatePingableFlags();
+            }
+            // save the SyncParameters if it changed or the reference policy key is not set or different
+            if ($spa->IsDataChanged() || !$spa->HasReferencePolicyKey() || GSync::GetProvisioningManager()->ProvisioningRequired($spa->GetReferencePolicyKey(), true, false)) {
+                // saves the SPA (while updating the reference policy key)
+                $spa->SetLastSynctime(time());
+                self::$deviceManager->GetStateManager()->SetSynchedFolderState($spa);
+            }
+        }
+
+        self::$encoder->endTag();
+
+        return true;
+    }
 }

Braces +6 added lines, -12 removed lines

@@ -49,11 +49,9 @@ 
 
 			// there are no SyncParameters for the hierarchy, but we use it to save the latest synckeys
 			$spa = self::$deviceManager->GetStateManager()->GetSynchedFolderState(false);
-		}
-		catch (StateNotFoundException $snfex) {
+		} catch (StateNotFoundException $snfex) {
 			$status = SYNC_FSSTATUS_SYNCKEYERROR;
-		}
-		catch (StateInvalidException $sive) {
+		} catch (StateInvalidException $sive) {
 			$status = SYNC_FSSTATUS_SYNCKEYERROR;
 		}
 
@@ -116,13 +114,11 @@ 
 								$serverid = $changesMem->ImportFolderDeletion($folder);
 								break;
 						}
-					}
-					else {
+					} else {
 						SLog::Write(LOGLEVEL_WARN, sprintf("Request->HandleFolderSync(): ignoring incoming folderchange for folder '%s' as status indicates problem.", $folder->displayname));
 						self::$topCollector->AnnounceInformation("Incoming change ignored", true);
 					}
-				}
-				catch (StatusException $stex) {
+				} catch (StatusException $stex) {
 					$status = $stex->getCode();
 				}
 			}
@@ -199,12 +195,10 @@ 
 
 				// get the new state from the backend
 				$newsyncstate = (isset($exporter)) ? $exporter->GetState() : "";
-			}
-			catch (StatusException $stex) {
+			} catch (StatusException $stex) {
 				if ($stex->getCode() == SYNC_FSSTATUS_CODEUNKNOWN) {
 					$status = SYNC_FSSTATUS_SYNCKEYERROR;
-				}
-				else {
+				} else {
 					$status = $stex->getCode();
 				}
 			}

lib/request/folderchange.php

Indentation +234 added lines, -234 removed lines

@@ -8,238 +8,238 @@
  */
 
 class FolderChange extends RequestProcessor {
-	/**
-	 * Handles creates, updates or deletes of a folder
-	 * issued by the commands FolderCreate, FolderUpdate and FolderDelete.
-	 *
-	 * @param int $commandCode
-	 *
-	 * @return bool
-	 */
-	public function Handle($commandCode) {
-		$el = self::$decoder->getElement();
-
-		if ($el[EN_TYPE] != EN_TYPE_STARTTAG) {
-			return false;
-		}
-
-		$create = $update = $delete = false;
-		if ($el[EN_TAG] == SYNC_FOLDERHIERARCHY_FOLDERCREATE) {
-			$create = true;
-		}
-		elseif ($el[EN_TAG] == SYNC_FOLDERHIERARCHY_FOLDERUPDATE) {
-			$update = true;
-		}
-		elseif ($el[EN_TAG] == SYNC_FOLDERHIERARCHY_FOLDERDELETE) {
-			$delete = true;
-		}
-
-		if (!$create && !$update && !$delete) {
-			return false;
-		}
-
-		// SyncKey
-		if (!self::$decoder->getElementStartTag(SYNC_FOLDERHIERARCHY_SYNCKEY)) {
-			return false;
-		}
-		$synckey = self::$decoder->getElementContent();
-		if (!self::$decoder->getElementEndTag()) {
-			return false;
-		}
-
-		// ServerID
-		$serverid = false;
-		$backendid = false;
-		if (self::$decoder->getElementStartTag(SYNC_FOLDERHIERARCHY_SERVERENTRYID)) {
-			$serverid = self::$decoder->getElementContent();
-			$backendid = self::$deviceManager->GetBackendIdForFolderId($serverid);
-			if (!self::$decoder->getElementEndTag()) {
-				return false;
-			}
-		}
-
-		// Parent
-		$parentid = false;
-		$parentBackendId = false;
-
-		// when creating or updating more information is necessary
-		if (!$delete) {
-			if (self::$decoder->getElementStartTag(SYNC_FOLDERHIERARCHY_PARENTID)) {
-				$parentid = self::$decoder->getElementContent();
-				$parentBackendId = self::$deviceManager->GetBackendIdForFolderId($parentid);
-				if (!self::$decoder->getElementEndTag()) {
-					return false;
-				}
-			}
-
-			// Displayname
-			if (!self::$decoder->getElementStartTag(SYNC_FOLDERHIERARCHY_DISPLAYNAME)) {
-				return false;
-			}
-			$displayname = self::$decoder->getElementContent();
-			if (!self::$decoder->getElementEndTag()) {
-				return false;
-			}
-
-			// Type
-			$type = false;
-			if (self::$decoder->getElementStartTag(SYNC_FOLDERHIERARCHY_TYPE)) {
-				$type = self::$decoder->getElementContent();
-				if (!self::$decoder->getElementEndTag()) {
-					return false;
-				}
-			}
-		}
-
-		// endtag foldercreate, folderupdate, folderdelete
-		if (!self::$decoder->getElementEndTag()) {
-			return false;
-		}
-
-		$status = SYNC_FSSTATUS_SUCCESS;
-		// Get state of hierarchy
-		try {
-			$syncstate = self::$deviceManager->GetStateManager()->GetSyncState($synckey);
-			$newsynckey = self::$deviceManager->GetStateManager()->GetNewSyncKey($synckey);
-
-			// there are no SyncParameters for the hierarchy, but we use it to save the latest synckeys
-			$spa = self::$deviceManager->GetStateManager()->GetSynchedFolderState(false);
-
-			// Over the ChangesWrapper the HierarchyCache is notified about all changes
-			$changesMem = self::$deviceManager->GetHierarchyChangesWrapper();
-
-			// the hierarchyCache should now fully be initialized - check for changes in the additional folders
-			$changesMem->Config(GSync::GetAdditionalSyncFolders(false));
-
-			// reset to default store in backend
-			self::$backend->Setup(false);
-
-			// there are unprocessed changes in the hierarchy, trigger resync
-			if ($changesMem->GetChangeCount() > 0) {
-				throw new StatusException("HandleFolderChange() can not proceed as there are unprocessed hierarchy changes", SYNC_FSSTATUS_SERVERERROR);
-			}
-
-			// any additional folders can not be modified - with exception if they are of type SYNC_FOLDER_TYPE_UNKNOWN (ZP-907)
-			if (self::$deviceManager->GetFolderTypeFromCacheById($serverid) != SYNC_FOLDER_TYPE_UNKNOWN && $serverid !== false && GSync::GetAdditionalSyncFolderStore($backendid)) {
-				throw new StatusException("HandleFolderChange() can not change additional folders which are configured", SYNC_FSSTATUS_SYSTEMFOLDER);
-			}
-
-			// switch user store if this this happens inside an additional folder
-			// if this is an additional folder the backend has to be setup correctly
-			// backend should also not be switched when type is SYNC_FOLDER_TYPE_UNKNOWN (ZP-1220)
-			if (self::$deviceManager->GetFolderTypeFromCacheById($serverid) != SYNC_FOLDER_TYPE_UNKNOWN && !self::$backend->Setup(GSync::GetAdditionalSyncFolderStore((($parentBackendId != false) ? $parentBackendId : $backendid)))) {
-				throw new StatusException(sprintf("HandleFolderChange() could not Setup() the backend for folder id '%s'", (($parentBackendId != false) ? $parentBackendId : $backendid)), SYNC_FSSTATUS_SERVERERROR);
-			}
-		}
-		catch (StateNotFoundException $snfex) {
-			$status = SYNC_FSSTATUS_SYNCKEYERROR;
-		}
-		catch (StatusException $stex) {
-			$status = $stex->getCode();
-		}
-
-		// set $newsynckey in case of an error
-		if (!isset($newsynckey)) {
-			$newsynckey = $synckey;
-		}
-
-		if ($status == SYNC_FSSTATUS_SUCCESS) {
-			try {
-				// Configure importer with last state
-				$importer = self::$backend->GetImporter();
-				$importer->Config($syncstate);
-
-				// the messages from the PIM will be forwarded to the real importer
-				$changesMem->SetDestinationImporter($importer);
-
-				// Create SyncFolder object
-				$folder = new SyncFolder();
-				$folder->serverid = $serverid;
-				$folder->parentid = $parentBackendId;
-				if (isset($displayname)) {
-					$folder->displayname = $displayname;
-				}
-				if (isset($type)) {
-					$folder->type = $type;
-				}
-				// add the backendId to the SyncFolder object
-				$folder->BackendId = $backendid;
-
-				// process incoming change
-				if (!$delete) {
-					// when creating, $folder->serverid is false, and the returned id is already mapped by the backend
-					$folder = $changesMem->ImportFolderChange($folder);
-				}
-				else {
-					// delete folder
-					$changesMem->ImportFolderDeletion($folder);
-				}
-			}
-			catch (StatusException $stex) {
-				$status = $stex->getCode();
-			}
-		}
-
-		self::$encoder->startWBXML();
-		if ($create) {
-			self::$encoder->startTag(SYNC_FOLDERHIERARCHY_FOLDERCREATE);
-
-			self::$encoder->startTag(SYNC_FOLDERHIERARCHY_STATUS);
-			self::$encoder->content($status);
-			self::$encoder->endTag();
-
-			self::$encoder->startTag(SYNC_FOLDERHIERARCHY_SYNCKEY);
-			self::$encoder->content($newsynckey);
-			self::$encoder->endTag();
-
-			self::$encoder->startTag(SYNC_FOLDERHIERARCHY_SERVERENTRYID);
-			self::$encoder->content($folder->serverid);
-			self::$encoder->endTag();
-
-			self::$encoder->endTag();
-		}
-		elseif ($update) {
-			self::$encoder->startTag(SYNC_FOLDERHIERARCHY_FOLDERUPDATE);
-
-			self::$encoder->startTag(SYNC_FOLDERHIERARCHY_STATUS);
-			self::$encoder->content($status);
-			self::$encoder->endTag();
-
-			self::$encoder->startTag(SYNC_FOLDERHIERARCHY_SYNCKEY);
-			self::$encoder->content($newsynckey);
-			self::$encoder->endTag();
-
-			self::$encoder->endTag();
-		}
-		elseif ($delete) {
-			self::$encoder->startTag(SYNC_FOLDERHIERARCHY_FOLDERDELETE);
-
-			self::$encoder->startTag(SYNC_FOLDERHIERARCHY_STATUS);
-			self::$encoder->content($status);
-			self::$encoder->endTag();
-
-			self::$encoder->startTag(SYNC_FOLDERHIERARCHY_SYNCKEY);
-			self::$encoder->content($newsynckey);
-			self::$encoder->endTag();
-
-			self::$encoder->endTag();
-		}
-
-		self::$topCollector->AnnounceInformation(sprintf("Operation status %d", $status), true);
-
-		// Save the sync state for the next time
-		if (isset($importer)) {
-			self::$deviceManager->GetStateManager()->SetSyncState($newsynckey, $importer->GetState());
-
-			// update SPA & save it
-			$spa->SetSyncKey($newsynckey);
-			$spa->SetFolderId(false);
-			self::$deviceManager->GetStateManager()->SetSynchedFolderState($spa);
-
-			// invalidate all pingable flags
-			SyncCollections::InvalidatePingableFlags();
-		}
-
-		return true;
-	}
+    /**
+     * Handles creates, updates or deletes of a folder
+     * issued by the commands FolderCreate, FolderUpdate and FolderDelete.
+     *
+     * @param int $commandCode
+     *
+     * @return bool
+     */
+    public function Handle($commandCode) {
+        $el = self::$decoder->getElement();
+
+        if ($el[EN_TYPE] != EN_TYPE_STARTTAG) {
+            return false;
+        }
+
+        $create = $update = $delete = false;
+        if ($el[EN_TAG] == SYNC_FOLDERHIERARCHY_FOLDERCREATE) {
+            $create = true;
+        }
+        elseif ($el[EN_TAG] == SYNC_FOLDERHIERARCHY_FOLDERUPDATE) {
+            $update = true;
+        }
+        elseif ($el[EN_TAG] == SYNC_FOLDERHIERARCHY_FOLDERDELETE) {
+            $delete = true;
+        }
+
+        if (!$create && !$update && !$delete) {
+            return false;
+        }
+
+        // SyncKey
+        if (!self::$decoder->getElementStartTag(SYNC_FOLDERHIERARCHY_SYNCKEY)) {
+            return false;
+        }
+        $synckey = self::$decoder->getElementContent();
+        if (!self::$decoder->getElementEndTag()) {
+            return false;
+        }
+
+        // ServerID
+        $serverid = false;
+        $backendid = false;
+        if (self::$decoder->getElementStartTag(SYNC_FOLDERHIERARCHY_SERVERENTRYID)) {
+            $serverid = self::$decoder->getElementContent();
+            $backendid = self::$deviceManager->GetBackendIdForFolderId($serverid);
+            if (!self::$decoder->getElementEndTag()) {
+                return false;
+            }
+        }
+
+        // Parent
+        $parentid = false;
+        $parentBackendId = false;
+
+        // when creating or updating more information is necessary
+        if (!$delete) {
+            if (self::$decoder->getElementStartTag(SYNC_FOLDERHIERARCHY_PARENTID)) {
+                $parentid = self::$decoder->getElementContent();
+                $parentBackendId = self::$deviceManager->GetBackendIdForFolderId($parentid);
+                if (!self::$decoder->getElementEndTag()) {
+                    return false;
+                }
+            }
+
+            // Displayname
+            if (!self::$decoder->getElementStartTag(SYNC_FOLDERHIERARCHY_DISPLAYNAME)) {
+                return false;
+            }
+            $displayname = self::$decoder->getElementContent();
+            if (!self::$decoder->getElementEndTag()) {
+                return false;
+            }
+
+            // Type
+            $type = false;
+            if (self::$decoder->getElementStartTag(SYNC_FOLDERHIERARCHY_TYPE)) {
+                $type = self::$decoder->getElementContent();
+                if (!self::$decoder->getElementEndTag()) {
+                    return false;
+                }
+            }
+        }
+
+        // endtag foldercreate, folderupdate, folderdelete
+        if (!self::$decoder->getElementEndTag()) {
+            return false;
+        }
+
+        $status = SYNC_FSSTATUS_SUCCESS;
+        // Get state of hierarchy
+        try {
+            $syncstate = self::$deviceManager->GetStateManager()->GetSyncState($synckey);
+            $newsynckey = self::$deviceManager->GetStateManager()->GetNewSyncKey($synckey);
+
+            // there are no SyncParameters for the hierarchy, but we use it to save the latest synckeys
+            $spa = self::$deviceManager->GetStateManager()->GetSynchedFolderState(false);
+
+            // Over the ChangesWrapper the HierarchyCache is notified about all changes
+            $changesMem = self::$deviceManager->GetHierarchyChangesWrapper();
+
+            // the hierarchyCache should now fully be initialized - check for changes in the additional folders
+            $changesMem->Config(GSync::GetAdditionalSyncFolders(false));
+
+            // reset to default store in backend
+            self::$backend->Setup(false);
+
+            // there are unprocessed changes in the hierarchy, trigger resync
+            if ($changesMem->GetChangeCount() > 0) {
+                throw new StatusException("HandleFolderChange() can not proceed as there are unprocessed hierarchy changes", SYNC_FSSTATUS_SERVERERROR);
+            }
+
+            // any additional folders can not be modified - with exception if they are of type SYNC_FOLDER_TYPE_UNKNOWN (ZP-907)
+            if (self::$deviceManager->GetFolderTypeFromCacheById($serverid) != SYNC_FOLDER_TYPE_UNKNOWN && $serverid !== false && GSync::GetAdditionalSyncFolderStore($backendid)) {
+                throw new StatusException("HandleFolderChange() can not change additional folders which are configured", SYNC_FSSTATUS_SYSTEMFOLDER);
+            }
+
+            // switch user store if this this happens inside an additional folder
+            // if this is an additional folder the backend has to be setup correctly
+            // backend should also not be switched when type is SYNC_FOLDER_TYPE_UNKNOWN (ZP-1220)
+            if (self::$deviceManager->GetFolderTypeFromCacheById($serverid) != SYNC_FOLDER_TYPE_UNKNOWN && !self::$backend->Setup(GSync::GetAdditionalSyncFolderStore((($parentBackendId != false) ? $parentBackendId : $backendid)))) {
+                throw new StatusException(sprintf("HandleFolderChange() could not Setup() the backend for folder id '%s'", (($parentBackendId != false) ? $parentBackendId : $backendid)), SYNC_FSSTATUS_SERVERERROR);
+            }
+        }
+        catch (StateNotFoundException $snfex) {
+            $status = SYNC_FSSTATUS_SYNCKEYERROR;
+        }
+        catch (StatusException $stex) {
+            $status = $stex->getCode();
+        }
+
+        // set $newsynckey in case of an error
+        if (!isset($newsynckey)) {
+            $newsynckey = $synckey;
+        }
+
+        if ($status == SYNC_FSSTATUS_SUCCESS) {
+            try {
+                // Configure importer with last state
+                $importer = self::$backend->GetImporter();
+                $importer->Config($syncstate);
+
+                // the messages from the PIM will be forwarded to the real importer
+                $changesMem->SetDestinationImporter($importer);
+
+                // Create SyncFolder object
+                $folder = new SyncFolder();
+                $folder->serverid = $serverid;
+                $folder->parentid = $parentBackendId;
+                if (isset($displayname)) {
+                    $folder->displayname = $displayname;
+                }
+                if (isset($type)) {
+                    $folder->type = $type;
+                }
+                // add the backendId to the SyncFolder object
+                $folder->BackendId = $backendid;
+
+                // process incoming change
+                if (!$delete) {
+                    // when creating, $folder->serverid is false, and the returned id is already mapped by the backend
+                    $folder = $changesMem->ImportFolderChange($folder);
+                }
+                else {
+                    // delete folder
+                    $changesMem->ImportFolderDeletion($folder);
+                }
+            }
+            catch (StatusException $stex) {
+                $status = $stex->getCode();
+            }
+        }
+
+        self::$encoder->startWBXML();
+        if ($create) {
+            self::$encoder->startTag(SYNC_FOLDERHIERARCHY_FOLDERCREATE);
+
+            self::$encoder->startTag(SYNC_FOLDERHIERARCHY_STATUS);
+            self::$encoder->content($status);
+            self::$encoder->endTag();
+
+            self::$encoder->startTag(SYNC_FOLDERHIERARCHY_SYNCKEY);
+            self::$encoder->content($newsynckey);
+            self::$encoder->endTag();
+
+            self::$encoder->startTag(SYNC_FOLDERHIERARCHY_SERVERENTRYID);
+            self::$encoder->content($folder->serverid);
+            self::$encoder->endTag();
+
+            self::$encoder->endTag();
+        }
+        elseif ($update) {
+            self::$encoder->startTag(SYNC_FOLDERHIERARCHY_FOLDERUPDATE);
+
+            self::$encoder->startTag(SYNC_FOLDERHIERARCHY_STATUS);
+            self::$encoder->content($status);
+            self::$encoder->endTag();
+
+            self::$encoder->startTag(SYNC_FOLDERHIERARCHY_SYNCKEY);
+            self::$encoder->content($newsynckey);
+            self::$encoder->endTag();
+
+            self::$encoder->endTag();
+        }
+        elseif ($delete) {
+            self::$encoder->startTag(SYNC_FOLDERHIERARCHY_FOLDERDELETE);
+
+            self::$encoder->startTag(SYNC_FOLDERHIERARCHY_STATUS);
+            self::$encoder->content($status);
+            self::$encoder->endTag();
+
+            self::$encoder->startTag(SYNC_FOLDERHIERARCHY_SYNCKEY);
+            self::$encoder->content($newsynckey);
+            self::$encoder->endTag();
+
+            self::$encoder->endTag();
+        }
+
+        self::$topCollector->AnnounceInformation(sprintf("Operation status %d", $status), true);
+
+        // Save the sync state for the next time
+        if (isset($importer)) {
+            self::$deviceManager->GetStateManager()->SetSyncState($newsynckey, $importer->GetState());
+
+            // update SPA & save it
+            $spa->SetSyncKey($newsynckey);
+            $spa->SetFolderId(false);
+            self::$deviceManager->GetStateManager()->SetSynchedFolderState($spa);
+
+            // invalidate all pingable flags
+            SyncCollections::InvalidatePingableFlags();
+        }
+
+        return true;
+    }
 }

Braces +8 added lines, -16 removed lines

@@ -26,11 +26,9 @@ 
 		$create = $update = $delete = false;
 		if ($el[EN_TAG] == SYNC_FOLDERHIERARCHY_FOLDERCREATE) {
 			$create = true;
-		}
-		elseif ($el[EN_TAG] == SYNC_FOLDERHIERARCHY_FOLDERUPDATE) {
+		} elseif ($el[EN_TAG] == SYNC_FOLDERHIERARCHY_FOLDERUPDATE) {
 			$update = true;
-		}
-		elseif ($el[EN_TAG] == SYNC_FOLDERHIERARCHY_FOLDERDELETE) {
+		} elseif ($el[EN_TAG] == SYNC_FOLDERHIERARCHY_FOLDERDELETE) {
 			$delete = true;
 		}
 
@@ -130,11 +128,9 @@ 
 			if (self::$deviceManager->GetFolderTypeFromCacheById($serverid) != SYNC_FOLDER_TYPE_UNKNOWN && !self::$backend->Setup(GSync::GetAdditionalSyncFolderStore((($parentBackendId != false) ? $parentBackendId : $backendid)))) {
 				throw new StatusException(sprintf("HandleFolderChange() could not Setup() the backend for folder id '%s'", (($parentBackendId != false) ? $parentBackendId : $backendid)), SYNC_FSSTATUS_SERVERERROR);
 			}
-		}
-		catch (StateNotFoundException $snfex) {
+		} catch (StateNotFoundException $snfex) {
 			$status = SYNC_FSSTATUS_SYNCKEYERROR;
-		}
-		catch (StatusException $stex) {
+		} catch (StatusException $stex) {
 			$status = $stex->getCode();
 		}
 
@@ -169,13 +165,11 @@ 
 				if (!$delete) {
 					// when creating, $folder->serverid is false, and the returned id is already mapped by the backend
 					$folder = $changesMem->ImportFolderChange($folder);
-				}
-				else {
+				} else {
 					// delete folder
 					$changesMem->ImportFolderDeletion($folder);
 				}
-			}
-			catch (StatusException $stex) {
+			} catch (StatusException $stex) {
 				$status = $stex->getCode();
 			}
 		}
@@ -197,8 +191,7 @@ 
 			self::$encoder->endTag();
 
 			self::$encoder->endTag();
-		}
-		elseif ($update) {
+		} elseif ($update) {
 			self::$encoder->startTag(SYNC_FOLDERHIERARCHY_FOLDERUPDATE);
 
 			self::$encoder->startTag(SYNC_FOLDERHIERARCHY_STATUS);
@@ -210,8 +203,7 @@ 
 			self::$encoder->endTag();
 
 			self::$encoder->endTag();
-		}
-		elseif ($delete) {
+		} elseif ($delete) {
 			self::$encoder->startTag(SYNC_FOLDERHIERARCHY_FOLDERDELETE);
 
 			self::$encoder->startTag(SYNC_FOLDERHIERARCHY_STATUS);

lib/request/moveitems.php

Indentation +123 added lines, -123 removed lines

@@ -8,127 +8,127 @@
  */
 
 class MoveItems extends RequestProcessor {
-	/**
-	 * Handles the MoveItems command.
-	 *
-	 * @param int $commandCode
-	 *
-	 * @return bool
-	 */
-	public function Handle($commandCode) {
-		if (!self::$decoder->getElementStartTag(SYNC_MOVE_MOVES)) {
-			return false;
-		}
-
-		$moves = [];
-		while (self::$decoder->getElementStartTag(SYNC_MOVE_MOVE)) {
-			$move = [];
-			if (self::$decoder->getElementStartTag(SYNC_MOVE_SRCMSGID)) {
-				$move["srcmsgid"] = self::$decoder->getElementContent();
-				if (!self::$decoder->getElementEndTag()) {
-					break;
-				}
-			}
-			if (self::$decoder->getElementStartTag(SYNC_MOVE_SRCFLDID)) {
-				$move["srcfldid"] = self::$decoder->getElementContent();
-				if (!self::$decoder->getElementEndTag()) {
-					break;
-				}
-			}
-			if (self::$decoder->getElementStartTag(SYNC_MOVE_DSTFLDID)) {
-				$move["dstfldid"] = self::$decoder->getElementContent();
-				if (!self::$decoder->getElementEndTag()) {
-					break;
-				}
-			}
-			array_push($moves, $move);
-
-			if (!self::$decoder->getElementEndTag()) {
-				return false;
-			}
-		}
-
-		if (!self::$decoder->getElementEndTag()) {
-			return false;
-		}
-
-		self::$encoder->StartWBXML();
-
-		self::$encoder->startTag(SYNC_MOVE_MOVES);
-
-		$operationResults = [];
-		$operationCounter = 0;
-		$operationTotal = count($moves);
-		foreach ($moves as $move) {
-			++$operationCounter;
-			self::$encoder->startTag(SYNC_MOVE_RESPONSE);
-			self::$encoder->startTag(SYNC_MOVE_SRCMSGID);
-			self::$encoder->content($move["srcmsgid"]);
-			self::$encoder->endTag();
-
-			$status = SYNC_MOVEITEMSSTATUS_SUCCESS;
-			$result = false;
-
-			try {
-				$sourceBackendFolderId = self::$deviceManager->GetBackendIdForFolderId($move["srcfldid"]);
-
-				// if the source folder is an additional folder the backend has to be setup correctly
-				if (!self::$backend->Setup(GSync::GetAdditionalSyncFolderStore($sourceBackendFolderId))) {
-					throw new StatusException(sprintf("HandleMoveItems() could not Setup() the backend for folder id %s/%s", $move["srcfldid"], $sourceBackendFolderId), SYNC_MOVEITEMSSTATUS_INVALIDSOURCEID);
-				}
-
-				$importer = self::$backend->GetImporter($sourceBackendFolderId);
-				if ($importer === false) {
-					throw new StatusException(sprintf("HandleMoveItems() could not get an importer for folder id %s/%s", $move["srcfldid"], $sourceBackendFolderId), SYNC_MOVEITEMSSTATUS_INVALIDSOURCEID);
-				}
-
-				// get saved SyncParameters of the source folder
-				$spa = self::$deviceManager->GetStateManager()->GetSynchedFolderState($move["srcfldid"]);
-				if (!$spa->HasSyncKey()) {
-					throw new StatusException(sprintf("MoveItems(): Source folder id '%s' is not fully synchronized. Unable to perform operation.", $move["srcfldid"]), SYNC_MOVEITEMSSTATUS_INVALIDSOURCEID);
-				}
-
-				$importer->ConfigContentParameters($spa->GetCPO());
-
-				$result = $importer->ImportMessageMove($move["srcmsgid"], self::$deviceManager->GetBackendIdForFolderId($move["dstfldid"]));
-				// We discard the standard importer state for now.
-			}
-			catch (StatusException $stex) {
-				if ($stex->getCode() == SYNC_STATUS_FOLDERHIERARCHYCHANGED) { // same as SYNC_FSSTATUS_CODEUNKNOWN
-					$status = SYNC_MOVEITEMSSTATUS_INVALIDSOURCEID;
-				}
-				else {
-					$status = $stex->getCode();
-				}
-			}
-
-			if ($operationCounter % 10 == 0) {
-				self::$topCollector->AnnounceInformation(sprintf("Moved %d objects out of %d", $operationCounter, $operationTotal));
-			}
-
-			// save the operation result
-			if (!isset($operationResults[$status])) {
-				$operationResults[$status] = 0;
-			}
-			++$operationResults[$status];
-
-			self::$encoder->startTag(SYNC_MOVE_STATUS);
-			self::$encoder->content($status);
-			self::$encoder->endTag();
-
-			self::$encoder->startTag(SYNC_MOVE_DSTMSGID);
-			self::$encoder->content((($result !== false) ? $result : $move["srcmsgid"]));
-			self::$encoder->endTag();
-			self::$encoder->endTag();
-		}
-
-		self::$topCollector->AnnounceInformation(sprintf("Moved %d - Codes", $operationTotal), true);
-		foreach ($operationResults as $status => $occurrences) {
-			self::$topCollector->AnnounceInformation(sprintf("%dx%d", $occurrences, $status), true);
-		}
-
-		self::$encoder->endTag();
-
-		return true;
-	}
+    /**
+     * Handles the MoveItems command.
+     *
+     * @param int $commandCode
+     *
+     * @return bool
+     */
+    public function Handle($commandCode) {
+        if (!self::$decoder->getElementStartTag(SYNC_MOVE_MOVES)) {
+            return false;
+        }
+
+        $moves = [];
+        while (self::$decoder->getElementStartTag(SYNC_MOVE_MOVE)) {
+            $move = [];
+            if (self::$decoder->getElementStartTag(SYNC_MOVE_SRCMSGID)) {
+                $move["srcmsgid"] = self::$decoder->getElementContent();
+                if (!self::$decoder->getElementEndTag()) {
+                    break;
+                }
+            }
+            if (self::$decoder->getElementStartTag(SYNC_MOVE_SRCFLDID)) {
+                $move["srcfldid"] = self::$decoder->getElementContent();
+                if (!self::$decoder->getElementEndTag()) {
+                    break;
+                }
+            }
+            if (self::$decoder->getElementStartTag(SYNC_MOVE_DSTFLDID)) {
+                $move["dstfldid"] = self::$decoder->getElementContent();
+                if (!self::$decoder->getElementEndTag()) {
+                    break;
+                }
+            }
+            array_push($moves, $move);
+
+            if (!self::$decoder->getElementEndTag()) {
+                return false;
+            }
+        }
+
+        if (!self::$decoder->getElementEndTag()) {
+            return false;
+        }
+
+        self::$encoder->StartWBXML();
+
+        self::$encoder->startTag(SYNC_MOVE_MOVES);
+
+        $operationResults = [];
+        $operationCounter = 0;
+        $operationTotal = count($moves);
+        foreach ($moves as $move) {
+            ++$operationCounter;
+            self::$encoder->startTag(SYNC_MOVE_RESPONSE);
+            self::$encoder->startTag(SYNC_MOVE_SRCMSGID);
+            self::$encoder->content($move["srcmsgid"]);
+            self::$encoder->endTag();
+
+            $status = SYNC_MOVEITEMSSTATUS_SUCCESS;
+            $result = false;
+
+            try {
+                $sourceBackendFolderId = self::$deviceManager->GetBackendIdForFolderId($move["srcfldid"]);
+
+                // if the source folder is an additional folder the backend has to be setup correctly
+                if (!self::$backend->Setup(GSync::GetAdditionalSyncFolderStore($sourceBackendFolderId))) {
+                    throw new StatusException(sprintf("HandleMoveItems() could not Setup() the backend for folder id %s/%s", $move["srcfldid"], $sourceBackendFolderId), SYNC_MOVEITEMSSTATUS_INVALIDSOURCEID);
+                }
+
+                $importer = self::$backend->GetImporter($sourceBackendFolderId);
+                if ($importer === false) {
+                    throw new StatusException(sprintf("HandleMoveItems() could not get an importer for folder id %s/%s", $move["srcfldid"], $sourceBackendFolderId), SYNC_MOVEITEMSSTATUS_INVALIDSOURCEID);
+                }
+
+                // get saved SyncParameters of the source folder
+                $spa = self::$deviceManager->GetStateManager()->GetSynchedFolderState($move["srcfldid"]);
+                if (!$spa->HasSyncKey()) {
+                    throw new StatusException(sprintf("MoveItems(): Source folder id '%s' is not fully synchronized. Unable to perform operation.", $move["srcfldid"]), SYNC_MOVEITEMSSTATUS_INVALIDSOURCEID);
+                }
+
+                $importer->ConfigContentParameters($spa->GetCPO());
+
+                $result = $importer->ImportMessageMove($move["srcmsgid"], self::$deviceManager->GetBackendIdForFolderId($move["dstfldid"]));
+                // We discard the standard importer state for now.
+            }
+            catch (StatusException $stex) {
+                if ($stex->getCode() == SYNC_STATUS_FOLDERHIERARCHYCHANGED) { // same as SYNC_FSSTATUS_CODEUNKNOWN
+                    $status = SYNC_MOVEITEMSSTATUS_INVALIDSOURCEID;
+                }
+                else {
+                    $status = $stex->getCode();
+                }
+            }
+
+            if ($operationCounter % 10 == 0) {
+                self::$topCollector->AnnounceInformation(sprintf("Moved %d objects out of %d", $operationCounter, $operationTotal));
+            }
+
+            // save the operation result
+            if (!isset($operationResults[$status])) {
+                $operationResults[$status] = 0;
+            }
+            ++$operationResults[$status];
+
+            self::$encoder->startTag(SYNC_MOVE_STATUS);
+            self::$encoder->content($status);
+            self::$encoder->endTag();
+
+            self::$encoder->startTag(SYNC_MOVE_DSTMSGID);
+            self::$encoder->content((($result !== false) ? $result : $move["srcmsgid"]));
+            self::$encoder->endTag();
+            self::$encoder->endTag();
+        }
+
+        self::$topCollector->AnnounceInformation(sprintf("Moved %d - Codes", $operationTotal), true);
+        foreach ($operationResults as $status => $occurrences) {
+            self::$topCollector->AnnounceInformation(sprintf("%dx%d", $occurrences, $status), true);
+        }
+
+        self::$encoder->endTag();
+
+        return true;
+    }
 }

Braces +2 added lines, -4 removed lines

@@ -92,12 +92,10 @@
 
 				$result = $importer->ImportMessageMove($move["srcmsgid"], self::$deviceManager->GetBackendIdForFolderId($move["dstfldid"]));
 				// We discard the standard importer state for now.
-			}
-			catch (StatusException $stex) {
+			} catch (StatusException $stex) {
 				if ($stex->getCode() == SYNC_STATUS_FOLDERHIERARCHYCHANGED) { // same as SYNC_FSSTATUS_CODEUNKNOWN
 					$status = SYNC_MOVEITEMSSTATUS_INVALIDSOURCEID;
-				}
-				else {
+				} else {
 					$status = $stex->getCode();
 				}
 			}