118098a5dfd4c911d444b3bd5814669b4f43c3c4
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)
59 return '<small>[<a href="' . $href . '">' . $text . '</a>]</small>';
62 /** Builds a toggle [link]
64 function asearch_get_toggle_link($value, $action, $text_array)
66 return ' - ' . asearch_get_link(asearch_get_href($action . '=' . (int)$value), $text_array[$value]);
72 * @return bool strcoll()-like result
74 function asearch_unhtml_strcoll($a, $b)
76 return strcoll(asearch_unhtmlentities($a), asearch_unhtmlentities($b));
80 * @param string $mailbox mailbox name utf7 encoded inc. special case INBOX
81 * @return string mailbox name ready to display (utf7 decoded or localized INBOX)
83 function imap_get_mailbox_display($mailbox)
85 if (strtoupper($mailbox) == 'INBOX')
87 return imap_utf7_decode_local($mailbox);
91 * @param string $mailbox mailbox name or special case 'All Folders'
92 * @return string mailbox name ready to display (utf7 decoded or localized 'All Folders')
94 function asearch_get_mailbox_display($mailbox)
96 if ($mailbox == 'All Folders')
97 return _("All Folders");
98 return imap_get_mailbox_display($mailbox);
102 * @param array $color color array
103 * @param string $txt text to display
104 * @return string title ready to display
106 function asearch_get_title_display(&$color, $txt)
108 return '<b><big>' . $txt . '</big></b>';
112 * @param array $color color array
113 * @param string $txt text to display
114 * @return string error text ready to display
116 function asearch_get_error_display(&$color, $txt)
118 return '<font color="' . $color[2] . '">' . '<b><big>' . $txt . '</big></b></font>';
122 * @param array $input_array array to serialize
123 * @return string a string containing a byte-stream representation of value that can be stored anywhere
125 function asearch_serialize(&$input_array)
127 global $search_advanced;
128 if ($search_advanced)
129 return serialize($input_array);
130 return $input_array[0];
134 * @param string $input_string string to unserialize
137 function asearch_unserialize($input_string)
139 global $search_advanced;
140 if ($search_advanced)
141 return unserialize($input_string);
142 return array($input_string);
146 * @param string $key the pref key
147 * @param integer $index the pref key index
148 * @param string $default default value
149 * @return string pref value
151 function asearch_getPref(&$key, $index, $default = '')
153 global $data_dir, $username, $search_advanced;
154 return getPref($data_dir, $username, $key . ($index +
!$search_advanced), $default);
158 * @param string $key the pref key
159 * @param integer $index the pref key index
160 * @param string $value pref value to set
161 * @return bool status
163 function asearch_setPref(&$key, $index, $value)
165 global $data_dir, $username, $search_advanced;
166 return setPref($data_dir, $username, $key . ($index +
!$search_advanced), $value);
170 * @param string $key the pref key
171 * @param integer $index the pref key index
172 * @return bool status
174 function asearch_removePref(&$key, $index)
176 global $data_dir, $username, $search_advanced;
177 return removePref($data_dir, $username, $key . ($index +
!$search_advanced));
180 /** Sanity checks, done before running the imap command and before calling push_recent
182 function asearch_check_query(&$where_array, &$what_array, &$exclude_array)
184 global $imap_asearch_opcodes;
186 if (empty($where_array))
187 return _("Please enter something to search for");
188 if (count($exclude_array) == count($where_array))
189 return _("There must be at least one criteria to search for");
190 for ($crit_num = 0; $crit_num < count($where_array); $crit_num++
) {
191 $where = $where_array[$crit_num];
192 $what = $what_array[$crit_num];
193 if (!(($what == '') ^
($imap_asearch_opcodes[$where] != '')))
194 return _("Error in criteria argument");
199 /** Read the recent searches from the prefs
201 function asearch_read_recent()
203 global $recent_prefkeys, $search_memory;
205 $recent_array = array();
207 for ($pref_num = 0; $pref_num < $search_memory; $pref_num++
) {
208 foreach ($recent_prefkeys as $prefkey) {
209 $pref = asearch_getPref($prefkey, $pref_num);
210 /* if (!empty($pref))*/
211 $recent_array[$prefkey][$recent_num] = $pref;
213 if (empty($recent_array[$recent_prefkeys[0]][$recent_num])) {
214 foreach ($recent_prefkeys as $key) {
215 array_pop($recent_array[$key]);
217 // break; //Disabled to support old search code broken prefs
222 return $recent_array;
225 /** Read the saved searches from the prefs
227 function asearch_read_saved()
229 global $saved_prefkeys;
231 $saved_array = array();
232 $saved_key = $saved_prefkeys[0];
233 for ($saved_count = 0; ; $saved_count++
) {
234 $pref = asearch_getPref($saved_key, $saved_count);
238 for ($saved_num = 0; $saved_num < $saved_count; $saved_num++
) {
239 foreach ($saved_prefkeys as $key) {
240 $saved_array[$key][$saved_num] = asearch_getPref($key, $saved_num);
246 /** Save a recent search to the prefs
248 function asearch_save_recent($recent_index)
250 global $recent_prefkeys, $saved_prefkeys;
252 $saved_array = asearch_read_saved();
253 $saved_index = count($saved_array[$saved_prefkeys[0]]);
254 $recent_array = asearch_read_recent();
256 foreach ($recent_prefkeys as $key) {
257 $recent_slice = array_slice($recent_array[$key], $recent_index, 1);
258 if (!empty($recent_slice[0]))
259 asearch_setPref($saved_prefkeys[$n], $saved_index, $recent_slice[0]);
261 asearch_removePref($saved_prefkeys[$n], $saved_index);
266 /** Write a recent search to prefs
268 function asearch_write_recent(&$recent_array)
270 global $recent_prefkeys, $search_memory;
272 $recent_count = min($search_memory, count($recent_array[$recent_prefkeys[0]]));
273 for ($recent_num = 0; $recent_num < $recent_count; $recent_num++
) {
274 foreach ($recent_prefkeys as $key) {
275 asearch_setPref($key, $recent_num, $recent_array[$key][$recent_num]);
278 for (; $recent_num < $search_memory; $recent_num++
) {
279 foreach ($recent_prefkeys as $key) {
280 asearch_removePref($key, $recent_num);
285 /** Remove a recent search from prefs
287 function asearch_forget_recent($forget_index)
289 global $recent_prefkeys;
291 $recent_array = asearch_read_recent();
292 foreach ($recent_prefkeys as $key) {
293 array_splice($recent_array[$key], $forget_index, 1);
295 asearch_write_recent($recent_array);
298 /** Find a recent search in the prefs (used to avoid saving duplicates)
300 function asearch_find_recent(&$recent_array, &$mailbox_array, &$biop_array, &$unop_array, &$where_array, &$what_array, &$exclude_array, &$sub_array)
302 global $recent_prefkeys, $search_advanced;
304 $where_string = asearch_serialize($where_array);
305 $mailbox_string = asearch_serialize($mailbox_array);
306 $what_string = asearch_serialize($what_array);
307 $unop_string = asearch_serialize($unop_array);
308 if ($search_advanced) {
309 $biop_string = asearch_serialize($biop_array);
310 $exclude_string = asearch_serialize($exclude_array);
311 $sub_string = asearch_serialize($sub_array);
313 $recent_count = count($recent_array[$recent_prefkeys[ASEARCH_WHERE
]]);
314 for ($recent_num = 0; $recent_num < $recent_count; $recent_num++
) {
315 if (isset($recent_array[$recent_prefkeys[ASEARCH_WHERE
]][$recent_num])) {
317 $where_string == $recent_array[$recent_prefkeys[ASEARCH_WHERE
]][$recent_num] &&
318 $mailbox_string == $recent_array[$recent_prefkeys[ASEARCH_MAILBOX
]][$recent_num] &&
319 $what_string == $recent_array[$recent_prefkeys[ASEARCH_WHAT
]][$recent_num] &&
320 $unop_string == $recent_array[$recent_prefkeys[ASEARCH_UNOP
]][$recent_num] &&
321 ((!$search_advanced) ||
322 ($biop_string == $recent_array[$recent_prefkeys[ASEARCH_BIOP
]][$recent_num] &&
323 $exclude_string == $recent_array[$recent_prefkeys[ASEARCH_EXCLUDE
]][$recent_num] &&
324 $sub_string == $recent_array[$recent_prefkeys[ASEARCH_SUB
]][$recent_num]))
332 /** Push a recent search into the prefs
334 function asearch_push_recent(&$mailbox_array, &$biop_array, &$unop_array, &$where_array, &$what_array, &$exclude_array, &$sub_array)
336 global $recent_prefkeys, $search_memory;
338 if ($search_memory > 0) {
339 $recent_array = asearch_read_recent();
340 $recent_found = asearch_find_recent($recent_array, $mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array, $sub_array);
341 if ($recent_found >= 0) { // Remove identical recent
342 foreach ($recent_prefkeys as $key) {
343 array_splice($recent_array[$key], $recent_found, 1);
346 $input = array($where_array, $mailbox_array, $what_array, $unop_array, $biop_array, $exclude_array, $sub_array);
348 foreach ($recent_prefkeys as $key) {
349 array_unshift($recent_array[$key], asearch_serialize($input[$i]));
352 asearch_write_recent($recent_array);
356 /** Edit a recent search
357 * @global array mailbox_array searched mailboxes
359 function asearch_edit_recent($index)
361 global $recent_prefkeys, $search_advanced;
362 global $where_array, $mailbox_array, $what_array, $unop_array;
363 global $biop_array, $exclude_array, $sub_array;
365 $where_array = asearch_unserialize(asearch_getPref($recent_prefkeys[ASEARCH_WHERE
], $index));
366 $mailbox_array = asearch_unserialize(asearch_getPref($recent_prefkeys[ASEARCH_MAILBOX
], $index));
367 $what_array = asearch_unserialize(asearch_getPref($recent_prefkeys[ASEARCH_WHAT
], $index));
368 $unop_array = asearch_unserialize(asearch_getPref($recent_prefkeys[ASEARCH_UNOP
], $index));
369 if ($search_advanced) {
370 $biop_array = asearch_unserialize(asearch_getPref($recent_prefkeys[ASEARCH_BIOP
], $index));
371 $exclude_array = asearch_unserialize(asearch_getPref($recent_prefkeys[ASEARCH_EXCLUDE
], $index));
372 $sub_array = asearch_unserialize(asearch_getPref($recent_prefkeys[ASEARCH_SUB
], $index));
376 /** Edit the last recent search if the prefs permit it
378 function asearch_edit_last()
380 global $search_memory;
381 if ($search_memory > 0)
382 asearch_edit_recent(0);
385 /** Edit a saved search
387 function asearch_edit_saved($index)
389 global $saved_prefkeys, $search_advanced;
390 global $where_array, $mailbox_array, $what_array, $unop_array;
391 global $biop_array, $exclude_array, $sub_array;
393 $where_array = asearch_unserialize(asearch_getPref($saved_prefkeys[ASEARCH_WHERE
], $index));
394 $mailbox_array = asearch_unserialize(asearch_getPref($saved_prefkeys[ASEARCH_MAILBOX
], $index));
395 $what_array = asearch_unserialize(asearch_getPref($saved_prefkeys[ASEARCH_WHAT
], $index));
396 $unop_array = asearch_unserialize(asearch_getPref($saved_prefkeys[ASEARCH_UNOP
], $index));
397 if ($search_advanced) {
398 $biop_array = asearch_unserialize(asearch_getPref($saved_prefkeys[ASEARCH_BIOP
], $index));
399 $exclude_array = asearch_unserialize(asearch_getPref($saved_prefkeys[ASEARCH_EXCLUDE
], $index));
400 $sub_array = asearch_unserialize(asearch_getPref($saved_prefkeys[ASEARCH_SUB
], $index));
404 /** Write a saved search to the prefs
406 function asearch_write_saved(&$saved_array)
408 global $saved_prefkeys;
410 $saved_count = count($saved_array[$saved_prefkeys[0]]);
411 for ($saved_num=0; $saved_num < $saved_count; $saved_num++
) {
412 foreach ($saved_prefkeys as $key) {
413 asearch_setPref($key, $saved_num, $saved_array[$key][$saved_num]);
416 foreach ($saved_prefkeys as $key) {
417 asearch_removePref($key, $saved_count);
421 /** Delete a saved search from the prefs
423 function asearch_delete_saved($saved_index)
425 global $saved_prefkeys;
427 $saved_array = asearch_read_saved();
428 $asearch_keys = $saved_prefkeys;
429 foreach ($asearch_keys as $key) {
430 array_splice($saved_array[$key], $saved_index, 1);
432 asearch_write_saved($saved_array);
435 /** Translate the input date to imap date to local date display,
436 * so the user can know if the date is wrong or illegal
437 * @return string locally formatted date or error text
439 function asearch_get_date_display(&$what)
441 $what_parts = sqimap_asearch_parse_date($what);
442 if (count($what_parts) == 4) {
443 if (checkdate($what_parts[2], $what_parts[1], $what_parts[3]))
444 return date_intl(_("M j, Y"), mktime(0,0,0,$what_parts[2],$what_parts[1],$what_parts[3]));
445 //return $what_parts[1] . ' ' . getMonthName($what_parts[2]) . ' ' . $what_parts[3];
446 return _("(Illegal date)");
448 return _("(Wrong date)");
451 /** Translate the query to rough natural display
452 * @return string rough natural query ready to display
454 function asearch_get_query_display(&$color, &$mailbox_array, &$biop_array, &$unop_array, &$where_array, &$what_array, &$exclude_array, &$sub_array)
456 global $imap_asearch_biops_in, $imap_asearch_biops, $imap_asearch_unops, $imap_asearch_options;
457 global $imap_asearch_opcodes;
459 $last_mailbox = $mailbox_array[0];
460 if (empty($last_mailbox))
461 $last_mailbox = 'INBOX';
463 for ($crit_num=0; $crit_num < count($where_array); $crit_num++
) {
464 if ((!isset($exclude_array[$crit_num])) ||
(!$exclude_array[$crit_num])) {
465 $cur_mailbox = $mailbox_array[$crit_num];
466 if (empty($cur_mailbox))
467 $cur_mailbox = 'INBOX';
468 $biop = asearch_nz($biop_array[$crit_num]);
469 if (($query_display == '') ||
($cur_mailbox != $last_mailbox)) {
470 $mailbox_display = ' <B>' . asearch_get_mailbox_display($cur_mailbox) . '</B>';
471 if ($query_display == '')
472 $biop_display = _("In");
474 $biop_display = $imap_asearch_biops_in[$biop];
475 $last_mailbox = $cur_mailbox;
478 $mailbox_display = '';
479 $biop_display = $imap_asearch_biops[$biop];
481 $biop_display = ' <U><I>' . $biop_display . '</I></U>';
482 $unop = $unop_array[$crit_num];
483 $unop_display = $imap_asearch_unops[$unop];
484 $where = $where_array[$crit_num];
485 $where_display = asearch_nz($imap_asearch_options[$where], $where);
486 if ($unop_display != '')
487 $where_display = ' <U><I>' . $unop_display . ' ' . $where_display . '</I></U>';
489 $where_display = ' <U><I>' . $where_display . '</I></U>';
490 $what_type = $imap_asearch_opcodes[$where];
491 $what = $what_array[$crit_num];
492 if ($what_type) { /* Check opcode parameter */
494 $what_display = ' ' . asearch_get_error_display($color, _("(Missing argument)"));
496 if ($what_type == 'adate')
497 $what_display = asearch_get_date_display($what);
499 $what_display = htmlspecialchars($what);
500 $what_display = ' <B>' . $what_display . '</B>';
505 $what_display = ' ' . asearch_get_error_display($color, _("(Spurious argument)"));
509 $query_display .= ' ' . $biop_display . $mailbox_display . $where_display . $what_display;
512 return $query_display;
515 /** Handle the alternate row colors
516 * @return string color value
518 function asearch_get_row_color(&$color, $row_num)
520 /*$color_string = ($row_num%2 ? $color[0] : $color[4]);*/
521 $color_string = $color[4];
522 if ($GLOBALS['alt_index_colors']) {
523 if (($row_num %
2) == 0) {
524 if (!isset($color[12]))
525 $color[12] = '#EAEAEA';
526 $color_string = $color[12];
529 return $color_string;
532 /** Print a whole query array, recent or saved
534 function asearch_print_query_array(&$boxes, &$query_array, &$query_keys, &$action_array, $title, $show_pref)
537 global $data_dir, $username;
539 $show_flag = getPref($data_dir, $username, $show_pref, 0) & 1;
540 $toggle_link = asearch_get_toggle_link(!$show_flag, $show_pref, array(_("Hide"), _("Show")));
543 echo html_tag('table', '', 'center', $color[9], 'width="95%" cellpadding="1" cellspacing="1" border="0"');
544 echo html_tag('tr', html_tag('td', asearch_get_title_display($color, $title) . $toggle_link, 'center', $color[5], 'colspan=5'));
546 $main_key = $query_keys[ASEARCH_WHERE
];
547 $query_count = count($query_array[$main_key]);
548 for ($query_num = 0, $row_num = 0; $query_num < $query_count; $query_num++
) {
549 if (!empty($query_array[$main_key][$query_num])) {
550 echo html_tag('tr', '', '', asearch_get_row_color($color, $row_num));
552 unset($search_array);
553 foreach ($query_keys as $query_key) {
554 $search_array[] = asearch_unserialize($query_array[$query_key][$query_num]);
556 $where_array = $search_array[ASEARCH_WHERE
];
557 $mailbox_array = $search_array[ASEARCH_MAILBOX
];
558 $what_array = $search_array[ASEARCH_WHAT
];
559 $unop_array = $search_array[ASEARCH_UNOP
];
560 $biop_array = asearch_nz($search_array[ASEARCH_BIOP
], array());
561 $exclude_array = asearch_nz($search_array[ASEARCH_EXCLUDE
], array());
562 $sub_array = asearch_nz($search_array[ASEARCH_SUB
], array());
563 $query_display = asearch_get_query_display($color, $mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array, $sub_array);
565 echo html_tag('td', $query_num +
1, 'right');
566 echo html_tag('td', $query_display, 'center', '', 'width="80%"');
567 foreach ($action_array as $action => $action_display) {
568 echo html_tag('td', '<a href="' . asearch_get_href('submit=' . $action . '&rownum=' . $query_num) . '">' . $action_display . '</a>', 'center');
576 echo '</table>' . "\n";
579 /** Print the saved array
581 function asearch_print_saved(&$boxes)
583 global $saved_prefkeys;
585 $saved_array = asearch_read_saved();
586 if (isset($saved_array[$saved_prefkeys[0]])) {
587 $saved_count = count($saved_array[$saved_prefkeys[0]]);
588 if ($saved_count > 0) {
589 $saved_actions = array('edit_saved' => _("edit"), 'search_saved' => _("search"), 'delete_saved' => _("delete"));
590 asearch_print_query_array($boxes, $saved_array, $saved_prefkeys, $saved_actions, _("Saved Searches"), 'search_show_saved');
596 * Print the recent array
598 function asearch_print_recent(&$boxes)
600 global $recent_prefkeys, $search_memory;
602 $recent_array = asearch_read_recent();
603 if (isset($recent_array[$recent_prefkeys[0]])) {
604 $recent_count = count($recent_array[$recent_prefkeys[0]]);
605 if (min($recent_count, $search_memory) > 0) {
606 $recent_actions = array('save_recent' => _("save"), 'search_recent' => _("search"), 'forget_recent' => _("forget"));
607 asearch_print_query_array($boxes, $recent_array, $recent_prefkeys, $recent_actions, _("Recent Searches"), 'search_show_recent');
612 /** Build an <option> statement
614 function asearch_opt($val, $sel, $tit)
616 return '<option value="' . $val . '"' . ($sel == $val ?
' selected' : '') . '>' . $tit . '</option>' . "\n";
619 /** Build a <select> statement from an array
621 function asearch_opt_array($var_name, $opt_array, $cur_val)
623 $output = '<select name="' . $var_name . '">' . "\n";
624 foreach($opt_array as $val => $display)
625 $output .= asearch_opt($val, $cur_val, asearch_nz($display, $val));
626 $output .= '</select>' . "\n";
630 /** Verify that a mailbox exists
631 * @return bool mailbox exists
633 function asearch_mailbox_exists($mailbox, &$boxes)
635 foreach ($boxes as $box) {
636 if ($box['unformatted'] == $mailbox)
642 function asearch_get_form_mailbox($imapConnection, &$boxes, $mailbox, $row_num = 0)
644 if (($mailbox != 'All Folders') && (!asearch_mailbox_exists($mailbox, $boxes)))
645 $missing = asearch_opt($mailbox, $mailbox, '[' . _("Missing") . '] ' . asearch_get_mailbox_display($mailbox));
648 return '<select name="mailbox[' . $row_num . ']">'
650 . asearch_opt('All Folders', $mailbox, '[' . asearch_get_mailbox_display('All Folders') . ']')
651 . sqimap_mailbox_option_list($imapConnection, array(strtolower($mailbox)), 0, $boxes, NULL)
655 function asearch_get_form_sub($sub, $row_num = 0)
657 return function_exists('addCheckBox') ?
addCheckBox('sub[' . $row_num .']', $sub)
658 : '<input type=checkbox name="sub[' . $row_num .']"' . ($sub ?
' CHECKED' : '') . '>';
661 function asearch_get_form_location($unop, $where, $row_num = 0)
663 global $imap_asearch_unops, $imap_asearch_options;
665 return asearch_opt_array('unop[' . $row_num . ']', $imap_asearch_unops, $unop)
666 . asearch_opt_array('where[' . $row_num . ']', $imap_asearch_options, $where);
669 function asearch_get_form_what($what, $row_num = 0)
671 return function_exists('addInput') ?
addInput('what[' . $row_num . ']', $what, '35')
672 : '<input type="text" size="35" name="what[' . $row_num . ']" value="' . htmlspecialchars($what) . '">';
675 function asearch_get_form_exclude($exclude, $row_num = 0)
677 return function_exists('addCheckBox') ?
addCheckBox('exclude['.$row_num.']', $exclude)
678 : '<input type=checkbox name="exclude[' . $row_num .']"' . ($exclude ?
' CHECKED' : '') . '>';
681 /** Print one advanced form row
683 function asearch_print_form_row($imapConnection, &$boxes, $mailbox, $biop, $unop, $where, $what, $exclude, $sub, $row_num)
685 global $imap_asearch_biops_in;
688 echo html_tag('tr', '', '', $color[4]);
691 echo html_tag('td', $row_num ?
692 asearch_opt_array('biop[' . $row_num . ']', $imap_asearch_biops_in, $biop)
693 : '<b>' . _("In") . '</b>', 'center') . "\n";
695 //Mailbox list and Include Subfolders
697 asearch_get_form_mailbox($imapConnection, $boxes, $mailbox, $row_num)
698 . _("and subfolders:") . asearch_get_form_sub($sub, $row_num), 'center') . "\n";
700 //Unary operator and Search location
701 echo html_tag('td', asearch_get_form_location($unop, $where, $row_num), 'center') . "\n";
704 echo html_tag('td', asearch_get_form_what($what, $row_num), 'center') . "\n";
707 echo html_tag('td', _("Exclude Criteria:") . asearch_get_form_exclude($exclude, $row_num), 'center') . "\n";
712 /** Print the advanced search form
714 function asearch_print_form($imapConnection, &$boxes, $mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array, $sub_array)
716 global $search_button_html, $add_criteria_button_html, $del_excluded_button_html, $del_all_button_html;
721 echo '<form action="' . asearch_get_href() . '" name="form_asearch">' . "\n";
723 echo html_tag('table', '', 'center', $color[9], 'width="100%" cellpadding="1" cellspacing="1" border="0"');
724 echo html_tag('tr', html_tag('td', asearch_get_title_display($color, _("Search Criteria")), 'center', $color[5], 'colspan=5'));
725 $row_count = count($where_array);
726 for ($row_num = 0; $row_num < $row_count; $row_num++
) {
727 $mailbox = asearch_nz($mailbox_array[$row_num]);
728 $biop = strip_tags(asearch_nz($biop_array[$row_num]));
729 $unop = strip_tags(asearch_nz($unop_array[$row_num]));
730 $where = strip_tags(asearch_nz($where_array[$row_num]));
731 $what = asearch_nz($what_array[$row_num]);
732 $exclude = strip_tags(asearch_nz($exclude_array[$row_num]));
733 $sub = strip_tags(asearch_nz($sub_array[$row_num]));
734 asearch_print_form_row($imapConnection, $boxes, $mailbox, $biop, $unop, $where, $what, $exclude, $sub, $row_num);
736 echo '</table>' . "\n";
739 echo html_tag('table', '', 'center', $color[9], 'width="100%" cellpadding="1" cellspacing="0" border="0"');
741 html_tag('td', getButton('SUBMIT', 'submit', $search_button_html), 'center') . "\n"
742 . html_tag('td', getButton('SUBMIT', 'submit', $add_criteria_button_html), 'center') . "\n"
743 . html_tag('td', getButton('SUBMIT', 'submit', $del_all_button_html), 'center') . "\n"
744 . html_tag('td', getButton('SUBMIT', 'submit', $del_excluded_button_html), 'center') . "\n"
746 echo '</table>' . "\n";
747 echo '</form>' . "\n";
750 /** Print one basic form row
752 function asearch_print_form_row_basic($imapConnection, &$boxes, $mailbox, $biop, $unop, $where, $what, $exclude, $sub, $row_num)
754 global $search_button_html;
757 echo html_tag('tr', '', '', $color[4]);
760 echo html_tag('td', '<b>' . _("In") . '</b> ' . asearch_get_form_mailbox($imapConnection, $boxes, $mailbox), 'center') . "\n";
762 //Unary operator and Search location
763 echo html_tag('td', asearch_get_form_location($unop, $where), 'center') . "\n";
766 echo html_tag('td', asearch_get_form_what($what), 'center') . "\n";
769 echo html_tag('td', getButton('SUBMIT', 'submit', $search_button_html), 'center') . "\n";
774 /** Print the basic search form
776 function asearch_print_form_basic($imapConnection, &$boxes, $mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array, $sub_array)
782 echo '<form action="' . asearch_get_href() . '" name="form_asearch">' . "\n";
784 echo html_tag('table', '', 'center', $color[9], 'width="100%" cellpadding="1" cellspacing="1" border="0"');
785 //echo html_tag('tr', html_tag('td', asearch_get_title_display($color, _("Search Criteria")), 'center', $color[5], 'colspan=4'));
786 $row_count = count($where_array);
787 for ($row_num = 0; $row_num < $row_count; $row_num++
) {
788 $mailbox = asearch_nz($mailbox_array[$row_num]);
789 $biop = strip_tags(asearch_nz($biop_array[$row_num]));
790 $unop = strip_tags(asearch_nz($unop_array[$row_num]));
791 $where = strip_tags(asearch_nz($where_array[$row_num]));
792 $what = asearch_nz($what_array[$row_num]);
793 $exclude = strip_tags(asearch_nz($exclude_array[$row_num]));
794 $sub = strip_tags(asearch_nz($sub_array[$row_num]));
795 asearch_print_form_row_basic($imapConnection, $boxes, $mailbox, $biop, $unop, $where, $what, $exclude, $sub, $row_num);
797 echo '</table>' . "\n";
798 echo '</form>' . "\n";
801 /** Print the $msgs messages from $mailbox mailbox
803 function asearch_print_mailbox_msgs($imapConnection, $mbxresponse, $mailbox, $msgs, $cnt, $sort, $color, $where, $what)
806 global $allow_server_sort, $allow_thread_sort, $thread_sort_messages;
808 $thread_sort_messages = 0;
809 if ($allow_thread_sort) {
810 global $data_dir, $username;
811 $thread_sort_messages = getPref($data_dir, $username, 'thread_' . $mailbox);
815 elseif ($allow_server_sort) {
820 $msort = calc_msort($msgs, $sort);
824 $mailbox_display = asearch_get_mailbox_display($mailbox);
825 $mailbox_title = '<b><big>' . _("Folder:") . ' '. $mailbox_display . ' </big></b>';
826 $devel = check_sm_version(1, 5, 0);
828 echo html_tag('div', $mailbox_title, 'center') . "\n";
829 $mailbox_title = get_selectall_link(1, $real_sort);
831 $msg_cnt_str = get_msgcnt_str(1, $cnt, $cnt);
833 echo '<table border="0" width="100%" cellpadding="0" cellspacing="0">';
837 mail_message_listing_beginning($imapConnection, $mbxresponse, $mailbox, $real_sort, $msg_cnt_str, $mailbox_title, 1, 1);
839 mail_message_listing_beginning($imapConnection, $mailbox, $real_sort, $msg_cnt_str, $mailbox_title, 1, 1);
842 echo '<tr><td HEIGHT="5" BGCOLOR="'.$color[4].'"></td></tr>';
845 echo ' <table width="100%" cellpadding="1" cellspacing="0" align="center"'.' border="0" bgcolor="'.$color[9].'">';
848 echo ' <table width="100%" cellpadding="1" cellspacing="0" align="center" border="0" bgcolor="'.$color[5].'">';
850 printHeader($mailbox, $sort, $color, !$thread_sort_messages);
851 displayMessageArray($imapConnection, $cnt, 1, $msort, $mailbox, $real_sort, $color, $cnt, $where, $what);
856 mail_message_listing_end($cnt, '', $msg_cnt_str, $color);
864 * @param array $boxes mailboxes array (reference)
865 * @return array selectable unformatted mailboxes names
867 function sqimap_asearch_get_selectable_unformatted_mailboxes(&$boxes)
869 $mboxes_array = array();
870 $boxcount = count($boxes);
871 for ($boxnum = 0; $boxnum < $boxcount; $boxnum++
) {
872 if (!in_array('noselect', $boxes[$boxnum]['flags']))
873 $mboxes_array[] = $boxes[$boxnum]['unformatted'];
875 return $mboxes_array;
878 /* ------------------------ main ------------------------ */
879 /* get globals we will need */
880 sqgetGlobalVar('username', $username, SQ_SESSION
);
881 sqgetGlobalVar('key', $key, SQ_COOKIE
);
882 sqgetGlobalVar('delimiter', $delimiter, SQ_SESSION
);
883 sqgetGlobalVar('onetimepad', $onetimepad, SQ_SESSION
);
885 $search_button_html = _("Search");
886 $search_button_text = asearch_unhtmlentities($search_button_html);
887 $add_criteria_button_html = _("Add New Criteria");
888 $add_criteria_button_text = asearch_unhtmlentities($add_criteria_button_html);
889 $del_excluded_button_html = _("Remove Excluded Criteria");
890 $del_excluded_button_text = asearch_unhtmlentities($del_excluded_button_html);
891 $del_all_button_html = _("Remove All Criteria");
892 $del_all_button_text = asearch_unhtmlentities($del_all_button_html);
894 /** Maximum number of recent searches to handle
896 * @global integer $search_memory
898 $search_memory = getPref($data_dir, $username, 'search_memory', 0);
900 /** Advanced search control
901 * - 0 => allow basic interface only
902 * - 1 => allow advanced interface only
905 * @global integer $allow_advanced_search
907 $allow_advanced_search = getPref($data_dir, $username, 'allow_advanced_search', 2);
910 * Toggle advanced/basic search
912 if (sqgetGlobalVar('advanced', $search_advanced, SQ_GET
))
913 setPref($data_dir, $username, 'search_advanced', $search_advanced & 1);
915 /** If 1, show advanced search interface
916 * Default from allow_advanced_search pref
917 * @global integer $search_advanced
919 if ($allow_advanced_search > 1)
920 $search_advanced = getPref($data_dir, $username, 'search_advanced', 0);
922 $search_advanced = $allow_advanced_search;
924 if ($search_advanced) {
925 /** Set recent prefkeys according to $search_advanced
926 * @global array $recent_prefkeys
928 $recent_prefkeys = array('asearch_recent_where', 'asearch_recent_mailbox', 'asearch_recent_what', 'asearch_recent_unop', 'asearch_recent_biop', 'asearch_recent_exclude', 'asearch_recent_sub');
930 /** Set saved prefkeys according to $search_advanced
931 * @global array $saved_prefkeys
933 $saved_prefkeys = array('asearch_saved_where', 'asearch_saved_mailbox', 'asearch_saved_what', 'asearch_saved_unop', 'asearch_saved_biop', 'asearch_saved_exclude', 'asearch_saved_sub');
935 /*$asearch_prefkeys = array('where', 'mailbox', 'what', 'biop', 'unop', 'exclude', 'sub');*/
938 $recent_prefkeys = array('search_where', 'search_folder', 'search_what', 'search_unop');
939 $saved_prefkeys = array('saved_where', 'saved_folder', 'saved_what', 'saved_unop');
942 /** How we did enter the form
943 * - unset : Enter key, or called from outside (eg read_body)
944 * - $search_button_text : Search button
945 * - 'Search_no_update' : Search but don't update recent
946 * - 'Search_last' : Same as no_update but reload and search last
947 * - 'Search_silent' : Same as no_update but only display results
948 * - $add_criteria_button_text : Add New Criteria button
949 * - $del_excluded_button_text : Remove Excluded Criteria button
950 * - $del_all_button_text : Remove All Criteria button
957 * @global string $submit
959 if (isset($_GET['submit']))
960 $submit = strip_tags($_GET['submit']);
962 /** Searched mailboxes
963 * @global array $mailbox_array
965 if (isset($_GET['mailbox'])) {
966 $mailbox_array = $_GET['mailbox'];
967 if (!is_array($mailbox_array))
968 $mailbox_array = array($mailbox_array);
971 $mailbox_array = array();
974 * @global array $biop_array
976 if (isset($_GET['biop'])) {
977 $biop_array = $_GET['biop'];
978 if (!is_array($biop_array))
979 $biop_array = array($biop_array);
982 $biop_array = array();
985 * @global array $unop_array
987 if (isset($_GET['unop'])) {
988 $unop_array = $_GET['unop'];
989 if (!is_array($unop_array))
990 $unop_array = array($unop_array);
993 $unop_array = array();
996 * @global array $where_array
998 if (isset($_GET['where'])) {
999 $where_array = $_GET['where'];
1000 if (!is_array($where_array))
1001 $where_array = array($where_array);
1004 $where_array = array();
1007 * @global array $what_array
1009 if (isset($_GET['what'])) {
1010 $what_array = $_GET['what'];
1011 if (!is_array($what_array))
1012 $what_array = array($what_array);
1015 $what_array = array();
1017 /** Whether to exclude this criteria from search
1018 * @global array $exclude_array
1020 if (isset($_GET['exclude']))
1021 $exclude_array = $_GET['exclude'];
1023 $exclude_array = array();
1025 /** Search within subfolders
1026 * @global array $sub_array
1028 if (isset($_GET['sub']))
1029 $sub_array = $_GET['sub'];
1031 $sub_array = array();
1033 /** Row number used by recent and saved stuff
1035 if (isset($_GET['rownum']))
1036 $submit_rownum = strip_tags($_GET['rownum']);
1038 /** Change global sort
1040 if (sqgetGlobalVar('newsort', $newsort, SQ_GET
)) {
1041 setPref($data_dir, $username, 'sort', $newsort);
1043 sqsession_register($sort, 'sort');
1044 asearch_edit_last();
1047 /** Toggle mailbox threading
1049 if (sqgetGlobalVar('set_thread', $set_thread, SQ_GET
)) {
1050 setPref($data_dir, $username, 'thread_' . $mailbox_array[0], $set_thread & 1);
1051 asearch_edit_last();
1054 /** Toggle show/hide saved searches
1056 if (sqgetGlobalVar('search_show_saved', $search_show_saved, SQ_GET
))
1057 setPref($data_dir, $username, 'search_show_saved', $search_show_saved & 1);
1059 /** Toggle show/hide recent searches
1061 if (sqgetGlobalVar('search_show_recent', $search_show_recent, SQ_GET
))
1062 setPref($data_dir, $username, 'search_show_recent', $search_show_recent & 1);
1064 // end of get globals
1066 /** If TRUE, do not show search interface
1068 * @global bool $search_silent
1070 $search_silent = FALSE;
1072 /* See how the page was called and fire off correct function */
1073 if ((empty($submit)) && (!empty($where_array))) {
1074 /* This happens when the Enter key is used or called from outside */
1075 $submit = $search_button_text;
1076 if (count($where_array) != count($unop_array)) /* Hack needed to handle coming back from read_body et als */
1077 asearch_edit_last();
1080 if (!isset($submit)) {
1085 case $search_button_text:
1086 if (asearch_check_query($where_array, $what_array, $exclude_array) == '')
1087 asearch_push_recent($mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array, $sub_array);
1089 case 'Search_silent':
1090 $search_silent = TRUE;
1092 case 'Search_no_update':
1093 $submit = $search_button_text;
1095 case $del_excluded_button_text:
1096 $delarray = array_keys($exclude_array);
1097 while (!empty($delarray)) {
1098 $delrow = array_pop($delarray);
1099 array_splice($mailbox_array, $delrow, 1);
1100 array_splice($biop_array, $delrow, 1);
1101 array_splice($unop_array, $delrow, 1);
1102 array_splice($where_array, $delrow, 1);
1103 array_splice($what_array, $delrow, 1);
1104 /* array_splice($exclude_array, $delrow, 1);*/ /* There is still some php magic that eludes me */
1105 array_splice($sub_array, $delrow, 1);
1107 $exclude_array = array();
1109 case $del_all_button_text:
1110 $mailbox_array = array();
1111 $biop_array = array();
1112 $unop_array = array();
1113 $where_array = array();
1114 $what_array = array();
1115 $exclude_array = array();
1116 $sub_array = array();
1119 asearch_save_recent($submit_rownum);
1121 case 'search_recent':
1122 $submit = $search_button_text;
1123 asearch_edit_recent($submit_rownum);
1124 asearch_push_recent($mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array, $sub_array);
1126 case 'edit_recent': /* no link to do this, yet */
1127 asearch_edit_recent($submit_rownum);
1129 case 'forget_recent':
1130 asearch_forget_recent($submit_rownum);
1132 case 'search_saved':
1133 $submit = $search_button_text;
1134 asearch_edit_saved($submit_rownum);
1135 asearch_push_recent($mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array, $sub_array);
1138 asearch_edit_saved($submit_rownum);
1140 case 'delete_saved':
1141 asearch_delete_saved($submit_rownum);
1146 //Texts in both basic and advanced form
1147 $imap_asearch_unops = array(
1152 if ($search_advanced) {
1153 //Texts in advanced form only
1154 $imap_asearch_options = array(
1156 //'ALL' is binary operator
1157 'ANSWERED' => _("Answered"),
1159 'BEFORE' => _("Before"),
1160 'BODY' => _("Message Body"),
1162 'DELETED' => _("Deleted"),
1163 'DRAFT' => _("Draft"),
1164 'FLAGGED' => _("Flagged"),
1165 'FROM' => _("Sent By"),
1166 'HEADER' => _("Header Field"),
1167 'KEYWORD' => _("Keyword"),
1168 'LARGER' => _("Larger Than"),
1170 //'NOT' is unary operator
1173 //'OR' is binary operator
1174 'RECENT' => _("Recent"),
1175 'SEEN' => _("Seen"),
1176 'SENTBEFORE' => _("Sent Before"),
1177 'SENTON' => _("Sent On"),
1178 'SENTSINCE' => _("Sent Since"),
1179 'SINCE' => _("Since"),
1180 'SMALLER' => _("Smaller Than"),
1181 'SUBJECT' => _("Subject Contains"),
1182 'TEXT' => _("Header and Body"),
1183 'TO' => _("Sent To"),
1185 /* 'UNANSWERED' => '',
1189 'UNKEYWORD' => _("Unkeyword"),
1190 'UNSEEN' => _("Unseen"),*/
1193 $imap_asearch_biops_in = array(
1194 'ALL' => _("And In"),
1198 $imap_asearch_biops = array(
1204 //Texts in basic form only
1205 $imap_asearch_options = array(
1207 'BODY' => _("Body"),
1209 'FROM' => _("From"),
1210 'SUBJECT' => _("Subject"),
1211 'TEXT' => _("Everywhere"),
1216 uasort($imap_asearch_options, 'asearch_unhtml_strcoll');
1218 /* open IMAP connection */
1219 $imapConnection = sqimap_login($username, $key, $imapServerAddress, $imapPort, 0);
1220 /* get mailbox names once here */
1221 $boxes = sqimap_mailbox_list($imapConnection);
1222 /* ensure we have a valid default mailbox name */
1223 $mailbox = asearch_nz($mailbox_array[0]);
1224 if (($mailbox == '') ||
($mailbox == 'None')) //Workaround for sm quirk IMHO (what if I really have a mailbox called None?)
1225 $mailbox = $boxes[0]['unformatted']; //Usually INBOX ;)
1227 if (isset($composenew) && $composenew) {
1228 $comp_uri = "../src/compose.php?mailbox=" . urlencode($mailbox)
1229 . "&session=$composesession&attachedmessages=true&";
1230 displayPageHeader($color, $mailbox, "comp_in_new('$comp_uri');", false);
1233 displayPageHeader($color, $mailbox);
1235 do_hook('search_before_form');
1237 if (!$search_silent) {
1238 //Add a link to the other search mode if allowed
1239 if ($allow_advanced_search > 1)
1240 $toggle_link = asearch_get_toggle_link(!$search_advanced, 'advanced', array(_("Standard search"), _("Advanced search")));
1244 echo html_tag('table',
1246 . html_tag('td', asearch_get_title_display($color, _("Search")) . $toggle_link, 'center', $color[0])
1248 '', '', 'width="100%"') . "\n";
1249 asearch_print_saved($boxes);
1250 asearch_print_recent($boxes);
1251 if (empty($where_array)) {
1252 global $sent_folder;
1254 $mailbox_array[0] = $mailbox;
1255 $biop_array[0] = '';
1256 $unop_array[0] = '';
1257 if ($mailbox == $sent_folder)
1258 $where_array[0] = 'TO';
1260 $where_array[0] = 'FROM';
1261 $what_array[0] = '';
1262 $exclude_array[0] = '';
1265 //Display advanced or basic form
1266 if ($search_advanced) {
1267 if ($submit == $add_criteria_button_text) {
1268 $last_index = max(count($where_array) - 1, 0);
1269 $mailbox_array[] = asearch_nz($mailbox_array[$last_index]);
1270 $biop_array[] = asearch_nz($biop_array[$last_index]);
1271 $unop_array[] = asearch_nz($unop_array[$last_index]);
1272 $where_array[] = asearch_nz($where_array[$last_index]);
1273 $what_array[] = asearch_nz($what_array[$last_index]);
1274 $exclude_array[] = asearch_nz($exclude_array[$last_index]);
1275 $sub_array[] = asearch_nz($sub_array[$last_index]);
1277 asearch_print_form($imapConnection, $boxes, $mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array, $sub_array);
1280 asearch_print_form_basic($imapConnection, $boxes, $mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array, $sub_array);
1283 /*********************************************************************
1284 * Check to see if we can use cache or not. Currently the only time *
1285 * when you will not use it is when a link on the left hand frame is *
1286 * used. Also check to make sure we actually have the array in the *
1287 * registered session data. :) *
1288 *********************************************************************/
1289 if (!isset($use_mailbox_cache))
1290 $use_mailbox_cache = 0;
1292 do_hook('search_after_form');
1294 if ($submit == $search_button_text) {
1295 echo html_tag('table', '', 'center', $color[9], 'width="100%" cellpadding="1" cellspacing="0" border="0"');
1296 echo html_tag('tr', html_tag('td', asearch_get_title_display($color, _("Search Results")), 'center', $color[5]));
1297 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]));
1298 echo '</table>' . "\n";
1302 $query_error = asearch_check_query($where_array, $what_array, $exclude_array);
1303 if ($query_error != '')
1304 echo '<br>' . html_tag('div', asearch_get_error_display($color, $query_error), 'center') . "\n";
1306 // Disable thread sort for now if there is more than one mailbox or at least one 'All Folders'
1307 global $allow_thread_sort;
1308 $old_allow_thread_sort = $allow_thread_sort;
1309 $allow_thread_sort = ((count(array_unique($mailbox_array)) <= 1) && (!in_array('All Folders', $mailbox_array)));
1311 $mboxes_array = sqimap_asearch_get_selectable_unformatted_mailboxes($boxes);
1312 $mboxes_msgs = sqimap_asearch($imapConnection, $mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array, $sub_array, $mboxes_array);
1313 if (empty($mboxes_msgs))
1314 echo '<br>' . html_tag('div', asearch_get_error_display($color, _("No Messages Found")), 'center') . "\n";
1316 foreach($mboxes_msgs as $mailbox => $msgs) {
1318 $mbxresponse = sqimap_mailbox_select($imapConnection, $mailbox);
1319 $msgs = fillMessageArray($imapConnection, $msgs, count($msgs));
1320 /* For now just keep the first criteria to make the regular search happy if the user tries to come back to search */
1321 /* $where = asearch_serialize($where_array);
1322 $what = asearch_serialize($what_array);*/
1323 $where = $where_array[0];
1324 $what = $what_array[0];
1325 asearch_print_mailbox_msgs($imapConnection, $mbxresponse, $mailbox, $msgs, count($msgs), $sort, $color, urlencode($where), urlencode($what));
1329 $allow_thread_sort = $old_allow_thread_sort; // Restore thread sort
1333 do_hook('search_bottom');
1334 sqimap_logout($imapConnection);
1335 echo '</body></html>';