+ * IMAP search page
+ *
+ * Subfolder search idea from Patch #806075 by Thomas Pohl xraven at users.sourceforge.net. Thanks Thomas!
+ *
+ * @version $Id$
+ * @package squirrelmail
+ * @link http://www.ietf.org/rfc/rfc3501.txt
+ * @author Alex Lemaresquier - Brainstorm - alex at brainstorm.fr
+ */
+
+/**
+ * Path for SquirrelMail required files.
+ * @ignore
+ */
+define('SM_PATH','../');
+
+/** SquirrelMail required files. */
+require_once(SM_PATH . 'include/validate.php');
+require_once(SM_PATH . 'functions/strings.php');
+require_once(SM_PATH . 'functions/imap_asearch.php');
+require_once(SM_PATH . 'functions/imap_mailbox.php');
+require_once(SM_PATH . 'functions/imap_messages.php');
+require_once(SM_PATH . 'functions/mime.php');
+require_once(SM_PATH . 'functions/mailbox_display.php'); //getButton()...
+
+/**
+ * @param string $a
+ * @param string $b
+ * @return bool strcoll()-like result
+ */
+function asearch_unhtml_strcoll($a, $b)
+{
+ return strcoll(asearch_unhtmlentities($a), asearch_unhtmlentities($b));
+}
+
+/**
+ * @param string $mailbox mailbox name
+ * @return string mailbox name ready to display
+ */
+function imap_get_mailbox_display($mailbox)
+{
+ if (strtoupper($mailbox) == 'INBOX')
+ return _("INBOX");
+ return imap_utf7_decode_local($mailbox);
+}
+
+/**
+ * @param string $mailbox mailbox name
+ * @return string mailbox name ready to display
+ */
+function asearch_get_mailbox_display($mailbox)
+{
+ if ($mailbox == 'All Folders')
+ return _("All Folders");
+ return imap_get_mailbox_display($mailbox);
+}
+
+/**
+ * @param array $color color array
+ * @param string $txt text to display
+ * @return string title ready to display
+ */
+function asearch_get_title_display($color, $txt)
+{
+ return '<b><big>' . $txt . '</big></b>';
+}
+
+/**
+ * @param array $color color array
+ * @param string $txt text to display
+ * @return string error text ready to display
+ */
+function asearch_get_error_display($color, $txt)
+{
+ return '<font color="' . $color[2] . '">' . '<b><big>' . $txt . '</big></b></font>';
+}
+
+/**
+ * @param array $input_array array to serialize
+ * @return string a string containing a byte-stream representation of value that can be stored anywhere
+ */
+function asearch_serialize($input_array)
+{
+ return serialize($input_array);
+}
+
+/**
+ * @param string $input_string string to unserialize
+ * @return array
+ */
+function asearch_unserialize($input_string)
+{
+ return unserialize($input_string);
+}
+
+/**
+ * @param string $data_dir prefs data dir or dsn
+ * @param string $username the username
+ * @param string $key the pref key
+ * @param integer $index the pref key index
+ * @param string $default default value
+ * @return string pref value
+ */
+function asearch_getPref($data_dir, $username, $key, $index, $default = '')
+{
+ return getPref($data_dir, $username, $key . $index, $default);
+}
+
+/**
+ * @param string $data_dir prefs data dir or dsn
+ * @param string $username the username
+ * @param string $key the pref key
+ * @param integer $index the pref key index
+ * @param string $value pref value to set
+ * @return bool status
+ */
+function asearch_setPref($data_dir, $username, $key, $index, $value)
+{
+ return setPref($data_dir, $username, $key . $index, $value);
+}
+
+/**
+ * @param string $data_dir prefs data dir or dsn
+ * @param string $username the username
+ * @param string $key the pref key
+ * @param integer $index the pref key index
+ * @return bool status
+ */
+function asearch_removePref($data_dir, $username, $key, $index)
+{
+ return removePref($data_dir, $username, $key . $index);
+}
+
+/** Sanity checks, done before running the imap command and before push_recent */
+function asearch_check_query($where_array, $what_array, $exclude_array)
+{
+ global $imap_asearch_opcodes;
+
+ if (empty($where_array))
+ return _("Please enter something to search for");
+ if (count($exclude_array) == count($where_array))
+ return _("There must be at least one criteria to search for");
+ for ($crit_num = 0; $crit_num < count($where_array); $crit_num++) {
+ $where = $where_array[$crit_num];
+ $what = $what_array[$crit_num];
+ if (!(($what == '') ^ ($imap_asearch_opcodes[$where] != '')))
+ return _("Error in criteria argument");
+ }
+ return '';
+}
+
+/** Read the recent searches */
+function asearch_read_recent($data_dir, $username)
+{
+ global $recent_prefkeys;
+
+ $recent_array = array();
+ $recent_max = getPref($data_dir, $username, 'search_memory', 0);
+ for ($recent_num = 0; $recent_num < $recent_max; $recent_num++) {
+ foreach ($recent_prefkeys as $prefkey) {
+ $pref = asearch_getPref($data_dir, $username, $prefkey, $recent_num);
+/* if (!empty($pref))*/
+ $recent_array[$prefkey][$recent_num] = $pref;
+ }
+ if (empty($recent_array[$recent_prefkeys[0]][$recent_num])) {
+ foreach ($recent_prefkeys as $key) {
+ array_pop($recent_array[$key]);
+ }
+ break;
+ }
+ }
+ return $recent_array;
+}
+
+/** Get the saved searches */
+function asearch_read_saved($data_dir, $username)
+{
+ global $saved_prefkeys;
+
+ $saved_array = array();
+ $saved_key = $saved_prefkeys[0];
+ for ($saved_count = 0; ; $saved_count++) {
+ $pref = asearch_getPref($data_dir, $username, $saved_key, $saved_count);
+ if (empty($pref))
+ break;
+ }
+ for ($saved_num = 0; $saved_num < $saved_count; $saved_num++) {
+ foreach ($saved_prefkeys as $key) {
+ $saved_array[$key][$saved_num] = asearch_getPref($data_dir, $username, $key, $saved_num);
+ }
+ }
+ return $saved_array;
+}
+
+/** Save a recent search */
+function asearch_save_recent($data_dir, $username, $recent_index)
+{
+ global $recent_prefkeys, $saved_prefkeys;
+
+ $saved_array = asearch_read_saved($data_dir, $username);
+ $saved_index = count($saved_array[$saved_prefkeys[0]]);
+ $recent_array = asearch_read_recent($data_dir, $username);
+ $n = 0;
+ foreach ($recent_prefkeys as $key) {
+ $recent_slice = array_slice($recent_array[$key], $recent_index, 1);
+ if (!empty($recent_slice[0]))
+ asearch_setPref($data_dir, $username, $saved_prefkeys[$n], $saved_index, $recent_slice[0]);
+ else
+ asearch_removePref($data_dir, $username, $saved_prefkeys[$n], $saved_index);
+ $n++;
+ }
+}
+
+/** Write a recent search */
+function asearch_write_recent($data_dir, $username, $recent_array)
+{
+ global $recent_prefkeys;
+
+ $recent_max = getPref($data_dir, $username, 'search_memory', 0);
+ $recent_count = min($recent_max, count($recent_array[$recent_prefkeys[0]]));
+ for ($recent_num=0; $recent_num < $recent_count; $recent_num++) {
+ foreach ($recent_prefkeys as $key) {
+ asearch_setPref($data_dir, $username, $key, $recent_num, $recent_array[$key][$recent_num]);
+ }
+ }
+ for (; $recent_num < $recent_max; $recent_num++) {
+ foreach ($recent_prefkeys as $key) {
+ asearch_removePref($data_dir, $username, $key, $recent_num);
+ }
+ }
+}
+
+/** Forget a recent search */
+function asearch_forget_recent($data_dir, $username, $forget_index)
+{
+ global $recent_prefkeys;
+
+ $recent_array = asearch_read_recent($data_dir, $username);
+ foreach ($recent_prefkeys as $key) {
+ array_splice($recent_array[$key], $forget_index, 1);
+ }
+ asearch_write_recent($data_dir, $username, $recent_array);
+}
+
+/** Find a recent search */
+function asearch_find_recent($recent_array, $mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array, $sub_array)
+{
+ global $recent_prefkeys;
+
+ $mailbox_string = asearch_serialize($mailbox_array);
+ $biop_string = asearch_serialize($biop_array);
+ $unop_string = asearch_serialize($unop_array);
+ $where_string = asearch_serialize($where_array);
+ $what_string = asearch_serialize($what_array);
+ $exclude_string = asearch_serialize($exclude_array);
+ $sub_string = asearch_serialize($sub_array);
+ $recent_count = count($recent_array[$recent_prefkeys[0]]);
+ for ($recent_num=0; $recent_num<$recent_count; $recent_num++) {
+ if (isset($recent_array[$recent_prefkeys[0]][$recent_num])) {
+ if (
+ $mailbox_string == $recent_array['asearch_recent_mailbox'][$recent_num] &&
+ $biop_string == $recent_array['asearch_recent_biop'][$recent_num] &&
+ $unop_string == $recent_array['asearch_recent_unop'][$recent_num] &&
+ $where_string == $recent_array['asearch_recent_where'][$recent_num] &&
+ $what_string == $recent_array['asearch_recent_what'][$recent_num] &&
+ $exclude_string == $recent_array['asearch_recent_exclude'][$recent_num] &&
+ $sub_string == $recent_array['asearch_recent_sub'][$recent_num]
+ )
+ return $recent_num;
+ }
+ }
+ return -1;
+}
+
+/** Push a recent search */
+function asearch_push_recent($data_dir, $username, $mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array, $sub_array)
+{
+ global $recent_prefkeys;
+
+ $recent_max = getPref($data_dir, $username, 'search_memory', 0);
+ if ($recent_max > 0) {
+ $recent_array = asearch_read_recent($data_dir, $username);
+ $recent_found = asearch_find_recent($recent_array, $mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array, $sub_array);
+ if ($recent_found >= 0) { // Remove identical recent
+ foreach ($recent_prefkeys as $key) {
+ array_splice($recent_array[$key], $recent_found, 1);
+ }
+ }
+ $input = array($where_array, $mailbox_array, $what_array, $biop_array, $unop_array, $exclude_array, $sub_array);
+ $i = 0;
+ foreach ($recent_prefkeys as $key) {
+ array_unshift($recent_array[$key], asearch_serialize($input[$i]));
+ $i++;
+ }
+ asearch_write_recent($data_dir, $username, $recent_array);
+ }
+}
+
+/**
+ * Edit a recent search
+ * @global array mailbox_array searched mailboxes