6 * Copyright (c) 1999-2004 The SquirrelMail Project Team
7 * Licensed under the GNU GPL. For full terms see the file COPYING.
11 * Subfolder search idea from Patch #806075 by Thomas Pohl xraven at users.sourceforge.net. Thanks Thomas!
14 * @package squirrelmail
15 * @link http://www.ietf.org/rfc/rfc3501.txt
16 * @author Alex Lemaresquier - Brainstorm - alex at brainstorm.fr
20 * Path for SquirrelMail required files.
23 define('SM_PATH','../');
25 /** SquirrelMail required files.
27 require_once(SM_PATH
. 'include/validate.php');
28 require_once(SM_PATH
. 'functions/strings.php');
29 require_once(SM_PATH
. 'functions/imap_asearch.php');
30 require_once(SM_PATH
. 'functions/imap_mailbox.php');
31 require_once(SM_PATH
. 'functions/imap_messages.php');
32 require_once(SM_PATH
. 'functions/mime.php');
33 require_once(SM_PATH
. 'functions/mailbox_display.php'); //getButton()...
35 /** Prefs array ordinals. Must match $recent_prefkeys and $saved_prefkeys
37 define('ASEARCH_WHERE', 0);
38 define('ASEARCH_MAILBOX', 1);
39 define('ASEARCH_WHAT', 2);
40 define('ASEARCH_UNOP', 3);
41 define('ASEARCH_BIOP', 4);
42 define('ASEARCH_EXCLUDE', 5);
43 define('ASEARCH_SUB', 6);
45 /** Builds a href with params
47 function asearch_get_href($params = '')
51 $href .= '?' . $params;
57 function asearch_get_link(&$href, $text, $title = '')
60 $title = ' title="' . $title . '"';
61 return '<small>[<a href="' . $href . '"' . $title . '>' . $text . '</a>]</small>';
64 /** Builds a toggle [link]
66 function asearch_get_toggle_link($value, $action, $text_array, $title_array = array())
68 return asearch_get_link(asearch_get_href($action . '=' . (int)$value), $text_array[$value], asearch_nz($title_array[$value]));
74 * @return bool strcoll()-like result
76 function asearch_unhtml_strcoll($a, $b)
78 return strcoll(asearch_unhtmlentities($a), asearch_unhtmlentities($b));
82 * @param string $mailbox mailbox name utf7 encoded inc. special case INBOX
83 * @return string mailbox name ready to display (utf7 decoded or localized INBOX)
85 function imap_get_mailbox_display($mailbox)
87 if (strtoupper($mailbox) == 'INBOX')
89 return imap_utf7_decode_local($mailbox);
93 * @param string $mailbox mailbox name or special case 'All Folders'
94 * @return string mailbox name ready to display (utf7 decoded or localized 'All Folders')
96 function asearch_get_mailbox_display($mailbox)
98 if ($mailbox == 'All Folders')
99 return _("All Folders");
100 return imap_get_mailbox_display($mailbox);
104 * @param array $color color array
105 * @param string $txt text to display
106 * @return string title ready to display
108 function asearch_get_title_display(&$color, $txt)
110 return '<b><big>' . $txt . '</big></b>';
114 * @param array $color color array
115 * @param string $txt text to display
116 * @return string error text ready to display
118 function asearch_get_error_display(&$color, $txt)
120 return '<font color="' . $color[2] . '">' . '<b><big>' . $txt . '</big></b></font>';
124 * @param array $input_array array to serialize
125 * @return string a string containing a byte-stream representation of value that can be stored anywhere
127 function asearch_serialize(&$input_array)
129 global $search_advanced;
130 if ($search_advanced)
131 return serialize($input_array);
132 return $input_array[0];
136 * @param string $input_string string to unserialize
139 function asearch_unserialize($input_string)
141 global $search_advanced;
142 if ($search_advanced)
143 return unserialize($input_string);
144 return array($input_string);
148 * @param string $key the pref key
149 * @param integer $index the pref key index
150 * @param string $default default value
151 * @return string pref value
153 function asearch_getPref(&$key, $index, $default = '')
155 global $data_dir, $username, $search_advanced;
156 return getPref($data_dir, $username, $key . ($index +
!$search_advanced), $default);
160 * @param string $key the pref key
161 * @param integer $index the pref key index
162 * @param string $value pref value to set
163 * @return bool status
165 function asearch_setPref(&$key, $index, $value)
167 global $data_dir, $username, $search_advanced;
168 return setPref($data_dir, $username, $key . ($index +
!$search_advanced), $value);
172 * @param string $key the pref key
173 * @param integer $index the pref key index
174 * @return bool status
176 function asearch_removePref(&$key, $index)
178 global $data_dir, $username, $search_advanced;
179 return removePref($data_dir, $username, $key . ($index +
!$search_advanced));
182 /** Sanity checks, done before running the imap command and before calling push_recent
184 function asearch_check_query(&$where_array, &$what_array, &$exclude_array)
186 global $imap_asearch_opcodes;
188 if (empty($where_array))
189 return _("Please enter something to search for");
190 if (count($exclude_array) == count($where_array))
191 return _("There must be at least one criteria to search for");
192 for ($crit_num = 0; $crit_num < count($where_array); $crit_num++
) {
193 $where = $where_array[$crit_num];
194 $what = $what_array[$crit_num];
195 if (!(($what == '') ^
($imap_asearch_opcodes[$where] != '')))
196 return _("Error in criteria argument");
201 /** Read the recent searches from the prefs
203 function asearch_read_recent()
205 global $recent_prefkeys, $search_memory;
207 $recent_array = array();
209 for ($pref_num = 0; $pref_num < $search_memory; $pref_num++
) {
210 foreach ($recent_prefkeys as $prefkey) {
211 $pref = asearch_getPref($prefkey, $pref_num);
212 /* if (!empty($pref))*/
213 $recent_array[$prefkey][$recent_num] = $pref;
215 if (empty($recent_array[$recent_prefkeys[0]][$recent_num])) {
216 foreach ($recent_prefkeys as $key) {
217 array_pop($recent_array[$key]);
219 // break; //Disabled to support old search code broken prefs
224 return $recent_array;
227 /** Read the saved searches from the prefs
229 function asearch_read_saved()
231 global $saved_prefkeys;
233 $saved_array = array();
234 $saved_key = $saved_prefkeys[0];
235 for ($saved_count = 0; ; $saved_count++
) {
236 $pref = asearch_getPref($saved_key, $saved_count);
240 for ($saved_num = 0; $saved_num < $saved_count; $saved_num++
) {
241 foreach ($saved_prefkeys as $key) {
242 $saved_array[$key][$saved_num] = asearch_getPref($key, $saved_num);
248 /** Save a recent search to the prefs
250 function asearch_save_recent($recent_index)
252 global $recent_prefkeys, $saved_prefkeys;
254 $saved_array = asearch_read_saved();
255 $saved_index = count($saved_array[$saved_prefkeys[0]]);
256 $recent_array = asearch_read_recent();
258 foreach ($recent_prefkeys as $key) {
259 $recent_slice = array_slice($recent_array[$key], $recent_index, 1);
260 if (!empty($recent_slice[0]))
261 asearch_setPref($saved_prefkeys[$n], $saved_index, $recent_slice[0]);
263 asearch_removePref($saved_prefkeys[$n], $saved_index);
268 /** Write a recent search to prefs
270 function asearch_write_recent(&$recent_array)
272 global $recent_prefkeys, $search_memory;
274 $recent_count = min($search_memory, count($recent_array[$recent_prefkeys[0]]));
275 for ($recent_num = 0; $recent_num < $recent_count; $recent_num++
) {
276 foreach ($recent_prefkeys as $key) {
277 asearch_setPref($key, $recent_num, $recent_array[$key][$recent_num]);
280 for (; $recent_num < $search_memory; $recent_num++
) {
281 foreach ($recent_prefkeys as $key) {
282 asearch_removePref($key, $recent_num);
287 /** Remove a recent search from prefs
289 function asearch_forget_recent($forget_index)
291 global $recent_prefkeys;
293 $recent_array = asearch_read_recent();
294 foreach ($recent_prefkeys as $key) {
295 array_splice($recent_array[$key], $forget_index, 1);
297 asearch_write_recent($recent_array);
300 /** Find a recent search in the prefs (used to avoid saving duplicates)
302 function asearch_find_recent(&$recent_array, &$mailbox_array, &$biop_array, &$unop_array, &$where_array, &$what_array, &$exclude_array, &$sub_array)
304 global $recent_prefkeys, $search_advanced;
306 $where_string = asearch_serialize($where_array);
307 $mailbox_string = asearch_serialize($mailbox_array);
308 $what_string = asearch_serialize($what_array);
309 $unop_string = asearch_serialize($unop_array);
310 if ($search_advanced) {
311 $biop_string = asearch_serialize($biop_array);
312 $exclude_string = asearch_serialize($exclude_array);
313 $sub_string = asearch_serialize($sub_array);
315 $recent_count = count($recent_array[$recent_prefkeys[ASEARCH_WHERE
]]);
316 for ($recent_num = 0; $recent_num < $recent_count; $recent_num++
) {
317 if (isset($recent_array[$recent_prefkeys[ASEARCH_WHERE
]][$recent_num])) {
319 $where_string == $recent_array[$recent_prefkeys[ASEARCH_WHERE
]][$recent_num] &&
320 $mailbox_string == $recent_array[$recent_prefkeys[ASEARCH_MAILBOX
]][$recent_num] &&
321 $what_string == $recent_array[$recent_prefkeys[ASEARCH_WHAT
]][$recent_num] &&
322 $unop_string == $recent_array[$recent_prefkeys[ASEARCH_UNOP
]][$recent_num] &&
323 ((!$search_advanced) ||
324 ($biop_string == $recent_array[$recent_prefkeys[ASEARCH_BIOP
]][$recent_num] &&
325 $exclude_string == $recent_array[$recent_prefkeys[ASEARCH_EXCLUDE
]][$recent_num] &&
326 $sub_string == $recent_array[$recent_prefkeys[ASEARCH_SUB
]][$recent_num]))
334 /** Push a recent search into the prefs
336 function asearch_push_recent(&$mailbox_array, &$biop_array, &$unop_array, &$where_array, &$what_array, &$exclude_array, &$sub_array)
338 global $recent_prefkeys, $search_memory;
340 if ($search_memory > 0) {
341 $recent_array = asearch_read_recent();
342 $recent_found = asearch_find_recent($recent_array, $mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array, $sub_array);
343 if ($recent_found >= 0) { // Remove identical recent
344 foreach ($recent_prefkeys as $key) {
345 array_splice($recent_array[$key], $recent_found, 1);
348 $input = array($where_array, $mailbox_array, $what_array, $unop_array, $biop_array, $exclude_array, $sub_array);
350 foreach ($recent_prefkeys as $key) {
351 array_unshift($recent_array[$key], asearch_serialize($input[$i]));
354 asearch_write_recent($recent_array);
358 /** Edit a recent search
359 * @global array mailbox_array searched mailboxes
361 function asearch_edit_recent($index)
363 global $recent_prefkeys, $search_advanced;
364 global $where_array, $mailbox_array, $what_array, $unop_array;
365 global $biop_array, $exclude_array, $sub_array;
367 $where_array = asearch_unserialize(asearch_getPref($recent_prefkeys[ASEARCH_WHERE
], $index));
368 $mailbox_array = asearch_unserialize(asearch_getPref($recent_prefkeys[ASEARCH_MAILBOX
], $index));
369 $what_array = asearch_unserialize(asearch_getPref($recent_prefkeys[ASEARCH_WHAT
], $index));
370 $unop_array = asearch_unserialize(asearch_getPref($recent_prefkeys[ASEARCH_UNOP
], $index));
371 if ($search_advanced) {
372 $biop_array = asearch_unserialize(asearch_getPref($recent_prefkeys[ASEARCH_BIOP
], $index));
373 $exclude_array = asearch_unserialize(asearch_getPref($recent_prefkeys[ASEARCH_EXCLUDE
], $index));
374 $sub_array = asearch_unserialize(asearch_getPref($recent_prefkeys[ASEARCH_SUB
], $index));
378 /** Edit the last recent search if the prefs permit it
380 function asearch_edit_last()
382 global $search_memory;
383 if ($search_memory > 0)
384 asearch_edit_recent(0);
387 /** Edit a saved search
389 function asearch_edit_saved($index)
391 global $saved_prefkeys, $search_advanced;
392 global $where_array, $mailbox_array, $what_array, $unop_array;
393 global $biop_array, $exclude_array, $sub_array;
395 $where_array = asearch_unserialize(asearch_getPref($saved_prefkeys[ASEARCH_WHERE
], $index));
396 $mailbox_array = asearch_unserialize(asearch_getPref($saved_prefkeys[ASEARCH_MAILBOX
], $index));
397 $what_array = asearch_unserialize(asearch_getPref($saved_prefkeys[ASEARCH_WHAT
], $index));
398 $unop_array = asearch_unserialize(asearch_getPref($saved_prefkeys[ASEARCH_UNOP
], $index));
399 if ($search_advanced) {
400 $biop_array = asearch_unserialize(asearch_getPref($saved_prefkeys[ASEARCH_BIOP
], $index));
401 $exclude_array = asearch_unserialize(asearch_getPref($saved_prefkeys[ASEARCH_EXCLUDE
], $index));
402 $sub_array = asearch_unserialize(asearch_getPref($saved_prefkeys[ASEARCH_SUB
], $index));
406 /** Write a saved search to the prefs
408 function asearch_write_saved(&$saved_array)
410 global $saved_prefkeys;
412 $saved_count = count($saved_array[$saved_prefkeys[0]]);
413 for ($saved_num=0; $saved_num < $saved_count; $saved_num++
) {
414 foreach ($saved_prefkeys as $key) {
415 asearch_setPref($key, $saved_num, $saved_array[$key][$saved_num]);
418 foreach ($saved_prefkeys as $key) {
419 asearch_removePref($key, $saved_count);
423 /** Delete a saved search from the prefs
425 function asearch_delete_saved($saved_index)
427 global $saved_prefkeys;
429 $saved_array = asearch_read_saved();
430 $asearch_keys = $saved_prefkeys;
431 foreach ($asearch_keys as $key) {
432 array_splice($saved_array[$key], $saved_index, 1);
434 asearch_write_saved($saved_array);
437 /** Translate the input date to imap date to local date display,
438 * so the user can know if the date is wrong or illegal
439 * @return string locally formatted date or error text
441 function asearch_get_date_display(&$what)
443 $what_parts = sqimap_asearch_parse_date($what);
444 if (count($what_parts) == 4) {
445 if (checkdate($what_parts[2], $what_parts[1], $what_parts[3]))
446 return date_intl(_("M j, Y"), mktime(0,0,0,$what_parts[2],$what_parts[1],$what_parts[3]));
447 //return $what_parts[1] . ' ' . getMonthName($what_parts[2]) . ' ' . $what_parts[3];
448 return _("(Illegal date)");
450 return _("(Wrong date)");
453 /** Translate the query to rough natural display
454 * @return string rough natural query ready to display
456 function asearch_get_query_display(&$color, &$mailbox_array, &$biop_array, &$unop_array, &$where_array, &$what_array, &$exclude_array, &$sub_array)
458 global $imap_asearch_biops_in, $imap_asearch_biops, $imap_asearch_unops, $imap_asearch_options;
459 global $imap_asearch_opcodes;
461 $last_mailbox = $mailbox_array[0];
462 if (empty($last_mailbox))
463 $last_mailbox = 'INBOX';
465 for ($crit_num=0; $crit_num < count($where_array); $crit_num++
) {
466 if ((!isset($exclude_array[$crit_num])) ||
(!$exclude_array[$crit_num])) {
467 $cur_mailbox = $mailbox_array[$crit_num];
468 if (empty($cur_mailbox))
469 $cur_mailbox = 'INBOX';
470 $biop = asearch_nz($biop_array[$crit_num]);
471 if (($query_display == '') ||
($cur_mailbox != $last_mailbox)) {
472 $mailbox_display = ' <B>' . asearch_get_mailbox_display($cur_mailbox) . '</B>';
473 if ($query_display == '')
474 $biop_display = _("In");
476 $biop_display = $imap_asearch_biops_in[$biop];
477 $last_mailbox = $cur_mailbox;
480 $mailbox_display = '';
481 $biop_display = $imap_asearch_biops[$biop];
483 $biop_display = ' <U><I>' . $biop_display . '</I></U>';
484 $unop = $unop_array[$crit_num];
485 $unop_display = $imap_asearch_unops[$unop];
486 $where = $where_array[$crit_num];
487 $where_display = asearch_nz($imap_asearch_options[$where], $where);
488 if ($unop_display != '')
489 $where_display = ' <U><I>' . $unop_display . ' ' . $where_display . '</I></U>';
491 $where_display = ' <U><I>' . $where_display . '</I></U>';
492 $what_type = $imap_asearch_opcodes[$where];
493 $what = $what_array[$crit_num];
494 if ($what_type) { /* Check opcode parameter */
496 $what_display = ' ' . asearch_get_error_display($color, _("(Missing argument)"));
498 if ($what_type == 'adate')
499 $what_display = asearch_get_date_display($what);
501 $what_display = htmlspecialchars($what);
502 $what_display = ' <B>' . $what_display . '</B>';
507 $what_display = ' ' . asearch_get_error_display($color, _("(Spurious argument)"));
511 $query_display .= ' ' . $biop_display . $mailbox_display . $where_display . $what_display;
514 return $query_display;
517 /** Handle the alternate row colors
518 * @return string color value
520 function asearch_get_row_color(&$color, $row_num)
522 /*$color_string = ($row_num%2 ? $color[0] : $color[4]);*/
523 $color_string = $color[4];
524 if ($GLOBALS['alt_index_colors']) {
525 if (($row_num %
2) == 0) {
526 if (!isset($color[12]))
527 $color[12] = '#EAEAEA';
528 $color_string = $color[12];
531 return $color_string;
534 /** Print a whole query array, recent or saved
536 function asearch_print_query_array(&$boxes, &$query_array, &$query_keys, &$action_array, $title, $show_pref)
539 global $data_dir, $username;
541 $show_flag = getPref($data_dir, $username, $show_pref, 0) & 1;
542 $toggle_link = asearch_get_toggle_link(!$show_flag, $show_pref, array(_("-"), _("+")), array(_("Hide"), _("Show")));
545 echo html_tag('table', '', 'center', $color[9], 'width="95%" cellpadding="1" cellspacing="1" border="0"');
547 html_tag('td', $toggle_link, 'center', $color[5], 'width="5%"')
548 . html_tag('td', asearch_get_title_display($color, $title), 'center', $color[5], 'colspan=4'));
550 $main_key = $query_keys[ASEARCH_WHERE
];
551 $query_count = count($query_array[$main_key]);
552 for ($query_num = 0, $row_num = 0; $query_num < $query_count; $query_num++
) {
553 if (!empty($query_array[$main_key][$query_num])) {
554 echo html_tag('tr', '', '', asearch_get_row_color($color, $row_num));
556 unset($search_array);
557 foreach ($query_keys as $query_key) {
558 $search_array[] = asearch_unserialize($query_array[$query_key][$query_num]);
560 $where_array = $search_array[ASEARCH_WHERE
];
561 $mailbox_array = $search_array[ASEARCH_MAILBOX
];
562 $what_array = $search_array[ASEARCH_WHAT
];
563 $unop_array = $search_array[ASEARCH_UNOP
];
564 $biop_array = asearch_nz($search_array[ASEARCH_BIOP
], array());
565 $exclude_array = asearch_nz($search_array[ASEARCH_EXCLUDE
], array());
566 $sub_array = asearch_nz($search_array[ASEARCH_SUB
], array());
567 $query_display = asearch_get_query_display($color, $mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array, $sub_array);
569 echo html_tag('td', $query_num +
1, 'right');
570 echo html_tag('td', $query_display, 'center', '', 'width="80%"');
571 foreach ($action_array as $action => $action_display) {
572 echo html_tag('td', '<a href="' . asearch_get_href('submit=' . $action . '&rownum=' . $query_num) . '">' . $action_display . '</a>', 'center');
580 echo '</table>' . "\n";
583 /** Print the saved array
585 function asearch_print_saved(&$boxes)
587 global $saved_prefkeys;
589 $saved_array = asearch_read_saved();
590 if (isset($saved_array[$saved_prefkeys[0]])) {
591 $saved_count = count($saved_array[$saved_prefkeys[0]]);
592 if ($saved_count > 0) {
593 $saved_actions = array('edit_saved' => _("edit"), 'search_saved' => _("search"), 'delete_saved' => _("delete"));
594 asearch_print_query_array($boxes, $saved_array, $saved_prefkeys, $saved_actions, _("Saved Searches"), 'search_show_saved');
600 * Print the recent array
602 function asearch_print_recent(&$boxes)
604 global $recent_prefkeys, $search_memory;
606 $recent_array = asearch_read_recent();
607 if (isset($recent_array[$recent_prefkeys[0]])) {
608 $recent_count = count($recent_array[$recent_prefkeys[0]]);
609 if (min($recent_count, $search_memory) > 0) {
610 $recent_actions = array('save_recent' => _("save"), 'search_recent' => _("search"), 'forget_recent' => _("forget"));
611 asearch_print_query_array($boxes, $recent_array, $recent_prefkeys, $recent_actions, _("Recent Searches"), 'search_show_recent');
616 /** Build an <option> statement
618 function asearch_opt($val, $sel, $tit)
620 return '<option value="' . $val . '"' . ($sel == $val ?
' selected' : '') . '>' . $tit . '</option>' . "\n";
623 /** Build a <select> statement from an array
625 function asearch_opt_array($var_name, $opt_array, $cur_val)
627 $output = '<select name="' . $var_name . '">' . "\n";
628 foreach($opt_array as $val => $display)
629 $output .= asearch_opt($val, $cur_val, asearch_nz($display, $val));
630 $output .= '</select>' . "\n";
634 /** Verify that a mailbox exists
635 * @return bool mailbox exists
637 function asearch_mailbox_exists($mailbox, &$boxes)
639 foreach ($boxes as $box) {
640 if ($box['unformatted'] == $mailbox)
646 function asearch_get_form_mailbox($imapConnection, &$boxes, $mailbox, $row_num = 0)
648 if (($mailbox != 'All Folders') && (!asearch_mailbox_exists($mailbox, $boxes)))
649 $missing = asearch_opt($mailbox, $mailbox, '[' . _("Missing") . '] ' . asearch_get_mailbox_display($mailbox));
652 return '<select name="mailbox[' . $row_num . ']">'
654 . asearch_opt('All Folders', $mailbox, '[' . asearch_get_mailbox_display('All Folders') . ']')
655 . sqimap_mailbox_option_list($imapConnection, array(strtolower($mailbox)), 0, $boxes, NULL)
659 function asearch_get_form_sub($sub, $row_num = 0)
661 return function_exists('addCheckBox') ?
addCheckBox('sub[' . $row_num .']', $sub)
662 : '<input type=checkbox name="sub[' . $row_num .']"' . ($sub ?
' CHECKED' : '') . '>';
665 function asearch_get_form_location($unop, $where, $row_num = 0)
667 global $imap_asearch_unops, $imap_asearch_options;
669 return asearch_opt_array('unop[' . $row_num . ']', $imap_asearch_unops, $unop)
670 . asearch_opt_array('where[' . $row_num . ']', $imap_asearch_options, $where);
673 function asearch_get_form_what($what, $row_num = 0)
675 return function_exists('addInput') ?
addInput('what[' . $row_num . ']', $what, '35')
676 : '<input type="text" size="35" name="what[' . $row_num . ']" value="' . htmlspecialchars($what) . '">';
679 function asearch_get_form_exclude($exclude, $row_num = 0)
681 return function_exists('addCheckBox') ?
addCheckBox('exclude['.$row_num.']', $exclude)
682 : '<input type=checkbox name="exclude[' . $row_num .']"' . ($exclude ?
' CHECKED' : '') . '>';
685 /** Print one advanced form row
687 function asearch_print_form_row($imapConnection, &$boxes, $mailbox, $biop, $unop, $where, $what, $exclude, $sub, $row_num)
689 global $imap_asearch_biops_in;
692 echo html_tag('tr', '', '', $color[4]);
695 echo html_tag('td', $row_num ?
696 asearch_opt_array('biop[' . $row_num . ']', $imap_asearch_biops_in, $biop)
697 : '<b>' . _("In") . '</b>', 'center') . "\n";
699 //Mailbox list and Include Subfolders
701 asearch_get_form_mailbox($imapConnection, $boxes, $mailbox, $row_num)
702 . _("and subfolders:") . asearch_get_form_sub($sub, $row_num), 'center') . "\n";
704 //Unary operator and Search location
705 echo html_tag('td', asearch_get_form_location($unop, $where, $row_num), 'center') . "\n";
708 echo html_tag('td', asearch_get_form_what($what, $row_num), 'center') . "\n";
711 echo html_tag('td', _("Exclude Criteria:") . asearch_get_form_exclude($exclude, $row_num), 'center') . "\n";
716 /** Print the advanced search form
718 function asearch_print_form($imapConnection, &$boxes, $mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array, $sub_array)
720 global $search_button_html, $add_criteria_button_html, $del_excluded_button_html, $del_all_button_html;
725 echo '<form action="' . asearch_get_href() . '" name="form_asearch">' . "\n";
727 echo html_tag('table', '', 'center', $color[9], 'width="100%" cellpadding="1" cellspacing="1" border="0"');
728 echo html_tag('tr', html_tag('td', asearch_get_title_display($color, _("Search Criteria")), 'center', $color[5], 'colspan=5'));
729 $row_count = count($where_array);
730 for ($row_num = 0; $row_num < $row_count; $row_num++
) {
731 $mailbox = asearch_nz($mailbox_array[$row_num]);
732 $biop = strip_tags(asearch_nz($biop_array[$row_num]));
733 $unop = strip_tags(asearch_nz($unop_array[$row_num]));
734 $where = strip_tags(asearch_nz($where_array[$row_num]));
735 $what = asearch_nz($what_array[$row_num]);
736 $exclude = strip_tags(asearch_nz($exclude_array[$row_num]));
737 $sub = strip_tags(asearch_nz($sub_array[$row_num]));
738 asearch_print_form_row($imapConnection, $boxes, $mailbox, $biop, $unop, $where, $what, $exclude, $sub, $row_num);
740 echo '</table>' . "\n";
743 echo html_tag('table', '', 'center', $color[9], 'width="100%" cellpadding="1" cellspacing="0" border="0"');
745 html_tag('td', getButton('SUBMIT', 'submit', $search_button_html), 'center') . "\n"
746 . html_tag('td', getButton('SUBMIT', 'submit', $add_criteria_button_html), 'center') . "\n"
747 . html_tag('td', getButton('SUBMIT', 'submit', $del_all_button_html), 'center') . "\n"
748 . html_tag('td', getButton('SUBMIT', 'submit', $del_excluded_button_html), 'center') . "\n"
750 echo '</table>' . "\n";
751 echo '</form>' . "\n";
754 /** Print one basic form row
756 function asearch_print_form_row_basic($imapConnection, &$boxes, $mailbox, $biop, $unop, $where, $what, $exclude, $sub, $row_num)
758 global $search_button_html;
761 echo html_tag('tr', '', '', $color[4]);
764 echo html_tag('td', '<b>' . _("In") . '</b> ' . asearch_get_form_mailbox($imapConnection, $boxes, $mailbox), 'center') . "\n";
766 //Unary operator and Search location
767 echo html_tag('td', asearch_get_form_location($unop, $where), 'center') . "\n";
770 echo html_tag('td', asearch_get_form_what($what), 'center') . "\n";
773 echo html_tag('td', getButton('SUBMIT', 'submit', $search_button_html), 'center') . "\n";
778 /** Print the basic search form
780 function asearch_print_form_basic($imapConnection, &$boxes, $mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array, $sub_array)
786 echo '<form action="' . asearch_get_href() . '" name="form_asearch">' . "\n";
788 echo html_tag('table', '', 'center', $color[9], 'width="100%" cellpadding="1" cellspacing="1" border="0"');
789 //echo html_tag('tr', html_tag('td', asearch_get_title_display($color, _("Search Criteria")), 'center', $color[5], 'colspan=4'));
790 $row_count = count($where_array);
791 for ($row_num = 0; $row_num < $row_count; $row_num++
) {
792 $mailbox = asearch_nz($mailbox_array[$row_num]);
793 $biop = strip_tags(asearch_nz($biop_array[$row_num]));
794 $unop = strip_tags(asearch_nz($unop_array[$row_num]));
795 $where = strip_tags(asearch_nz($where_array[$row_num]));
796 $what = asearch_nz($what_array[$row_num]);
797 $exclude = strip_tags(asearch_nz($exclude_array[$row_num]));
798 $sub = strip_tags(asearch_nz($sub_array[$row_num]));
799 asearch_print_form_row_basic($imapConnection, $boxes, $mailbox, $biop, $unop, $where, $what, $exclude, $sub, $row_num);
801 echo '</table>' . "\n";
802 echo '</form>' . "\n";
805 /** Print the $msgs messages from $mailbox mailbox
807 function asearch_print_mailbox_msgs($imapConnection, $mbxresponse, $mailbox, $msgs, $cnt, $sort, $color, $where, $what)
810 global $allow_server_sort, $allow_thread_sort, $thread_sort_messages;
812 $thread_sort_messages = 0;
813 if ($allow_thread_sort) {
814 global $data_dir, $username;
815 $thread_sort_messages = getPref($data_dir, $username, 'thread_' . $mailbox);
819 elseif ($allow_server_sort) {
824 $msort = calc_msort($msgs, $sort);
828 $mailbox_display = asearch_get_mailbox_display($mailbox);
829 $mailbox_title = '<b><big>' . _("Folder:") . ' '. $mailbox_display . ' </big></b>';
830 $devel = check_sm_version(1, 5, 0);
832 echo html_tag('div', $mailbox_title, 'center') . "\n";
833 $mailbox_title = get_selectall_link(1, $real_sort);
835 $msg_cnt_str = get_msgcnt_str(1, $cnt, $cnt);
837 echo '<table border="0" width="100%" cellpadding="0" cellspacing="0">';
841 mail_message_listing_beginning($imapConnection, $mbxresponse, $mailbox, $real_sort, $msg_cnt_str, $mailbox_title, 1, 1);
843 mail_message_listing_beginning($imapConnection, $mailbox, $real_sort, $msg_cnt_str, $mailbox_title, 1, 1);
846 echo '<tr><td HEIGHT="5" BGCOLOR="'.$color[4].'"></td></tr>';
849 echo ' <table width="100%" cellpadding="1" cellspacing="0" align="center"'.' border="0" bgcolor="'.$color[9].'">';
852 echo ' <table width="100%" cellpadding="1" cellspacing="0" align="center" border="0" bgcolor="'.$color[5].'">';
854 printHeader($mailbox, $sort, $color, !$thread_sort_messages);
855 displayMessageArray($imapConnection, $cnt, 1, $msort, $mailbox, $real_sort, $color, $cnt, $where, $what);
860 mail_message_listing_end($cnt, '', $msg_cnt_str, $color);
868 * @param array $boxes mailboxes array (reference)
869 * @return array selectable unformatted mailboxes names
871 function sqimap_asearch_get_selectable_unformatted_mailboxes(&$boxes)
873 $mboxes_array = array();
874 $boxcount = count($boxes);
875 for ($boxnum = 0; $boxnum < $boxcount; $boxnum++
) {
876 if (!in_array('noselect', $boxes[$boxnum]['flags']))
877 $mboxes_array[] = $boxes[$boxnum]['unformatted'];
879 return $mboxes_array;
882 /* ------------------------ main ------------------------ */
883 /* get globals we will need */
884 sqgetGlobalVar('username', $username, SQ_SESSION
);
885 sqgetGlobalVar('key', $key, SQ_COOKIE
);
886 sqgetGlobalVar('delimiter', $delimiter, SQ_SESSION
);
887 sqgetGlobalVar('onetimepad', $onetimepad, SQ_SESSION
);
889 $search_button_html = _("Search");
890 $search_button_text = asearch_unhtmlentities($search_button_html);
891 $add_criteria_button_html = _("Add New Criteria");
892 $add_criteria_button_text = asearch_unhtmlentities($add_criteria_button_html);
893 $del_excluded_button_html = _("Remove Excluded Criteria");
894 $del_excluded_button_text = asearch_unhtmlentities($del_excluded_button_html);
895 $del_all_button_html = _("Remove All Criteria");
896 $del_all_button_text = asearch_unhtmlentities($del_all_button_html);
898 /** Maximum number of recent searches to handle
900 * @global integer $search_memory
902 $search_memory = getPref($data_dir, $username, 'search_memory', 0);
904 /** Advanced search control
905 * - 0 => allow basic interface only
906 * - 1 => allow advanced interface only
909 * @global integer $allow_advanced_search
911 $allow_advanced_search = getPref($data_dir, $username, 'allow_advanced_search', 2);
914 * Toggle advanced/basic search
916 if (sqgetGlobalVar('advanced', $search_advanced, SQ_GET
))
917 setPref($data_dir, $username, 'search_advanced', $search_advanced & 1);
919 /** If 1, show advanced search interface
920 * Default from allow_advanced_search pref
921 * @global integer $search_advanced
923 if ($allow_advanced_search > 1)
924 $search_advanced = getPref($data_dir, $username, 'search_advanced', 0);
926 $search_advanced = $allow_advanced_search;
928 if ($search_advanced) {
929 /** Set recent prefkeys according to $search_advanced
930 * @global array $recent_prefkeys
932 $recent_prefkeys = array('asearch_recent_where', 'asearch_recent_mailbox', 'asearch_recent_what', 'asearch_recent_unop', 'asearch_recent_biop', 'asearch_recent_exclude', 'asearch_recent_sub');
934 /** Set saved prefkeys according to $search_advanced
935 * @global array $saved_prefkeys
937 $saved_prefkeys = array('asearch_saved_where', 'asearch_saved_mailbox', 'asearch_saved_what', 'asearch_saved_unop', 'asearch_saved_biop', 'asearch_saved_exclude', 'asearch_saved_sub');
939 /*$asearch_prefkeys = array('where', 'mailbox', 'what', 'biop', 'unop', 'exclude', 'sub');*/
942 $recent_prefkeys = array('search_where', 'search_folder', 'search_what', 'search_unop');
943 $saved_prefkeys = array('saved_where', 'saved_folder', 'saved_what', 'saved_unop');
946 /** How we did enter the form
947 * - unset : Enter key, or called from outside (eg read_body)
948 * - $search_button_text : Search button
949 * - 'Search_no_update' : Search but don't update recent
950 * - 'Search_last' : Same as no_update but reload and search last
951 * - 'Search_silent' : Same as no_update but only display results
952 * - $add_criteria_button_text : Add New Criteria button
953 * - $del_excluded_button_text : Remove Excluded Criteria button
954 * - $del_all_button_text : Remove All Criteria button
961 * @global string $submit
963 if (isset($_GET['submit']))
964 $submit = strip_tags($_GET['submit']);
966 /** Searched mailboxes
967 * @global array $mailbox_array
969 if (isset($_GET['mailbox'])) {
970 $mailbox_array = $_GET['mailbox'];
971 if (!is_array($mailbox_array))
972 $mailbox_array = array($mailbox_array);
975 $mailbox_array = array();
978 * @global array $biop_array
980 if (isset($_GET['biop'])) {
981 $biop_array = $_GET['biop'];
982 if (!is_array($biop_array))
983 $biop_array = array($biop_array);
986 $biop_array = array();
989 * @global array $unop_array
991 if (isset($_GET['unop'])) {
992 $unop_array = $_GET['unop'];
993 if (!is_array($unop_array))
994 $unop_array = array($unop_array);
997 $unop_array = array();
1000 * @global array $where_array
1002 if (isset($_GET['where'])) {
1003 $where_array = $_GET['where'];
1004 if (!is_array($where_array))
1005 $where_array = array($where_array);
1008 $where_array = array();
1011 * @global array $what_array
1013 if (isset($_GET['what'])) {
1014 $what_array = $_GET['what'];
1015 if (!is_array($what_array))
1016 $what_array = array($what_array);
1019 $what_array = array();
1021 /** Whether to exclude this criteria from search
1022 * @global array $exclude_array
1024 if (isset($_GET['exclude']))
1025 $exclude_array = $_GET['exclude'];
1027 $exclude_array = array();
1029 /** Search within subfolders
1030 * @global array $sub_array
1032 if (isset($_GET['sub']))
1033 $sub_array = $_GET['sub'];
1035 $sub_array = array();
1037 /** Row number used by recent and saved stuff
1039 if (isset($_GET['rownum']))
1040 $submit_rownum = strip_tags($_GET['rownum']);
1042 /** Change global sort
1044 if (sqgetGlobalVar('newsort', $newsort, SQ_GET
)) {
1045 setPref($data_dir, $username, 'sort', $newsort);
1047 sqsession_register($sort, 'sort');
1048 asearch_edit_last();
1051 /** Toggle mailbox threading
1053 if (sqgetGlobalVar('set_thread', $set_thread, SQ_GET
)) {
1054 setPref($data_dir, $username, 'thread_' . $mailbox_array[0], $set_thread & 1);
1055 asearch_edit_last();
1058 /** Toggle show/hide saved searches
1060 if (sqgetGlobalVar('search_show_saved', $search_show_saved, SQ_GET
))
1061 setPref($data_dir, $username, 'search_show_saved', $search_show_saved & 1);
1063 /** Toggle show/hide recent searches
1065 if (sqgetGlobalVar('search_show_recent', $search_show_recent, SQ_GET
))
1066 setPref($data_dir, $username, 'search_show_recent', $search_show_recent & 1);
1068 // end of get globals
1070 /** If TRUE, do not show search interface
1072 * @global bool $search_silent
1074 $search_silent = FALSE;
1076 /* See how the page was called and fire off correct function */
1077 if ((empty($submit)) && (!empty($where_array))) {
1078 /* This happens when the Enter key is used or called from outside */
1079 $submit = $search_button_text;
1080 if (count($where_array) != count($unop_array)) /* Hack needed to handle coming back from read_body et als */
1081 asearch_edit_last();
1084 if (!isset($submit)) {
1089 case $search_button_text:
1090 if (asearch_check_query($where_array, $what_array, $exclude_array) == '')
1091 asearch_push_recent($mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array, $sub_array);
1093 case 'Search_silent':
1094 $search_silent = TRUE;
1096 case 'Search_no_update':
1097 $submit = $search_button_text;
1099 case $del_excluded_button_text:
1100 $delarray = array_keys($exclude_array);
1101 while (!empty($delarray)) {
1102 $delrow = array_pop($delarray);
1103 array_splice($mailbox_array, $delrow, 1);
1104 array_splice($biop_array, $delrow, 1);
1105 array_splice($unop_array, $delrow, 1);
1106 array_splice($where_array, $delrow, 1);
1107 array_splice($what_array, $delrow, 1);
1108 /* array_splice($exclude_array, $delrow, 1);*/ /* There is still some php magic that eludes me */
1109 array_splice($sub_array, $delrow, 1);
1111 $exclude_array = array();
1113 case $del_all_button_text:
1114 $mailbox_array = array();
1115 $biop_array = array();
1116 $unop_array = array();
1117 $where_array = array();
1118 $what_array = array();
1119 $exclude_array = array();
1120 $sub_array = array();
1123 asearch_save_recent($submit_rownum);
1125 case 'search_recent':
1126 $submit = $search_button_text;
1127 asearch_edit_recent($submit_rownum);
1128 asearch_push_recent($mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array, $sub_array);
1130 case 'edit_recent': /* no link to do this, yet */
1131 asearch_edit_recent($submit_rownum);
1133 case 'forget_recent':
1134 asearch_forget_recent($submit_rownum);
1136 case 'search_saved':
1137 $submit = $search_button_text;
1138 asearch_edit_saved($submit_rownum);
1139 asearch_push_recent($mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array, $sub_array);
1142 asearch_edit_saved($submit_rownum);
1144 case 'delete_saved':
1145 asearch_delete_saved($submit_rownum);
1150 //Texts in both basic and advanced form
1151 $imap_asearch_unops = array(
1156 if ($search_advanced) {
1157 //Texts in advanced form only
1158 $imap_asearch_options = array(
1160 //'ALL' is binary operator
1161 'ANSWERED' => _("Answered"),
1163 'BEFORE' => _("Before"),
1164 'BODY' => _("Message Body"),
1166 'DELETED' => _("Deleted"),
1167 'DRAFT' => _("Draft"),
1168 'FLAGGED' => _("Flagged"),
1169 'FROM' => _("Sent By"),
1170 'HEADER' => _("Header Field"),
1171 'KEYWORD' => _("Keyword"),
1172 'LARGER' => _("Larger Than"),
1174 //'NOT' is unary operator
1177 //'OR' is binary operator
1178 'RECENT' => _("Recent"),
1179 'SEEN' => _("Seen"),
1180 'SENTBEFORE' => _("Sent Before"),
1181 'SENTON' => _("Sent On"),
1182 'SENTSINCE' => _("Sent Since"),
1183 'SINCE' => _("Since"),
1184 'SMALLER' => _("Smaller Than"),
1185 'SUBJECT' => _("Subject Contains"),
1186 'TEXT' => _("Header and Body"),
1187 'TO' => _("Sent To"),
1189 /* 'UNANSWERED' => '',
1193 'UNKEYWORD' => _("Unkeyword"),
1194 'UNSEEN' => _("Unseen"),*/
1197 $imap_asearch_biops_in = array(
1198 'ALL' => _("And In"),
1202 $imap_asearch_biops = array(
1208 //Texts in basic form only
1209 $imap_asearch_options = array(
1211 'BODY' => _("Body"),
1213 'FROM' => _("From"),
1214 'SUBJECT' => _("Subject"),
1215 'TEXT' => _("Everywhere"),
1220 uasort($imap_asearch_options, 'asearch_unhtml_strcoll');
1222 /* open IMAP connection */
1223 $imapConnection = sqimap_login($username, $key, $imapServerAddress, $imapPort, 0);
1224 /* get mailbox names once here */
1225 $boxes = sqimap_mailbox_list($imapConnection);
1226 /* ensure we have a valid default mailbox name */
1227 $mailbox = asearch_nz($mailbox_array[0]);
1228 if (($mailbox == '') ||
($mailbox == 'None')) //Workaround for sm quirk IMHO (what if I really have a mailbox called None?)
1229 $mailbox = $boxes[0]['unformatted']; //Usually INBOX ;)
1231 if (isset($composenew) && $composenew) {
1232 $comp_uri = "../src/compose.php?mailbox=" . urlencode($mailbox)
1233 . "&session=$composesession&attachedmessages=true&";
1234 displayPageHeader($color, $mailbox, "comp_in_new('$comp_uri');", false);
1237 displayPageHeader($color, $mailbox);
1239 do_hook('search_before_form');
1241 if (!$search_silent) {
1242 //Add a link to the other search mode if allowed
1243 if ($allow_advanced_search > 1)
1244 $toggle_link = ' - ' . asearch_get_toggle_link(!$search_advanced, 'advanced', array(_("Standard search"), _("Advanced search")));
1248 echo html_tag('table',
1250 . html_tag('td', asearch_get_title_display($color, _("Search")) . $toggle_link, 'center', $color[0])
1252 '', '', 'width="100%"') . "\n";
1253 asearch_print_saved($boxes);
1254 asearch_print_recent($boxes);
1255 if (empty($where_array)) {
1256 global $sent_folder;
1258 $mailbox_array[0] = $mailbox;
1259 $biop_array[0] = '';
1260 $unop_array[0] = '';
1261 if ($mailbox == $sent_folder)
1262 $where_array[0] = 'TO';
1264 $where_array[0] = 'FROM';
1265 $what_array[0] = '';
1266 $exclude_array[0] = '';
1269 //Display advanced or basic form
1270 if ($search_advanced) {
1271 if ($submit == $add_criteria_button_text) {
1272 $last_index = max(count($where_array) - 1, 0);
1273 $mailbox_array[] = asearch_nz($mailbox_array[$last_index]);
1274 $biop_array[] = asearch_nz($biop_array[$last_index]);
1275 $unop_array[] = asearch_nz($unop_array[$last_index]);
1276 $where_array[] = asearch_nz($where_array[$last_index]);
1277 $what_array[] = asearch_nz($what_array[$last_index]);
1278 $exclude_array[] = asearch_nz($exclude_array[$last_index]);
1279 $sub_array[] = asearch_nz($sub_array[$last_index]);
1281 asearch_print_form($imapConnection, $boxes, $mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array, $sub_array);
1284 asearch_print_form_basic($imapConnection, $boxes, $mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array, $sub_array);
1287 /*********************************************************************
1288 * Check to see if we can use cache or not. Currently the only time *
1289 * when you will not use it is when a link on the left hand frame is *
1290 * used. Also check to make sure we actually have the array in the *
1291 * registered session data. :) *
1292 *********************************************************************/
1293 if (!isset($use_mailbox_cache))
1294 $use_mailbox_cache = 0;
1296 do_hook('search_after_form');
1298 if ($submit == $search_button_text) {
1299 echo html_tag('table', '', 'center', $color[9], 'width="100%" cellpadding="1" cellspacing="0" border="0"');
1300 echo html_tag('tr', html_tag('td', asearch_get_title_display($color, _("Search Results")), 'center', $color[5]));
1301 echo html_tag('tr', html_tag('td', asearch_get_query_display($color, $mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array, $sub_array), 'center', $color[4]));
1302 echo '</table>' . "\n";
1306 $query_error = asearch_check_query($where_array, $what_array, $exclude_array);
1307 if ($query_error != '')
1308 echo '<br>' . html_tag('div', asearch_get_error_display($color, $query_error), 'center') . "\n";
1310 // Disable thread sort for now if there is more than one mailbox or at least one 'All Folders'
1311 global $allow_thread_sort;
1312 $old_allow_thread_sort = $allow_thread_sort;
1313 $allow_thread_sort = ((count(array_unique($mailbox_array)) <= 1) && (!in_array('All Folders', $mailbox_array)));
1315 $mboxes_array = sqimap_asearch_get_selectable_unformatted_mailboxes($boxes);
1316 $mboxes_msgs = sqimap_asearch($imapConnection, $mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array, $sub_array, $mboxes_array);
1317 if (empty($mboxes_msgs))
1318 echo '<br>' . html_tag('div', asearch_get_error_display($color, _("No Messages Found")), 'center') . "\n";
1320 foreach($mboxes_msgs as $mailbox => $msgs) {
1322 $mbxresponse = sqimap_mailbox_select($imapConnection, $mailbox);
1323 $msgs = fillMessageArray($imapConnection, $msgs, count($msgs));
1324 /* For now just keep the first criteria to make the regular search happy if the user tries to come back to search */
1325 /* $where = asearch_serialize($where_array);
1326 $what = asearch_serialize($what_array);*/
1327 $where = $where_array[0];
1328 $what = $what_array[0];
1329 asearch_print_mailbox_msgs($imapConnection, $mbxresponse, $mailbox, $msgs, count($msgs), $sort, $color, urlencode($where), urlencode($what));
1333 $allow_thread_sort = $old_allow_thread_sort; // Restore thread sort
1337 do_hook('search_bottom');
1338 sqimap_logout($imapConnection);
1339 echo '</body></html>';