src/search.php

   1 <?php
   2
   3 /**
   4  * search.php
   5  *
   6  * IMAP search page
   7  *
   8  * Subfolder search idea from Patch #806075 by Thomas Pohl xraven at users.sourceforge.net. Thanks Thomas!
   9  *
  10  * @author Alex Lemaresquier - Brainstorm <alex at brainstorm.fr>
  11  * @copyright &copy; 1999-2005 The SquirrelMail Project Team
  12  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  13  * @version $Id$
  14  * @package squirrelmail
  15  * @subpackage search
  16  * @link http://www.ietf.org/rfc/rfc3501.txt
  17  */
  18
  19 /**
  20  * Path for SquirrelMail required files.
  21  * @ignore
  22  */
  23 define('SM_PATH','../');
  24
  25 /** SquirrelMail required files.
  26  */
  27 require_once(SM_PATH . 'include/validate.php');
  28 include_once(SM_PATH . 'functions/strings.php');
  29 include_once(SM_PATH . 'functions/imap_asearch.php');
  30 include_once(SM_PATH . 'functions/imap_mailbox.php');
  31 include_once(SM_PATH . 'functions/imap_messages.php');
  32 include_once(SM_PATH . 'functions/mime.php');
  33 include_once(SM_PATH . 'functions/mailbox_display.php'); //getButton()...
  34 include_once(SM_PATH . 'class/template/template.class.php');
  35
  36 /** Prefs array ordinals. Must match $recent_prefkeys and $saved_prefkeys
  37  */
  38 define('ASEARCH_WHERE', 0);
  39 define('ASEARCH_MAILBOX', 1);
  40 define('ASEARCH_WHAT', 2);
  41 define('ASEARCH_UNOP', 3);
  42 define('ASEARCH_BIOP', 4);
  43 define('ASEARCH_EXCLUDE', 5);
  44 define('ASEARCH_SUB', 6);
  45 define('ASEARCH_MAX', 7);
  46
  47 /** Name of session var
  48  */
  49 define('ASEARCH_CRITERIA', 'criteria');
  50
  51 /** Builds a href with params
  52  * @param string $params optional parameters to GET
  53  */
  54 function asearch_get_href($params = '')
  55 {
  56     $href = 'search.php';
  57     if ($params != '')
  58         $href .= '?' . $params;
  59     return $href;
  60 }
  61
  62 /** Builds a [link]
  63  * @param string $href (reference)
  64  * @param string $text
  65  * @param string $title
  66  */
  67 function asearch_get_link(&$href, $text, $title = '')
  68 {
  69     if ($title != '')
  70         $title = ' title="' . $title . '"';
  71     return '<a href="' . $href . '"' . $title . '>' . $text . '</a>';
  72 }
  73
  74 /** Builds a toggle [link]
  75  * @param integer $value
  76  * @param string $action
  77  * @param array $text_array
  78  * @param array $title_array
  79  */
  80 function asearch_get_toggle_link($value, $action, $text_array, $title_array = array())
  81 {
  82     return asearch_get_link(asearch_get_href($action . '=' . (int)$value), $text_array[$value], asearch_nz($title_array[$value]));
  83 }
  84
  85 /**
  86  * @param string $a
  87  * @param string $b
  88  * @return bool strcoll()-like result
  89  */
  90 function asearch_unhtml_strcoll($a, $b)
  91 {
  92     return strcoll(asearch_unhtmlentities($a), asearch_unhtmlentities($b));
  93 }
  94
  95
  96 /**
  97  * @param string $mailbox mailbox name utf7 encoded inc. special case INBOX
  98  * @return string mailbox name ready to display (utf7 decoded or localized INBOX)
  99  */
 100 function imap_get_mailbox_display($mailbox)
 101 {
 102     if (strtoupper($mailbox) == 'INBOX')
 103         return _("INBOX");
 104     return imap_utf7_decode_local($mailbox);
 105 }
 106
 107 /**
 108  * @param string $mailbox mailbox name or special case 'All Folders'
 109  * @return string mailbox name ready to display (utf7 decoded or localized 'All Folders')
 110  */
 111 function asearch_get_mailbox_display($mailbox)
 112 {
 113     if ($mailbox == 'All Folders')
 114         return _("All Folders");
 115     return imap_get_mailbox_display($mailbox);
 116 }
 117
 118 /**
 119  * @param array $color color array
 120  * @param string $txt text to display
 121  * @return string title ready to display
 122  */
 123 function asearch_get_title_display(&$color, $txt)
 124 {
 125     return '<b><big>' . $txt . '</big></b>';
 126 }
 127 /**
 128  * @param array $color color array
 129  * @param string $txt text to display
 130  * @return string error text ready to display
 131  */
 132 function asearch_get_error_display(&$color, $txt)
 133 {
 134     return '<font color="' . $color[2] . '">' . '<b><big>' . $txt . '</big></b></font>';
 135 }
 136
 137 /**
 138  * @param array $input_array array to serialize
 139  * @return string a string containing a byte-stream representation of value that can be stored anywhere
 140  */
 141 function asearch_serialize(&$input_array)
 142 {
 143     global $search_advanced;
 144     if ($search_advanced)
 145         return serialize($input_array);
 146     return $input_array[0];
 147 }
 148
 149 /**
 150  * @param string $input_string string to unserialize
 151  * @return array
 152  */
 153 function asearch_unserialize($input_string)
 154 {
 155     global $search_advanced;
 156     if ($search_advanced)
 157         return unserialize($input_string);
 158     return array($input_string);
 159 }
 160
 161 /**
 162  * @param string $key the pref key
 163  * @param integer $index the pref key index
 164  * @param string $default default value
 165  * @return string pref value
 166  */
 167 function asearch_getPref(&$key, $index, $default = '')
 168 {
 169     global $data_dir, $username, $search_advanced;
 170     return getPref($data_dir, $username, $key . ($index + !$search_advanced), $default);
 171 }
 172
 173 /**
 174  * @param string $key the pref key
 175  * @param integer $index the pref key index
 176  * @param string $value pref value to set
 177  * @return bool status
 178  */
 179 function asearch_setPref(&$key, $index, $value)
 180 {
 181     global $data_dir, $username, $search_advanced;
 182     return setPref($data_dir, $username, $key . ($index + !$search_advanced), $value);
 183 }
 184
 185 /**
 186  * @param string $key the pref key
 187  * @param integer $index the pref key index
 188  * @return bool status
 189  */
 190 function asearch_removePref(&$key, $index)
 191 {
 192     global $data_dir, $username, $search_advanced;
 193     return removePref($data_dir, $username, $key . ($index + !$search_advanced));
 194 }
 195
 196 /** Sanity checks, done before running the imap command and before calling push_recent
 197  */
 198 function asearch_check_query(&$where_array, &$what_array, &$exclude_array)
 199 {
 200     global $imap_asearch_opcodes;
 201
 202     if (empty($where_array))
 203         return _("Please enter something to search for");
 204     if (count($exclude_array) == count($where_array))
 205         return _("There must be at least one criteria to search for");
 206     for ($crit_num = 0; $crit_num < count($where_array); $crit_num++) {
 207         $where = $where_array[$crit_num];
 208         $what = $what_array[$crit_num];
 209         if (!(($what == '') ^ ($imap_asearch_opcodes[$where] != '')))
 210             return _("Error in criteria argument");
 211     }
 212     return '';
 213 }
 214
 215 /** Read the recent searches from the prefs
 216  */
 217 function asearch_read_recent()
 218 {
 219     global $recent_prefkeys, $search_memory;
 220
 221     $recent_array = array();
 222     $recent_num = 0;
 223     for ($pref_num = 0; $pref_num < $search_memory; $pref_num++) {
 224         foreach ($recent_prefkeys as $prefkey) {
 225             $pref = asearch_getPref($prefkey, $pref_num);
 226 /*            if (!empty($pref))*/
 227                 $recent_array[$prefkey][$recent_num] = $pref;
 228         }
 229         if (empty($recent_array[$recent_prefkeys[0]][$recent_num])) {
 230             foreach ($recent_prefkeys as $key) {
 231                 array_pop($recent_array[$key]);
 232             }
 233 //            break; //Disabled to support old search code broken prefs
 234         }
 235         else
 236             $recent_num++;
 237     }
 238     return $recent_array;
 239 }
 240
 241 /** Read the saved searches from the prefs
 242  */
 243 function asearch_read_saved()
 244 {
 245     global $saved_prefkeys;
 246
 247     $saved_array = array();
 248     $saved_key = $saved_prefkeys[0];
 249     for ($saved_count = 0; ; $saved_count++) {
 250         $pref = asearch_getPref($saved_key, $saved_count);
 251         if (empty($pref))
 252             break;
 253     }
 254     for ($saved_num = 0; $saved_num < $saved_count; $saved_num++) {
 255         foreach ($saved_prefkeys as $key) {
 256             $saved_array[$key][$saved_num] = asearch_getPref($key, $saved_num);
 257         }
 258     }
 259     return $saved_array;
 260 }
 261
 262 /** Save a recent search to the prefs
 263  */
 264 function asearch_save_recent($recent_index)
 265 {
 266     global $recent_prefkeys, $saved_prefkeys;
 267
 268     $saved_array = asearch_read_saved();
 269     $saved_index = count($saved_array[$saved_prefkeys[0]]);
 270     $recent_array = asearch_read_recent();
 271     $n = 0;
 272     foreach ($recent_prefkeys as $key) {
 273         $recent_slice = array_slice($recent_array[$key], $recent_index, 1);
 274         if (!empty($recent_slice[0]))
 275             asearch_setPref($saved_prefkeys[$n], $saved_index, $recent_slice[0]);
 276         else
 277             asearch_removePref($saved_prefkeys[$n], $saved_index);
 278         $n++;
 279     }
 280 }
 281
 282 /** Write a recent search to prefs
 283  */
 284 function asearch_write_recent(&$recent_array)
 285 {
 286     global $recent_prefkeys, $search_memory;
 287
 288     $recent_count = min($search_memory, count($recent_array[$recent_prefkeys[0]]));
 289     for ($recent_num = 0; $recent_num < $recent_count; $recent_num++) {
 290         foreach ($recent_prefkeys as $key) {
 291             asearch_setPref($key, $recent_num, $recent_array[$key][$recent_num]);
 292         }
 293     }
 294     for (; $recent_num < $search_memory; $recent_num++) {
 295         foreach ($recent_prefkeys as $key) {
 296             asearch_removePref($key, $recent_num);
 297         }
 298     }
 299 }
 300
 301 /** Remove a recent search from prefs
 302  */
 303 function asearch_forget_recent($forget_index)
 304 {
 305     global $recent_prefkeys;
 306
 307     $recent_array = asearch_read_recent();
 308     foreach ($recent_prefkeys as $key) {
 309         array_splice($recent_array[$key], $forget_index, 1);
 310     }
 311     asearch_write_recent($recent_array);
 312 }
 313
 314 /** Find a recent search in the prefs (used to avoid saving duplicates)
 315  */
 316 function asearch_find_recent(&$recent_array, &$mailbox_array, &$biop_array, &$unop_array, &$where_array, &$what_array, &$exclude_array, &$sub_array)
 317 {
 318     global $recent_prefkeys, $search_advanced;
 319
 320     $where_string = asearch_serialize($where_array);
 321     $mailbox_string = asearch_serialize($mailbox_array);
 322     $what_string = asearch_serialize($what_array);
 323     $unop_string = asearch_serialize($unop_array);
 324     if ($search_advanced) {
 325         $biop_string = asearch_serialize($biop_array);
 326         $exclude_string = asearch_serialize($exclude_array);
 327         $sub_string = asearch_serialize($sub_array);
 328     }
 329     $recent_count = count($recent_array[$recent_prefkeys[ASEARCH_WHERE]]);
 330     for ($recent_num = 0; $recent_num < $recent_count; $recent_num++) {
 331         if (isset($recent_array[$recent_prefkeys[ASEARCH_WHERE]][$recent_num])) {
 332             if (
 333                     $where_string == $recent_array[$recent_prefkeys[ASEARCH_WHERE]][$recent_num] &&
 334                     $mailbox_string == $recent_array[$recent_prefkeys[ASEARCH_MAILBOX]][$recent_num] &&
 335                     $what_string == $recent_array[$recent_prefkeys[ASEARCH_WHAT]][$recent_num] &&
 336                     $unop_string == $recent_array[$recent_prefkeys[ASEARCH_UNOP]][$recent_num] &&
 337                     ((!$search_advanced) ||
 338                         ($biop_string == $recent_array[$recent_prefkeys[ASEARCH_BIOP]][$recent_num] &&
 339                         $exclude_string == $recent_array[$recent_prefkeys[ASEARCH_EXCLUDE]][$recent_num] &&
 340                         $sub_string == $recent_array[$recent_prefkeys[ASEARCH_SUB]][$recent_num]))
 341                     )
 342                 return $recent_num;
 343         }
 344     }
 345     return -1;
 346 }
 347
 348 /** Push a recent search into the prefs
 349  */
 350 function asearch_push_recent(&$mailbox_array, &$biop_array, &$unop_array, &$where_array, &$what_array, &$exclude_array, &$sub_array)
 351 {
 352     global $recent_prefkeys, $search_memory;
 353     //global $what; // Hack to access issued search from read_body.php
 354     $what = 1;
 355     /**
 356      * Update search history and store it in the session so we can retrieve the
 357      * issued search when returning from an external page like read_body.php
 358      */
 359     $criteria[$what] = array($mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array, $sub_array);
 360     sqsession_register($criteria, ASEARCH_CRITERIA);
 361     if ($search_memory > 0) {
 362         $recent_array = asearch_read_recent();
 363         $recent_found = asearch_find_recent($recent_array, $mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array, $sub_array);
 364         if ($recent_found >= 0) { // Remove identical recent
 365             foreach ($recent_prefkeys as $key) {
 366                 array_splice($recent_array[$key], $recent_found, 1);
 367             }
 368         }
 369         $input = array($where_array, $mailbox_array, $what_array, $unop_array, $biop_array, $exclude_array, $sub_array);
 370         $i = 0;
 371         foreach ($recent_prefkeys as $key) {
 372             array_unshift($recent_array[$key], asearch_serialize($input[$i]));
 373             $i++;
 374         }
 375         asearch_write_recent($recent_array);
 376     }
 377 }
 378
 379 /** Edit a recent search
 380  * @global array mailbox_array searched mailboxes
 381  */
 382 function asearch_edit_recent($index)
 383 {
 384     global $recent_prefkeys, $search_advanced;
 385     global $where_array, $mailbox_array, $what_array, $unop_array;
 386     global $biop_array, $exclude_array, $sub_array;
 387
 388     $where_array = asearch_unserialize(asearch_getPref($recent_prefkeys[ASEARCH_WHERE], $index));
 389     $mailbox_array = asearch_unserialize(asearch_getPref($recent_prefkeys[ASEARCH_MAILBOX], $index));
 390     $what_array = asearch_unserialize(asearch_getPref($recent_prefkeys[ASEARCH_WHAT], $index));
 391     $unop_array = asearch_unserialize(asearch_getPref($recent_prefkeys[ASEARCH_UNOP], $index));
 392     if ($search_advanced) {
 393         $biop_array = asearch_unserialize(asearch_getPref($recent_prefkeys[ASEARCH_BIOP], $index));
 394         $exclude_array = asearch_unserialize(asearch_getPref($recent_prefkeys[ASEARCH_EXCLUDE], $index));
 395         $sub_array = asearch_unserialize(asearch_getPref($recent_prefkeys[ASEARCH_SUB], $index));
 396     }
 397 }
 398
 399 /** Get last search criteria from session or prefs
 400  * FIX ME, try to avoid globals
 401  */
 402 function asearch_edit_last($index) {
 403     if (sqGetGlobalVar(ASEARCH_CRITERIA, $criteria, SQ_SESSION)) {
 404         global $where_array, $mailbox_array, $what_array, $unop_array;
 405         global $biop_array, $exclude_array, $sub_array;
 406         $mailbox_array = $criteria[$index][0];
 407         $biop_array = $criteria[$index][1];
 408         $unop_array = $criteria[$index][2];
 409         $where_array = $criteria[$index][3];
 410         $what_array = $criteria[$index][4];
 411         $exclude_array = $criteria[$index][5];
 412         $sub_array = $criteria[$index][6];
 413         unset($criteria[$index]);
 414         //sqsession_unregister(ASEARCH_CRITERIA);
 415     } else {
 416         global $search_memory;
 417         if ($search_memory > 0) {
 418             asearch_edit_recent(0);
 419         }
 420     }
 421 }
 422
 423 /** Edit a saved search
 424  */
 425 function asearch_edit_saved($index)
 426 {
 427     global $saved_prefkeys, $search_advanced;
 428     global $where_array, $mailbox_array, $what_array, $unop_array;
 429     global $biop_array, $exclude_array, $sub_array;
 430
 431     $where_array = asearch_unserialize(asearch_getPref($saved_prefkeys[ASEARCH_WHERE], $index));
 432     $mailbox_array = asearch_unserialize(asearch_getPref($saved_prefkeys[ASEARCH_MAILBOX], $index));
 433     $what_array = asearch_unserialize(asearch_getPref($saved_prefkeys[ASEARCH_WHAT], $index));
 434     $unop_array = asearch_unserialize(asearch_getPref($saved_prefkeys[ASEARCH_UNOP], $index));
 435     if ($search_advanced) {
 436         $biop_array = asearch_unserialize(asearch_getPref($saved_prefkeys[ASEARCH_BIOP], $index));
 437         $exclude_array = asearch_unserialize(asearch_getPref($saved_prefkeys[ASEARCH_EXCLUDE], $index));
 438         $sub_array = asearch_unserialize(asearch_getPref($saved_prefkeys[ASEARCH_SUB], $index));
 439     }
 440 }
 441
 442 /** Write a saved search to the prefs
 443  */
 444 function asearch_write_saved(&$saved_array)
 445 {
 446     global $saved_prefkeys;
 447
 448     $saved_count = count($saved_array[$saved_prefkeys[0]]);
 449     for ($saved_num=0; $saved_num < $saved_count; $saved_num++) {
 450         foreach ($saved_prefkeys as $key) {
 451             asearch_setPref($key, $saved_num, $saved_array[$key][$saved_num]);
 452         }
 453     }
 454     foreach ($saved_prefkeys as $key) {
 455         asearch_removePref($key, $saved_count);
 456     }
 457 }
 458
 459 /** Delete a saved search from the prefs
 460  */
 461 function asearch_delete_saved($saved_index)
 462 {
 463     global $saved_prefkeys;
 464
 465     $saved_array = asearch_read_saved();
 466     $asearch_keys = $saved_prefkeys;
 467     foreach ($asearch_keys as $key) {
 468         array_splice($saved_array[$key], $saved_index, 1);
 469     }
 470     asearch_write_saved($saved_array);
 471 }
 472
 473 /** Translate the input date to imap date to local date display,
 474  * so the user can know if the date is wrong or illegal
 475  * @return string locally formatted date or error text
 476  */
 477 function asearch_get_date_display(&$what)
 478 {
 479     $what_parts = sqimap_asearch_parse_date($what);
 480     if (count($what_parts) == 4) {
 481         if (checkdate($what_parts[2], $what_parts[1], $what_parts[3]))
 482             return date_intl(_("M j, Y"), mktime(0,0,0,$what_parts[2],$what_parts[1],$what_parts[3]));
 483             //return $what_parts[1] . ' ' . getMonthName($what_parts[2]) . ' ' . $what_parts[3];
 484         return _("(Illegal date)");
 485     }
 486     return _("(Wrong date)");
 487 }
 488
 489 /** Translate the query to rough natural display
 490  * @return string rough natural query ready to display
 491  */
 492 function asearch_get_query_display(&$color, &$mailbox_array, &$biop_array, &$unop_array, &$where_array, &$what_array, &$exclude_array, &$sub_array)
 493 {
 494     global $imap_asearch_biops_in, $imap_asearch_biops, $imap_asearch_unops, $imap_asearch_options;
 495     global $imap_asearch_opcodes;
 496
 497     $last_mailbox = $mailbox_array[0];
 498     if (empty($last_mailbox))
 499         $last_mailbox = 'INBOX';
 500     $query_display = '';
 501     for ($crit_num=0; $crit_num < count($where_array); $crit_num++) {
 502         if ((!isset($exclude_array[$crit_num])) || (!$exclude_array[$crit_num])) {
 503             $cur_mailbox = $mailbox_array[$crit_num];
 504             if (empty($cur_mailbox))
 505                 $cur_mailbox = 'INBOX';
 506             $biop = asearch_nz($biop_array[$crit_num]);
 507             if (($query_display == '') || ($cur_mailbox != $last_mailbox)) {
 508                 $mailbox_display = ' <b>' . asearch_get_mailbox_display($cur_mailbox) . '</b>';
 509                 if ($query_display == '')
 510                     $biop_display = _("In");
 511                 else
 512                     $biop_display = $imap_asearch_biops_in[$biop];
 513                 $last_mailbox = $cur_mailbox;
 514             }
 515             else {
 516                 $mailbox_display = '';
 517                 $biop_display = $imap_asearch_biops[$biop];
 518             }
 519             $unop = $unop_array[$crit_num];
 520             $unop_display = $imap_asearch_unops[$unop];
 521             if ($unop_display != '')
 522                 $unop_display .= ' ';
 523             $where = $where_array[$crit_num];
 524             $where_display = $unop_display . asearch_nz($imap_asearch_options[$where], $where);
 525             $what_type = $imap_asearch_opcodes[$where];
 526             $what = $what_array[$crit_num];
 527             if ($what_type) { /* Check opcode parameter */
 528                 if ($what == '')
 529                     $what_display = ' ' . asearch_get_error_display($color, _("(Missing argument)"));
 530                 else {
 531                     if ($what_type == 'adate')
 532                         $what_display = asearch_get_date_display($what);
 533                     else
 534                         $what_display = htmlspecialchars($what);
 535                     $what_display = ' <b>' . $what_display . '</b>';
 536                 }
 537             }
 538             else {
 539                 if ($what)
 540                     $what_display = ' ' . asearch_get_error_display($color, _("(Spurious argument)"));
 541                 else
 542                     $what_display = '';
 543             }
 544             if ($mailbox_display != '')
 545                 $query_display .= ' <u><i>' . $biop_display . '</i></u>' . $mailbox_display . ' <u><i>' . $where_display . '</i></u>' . $what_display;
 546             else
 547                 $query_display .= ' <u><i>' . $biop_display . ' ' . $where_display . '</i></u>' . $what_display;
 548         }
 549     }
 550     return $query_display;
 551 }
 552
 553 /**
 554  * Creates button
 555  *
 556  * @deprecated see form functions available in 1.5.1 and 1.4.3.
 557  * @param string $type
 558  * @param string $name
 559  * @param string $value
 560  * @param string $js
 561  * @param bool $enabled
 562  */
 563 function getButton($type, $name, $value, $js = '', $enabled = TRUE) {
 564     $disabled = ( $enabled ? '' : 'disabled ' );
 565     $js = ( $js ? $js.' ' : '' );
 566     return '<input '.$disabled.$js.
 567             'type="'.$type.
 568             '" name="'.$name.
 569             '" value="'.$value .
 570             '" style="padding: 0px; margin: 0px" />';
 571 }
 572
 573
 574 /** Handle the alternate row colors
 575  * @return string color value
 576  */
 577 function asearch_get_row_color(&$color, $row_num)
 578 {
 579 /*$color_string = ($row_num%2 ? $color[0] : $color[4]);*/
 580     $color_string = $color[4];
 581     if ($GLOBALS['alt_index_colors']) {
 582         if (($row_num % 2) == 0) {
 583             if (!isset($color[12]))
 584                 $color[12] = '#EAEAEA';
 585             $color_string = $color[12];
 586         }
 587     }
 588     return $color_string;
 589 }
 590
 591 /** Print a whole query array, recent or saved
 592  */
 593 function asearch_print_query_array(&$boxes, &$query_array, &$query_keys, &$action_array, $title, $show_pref)
 594 {
 595     global $color;
 596     global $data_dir, $username;
 597     global $use_icons, $icon_theme;
 598
 599     $show_flag = getPref($data_dir, $username, $show_pref, 0) & 1;
 600     $use_icons_flag = ($use_icons) && ($icon_theme != 'none');
 601     if ($use_icons_flag)
 602         $text_array = array('<img src="' . SM_PATH . 'images/minus.png" border="0" height="7" width="7" />',
 603             '<img src="' . SM_PATH . 'images/plus.png" border="0" height="7" width="7" />');
 604     else
 605         $text_array = array('-', '+');
 606     $toggle_link = asearch_get_toggle_link(!$show_flag, $show_pref, $text_array, array(_("Fold"), _("Unfold")));
 607     if (!$use_icons_flag)
 608         $toggle_link = '<small>[' . $toggle_link . ']</small>';
 609
 610     echo "<br />\n";
 611     echo html_tag('table', '', 'center', $color[9], 'width="95%" cellpadding="1" cellspacing="1" border="0"');
 612     echo html_tag('tr',
 613         html_tag('td', $toggle_link, 'center', $color[5], 'width="5%"')
 614         . html_tag('td', asearch_get_title_display($color, $title), 'center', $color[5], 'colspan=4'));
 615     if ($show_flag) {
 616         $main_key = $query_keys[ASEARCH_WHERE];
 617         $query_count = count($query_array[$main_key]);
 618         for ($query_num = 0, $row_num = 0; $query_num < $query_count; $query_num++) {
 619             if (!empty($query_array[$main_key][$query_num])) {
 620                 echo html_tag('tr', '', '', asearch_get_row_color($color, $row_num));
 621
 622                 unset($search_array);
 623                 foreach ($query_keys as $query_key) {
 624                     $search_array[] = asearch_unserialize($query_array[$query_key][$query_num]);
 625                 }
 626                 $where_array = $search_array[ASEARCH_WHERE];
 627                 $mailbox_array = $search_array[ASEARCH_MAILBOX];
 628                 $what_array = $search_array[ASEARCH_WHAT];
 629                 $unop_array = $search_array[ASEARCH_UNOP];
 630                 $biop_array = asearch_nz($search_array[ASEARCH_BIOP], array());
 631                 $exclude_array = asearch_nz($search_array[ASEARCH_EXCLUDE], array());
 632                 $sub_array = asearch_nz($search_array[ASEARCH_SUB], array());
 633                 $query_display = asearch_get_query_display($color, $mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array, $sub_array);
 634
 635                 echo html_tag('td', $query_num + 1, 'right');
 636                 echo html_tag('td', $query_display, 'center', '', 'width="80%"');
 637                 foreach ($action_array as $action => $action_display) {
 638                     echo html_tag('td', '<a href="' . asearch_get_href('submit=' . $action . '&amp;rownum=' . $query_num) . '">' . $action_display . '</a>', 'center');
 639                 }
 640
 641                 echo '</tr>' . "\n";
 642                 $row_num++;
 643             }
 644         }
 645     }
 646     echo '</table>' . "\n";
 647 }
 648
 649 /** Print the saved array
 650  */
 651 function asearch_print_saved(&$boxes)
 652 {
 653     global $saved_prefkeys;
 654
 655     $saved_array = asearch_read_saved();
 656     if (isset($saved_array[$saved_prefkeys[0]])) {
 657         $saved_count = count($saved_array[$saved_prefkeys[0]]);
 658         if ($saved_count > 0) {
 659             $saved_actions = array('edit_saved' => _("edit"), 'search_saved' => _("search"), 'delete_saved' => _("delete"));
 660             asearch_print_query_array($boxes, $saved_array, $saved_prefkeys, $saved_actions, _("Saved Searches"), 'search_show_saved');
 661         }
 662     }
 663 }
 664
 665 /**
 666  * Print the recent array
 667  */
 668 function asearch_print_recent(&$boxes)
 669 {
 670     global $recent_prefkeys, $search_memory;
 671
 672     $recent_array = asearch_read_recent();
 673     if (isset($recent_array[$recent_prefkeys[0]])) {
 674         $recent_count = count($recent_array[$recent_prefkeys[0]]);
 675         if (min($recent_count, $search_memory) > 0) {
 676             $recent_actions = array('save_recent' => _("save"), 'search_recent' => _("search"), 'forget_recent' => _("forget"));
 677             asearch_print_query_array($boxes, $recent_array, $recent_prefkeys, $recent_actions, _("Recent Searches"), 'search_show_recent');
 678         }
 679     }
 680 }
 681
 682 /** Build an <option> statement
 683  */
 684 function asearch_opt($val, $sel, $tit)
 685 {
 686     return '<option value="' . $val . '"' . ($sel == $val ? ' selected="selected"' : '') . '>' . $tit . '</option>' . "\n";
 687 }
 688
 689 /** Build a <select> statement from an array
 690  */
 691 function asearch_opt_array($var_name, $opt_array, $cur_val)
 692 {
 693     $output = '<select name="' . $var_name . '">' . "\n";
 694     foreach($opt_array as $val => $display)
 695         $output .= asearch_opt($val, $cur_val, asearch_nz($display, $val));
 696     $output .= '</select>' . "\n";
 697     return $output;
 698 }
 699
 700 /** Verify that a mailbox exists
 701  * @return bool mailbox exists
 702  */
 703 function asearch_mailbox_exists($mailbox, &$boxes)
 704 {
 705     foreach ($boxes as $box) {
 706         if ($box['unformatted'] == $mailbox)
 707             return TRUE;
 708     }
 709     return FALSE;
 710 }
 711
 712 /** Build the mailbox select
 713  */
 714 function asearch_get_form_mailbox($imapConnection, &$boxes, $mailbox, $row_num = 0)
 715 {
 716     if (($mailbox != 'All Folders') && (!asearch_mailbox_exists($mailbox, $boxes))) {
 717         $missing = asearch_opt($mailbox, $mailbox, '[' . _("Missing") . '] ' . asearch_get_mailbox_display($mailbox));
 718     } else {
 719         $missing = '';
 720     }
 721     return '<select name="mailbox[' . $row_num . ']">'
 722         . $missing
 723         . asearch_opt('All Folders', $mailbox, '[' . asearch_get_mailbox_display('All Folders') . ']')
 724         . sqimap_mailbox_option_list($imapConnection, array(strtolower($mailbox)), 0, $boxes, NULL)
 725         . '</select>';
 726 }
 727
 728 /** Build the Include subfolders checkbox
 729  * @todo if(function_exists('addCheckBox')) ?
 730  */
 731 function asearch_get_form_sub($sub, $row_num = 0)
 732 {
 733     return function_exists('addCheckBox') ? addCheckBox('sub[' . $row_num .']', $sub)
 734     : '<input type="checkbox" name="sub[' . $row_num .']"' . ($sub ? ' checked="checked"' : '') . ' />';
 735 }
 736
 737 /** Build the 2 unop and where selects
 738  */
 739 function asearch_get_form_location($unop, $where, $row_num = 0)
 740 {
 741     global $imap_asearch_unops, $imap_asearch_options;
 742
 743     return asearch_opt_array('unop[' . $row_num . ']', $imap_asearch_unops, $unop)
 744         . asearch_opt_array('where[' . $row_num . ']', $imap_asearch_options, $where);
 745 }
 746
 747 /** Build the what text input
 748  */
 749 function asearch_get_form_what($what, $row_num = 0)
 750 {
 751     return function_exists('addInput') ? addInput('what[' . $row_num . ']', $what, '35')
 752     : '<input type="text" size="35" name="what[' . $row_num . ']" value="' . htmlspecialchars($what) . '" />';
 753 }
 754
 755 /** Build the Exclude criteria checkbox
 756  * @todo if(function_exists('addCheckBox')) ?
 757  */
 758 function asearch_get_form_exclude($exclude, $row_num = 0)
 759 {
 760     return function_exists('addCheckBox') ? addCheckBox('exclude['.$row_num.']', $exclude)
 761     : '<input type="checkbox" name="exclude[' . $row_num .']"' . ($exclude ? ' checked="checked"' : '') . ' />';
 762 }
 763
 764 /** Print one advanced form row
 765  */
 766 function asearch_print_form_row($imapConnection, &$boxes, $mailbox, $biop, $unop, $where, $what, $exclude, $sub, $row_num)
 767 {
 768     global $imap_asearch_biops_in;
 769     global $color;
 770
 771     echo html_tag('tr', '', '', $color[4]);
 772
 773 //Binary operator
 774     echo html_tag('td', $row_num ?
 775             asearch_opt_array('biop[' . $row_num . ']', $imap_asearch_biops_in, $biop)
 776             : '<b>' . _("In") . '</b>', 'center') . "\n";
 777
 778 //Mailbox list and Include Subfolders
 779     echo html_tag('td',
 780             asearch_get_form_mailbox($imapConnection, $boxes, $mailbox, $row_num)
 781         . _("and&nbsp;subfolders:") . asearch_get_form_sub($sub, $row_num), 'center') . "\n";
 782
 783 //Unary operator and Search location
 784     echo html_tag('td', asearch_get_form_location($unop, $where, $row_num), 'center') . "\n";
 785
 786 //Text input
 787     echo html_tag('td', asearch_get_form_what($what, $row_num), 'center') . "\n";
 788
 789 //Exclude criteria
 790     echo html_tag('td', _("Exclude Criteria:") . asearch_get_form_exclude($exclude, $row_num), 'center') . "\n";
 791
 792     echo "</tr>\n";
 793 }
 794
 795 /** Print the advanced search form
 796  */
 797 function asearch_print_form($imapConnection, &$boxes, $mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array, $sub_array)
 798 {
 799     global $search_button_html, $add_criteria_button_html, $del_excluded_button_html, $del_all_button_html;
 800     global $color;
 801
 802 //Search Form
 803     echo "<br />\n";
 804     echo '<form action="' . asearch_get_href() . '" name="form_asearch">' . "\n";
 805
 806     echo html_tag('table', '', 'center', $color[9], 'width="100%" cellpadding="1" cellspacing="1" border="0"');
 807     echo html_tag('tr', html_tag('td', asearch_get_title_display($color, _("Search Criteria")), 'center', $color[5], 'colspan=5'));
 808     $row_count = count($where_array);
 809     for ($row_num = 0; $row_num < $row_count; $row_num++) {
 810         $mailbox = asearch_nz($mailbox_array[$row_num]);
 811         $biop = strip_tags(asearch_nz($biop_array[$row_num]));
 812         $unop = strip_tags(asearch_nz($unop_array[$row_num]));
 813         $where = strip_tags(asearch_nz($where_array[$row_num]));
 814         $what = asearch_nz($what_array[$row_num]);
 815         $exclude = strip_tags(asearch_nz($exclude_array[$row_num]));
 816         $sub = strip_tags(asearch_nz($sub_array[$row_num]));
 817         asearch_print_form_row($imapConnection, $boxes, $mailbox, $biop, $unop, $where, $what, $exclude, $sub, $row_num);
 818     }
 819     echo '</table>' . "\n";
 820
 821 //Submit buttons
 822     echo html_tag('table', '', 'center', $color[9], 'width="100%" cellpadding="1" cellspacing="0" border="0"');
 823     echo html_tag('tr',
 824                 html_tag('td', getButton('submit', 'submit', $search_button_html), 'center') . "\n"
 825             . html_tag('td', getButton('submit', 'submit', $add_criteria_button_html), 'center') . "\n"
 826             . html_tag('td', getButton('submit', 'submit', $del_all_button_html), 'center') . "\n"
 827             . html_tag('td', getButton('submit', 'submit', $del_excluded_button_html), 'center') . "\n"
 828             );
 829     echo '</table>' . "\n";
 830     echo '</form>' . "\n";
 831 }
 832
 833 /** Print one basic form row
 834  */
 835 function asearch_print_form_row_basic($imapConnection, &$boxes, $mailbox, $biop, $unop, $where, $what, $exclude, $sub, $row_num)
 836 {
 837     global $search_button_html;
 838     global $color;
 839
 840     echo html_tag('tr', '', '', $color[4]);
 841
 842 //Mailbox list
 843     echo html_tag('td', '<b>' . _("In") . '</b> ' . asearch_get_form_mailbox($imapConnection, $boxes, $mailbox), 'center') . "\n";
 844
 845 //Unary operator and Search location
 846     echo html_tag('td', asearch_get_form_location($unop, $where), 'center') . "\n";
 847
 848 //Text input
 849     echo html_tag('td', asearch_get_form_what($what), 'center') . "\n";
 850
 851 //Submit button
 852     echo html_tag('td', getButton('submit', 'submit', $search_button_html), 'center') . "\n";
 853
 854     echo "</tr>\n";
 855 }
 856
 857 /** Print the basic search form
 858  */
 859 function asearch_print_form_basic($imapConnection, &$boxes, $mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array, $sub_array)
 860 {
 861     global $color;
 862
 863 //Search Form
 864     echo "<br />\n";
 865     echo '<form action="' . asearch_get_href() . '" name="form_asearch">' . "\n";
 866
 867     echo html_tag('table', '', 'center', $color[9], 'width="100%" cellpadding="1" cellspacing="1" border="0"');
 868     //echo html_tag('tr', html_tag('td', asearch_get_title_display($color, _("Search Criteria")), 'center', $color[5], 'colspan=4'));
 869     $row_count = count($where_array);
 870     for ($row_num = 0; $row_num < $row_count; $row_num++) {
 871         $mailbox = asearch_nz($mailbox_array[$row_num]);
 872         $biop = strip_tags(asearch_nz($biop_array[$row_num]));
 873         $unop = strip_tags(asearch_nz($unop_array[$row_num]));
 874         $where = strip_tags(asearch_nz($where_array[$row_num]));
 875         $what = asearch_nz($what_array[$row_num]);
 876         $exclude = strip_tags(asearch_nz($exclude_array[$row_num]));
 877         $sub = strip_tags(asearch_nz($sub_array[$row_num]));
 878         asearch_print_form_row_basic($imapConnection, $boxes, $mailbox, $biop, $unop, $where, $what, $exclude, $sub, $row_num);
 879     }
 880     echo '</table>' . "\n";
 881     echo '</form>' . "\n";
 882 }
 883
 884
 885 /**
 886  * @param array $boxes mailboxes array (reference)
 887  * @return array selectable unformatted mailboxes names
 888  */
 889 function sqimap_asearch_get_selectable_unformatted_mailboxes(&$boxes)
 890 {
 891     $mboxes_array = array();
 892     $boxcount = count($boxes);
 893     for ($boxnum = 0; $boxnum < $boxcount; $boxnum++) {
 894         if (!in_array('noselect', $boxes[$boxnum]['flags']))
 895             $mboxes_array[] = $boxes[$boxnum]['unformatted'];
 896     }
 897     return $mboxes_array;
 898 }
 899
 900 /* ------------------------ main ------------------------ */
 901 /* get globals we will need */
 902 sqgetGlobalVar('username', $username, SQ_SESSION);
 903 sqgetGlobalVar('key', $key, SQ_COOKIE);
 904 sqgetGlobalVar('delimiter', $delimiter, SQ_SESSION);
 905 sqgetGlobalVar('onetimepad', $onetimepad, SQ_SESSION);
 906
 907 if ( sqgetGlobalVar('checkall', $temp, SQ_GET) ) {
 908     $checkall = (int) $temp;
 909 }
 910
 911 /**
 912  * Retrieve the mailbox cache from the session.
 913  */
 914 sqgetGlobalVar('mailbox_cache',$mailbox_cache,SQ_SESSION);
 915
 916
 917 $search_button_html = _("Search");
 918 $search_button_text = asearch_unhtmlentities($search_button_html);
 919 $add_criteria_button_html = _("Add New Criteria");
 920 $add_criteria_button_text = asearch_unhtmlentities($add_criteria_button_html);
 921 $del_excluded_button_html = _("Remove Excluded Criteria");
 922 $del_excluded_button_text = asearch_unhtmlentities($del_excluded_button_html);
 923 $del_all_button_html = _("Remove All Criteria");
 924 $del_all_button_text = asearch_unhtmlentities($del_all_button_html);
 925
 926 /** Maximum number of recent searches to handle
 927  * Default 0
 928  * @global integer $search_memory
 929  */
 930 $search_memory = getPref($data_dir, $username, 'search_memory', 0);
 931
 932 /** Advanced search control
 933  * - 0 => allow basic interface only
 934  * - 1 => allow advanced interface only
 935  * - 2 => allow both
 936  * Default 2
 937  */
 938 $allow_advanced_search = asearch_nz($allow_advanced_search, 2);
 939
 940 /**
 941  * Toggle advanced/basic search
 942  */
 943 if (sqgetGlobalVar('advanced', $search_advanced, SQ_GET)) {
 944     setPref($data_dir, $username, 'search_advanced', $search_advanced & 1);
 945 }
 946 /** If 1, show advanced search interface
 947  * Default from allow_advanced_search pref
 948  * @global integer $search_advanced
 949  */
 950 if ($allow_advanced_search > 1) {
 951     $search_advanced = getPref($data_dir, $username, 'search_advanced', 0);
 952 } else {
 953     $search_advanced = $allow_advanced_search;
 954 }
 955 if ($search_advanced) {
 956 /** Set recent prefkeys according to $search_advanced
 957  * @global array $recent_prefkeys
 958  */
 959     $recent_prefkeys = array('asearch_recent_where', 'asearch_recent_mailbox', 'asearch_recent_what', 'asearch_recent_unop', 'asearch_recent_biop', 'asearch_recent_exclude', 'asearch_recent_sub');
 960
 961 /** Set saved prefkeys according to $search_advanced
 962  * @global array $saved_prefkeys
 963  */
 964     $saved_prefkeys = array('asearch_saved_where', 'asearch_saved_mailbox', 'asearch_saved_what', 'asearch_saved_unop', 'asearch_saved_biop', 'asearch_saved_exclude', 'asearch_saved_sub');
 965
 966 /*$asearch_prefkeys = array('where', 'mailbox', 'what', 'biop', 'unop', 'exclude', 'sub');*/
 967 } else {
 968     $recent_prefkeys = array('search_where', 'search_folder', 'search_what', 'search_unop');
 969     $saved_prefkeys = array('saved_where', 'saved_folder', 'saved_what', 'saved_unop');
 970 }
 971
 972 /** How we did enter the form
 973  * - unset : Enter key, or called from outside (eg read_body)
 974  * - $search_button_text : Search button
 975  * - 'Search_no_update' : Search but don't update recent
 976  * - 'Search_last' : Same as no_update but reload and search last
 977  * - 'Search_silent' : Same as no_update but only display results
 978  * - $add_criteria_button_text : Add New Criteria button
 979  * - $del_excluded_button_text : Remove Excluded Criteria button
 980  * - $del_all_button_text : Remove All Criteria button
 981  * - 'save_recent'
 982  * - 'search_recent'
 983  * - 'forget_recent'
 984  * - 'edit_saved'
 985  * - 'search_saved'
 986  * - 'delete_saved'
 987  * @global string $submit
 988  */
 989 $searchpressed = false;
 990 if (isset($_GET['submit'])) {
 991     $submit = strip_tags($_GET['submit']);
 992 }
 993
 994 /** Searched mailboxes
 995  * @global array $mailbox_array
 996  */
 997 if (isset($_GET['mailbox'])) {
 998     $mailbox_array = $_GET['mailbox'];
 999     $targetmailbox = $_GET['mailbox'];
1000     if (!is_array($mailbox_array)) {
1001         $mailbox_array = array($mailbox_array);
1002     }
1003 } else {
1004     $mailbox_array = array();
1005     $targetmailbox = array();
1006 }
1007 $aMailboxGlobalPref = array(
1008                        MBX_PREF_SORT         => 0,
1009                        MBX_PREF_LIMIT        => (int)  $show_num,
1010                        MBX_PREF_AUTO_EXPUNGE => (bool) $auto_expunge,
1011                        MBX_PREF_INTERNALDATE => (bool) getPref($data_dir, $username, 'internal_date_sort')
1012                     // MBX_PREF_FUTURE       => (var)  $future
1013                      );
1014
1015 /**
1016  * system wide admin settings and incoming vars.
1017  */
1018 $aConfig = array(
1019                 'allow_thread_sort' => $allow_thread_sort,
1020                 'allow_server_sort' => $allow_server_sort,
1021                 'user'              => $username,
1022                 'setindex'          => 1
1023                 );
1024
1025 /** Binary operators
1026  * @global array $biop_array
1027  */
1028 if (isset($_GET['biop'])) {
1029     $biop_array = $_GET['biop'];
1030     if (!is_array($biop_array))
1031         $biop_array = array($biop_array);
1032 } else {
1033     $biop_array = array();
1034 }
1035 /** Unary operators
1036  * @global array $unop_array
1037  */
1038 if (isset($_GET['unop'])) {
1039     $unop_array = $_GET['unop'];
1040     if (!is_array($unop_array))
1041         $unop_array = array($unop_array);
1042 } else {
1043     $unop_array = array();
1044 }
1045 /** Where to search
1046  * @global array $where_array
1047  */
1048 if (isset($_GET['where'])) {
1049     $where_array = $_GET['where'];
1050     if (!is_array($where_array)) {
1051         $where_array = array($where_array);
1052     }
1053 } else {
1054     $where_array = array();
1055 }
1056 /** What to search
1057  * @global array $what_array
1058  */
1059 if (isset($_GET['what'])) {
1060     $what_array = $_GET['what'];
1061     if (!is_array($what_array)) {
1062         $what_array = array($what_array);
1063     }
1064 } else {
1065     $what_array = array();
1066 }
1067 /** Whether to exclude this criteria from search
1068  * @global array $exclude_array
1069  */
1070 if (isset($_GET['exclude'])) {
1071     $exclude_array = $_GET['exclude'];
1072 } else {
1073     $exclude_array = array();
1074 }
1075 /** Search within subfolders
1076  * @global array $sub_array
1077  */
1078 if (isset($_GET['sub'])) {
1079     $sub_array = $_GET['sub'];
1080 } else {
1081     $sub_array = array();
1082 }
1083 /** Row number used by recent and saved stuff
1084  */
1085 if (isset($_GET['rownum'])) {
1086     $submit_rownum = strip_tags($_GET['rownum']);
1087 }
1088 /** Change global sort
1089  */
1090 if (sqgetGlobalVar('srt', $temp, SQ_GET)) {
1091     $srt = (int) $temp;
1092     asearch_edit_last(1);
1093 //    asearch_push_recent($mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array, $sub_array);
1094 }
1095 if (sqgetGlobalVar('startMessage', $temp, SQ_GET)) {
1096     $startMessage = (int) $temp;
1097     asearch_edit_last(1);
1098 //    asearch_push_recent($mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array, $sub_array);
1099 }
1100
1101 if ( sqgetGlobalVar('showall', $temp, SQ_GET) ) {
1102     $showall = (int) $temp;
1103     asearch_edit_last(1);
1104 //    asearch_push_recent($mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array, $sub_array);
1105 }
1106
1107 if ( sqgetGlobalVar('account', $temp,  SQ_GET) ) {
1108     $iAccount = (int) $temp;
1109 } else {
1110     $iAccount = 0;
1111 }
1112
1113 /**
1114  * Which templatedir are we using. TODO, add make a config var of this and make it possible to switch templates
1115  */
1116 $sTplDir = SM_PATH . 'templates/default/';
1117
1118
1119 /**
1120  * Incoming submit buttons from the message list with search results
1121  */
1122 if (sqgetGlobalVar('moveButton',      $moveButton,      SQ_POST) ||
1123     sqgetGlobalVar('expungeButton',   $expungeButton,   SQ_POST) ||
1124     sqgetGlobalVar('delete',          $markDelete,      SQ_POST) ||
1125     sqgetGlobalVar('undeleteButton',  $undeleteButton,  SQ_POST) ||
1126     sqgetGlobalVar('markRead',        $markRead,        SQ_POST) ||
1127     sqgetGlobalVar('markUnread',      $markUnread,      SQ_POST) ||
1128     sqgetGlobalVar('markFlagged',     $markFlagged,     SQ_POST) ||
1129     sqgetGlobalVar('markUnflagged',   $markUnflagged,   SQ_POST) ||
1130     sqgetGlobalVar('attache',         $attache,         SQ_POST)) {
1131     asearch_edit_last(1);
1132     $submit = '';
1133     asearch_push_recent($mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array, $sub_array);
1134 }
1135
1136
1137
1138 /** Toggle show/hide saved searches
1139  */
1140 if (sqgetGlobalVar('search_show_saved', $search_show_saved, SQ_GET)) {
1141     setPref($data_dir, $username, 'search_show_saved', $search_show_saved & 1);
1142 }
1143 /** Toggle show/hide recent searches
1144  */
1145 if (sqgetGlobalVar('search_show_recent', $search_show_recent, SQ_GET)) {
1146     setPref($data_dir, $username, 'search_show_recent', $search_show_recent & 1);
1147 }
1148 // end of get globals
1149
1150 /** If TRUE, do not show search interface
1151  * Default FALSE
1152  * @global bool $search_silent
1153  */
1154 $search_silent = FALSE;
1155
1156 /*  See how the page was called and fire off correct function  */
1157 if ((empty($submit)) && (!empty($where_array))) {
1158     /* This happens when the Enter key is used or called from outside */
1159     $submit = $search_button_text;
1160     /* Hack needed to handle coming back from read_body et als */
1161     if (count($where_array) != count($unop_array)) {
1162         /**
1163          * Hack to use already existen where and what vars.
1164          * where now contains the initiator page of the messagelist
1165          * and in this case 'search'. what contains an index to access
1166          * the search history
1167          */
1168
1169         sqgetGlobalVar('what',$what,SQ_GET);
1170         asearch_edit_last($what);
1171     }
1172 }
1173
1174 if (!isset($submit)) {
1175     $submit = '';
1176 } else {
1177     switch ($submit) {
1178       case $search_button_text:
1179         if (asearch_check_query($where_array, $what_array, $exclude_array) == '') {
1180             asearch_push_recent($mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array, $sub_array);
1181         }
1182         break;
1183       case 'Search_silent':
1184         $search_silent = TRUE;
1185         /*nobreak;*/
1186       case 'Search_no_update':
1187         $submit = $search_button_text;
1188         break;
1189       case $del_excluded_button_text:
1190         $delarray = array_keys($exclude_array);
1191         while (!empty($delarray)) {
1192             $delrow = array_pop($delarray);
1193             array_splice($mailbox_array, $delrow, 1);
1194             array_splice($biop_array, $delrow, 1);
1195             array_splice($unop_array, $delrow, 1);
1196             array_splice($where_array, $delrow, 1);
1197             array_splice($what_array, $delrow, 1);
1198             /* array_splice($exclude_array, $delrow, 1);*/ /* There is still some php magic that eludes me */
1199             array_splice($sub_array, $delrow, 1);
1200         }
1201         $exclude_array = array();
1202         break;
1203       case $del_all_button_text:
1204         $mailbox_array = array();
1205         $biop_array = array();
1206         $unop_array = array();
1207         $where_array = array();
1208         $what_array = array();
1209         $exclude_array = array();
1210         $sub_array = array();
1211         break;
1212       case 'save_recent':
1213         asearch_save_recent($submit_rownum);
1214         break;
1215       case 'search_recent':
1216         $submit = $search_button_text;
1217         asearch_edit_recent($submit_rownum);
1218         asearch_push_recent($mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array, $sub_array);
1219         break;
1220       case 'edit_recent': /* no link to do this, yet */
1221         asearch_edit_recent($submit_rownum);
1222         break;
1223       case 'forget_recent':
1224         asearch_forget_recent($submit_rownum);
1225         break;
1226       case 'search_saved':
1227         $submit = $search_button_text;
1228         asearch_edit_saved($submit_rownum);
1229         asearch_push_recent($mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array, $sub_array);
1230         break;
1231       case 'edit_saved':
1232         asearch_edit_saved($submit_rownum);
1233         break;
1234       case 'delete_saved':
1235         asearch_delete_saved($submit_rownum);
1236         break;
1237     }
1238 }
1239
1240 //Texts in both basic and advanced form
1241 $imap_asearch_unops = array(
1242     '' => '',
1243     'NOT' => _("Not")
1244 );
1245
1246 if ($search_advanced) {
1247     //Texts in advanced form only
1248     $imap_asearch_options = array(
1249         //<message set>,
1250         //'ALL' is binary operator
1251         'ANSWERED' => _("Answered"),
1252         'BCC' => _("Bcc"),
1253         'BEFORE' => _("Before"),
1254         'BODY' => _("Message Body"),
1255         'CC' => _("Cc"),
1256         'DELETED' => _("Deleted"),
1257         'DRAFT' => _("Draft"),
1258         'FLAGGED' => _("Flagged"),
1259         'FROM' => _("Sent By"),
1260         'HEADER' => _("Header Field"),
1261         'KEYWORD' => _("Keyword"),
1262         'LARGER' => _("Larger Than"),
1263         'NEW' => _("New"),
1264         //'NOT' is unary operator
1265         'OLD' => _("Old"),
1266         'ON' => _("On"),
1267         //'OR' is binary operator
1268         'RECENT' => _("Recent"),
1269         'SEEN' => _("Seen"),
1270         'SENTBEFORE' => _("Sent Before"),
1271         'SENTON' => _("Sent On"),
1272         'SENTSINCE' => _("Sent Since"),
1273         'SINCE' => _("Since"),
1274         'SMALLER' => _("Smaller Than"),
1275         'SUBJECT' => _("Subject Contains"),
1276         'TEXT' => _("Header and Body"),
1277         'TO' => _("Sent To"),
1278         //'UID' => 'anum',
1279 /*        'UNANSWERED' => '',
1280         'UNDELETED' => '',
1281         'UNDRAFT' => '',
1282         'UNFLAGGED' => '',
1283         'UNKEYWORD' => _("Unkeyword"),
1284         'UNSEEN' => _("Unseen"),*/
1285     );
1286
1287     $imap_asearch_biops_in = array(
1288         'ALL' => _("And In"),
1289         'OR' => _("Or In")
1290     );
1291
1292     $imap_asearch_biops = array(
1293         'ALL' => _("And"),
1294         'OR' => _("Or")
1295     );
1296 } else {
1297     //Texts in basic form only
1298     $imap_asearch_options = array(
1299         'BCC' => _("Bcc"),
1300         'BODY' => _("Body"),
1301         'CC' => _("Cc"),
1302         'FROM' => _("From"),
1303         'SUBJECT' => _("Subject"),
1304         'TEXT' => _("Everywhere"),
1305         'TO' => _("To"),
1306     );
1307 }
1308
1309 uasort($imap_asearch_options, 'asearch_unhtml_strcoll');
1310
1311 /* open IMAP connection */
1312 $imapConnection = sqimap_login($username, $key, $imapServerAddress, $imapPort, 0);
1313
1314
1315 /* get mailboxes once here */
1316 $boxes = sqimap_mailbox_list($imapConnection);
1317 /* ensure we have a valid default mailbox name */
1318 $mailbox = asearch_nz($mailbox_array[0]);
1319 if (($mailbox == '') || ($mailbox == 'None')) //Workaround for sm quirk IMHO (what if I really have a mailbox called None?)
1320     $mailbox = $boxes[0]['unformatted']; //Usually INBOX ;)
1321
1322
1323 /**
1324 * Handle form actions like flag / unflag, seen / unseen, delete
1325 */
1326 if (sqgetGlobalVar('mailbox',$postMailbox,SQ_POST)) {
1327     if ($postMailbox) {
1328         /**
1329         * system wide admin settings and incoming vars.
1330         */
1331         $aConfig = array(
1332                         'user'              => $username,
1333                         );
1334         $aConfig['setindex'] = 1; // $what $where = 'search'
1335         /**
1336          * Set the max cache size to the number of mailboxes to avoid cache cleanups
1337          * when searching all mailboxes
1338          */
1339         $aConfig['max_cache_size'] = count($boxes) +1;
1340
1341         $aMailbox = sqm_api_mailbox_select($imapConnection, $iAccount, $postMailbox,$aConfig,array());
1342         $sError = handleMessageListForm($imapConnection,$aMailbox);
1343         /* add the mailbox to the cache */
1344         $mailbox_cache[$iAccount.'_'.$aMailbox['NAME']] = $aMailbox;
1345
1346         if ($sError) {
1347             $note = $sError;
1348         }
1349     }
1350 }
1351
1352 if (isset($aMailbox['FORWARD_SESSION'])) {
1353     /* add the mailbox to the cache */
1354     $mailbox_cache[$iAccount.'_'.$aMailbox['NAME']] = $aMailbox;
1355     sqsession_register($mailbox_cache,'mailbox_cache');
1356
1357     if ($compose_new_win) {
1358         // write the session in order to make sure that the compose window has
1359         // access to the composemessages array which is stored in the session
1360         session_write_close();
1361         // restart the session. Do not use sqsession_is_active because the session_id
1362         // isn't empty after a session_write_close
1363         sqsession_start();
1364
1365         if (!preg_match("/^[0-9]{3,4}$/", $compose_width)) {
1366             $compose_width = '640';
1367         }
1368         if (!preg_match("/^[0-9]{3,4}$/", $compose_height)) {
1369             $compose_height = '550';
1370         }
1371         // do not use &amp;, it will break the query string and $session will not be detected!!!
1372         $comp_uri = SM_PATH . 'src/compose.php?mailbox='. urlencode($mailbox).
1373                     '&session='.$aMailbox['FORWARD_SESSION'];
1374         displayPageHeader($color, $mailbox, "comp_in_new('$comp_uri', $compose_width, $compose_height);", false);
1375     } else {
1376         // save mailboxstate
1377         sqsession_register($aMailbox,'aLastSelectedMailbox');
1378         session_write_close();
1379         // we have to redirect to the compose page
1380         $location = SM_PATH . 'src/compose.php?mailbox='. urlencode($mailbox).
1381                     '&amp;session='.$aMailbox['FORWARD_SESSION'];
1382         header("Location: $location");
1383         exit;
1384     }
1385 } else {
1386     displayPageHeader($color, $mailbox);
1387 //    $compose_uri = $base_uri.'src/compose.php?newmessage=1';
1388 }
1389
1390 if (isset($note)) {
1391     echo html_tag( 'div', '<b>' . htmlspecialchars($note) .'</b>', 'center' ) . "<br />\n";
1392 }
1393
1394
1395 do_hook('search_before_form');
1396
1397 if (!$search_silent) {
1398     //Add a link to the other search mode if allowed
1399     if ($allow_advanced_search > 1)
1400         $toggle_link = ' - <small>['
1401             . asearch_get_toggle_link(!$search_advanced, 'advanced', array(_("Standard search"), _("Advanced search")))
1402             . ']</small>';
1403     else
1404         $toggle_link = '';
1405
1406     echo html_tag('table',
1407                 html_tag('tr', "\n"
1408                 . html_tag('td', asearch_get_title_display($color, _("Search")) . $toggle_link, 'center', $color[0])
1409                     ) ,
1410                 '', '', 'width="100%"') . "\n";
1411     asearch_print_saved($boxes);
1412     asearch_print_recent($boxes);
1413     if (empty($where_array)) {
1414         global $sent_folder;
1415
1416         $mailbox_array[0] = $mailbox;
1417         $biop_array[0] = '';
1418         $unop_array[0] = '';
1419         if ($mailbox == $sent_folder) {
1420             $where_array[0] = 'TO';
1421         } else {
1422             $where_array[0] = 'FROM';
1423         }
1424         $what_array[0] = '';
1425         $exclude_array[0] = '';
1426         $sub_array[0] = '';
1427     }
1428     //Display advanced or basic form
1429     if ($search_advanced) {
1430         if ($submit == $add_criteria_button_text) {
1431             $last_index = max(count($where_array) - 1, 0);
1432             $mailbox_array[] = asearch_nz($mailbox_array[$last_index]);
1433             $biop_array[] = asearch_nz($biop_array[$last_index]);
1434             $unop_array[] = asearch_nz($unop_array[$last_index]);
1435             $where_array[] = asearch_nz($where_array[$last_index]);
1436             $what_array[] = asearch_nz($what_array[$last_index]);
1437             $exclude_array[] = asearch_nz($exclude_array[$last_index]);
1438             $sub_array[] = asearch_nz($sub_array[$last_index]);
1439         }
1440         asearch_print_form($imapConnection, $boxes, $mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array, $sub_array);
1441     } else {
1442         asearch_print_form_basic($imapConnection, $boxes, $mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array, $sub_array);
1443     }
1444 }
1445
1446 do_hook('search_after_form');
1447
1448 if ($submit == $search_button_text) {
1449     $msgsfound = false;
1450     echo html_tag('table', '', 'center', $color[9], 'width="100%" cellpadding="1" cellspacing="0" border="0"');
1451     echo html_tag('tr', html_tag('td', asearch_get_title_display($color, _("Search Results")), 'center', $color[5]));
1452     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]));
1453     echo '</table>' . "\n";
1454
1455     flush();
1456     $iMsgCnt = 0;
1457     $query_error = asearch_check_query($where_array, $what_array, $exclude_array);
1458     if ($query_error != '') {
1459         echo '<br />' . html_tag('div', asearch_get_error_display($color, $query_error), 'center') . "\n";
1460     } else {
1461         $mboxes_array = sqimap_asearch_get_selectable_unformatted_mailboxes($boxes);
1462         /**
1463          * Retrieve the search queries
1464          */
1465         $mboxes_mailbox = sqimap_asearch($imapConnection, $mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array, $sub_array, $mboxes_array);
1466         foreach($mboxes_mailbox as $mbx => $search) {
1467
1468             /**
1469             * until there is no per mailbox option screen to set prefs we override
1470             * the mailboxprefs by the default ones
1471             */
1472
1473             $aMailboxPrefSer=getPref($data_dir, $username,'pref_'.$iAccount.'_'.$mbx);
1474             if ($aMailboxPrefSer) {
1475                 $aMailboxPref = unserialize($aMailboxPrefSer);
1476                 $aMailboxPref[MBX_PREF_COLUMNS] = $index_order;
1477             } else {
1478                 setUserPref($username,'pref_'.$iAccount.'_'.$mbx,serialize($default_mailbox_pref));
1479                 $aMailboxPref = $default_mailbox_pref;
1480             }
1481             if (isset($srt) && $targetmailbox == $mbx) {
1482                 $aMailboxPref[MBX_PREF_SORT] = (int) $srt;
1483             }
1484
1485             $trash_folder = (isset($trash_folder)) ? $trash_folder : false;
1486             $sent_folder = (isset($sent_folder)) ? $sent_folder : false;
1487             $draft_folder = (isset($draft_folder)) ? $draft_folder : false;
1488
1489
1490             /**
1491             * until there is no per mailbox option screen to set prefs we override
1492             * the mailboxprefs by the default ones
1493             */
1494             $aMailboxPref[MBX_PREF_LIMIT] = (int)  $show_num;
1495             $aMailboxPref[MBX_PREF_AUTO_EXPUNGE] = (bool) $auto_expunge;
1496             $aMailboxPref[MBX_PREF_INTERNALDATE] = (bool) getPref($data_dir, $username, 'internal_date_sort');
1497             $aMailboxPref[MBX_PREF_COLUMNS] = $index_order;
1498
1499             /**
1500             * Replace From => To  in case it concerns a draft or sent folder
1501             */
1502             if (($mbx == $sent_folder || $mbx == $draft_folder) &&
1503                 !in_array(SQM_COL_TO,$aMailboxPref[MBX_PREF_COLUMNS])) {
1504                 $aNewOrder = array(); // nice var name ;)
1505                 foreach($aMailboxPref[MBX_PREF_COLUMNS] as $iCol) {
1506                     if ($iCol == SQM_COL_FROM) {
1507                         $iCol = SQM_COL_TO;
1508                     }
1509                     $aNewOrder[] = $iCol;
1510                 }
1511                 $aMailboxPref[MBX_PREF_COLUMNS] = $aNewOrder;
1512                 setUserPref($username,'pref_'.$iAccount.'_'.$mbx,serialize($aMailboxPref));
1513             }
1514
1515             $aConfig['search'] = $search['search'];
1516             $aConfig['charset'] = $search['charset'];
1517
1518             /**
1519              * Set the max cache size to the number of mailboxes to avoid cache cleanups
1520              * when searching all mailboxes
1521              */
1522             $aConfig['max_cache_size'] = count($mboxes_mailbox) +1;
1523             if (isset($startMessage) && $targetmailbox == $mbx) {
1524                 $aConfig['offset'] = $startMessage;
1525             } else {
1526                 $aConfig['offset'] = 0;
1527             }
1528             if (isset($showall) && $targetmailbox == $mbx) {
1529                 $aConfig['showall'] = $showall;
1530             } else {
1531                 if (isset($aConfig['showall'])) {
1532                     unset($aConfig['showall']);
1533                 }
1534                 $showall = false;
1535             }
1536
1537             /**
1538             * Set the config options for the messages list
1539             */
1540             $aColumns = array();
1541             foreach ($aMailboxPref[MBX_PREF_COLUMNS] as $iCol) {
1542                 $aColumns[$iCol] = array();
1543                 switch ($iCol) {
1544                     case SQM_COL_SUBJ:
1545                         if ($truncate_subject) {
1546                             $aColumns[$iCol]['truncate'] = $truncate_subject;
1547                         }
1548                         break;
1549                     case SQM_COL_FROM:
1550                     case SQM_COL_TO:
1551                     case SQM_COL_CC:
1552                     case SQM_COL_BCC:
1553                         if ($truncate_sender) {
1554                             $aColumns[$iCol]['truncate'] = $truncate_sender;
1555                         }
1556                         break;
1557                 }
1558             }
1559
1560
1561             $aProps = array(
1562                 'columns' => $aColumns,
1563                 'config'  => array('alt_index_colors'      => $alt_index_colors,
1564                                     'highlight_list'        => $message_highlight_list,
1565                                     'fancy_index_highlite'  => $fancy_index_highlite,
1566                                     'show_flag_buttons'     => (isset($show_flag_buttons)) ? $show_flag_buttons : true,
1567                                     'lastTargetMailbox'     => (isset($lastTargetMailbox)) ? $lastTargetMailbox : '',
1568                                     'trash_folder'          => $trash_folder,
1569                                     'sent_folder'           => $sent_folder,
1570                                     'draft_folder'          => $draft_folder,
1571                                     'enablesort'            => true,
1572                                     'color'                 => $color
1573                             ),
1574                 'mailbox' => $mbx,
1575                 'account' => (isset($iAccount)) ? $iAccount : 0,
1576                 'module' => 'read_body',
1577                 'email'  => false);
1578
1579
1580             $aMailbox = sqm_api_mailbox_select($imapConnection, $iAccount, $mbx,$aConfig,$aMailboxPref);
1581
1582             $iError = 0;
1583             $aTemplate = showMessagesForMailbox($imapConnection, $aMailbox,$aProps, $iError);
1584
1585             // in th future we can make use of multiple message sets, now set it to 1 for search.
1586             $iSetIndex = 1;
1587             if (isset($aMailbox['UIDSET'][$iSetIndex])) {
1588                 $iMsgCnt += count($aMailbox['UIDSET'][$iSetIndex]);
1589             }
1590             if ($iError) {
1591                 // error handling
1592             } else {
1593                 /**
1594                 * In the future, move this the the initialisation area
1595                 */
1596                 sqgetGlobalVar('align',$align,SQ_SESSION);
1597
1598                 $oTemplate = new Template($sTplDir);
1599
1600                 if ($aMailbox['EXISTS'] > 0) {
1601                     if ($iError) {
1602                        // TODO
1603                        echo "ERROR occured, errorhandler will be implemented very soon";
1604                     } else {
1605                         foreach ($aTemplate as $k => $v) {
1606                             $oTemplate->assign($k, $v);
1607                         }
1608                         $oTemplate->assign('page_selector',  $page_selector);
1609                         $oTemplate->assign('page_selector_max', $page_selector_max);
1610                         $oTemplate->assign('compact_paginator', $compact_paginator);
1611                         $oTemplate->assign('javascript_on', $javascript_on);
1612                         $oTemplate->assign('enablesort', (isset($aProps['config']['enablesort'])) ? $aProps['config']['enablesort'] : false);
1613                         // Aaaaaahhhhhhh FIX ME DO NOT USE the string "none" for a var when you mean the boolean false or null
1614                         $oTemplate->assign('icon_theme', (isset($icon_theme) && $icon_theme !== 'none') ? $icon_theme : false);
1615                         $oTemplate->assign('use_icons', (isset($use_icons)) ? $use_icons : false);
1616                         $oTemplate->assign('aOrder', array_keys($aColumns));
1617                         $oTemplate->assign('alt_index_colors', isset($alt_index_colors) ? $alt_index_colors: false);
1618                         $oTemplate->assign('color', $color);
1619                         $oTemplate->assign('align', $align);
1620
1621                         $mailbox_display = asearch_get_mailbox_display($aMailbox['NAME']);
1622                         if (strtoupper($mbx) == 'INBOX') {
1623                             $mailbox_display = _("INBOX");
1624                         } else {
1625                             $mailbox_display = imap_utf7_decode_local($mbx);
1626                         }
1627
1628                         echo '<br /><b><big>' . _("Folder:") . ' '. $mailbox_display . '&nbsp;</big></b>';
1629
1630                         $oTemplate->display('message_list.tpl');
1631                     }
1632                 }
1633             }
1634
1635             /* add the mailbox to the cache */
1636             $mailbox_cache[$iAccount.'_'.$aMailbox['NAME']] = $aMailbox;
1637
1638         }
1639     }
1640     if(!$iMsgCnt) {
1641         echo '<br />' . html_tag('div', asearch_get_error_display($color, _("No Messages Found")), 'center') . "\n";
1642     }
1643 }
1644
1645 do_hook('search_bottom');
1646 sqimap_logout($imapConnection);
1647 echo '</body></html>';
1648 sqsession_register($mailbox_cache,'mailbox_cache');
1649
1650 ?>