+ } else if ($response == 'BAD') {
+ sqm_trigger_imap_error('SQM_IMAP_NO_SORT',$query, $response, $message);
+ }
+ }
+
+ if ($response == 'OK') {
+ return parseUidList($aData,'SORT');
+ } else {
+ return false;
+ }
+}
+
+
+/**
+ * Parses a UID list returned on a SORT or SEARCH request
+ * @param array $aData imap response (retrieved from sqimap_run_command_list)
+ * @param string $sCommand issued imap command (SEARCH or SORT)
+ * @return array $aUid uid list
+ */
+function parseUidList($aData,$sCommand) {
+ $aUid = array();
+ if (isset($aData) && count($aData)) {
+ for ($i=0,$iCnt=count($aData);$i<$iCnt;++$i) {
+ for ($j=0,$jCnt=count($aData[$i]);$j<$jCnt;++$j) {
+ if (preg_match("/^\* $sCommand (.+)$/", $aData[$i][$j], $aMatch)) {
+ $aUid += explode(' ', trim($aMatch[1]));
+ }
+ }
+ }
+ }
+ return array_unique($aUid);
+}
+
+/**
+ * Retrieves an array with a sorted uid list. Sorting is done by SquirrelMail
+ *
+ * @param resource $imap_stream IMAP socket connection
+ * @param string $sSortField Field to sort on
+ * @param bool $reverse Reverse order search
+ * @param array $aUid limit the search to the provided array with uid's default sqimap_get_small_headers uses 1:*
+ * @return array $aUid sorted uid list
+ */
+function get_squirrel_sort($imap_stream, $sSortField, $reverse = false, $aUid = NULL) {
+ if ($sSortField != 'RFC822.SIZE' && $sSortField != 'INTERNALDATE') {
+ $msgs = sqimap_get_small_header_list($imap_stream, $aUid,
+ array($sSortField), array());
+ } else {
+ $msgs = sqimap_get_small_header_list($imap_stream, $aUid,
+ array(), array($sSortField));
+ }
+
+ // sqimap_get_small_header (see above) returns fields in lower case,
+ // but the code below uses all upper case
+ foreach ($msgs as $k => $v)
+ if (isset($msgs[$k][strtolower($sSortField)]))
+ $msgs[$k][strtoupper($sSortField)] = $msgs[$k][strtolower($sSortField)];
+
+ $aUid = array();
+ $walk = false;
+ switch ($sSortField) {
+ // natcasesort section
+ case 'FROM':
+ case 'TO':
+ case 'CC':
+ if(!$walk) {
+ array_walk($msgs, create_function('&$v,&$k,$f',
+ '$v[$f] = (isset($v[$f])) ? $v[$f] : "";
+ $addr = reset(parseRFC822Address($v[$f],1));
+ $sPersonal = (isset($addr[SQM_ADDR_PERSONAL]) && $addr[SQM_ADDR_PERSONAL]) ?
+ $addr[SQM_ADDR_PERSONAL] : "";
+ $sEmail = ($addr[SQM_ADDR_HOST]) ?
+ $addr[SQM_ADDR_MAILBOX] . "@".$addr[SQM_ADDR_HOST] :
+ $addr[SQM_ADDR_HOST];
+ $v[$f] = ($sPersonal) ? decodeHeader($sPersonal, true, false):$sEmail;'),$sSortField);
+ $walk = true;
+ }
+ // nobreak
+ case 'SUBJECT':
+ if(!$walk) {
+ array_walk($msgs, create_function('&$v,&$k,$f',
+ '$v[$f] = (isset($v[$f])) ? $v[$f] : "";
+ $v[$f] = strtolower(decodeHeader(trim($v[$f]), true, false));
+ $v[$f] = (preg_match("/^(?:(?:vedr|sv|re|aw|fw|fwd|\[\w\]):\s*)*\s*(.*)$/si", $v[$f], $matches)) ?
+ $matches[1] : $v[$f];'),$sSortField);
+ $walk = true;
+ }
+ foreach ($msgs as $item) {
+ $aUid[$item['UID']] = $item[$sSortField];
+ }
+ natcasesort($aUid);
+ $aUid = array_keys($aUid);
+ if ($reverse) {
+ $aUid = array_reverse($aUid);
+ }
+ break;
+ // \natcasesort section
+ // sort_numeric section
+ case 'DATE':
+ case 'INTERNALDATE':
+ if(!$walk) {
+ array_walk($msgs, create_function('&$v,$k,$f',
+ '$v[$f] = (isset($v[$f])) ? $v[$f] : "";
+ $v[$f] = getTimeStamp(explode(" ",$v[$f]));'),$sSortField);
+ $walk = true;
+ }
+ // nobreak;
+ case 'RFC822.SIZE':
+ if(!$walk) {
+ // redefine $sSortField to maintain the same namespace between
+ // server-side sorting and SquirrelMail sorting
+ $sSortField = 'SIZE';
+ }
+ foreach ($msgs as $item) {
+ $aUid[$item['UID']] = (isset($item[$sSortField])) ? $item[$sSortField] : 0;
+ }
+ if ($reverse) {
+ arsort($aUid,SORT_NUMERIC);
+ } else {
+ asort($aUid, SORT_NUMERIC);
+ }
+ $aUid = array_keys($aUid);
+ break;
+ // \sort_numeric section
+ case 'UID':
+ $aUid = array_reverse($msgs);
+ break;
+ }
+ return $aUid;
+}
+
+/**
+ * Returns an array with each element as a string representing one
+ * message-thread as returned by the IMAP server.
+ * @param resource $imap_stream IMAP socket connection
+ * @param string $search optional search string
+ * @return array
+ * @link http://www.ietf.org/internet-drafts/draft-ietf-imapext-sort-13.txt
+ */
+function get_thread_sort($imap_stream, $search='ALL') {
+ global $sort_by_ref, $default_charset;
+
+ if ($sort_by_ref == 1) {
+ $sort_type = 'REFERENCES';
+ } else {
+ $sort_type = 'ORDEREDSUBJECT';
+ }
+ $query = "THREAD $sort_type ".strtoupper($default_charset)." $search";
+
+ // TODO use sqimap_run_command_list as we do in get_server_sort()
+ $sRead = sqimap_run_command ($imap_stream, $query, false, $response, $message, TRUE);
+
+ /* fallback to default charset */
+ if ($response == 'NO') {
+ if (strpos($message,'BADCHARSET') !== false ||
+ strpos($message,'character') !== false) {
+ sqm_trigger_imap_error('SQM_IMAP_BADCHARSET',$query, $response, $message);
+ $query = "THREAD $sort_type US-ASCII $search";
+ $sRead = sqimap_run_command ($imap_stream, $query, true, $response, $message, TRUE);
+ } else {
+ sqm_trigger_imap_error('SQM_IMAP_ERROR',$query, $response, $message);
+ }
+ } elseif ($response == 'BAD') {
+ sqm_trigger_imap_error('SQM_IMAP_NO_THREAD',$query, $response, $message);
+ }
+ $sThreadResponse = '';
+ if (isset($sRead[0])) {
+ for ($i=0,$iCnt=count($sRead);$i<$iCnt;++$i) {
+ if (preg_match("/^\* THREAD (.+)$/", $sRead[$i], $aMatch)) {
+ $sThreadResponse = trim($aMatch[1]);
+ break;
+ }
+ }
+ }
+ unset($sRead);
+
+ if ($response !== 'OK') {
+ return false;
+ }
+
+ /* Example response
+ * S: * THREAD (2)(3 6 (4 23)(44 7 96))
+ * -- 2
+ *
+ * -- 3
+ * \-- 6
+ * |-- 4
+ * | \-- 23
+ * |
+ * \-- 44
+ * \-- 7
+ * \-- 96
+ */
+/*
+ * Notes for future work:
+ * indent_array should contain: indent_level, parent and flags,
+ * sibling nodes ..
+ * To achieve that we need to define the following flags:
+ * 0: hasnochildren
+ * 1: haschildren
+ * 2: is first
+ * 4: is last
+ * a node has sibling nodes if it's not the last node
+ * a node has no sibling nodes if it's the last node
+ * By using binary comparations we can store the flag in one var
+ *
+ * example:
+ * -1 par = 0, level = 0, flag = 1 + 2 + 4 = 7 (haschildren, isfirst, islast)
+ * \-2 par = 1, level = 1, flag = 0 + 2 = 2 (hasnochildren, isfirst)
+ * |-3 par = 1, level = 1, flag = 1 + 4 = 5 (haschildren, islast)
+ * \-4 par = 3, level = 2, flag = 1 + 2 + 4 = 7 (haschildren, isfirst, islast)
+ * \-5 par = 4, level = 3, flag = 0 + 2 + 4 = 6 (hasnochildren, isfirst, islast)
+ */
+
+ $j = 0;
+ $k = 0;
+ $l = 0;
+ $aUidThread = array();
+ $aIndent = array();
+ $aUidSubThread = array();
+ $aDepthStack = array();
+ $sUid = '';
+
+ if ($sThreadResponse) {
+ for ($i=0,$iCnt = strlen($sThreadResponse);$i<$iCnt;++$i) {
+ $cChar = $sThreadResponse{$i};
+ switch ($cChar) {
+ case '(': // new sub thread
+ // correction for a subthread of a thread with no parents in thread
+ if (!count($aUidSubThread) && $j > 0) {
+ --$l;
+ }
+ $aDepthStack[$j] = $l;
+ ++$j;
+ break;
+ case ')': // close sub thread
+ if($sUid !== '') {
+ $aUidSubThread[] = $sUid;
+ $aIndent[$sUid] = $j + $l - 1;
+ ++$l;
+ $sUid = '';
+ }
+ --$j;
+ if ($j === 0) {
+ // show message that starts the thread first.
+ $aUidSubThread = array_reverse($aUidSubThread);
+ // do not use array_merge because it's extremely slow and is causing timeouts
+ foreach ($aUidSubThread as $iUid) {
+ $aUidThread[] = $iUid;
+ }
+ $aUidSubThread = array();
+ $l = 0;
+ $aDepthStack = array();
+ } else {
+ $l = $aDepthStack[$j];
+ }
+ break;
+ case ' ': // new child
+ if ($sUid !== '') {
+ $aUidSubThread[] = $sUid;
+ $aIndent[$sUid] = $j + $l - 1;
+ ++$l;
+ $sUid = '';
+ }
+ break;
+ default: // part of UID
+ $sUid .= $cChar;
+ break;
+ }
+ }
+ }
+ unset($sThreadResponse);
+ // show newest threads first
+ $aUidThread = array_reverse($aUidThread);
+ return array($aUidThread,$aIndent);
+}
+
+
+function elapsedTime($start) {
+ $stop = gettimeofday();
+ $timepassed = 1000000 * ($stop['sec'] - $start['sec']) + $stop['usec'] - $start['usec'];
+ return $timepassed;
+}
+
+/**
+ * Parses a string in an imap response. String starts with " or { which means it
+ * can handle double quoted strings and literal strings
+ *
+ * @param string $read imap response
+ * @param integer $i (reference) offset in string
+ * @return string $s parsed string without the double quotes or literal count
+ */
+function parseString($read,&$i) {
+ $char = $read{$i};
+ $s = '';
+ if ($char == '"') {
+ $iPos = ++$i;
+ while (true) {
+ $iPos = strpos($read,'"',$iPos);
+ if (!$iPos) break;
+ if ($iPos && $read{$iPos -1} != '\\') {
+ $s = substr($read,$i,($iPos-$i));
+ $i = $iPos;
+ break;