src/search.php

   1 <?php
   2
   3 /**
   4  * search.php
   5  *
   6  * Copyright (c) 1999-2002 The SquirrelMail Project Team
   7  * Licensed under the GNU GPL. For full terms see the file COPYING.
   8  *
   9  * $Id$
  10  */
  11
  12 require_once('../src/validate.php');
  13 require_once('../functions/imap.php');
  14 require_once('../functions/imap_search.php');
  15 require_once('../functions/imap_utf7_decode_local.php');
  16 require_once('../functions/array.php');
  17 require_once('../functions/strings.php');
  18
  19 global $allow_thread_sort;
  20
  21 /*  here are some functions, could go in imap_search.php
  22
  23     this was here, pretty handy  */
  24 function s_opt( $val, $sel, $tit ) {
  25     echo "            <option value=\"$val\"";
  26     if ( $sel == $val ) {
  27         echo ' selected';
  28     }
  29     echo  ">$tit</option>\n";
  30 }
  31
  32 /*  function to get the recent searches and put them in the attributes array  */
  33 function get_recent($username, $data_dir) {
  34     $attributes = array();
  35     $types = array('search_what', 'search_where', 'search_folder');
  36     $recent_count = getPref($data_dir, $username, 'search_memory', 0);
  37     for ($x=1;$x<=$recent_count;$x++) {
  38         reset($types);
  39         foreach ($types as $key) {
  40             $attributes[$key][$x] = getPref($data_dir, $username, $key.$x, "");
  41         }
  42     }
  43     return $attributes;
  44 }
  45
  46 /*  function to get the saved searches and put them in the saved_attributes array  */
  47 function get_saved($username, $data_dir) {
  48     $saved_attributes = array();
  49     $types = array('saved_what', 'saved_where', 'saved_folder');
  50     foreach ($types as $key) {
  51         for ($x=1;;$x++) {
  52             $saved_attributes[$key][$x] = getPref($data_dir, $username, $key."$x", "");
  53             if ($saved_attributes[$key][$x] == "") {
  54                 array_pop($saved_attributes[$key]);
  55                break;
  56             }
  57         }
  58     }
  59     return $saved_attributes;
  60 }
  61
  62 /*  function to update recent pref arrays  */
  63 function update_recent($what, $where, $mailbox, $username, $data_dir) {
  64     $attributes = array();
  65     $types = array('search_what', 'search_where', 'search_folder');
  66     $input = array($what, $where, $mailbox);
  67     $attributes = get_recent( $username, $data_dir);
  68     reset($types);
  69     $dupe = 'no';
  70     for ($i=1;$i<=count($attributes['search_what']);$i++) {
  71         if (isset($attributes['search_what'][$i])) {
  72             if ($what == $attributes['search_what'][$i] &&
  73                 $where == $attributes['search_where'][$i] &&
  74                 $mailbox == $attributes['search_folder'][$i]) {
  75                     $dupe = 'yes';
  76             }
  77         }
  78     }
  79     if ($dupe == 'no') {
  80         $i = 0;
  81         foreach ($types as $key) {
  82             array_push ($attributes[$key], $input[$i]);
  83             array_shift ($attributes[$key]);
  84             $i++;
  85         }
  86         $recent_count = getPref($data_dir, $username, 'search_memory', 0);
  87         $n=0;
  88         for ($i=1;$i<=$recent_count;$i++) {
  89             reset($types);
  90             foreach ($types as $key) {
  91                 setPref($data_dir, $username, $key.$i, $attributes[$key][$n]);
  92             }
  93             $n++;
  94         }
  95     }
  96 }
  97
  98 /*  function to forget a recent search  */
  99 function forget_recent($forget_index, $username, $data_dir) {
 100     $attributes = array();
 101     $types = array('search_what', 'search_where', 'search_folder');
 102     $attributes = get_recent( $username, $data_dir);
 103     reset($types);
 104     foreach ($types as $key) {
 105         array_splice($attributes[$key], $forget_index, 1);
 106         array_unshift($attributes[$key], '');
 107     }
 108     reset($types);
 109     $recent_count = getPref($data_dir, $username, 'search_memory', 0);
 110     $n=0;
 111     for ($i=1;$i<=$recent_count;$i++) {
 112         reset($types);
 113         foreach ($types as $key) {
 114             setPref($data_dir, $username, $key.$i, $attributes[$key][$n]);
 115         }
 116         $n++;
 117     }
 118 }
 119
 120 /*  function to delete a saved search  */
 121 function delete_saved($delete_index, $username, $data_dir) {
 122     $types = array('saved_what', 'saved_where', 'saved_folder');
 123     $attributes = get_saved($username, $data_dir);
 124     foreach ($types as $key) {
 125         array_splice($attributes[$key], $delete_index, 1);
 126     }
 127     reset($types);
 128     $n=0;
 129     $saved_count = count($attributes['saved_what']);
 130     $last_element = $saved_count + 1;
 131         for ($i=1;$i<=$saved_count;$i++) {
 132             reset($types);
 133             foreach ($types as $key) {
 134                 setPref($data_dir, $username, $key.$i, $attributes[$key][$n]);
 135             }
 136         $n++;
 137         }
 138     reset($types);
 139     foreach($types as $key) {
 140     removePref($data_dir, $username, $key.$last_element);
 141     }
 142 }
 143
 144 /*  function to save a search from recent to saved  */
 145 function save_recent($save_index, $username, $data_dir) {
 146     $attributes = array();
 147     $types = array('search_what', 'search_where', 'search_folder');
 148     $saved_types = array(0 => 'saved_what', 1 => 'saved_where', 2 => 'saved_folder');
 149     $saved_array = get_saved($username, $data_dir);
 150     $save_index = $save_index -1;
 151     $saved_count = (count($saved_array['saved_what']) + 1);
 152     $attributes = get_recent ($username, $data_dir);
 153     $n = 0;
 154     foreach ($types as $key) {
 155         $slice = array_slice($attributes[$key], $save_index, 1);
 156         $name = $saved_types[$n];
 157         setPref($data_dir, $username, $name.$saved_count, $slice[0]);
 158         $n++;
 159     }
 160 }
 161
 162 /* ------------------------ main ------------------------ */
 163
 164 /*  reset these arrays on each page load just in case  */
 165 $attributes = array ();
 166 $saved_attributes = array ();
 167 $search_all = 'none';
 168 $perbox_count = array ();
 169 $recent_count = getPref($data_dir, $username, 'search_memory', 0);
 170
 171
 172 /*  get mailbox names  */
 173 $imapConnection = sqimap_login($username, $key, $imapServerAddress, $imapPort, 0);
 174 $boxes = sqimap_mailbox_list($imapConnection);
 175
 176 if (isset($newsort)) {
 177     printSearchMessages('',$mailbox, '', $imapConnection, true, $newsort);
 178 }
 179
 180
 181
 182 /*  set current mailbox to INBOX if none was selected or if page
 183     was called to search all folders.  */
 184 if ( !isset($mailbox) || $mailbox == 'None' || $mailbox == '' ) {
 185     $mailbox = $boxes[0]['unformatted'];
 186 }
 187 if ($mailbox == 'All Folders') {
 188     $search_all = 'all';
 189 }
 190
 191 if (isset($composenew) && $composenew) {
 192     $comp_uri = "../src/compose.php?mailbox=". urlencode($mailbox).
 193                 "&amp;session=$composesession&amp;attachedmessages=true&amp";
 194     displayPageHeader($color, $mailbox, "comp_in_new(false,'$comp_uri');", false);
 195 } else {
 196     displayPageHeader($color, $mailbox);
 197 }
 198 /*  See how the page was called and fire off correct function  */
 199 if ((!isset($submit) || empty($submit)) && !empty($what)) {
 200     $submit = _("Search");
 201 }
 202 if ( !isset( $submit ) ) {
 203     $submit = '';
 204 } else if ($submit == _("Search") && !empty($what)) {
 205     if ($recent_count > 0) {
 206         update_recent($what, $where, $mailbox, $username, $data_dir);
 207     }
 208 }
 209 elseif ($submit == 'forget') {
 210     forget_recent($count, $username, $data_dir);
 211 }
 212 elseif ($submit == 'save') {
 213     save_recent($count, $username, $data_dir);
 214 }
 215 elseif ($submit == 'delete') {
 216     delete_saved($count, $username, $data_dir);
 217 }
 218
 219 do_hook('search_before_form');
 220
 221 echo "<BR>\n".
 222      "<table width=\"100%\">\n".
 223         "<TR><td bgcolor=\"$color[0]\">\n".
 224             "<CENTER><B>" . _("Search") . "</B></CENTER>\n".
 225         "</TD></TR>\n".
 226      "</TABLE>\n";
 227
 228 /*  update the recent and saved searches from the pref files  */
 229 $attributes = get_recent($username, $data_dir);
 230 $saved_attributes = get_saved($username, $data_dir);
 231 $saved_count = count($saved_attributes['saved_what']);
 232 $count_all = 0;
 233
 234 /* Saved Search Table */
 235 if ($saved_count > 0) {
 236     echo "<BR>\n"
 237     . "<TABLE WIDTH=\"95%\" BGCOLOR=\"$color[9]\" ALIGN=\"CENTER\" CELLPADDING=1 CELLSPACING=1>"
 238     . '<TR><TD align=center><B>Saved Searches</B></TD></TR><TR><TD>'
 239     . '<TABLE WIDTH="100%" ALIGN="CENTER" CELLPADDING=0 CELLSPACING=0>';
 240     for ($i=0; $i < $saved_count; ++$i) {
 241         if ($i % 2) {
 242             echo "<TR BGCOLOR=\"$color[0]\">";
 243         } else {
 244             echo "<TR BGCOLOR=\"$color[4]\">";
 245         }
 246         echo "<TD WIDTH=\"35%\">".$saved_attributes['saved_folder'][$i]."</TD>"
 247         . "<TD ALIGN=LEFT>".$saved_attributes['saved_what'][$i]."</TD>"
 248         . "<TD ALIGN=CENTER>".$saved_attributes['saved_where'][$i]."</TD>"
 249         . '<TD ALIGN=RIGHT>'
 250         .   '<A HREF=search.php'
 251         .     '?mailbox=' . urlencode($saved_attributes['saved_folder'][$i])
 252         .     '&amp;what=' . urlencode($saved_attributes['saved_what'][$i])
 253         .     '&amp;where=' . urlencode($saved_attributes['saved_where'][$i])
 254         .   '>' . _("edit") . '</A>'
 255         .   '&nbsp;|&nbsp;'
 256         .   '<A HREF=search.php'
 257         .     '?mailbox=' . urlencode($saved_attributes['saved_folder'][$i])
 258         .     '&amp;what=' . urlencode($saved_attributes['saved_what'][$i])
 259         .     '&amp;where=' . urlencode($saved_attributes['saved_where'][$i])
 260         .     '&amp;submit=Search_no_update'
 261         .   '>' . _("search") . '</A>'
 262         .   '&nbsp;|&nbsp;'
 263         .   "<A HREF=search.php?count=$i&amp;submit=delete>"
 264         .     _("delete")
 265         .   '</A>'
 266         . '</TD></TR>';
 267     }
 268     echo "</TABLE></TD></TR></TABLE>\n";
 269 }
 270
 271 if ($recent_count > 0) {
 272     echo "<br>\n"
 273        . html_tag( 'table', '', 'center', $color[9], 'width="95%" cellpadding="1" cellspacing="1" border="0"' )
 274        . html_tag( 'tr',
 275              html_tag( 'td', '<b>' . _("Recent Searches") . '</b>', 'center' )
 276          )
 277        . html_tag( 'tr' )
 278        . html_tag( 'td' )
 279        . html_tag( 'table', '', 'center', '', 'width="100%" cellpadding="0" cellspacing="0" border="0"' );
 280     for ($i=1; $i <= $recent_count; ++$i) {
 281             if (isset($attributes['search_folder'][$i])) {
 282             if ($attributes['search_folder'][$i] == "") {
 283                 $attributes['search_folder'][$i] = "INBOX";
 284             }
 285             }
 286             if ($i % 2) {
 287                 echo html_tag( 'tr', '', '', $color[0] );
 288             } else {
 289                 echo html_tag( 'tr', '', '', $color[0] );
 290             }
 291             if (isset($attributes['search_what'][$i]) &&
 292                 !empty($attributes['search_what'][$i])) {
 293             echo html_tag( 'td', $attributes['search_folder'][$i], 'left', '', 'width="35%"' )
 294                . html_tag( 'td', $attributes['search_what'][$i], 'left' )
 295                . html_tag( 'td', $attributes['search_where'][$i], 'center' )
 296                . html_tag( 'td', '', 'right' )
 297                .   "<a href=search.php?count=$i&amp;submit=save>"
 298                .     _("save")
 299                .   '</a>'
 300                .   '&nbsp;|&nbsp;'
 301                .   '<a href=search.php'
 302                .     '?mailbox=' . urlencode($attributes['search_folder'][$i])
 303                .     '&amp;what=' . urlencode($attributes['search_what'][$i])
 304                .     '&amp;where=' . urlencode($attributes['search_where'][$i])
 305                .     '&amp;submit=Search_no_update'
 306                .   '>' . _("search") . '</a>'
 307                .   '&nbsp;|&nbsp;'
 308                .   "<a href=search.php?count=$i&amp;submit=forget>"
 309                .     _("forget")
 310                .   '</a>'
 311                . '</td></tr>';
 312         }
 313         }
 314     echo '</table></td></tr></table><br>';
 315 }
 316
 317 function printSearchMessages($msgs,$mailbox, $cnt, $imapConnection, $usecache = false, $newsort = false) {
 318     global $sort, $color;
 319
 320     if (!$usecache) {
 321        if (!isset($search_msgs) || !session_is_registered('search_msgs')) {
 322           $search_msgs = array();
 323           $search_msgs[$mailbox] = $msgs;
 324           session_register('search_msgs');
 325        } else {
 326           $old_search_msgs = $search_msgs;
 327           session_unregister('search_msgs');
 328           $old_search_msgs[$mailbox] = $msgs;
 329           $search_msgs = $old_search_msgs;
 330           session_register('search_msgs');
 331        }
 332     } else {
 333 //       if (session_is_registered('search_msgs')) {
 334 //          global $search_msgs;
 335           $msgs = $search_msgs[$mailbox];
 336 //       } else {
 337 //          $msgs = $search_msgs[$mailbox];
 338 //       }
 339     }
 340     if ($newsort) {
 341       $cnt = count($msgs);
 342       $sort = $newsort;
 343     }
 344     $msort = calc_msort($msgs, $sort, $cnt, true);
 345     displayMessageArray($imapConnection, $cnt, 1,
 346                              $msgs, $msort, $mailbox, $sort, $color,
 347                              $cnt, true);
 348 }
 349
 350 if (isset($newsort)) {
 351     $sort = $newsort;
 352     session_register('sort');
 353 }
 354
 355 /*********************************************************************
 356  * Check to see if we can use cache or not. Currently the only time  *
 357  * when you will not use it is when a link on the left hand frame is *
 358  * used. Also check to make sure we actually have the array in the   *
 359  * registered session data.  :)                                      *
 360  *********************************************************************/
 361 if (! isset($use_mailbox_cache)) {
 362     $use_mailbox_cache = 0;
 363 }
 364
 365 /* There is a problem with registered vars in 4.1 */
 366 /*
 367 if( substr( phpversion(), 0, 3 ) == '4.1'  ) {
 368     $use_mailbox_cache = FALSE;
 369 }
 370 */
 371
 372 /* Search Form */
 373 echo html_tag( 'div', '<b>' . _("Current Search") . '</b>', 'left' ) . "\n"
 374    . '<form action="search.php" name="s">'
 375    . html_tag( 'table', '', '', '', 'width="95%" cellpadding="0" cellspacing="0" border="0"' )
 376    . html_tag( 'tr' )
 377    . html_tag( 'td', '', 'left' )
 378    . '<select name="mailbox">';
 379 for ($i = 0; $i < count($boxes); $i++) {
 380     if (!in_array('noselect', $boxes[$i]['flags'])) {
 381         $box = $boxes[$i]['unformatted'];
 382         $box2 = str_replace(' ', '&nbsp;',
 383                          imap_utf7_decode_local($boxes[$i]['unformatted-disp']));
 384         if( $box2 == 'INBOX' ) {
 385             $box2 = _("INBOX");
 386         }
 387         echo '         <option value="' . $box . '"';
 388         if ($mailbox == $box) { echo ' selected'; }
 389         echo '>' . $box2 . '</option>' . "\n";
 390     }
 391 }
 392         echo '<option value="All Folders"';
 393         if ($mailbox == 'All Folders') {
 394             echo ' selected';
 395         }
 396         echo ">All folders</option>\n";
 397 echo '         </select>'.
 398      "       </td>\n";
 399 if ( !isset( $what ) ) {
 400     $what = '';
 401 }
 402 if ( !isset( $where ) ) {
 403     $where = '';
 404 }
 405
 406
 407 $what_disp = str_replace(',', ' ', $what);
 408 $what_disp = str_replace('\\\\', '\\', $what_disp);
 409 $what_disp = str_replace('\\"', '"', $what_disp);
 410 $what_disp = str_replace('"', '&quot;', $what_disp);
 411 echo html_tag( 'td', '<input type="text" size="35" name="what" value="' . $what_disp . '">' . "\n", 'center' )
 412      . html_tag( 'td', '', 'right' )
 413      . "<select name=\"where\">";
 414 s_opt( 'BODY', $where, _("Body") );
 415 s_opt( 'TEXT', $where, _("Everywhere") );
 416 s_opt( 'SUBJECT', $where, _("Subject") );
 417 s_opt( 'FROM', $where, _("From") );
 418 s_opt( 'CC', $where, _("Cc") );
 419 s_opt( 'TO', $where, _("To") );
 420 echo "         </select>\n" .
 421      "        </td>\n".
 422      html_tag( 'td', '<input type="submit" name="submit" value="' . _("Search") . '">' . "\n", 'center', '', 'colspan="3"' ) .
 423      "     </tr>\n".
 424      "</form>\n".
 425      "   </table>\n".
 426      "</td></tr></table>\n";
 427
 428
 429 do_hook('search_after_form');
 430
 431 /*
 432     search all folders option still in the works. returns a table for each
 433     folder it finds a match in.
 434 */
 435
 436 $old_value = 0;
 437 if ($allow_thread_sort == TRUE) {
 438     $old_value = $allow_thread_sort;
 439     $allow_thread_sort = FALSE;
 440 }
 441
 442 if ($search_all == 'all') {
 443     $mailbox == '';
 444     $boxcount = count($boxes);
 445     echo '<BR><CENTER><B>' .
 446          _("Search Results") .
 447          "</B><CENTER><BR>\n";
 448     for ($x=0;$x<$boxcount;$x++) {
 449         if (!in_array('noselect', $boxes[$x]['flags'])) {
 450             $mailbox = $boxes[$x]['unformatted'];
 451         }
 452         if (($submit == _("Search") || $submit == 'Search_no_update') && !empty($what)) {
 453             sqimap_mailbox_select($imapConnection, $mailbox);
 454             $msgs = sqimap_search($imapConnection, $where, $what, $mailbox, $color, 0, $search_all, $count_all);
 455             $count_all = count($msgs);
 456             printSearchMessages($msgs, $mailbox, $count_all, $imapConnection);
 457             array_push($perbox_count, $count_all);
 458         }
 459     }
 460     for ($i=0;$i<count($perbox_count);$i++) {
 461         if ($perbox_count[$i] != "") {
 462             $count_all = "found";
 463             break;
 464         }
 465     }
 466     if ($count_all != "found") {
 467         echo '<br><b>' .
 468              _("No Messages found") .
 469              '</b><br>';
 470     }
 471 }
 472
 473 /*  search one folder option  */
 474 else {
 475     if (($submit == _("Search") || $submit == 'Search_no_update') && !empty($what)) {
 476         echo '<BR><CENTER><B>' .
 477              _("Search Results") .
 478              "</B></CENTER>\n";
 479         sqimap_mailbox_select($imapConnection, $mailbox);
 480         $msgs = sqimap_search($imapConnection, $where, $what, $mailbox, $color, 0, $search_all, $count_all);
 481         printSearchMessages($msgs, $mailbox, count($msgs), $imapConnection);
 482     }
 483 }
 484
 485 /*  must have search terms to search  */
 486 if ($submit == _("Search") && empty($what)) {
 487     echo "<BR><CENTER><B>Please enter something to search for</B></CENTER>\n";
 488 }
 489
 490 $allow_thread_sort = $old_value;
 491
 492
 493 do_hook('search_bottom');
 494 sqimap_logout ($imapConnection);
 495 echo '</body></html>';
 496
 497 ?>