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/array.php');
  16 require_once('../functions/strings.php');
  17
  18 global $allow_thread_sort;
  19
  20 /*  here are some functions, could go in imap_search.php
  21
  22     this was here, pretty handy  */
  23 function s_opt( $val, $sel, $tit ) {
  24     echo "            <option value=\"$val\"";
  25     if ( $sel == $val ) {
  26         echo ' selected';
  27     }
  28     echo  ">$tit</option>\n";
  29 }
  30
  31 /*  function to get the recent searches and put them in the attributes array  */
  32 function get_recent($username, $data_dir) {
  33     $attributes = array();
  34     $types = array('search_what', 'search_where', 'search_folder');
  35     $recent_count = getPref($data_dir, $username, 'search_memory', 0);
  36     for ($x=1;$x<=$recent_count;$x++) {
  37         reset($types);
  38         foreach ($types as $key) {
  39             $attributes[$key][$x] = getPref($data_dir, $username, $key.$x, "");
  40         }
  41     }
  42     return $attributes;
  43 }
  44
  45 /*  function to get the saved searches and put them in the saved_attributes array  */
  46 function get_saved($username, $data_dir) {
  47     $saved_attributes = array();
  48     $types = array('saved_what', 'saved_where', 'saved_folder');
  49     foreach ($types as $key) {
  50         for ($x=1;;$x++) {
  51             $saved_attributes[$key][$x] = getPref($data_dir, $username, $key."$x", "");
  52             if ($saved_attributes[$key][$x] == "") {
  53                 array_pop($saved_attributes[$key]);
  54                break;
  55             }
  56         }
  57     }
  58     return $saved_attributes;
  59 }
  60
  61 /*  function to update recent pref arrays  */
  62 function update_recent($what, $where, $mailbox, $username, $data_dir) {
  63     $attributes = array();
  64     $types = array('search_what', 'search_where', 'search_folder');
  65     $input = array($what, $where, $mailbox);
  66     $attributes = get_recent( $username, $data_dir);
  67     reset($types);
  68     $dupe = 'no';
  69     for ($i=1;$i<=count($attributes['search_what']);$i++) {
  70         if (isset($attributes['search_what'][$i])) {
  71             if ($what == $attributes['search_what'][$i] &&
  72                 $where == $attributes['search_where'][$i] &&
  73                 $mailbox == $attributes['search_folder'][$i]) {
  74                     $dupe = 'yes';
  75             }
  76         }
  77     }
  78     if ($dupe == 'no') {
  79         $i = 0;
  80         foreach ($types as $key) {
  81             array_push ($attributes[$key], $input[$i]);
  82             array_shift ($attributes[$key]);
  83             $i++;
  84         }
  85         $recent_count = getPref($data_dir, $username, 'search_memory', 0);
  86         $n=0;
  87         for ($i=1;$i<=$recent_count;$i++) {
  88             reset($types);
  89             foreach ($types as $key) {
  90                 setPref($data_dir, $username, $key.$i, $attributes[$key][$n]);
  91             }
  92             $n++;
  93         }
  94     }
  95 }
  96
  97 /*  function to forget a recent search  */
  98 function forget_recent($forget_index, $username, $data_dir) {
  99     $attributes = array();
 100     $types = array('search_what', 'search_where', 'search_folder');
 101     $attributes = get_recent( $username, $data_dir);
 102     reset($types);
 103     foreach ($types as $key) {
 104         array_splice($attributes[$key], $forget_index, 1);
 105         array_unshift($attributes[$key], '');
 106     }
 107     reset($types);
 108     $recent_count = getPref($data_dir, $username, 'search_memory', 0);
 109     $n=0;
 110     for ($i=1;$i<=$recent_count;$i++) {
 111         reset($types);
 112         foreach ($types as $key) {
 113             setPref($data_dir, $username, $key.$i, $attributes[$key][$n]);
 114         }
 115         $n++;
 116     }
 117 }
 118
 119 /*  function to delete a saved search  */
 120 function delete_saved($delete_index, $username, $data_dir) {
 121     $types = array('saved_what', 'saved_where', 'saved_folder');
 122     $attributes = get_saved($username, $data_dir);
 123     foreach ($types as $key) {
 124         array_splice($attributes[$key], $delete_index, 1);
 125     }
 126     reset($types);
 127     $n=0;
 128     $saved_count = count($attributes['saved_what']);
 129     $last_element = $saved_count + 1;
 130         for ($i=1;$i<=$saved_count;$i++) {
 131             reset($types);
 132             foreach ($types as $key) {
 133                 setPref($data_dir, $username, $key.$i, $attributes[$key][$n]);
 134             }
 135         $n++;
 136         }
 137     reset($types);
 138     foreach($types as $key) {
 139     removePref($data_dir, $username, $key.$last_element);
 140     }
 141 }
 142
 143 /*  function to save a search from recent to saved  */
 144 function save_recent($save_index, $username, $data_dir) {
 145     $attributes = array();
 146     $types = array('search_what', 'search_where', 'search_folder');
 147     $saved_types = array(0 => 'saved_what', 1 => 'saved_where', 2 => 'saved_folder');
 148     $saved_array = get_saved($username, $data_dir);
 149     $save_index = $save_index -1;
 150     $saved_count = (count($saved_array['saved_what']) + 1);
 151     $attributes = get_recent ($username, $data_dir);
 152     $n = 0;
 153     foreach ($types as $key) {
 154         $slice = array_slice($attributes[$key], $save_index, 1);
 155         $name = $saved_types[$n];
 156         setPref($data_dir, $username, $name.$saved_count, $slice[0]);
 157         $n++;
 158     }
 159 }
 160
 161 /* ------------------------ main ------------------------ */
 162
 163 /*  reset these arrays on each page load just in case  */
 164 $attributes = array ();
 165 $saved_attributes = array ();
 166 $search_all = 'none';
 167 $perbox_count = array ();
 168
 169 /*  get mailbox names  */
 170 $imapConnection = sqimap_login($username, $key, $imapServerAddress, $imapPort, 0);
 171 $boxes = sqimap_mailbox_list($imapConnection);
 172
 173 /*  set current mailbox to INBOX if none was selected or if page
 174     was called to search all folders.  */
 175 if ( !isset($mailbox) || $mailbox == 'None' || $mailbox == '' ) {
 176     $mailbox = $boxes[0]['unformatted'];
 177 }
 178 if ($mailbox == 'All Folders') {
 179     $search_all = 'all';
 180 }
 181
 182 displayPageHeader($color, $mailbox);
 183
 184 /*  See how the page was called and fire off correct function  */
 185 if ((!isset($submit) || empty($submit)) && !empty($what)) {
 186     $submit = _("Search");
 187 }
 188 if ( !isset( $submit ) ) {
 189     $submit = '';
 190 } else if ($submit == _("Search") && !empty($what)) {
 191     update_recent($what, $where, $mailbox, $username, $data_dir);
 192 }
 193 elseif ($submit == 'forget') {
 194     forget_recent($count, $username, $data_dir);
 195 }
 196 elseif ($submit == 'save') {
 197     save_recent($count, $username, $data_dir);
 198 }
 199 elseif ($submit == 'delete') {
 200     delete_saved($count, $username, $data_dir);
 201 }
 202
 203 do_hook('search_before_form');
 204
 205 echo "<BR>\n".
 206      "<table width=\"100%\">\n".
 207         "<TR><td bgcolor=\"$color[0]\">\n".
 208             "<CENTER><B>" . _("Search") . "</B></CENTER>\n".
 209         "</TD></TR>\n".
 210      "</TABLE>\n";
 211
 212 /*  update the recent and saved searches from the pref files  */
 213 $attributes = get_recent($username, $data_dir);
 214 $recent_count = getPref($data_dir, $username, 'search_memory', 0);
 215 $saved_attributes = get_saved($username, $data_dir);
 216 $saved_count = count($saved_attributes['saved_what']);
 217 $count_all = 0;
 218
 219 /* Saved Search Table */
 220 if ($saved_count > 0) {
 221     echo "<BR>\n"
 222     . "<TABLE WIDTH=\"95%\" BGCOLOR=\"$color[9]\" ALIGN=\"CENTER\" CELLPADDING=1 CELLSPACING=1>"
 223     . '<TR><TD align=center><B>Saved Searches</B></TD></TR><TR><TD>'
 224     . '<TABLE WIDTH="100%" ALIGN="CENTER" CELLPADDING=0 CELLSPACING=0>';
 225     for ($i=0; $i < $saved_count; ++$i) {
 226         if ($i % 2) {
 227             echo "<TR BGCOLOR=\"$color[0]\">";
 228         } else {
 229             echo "<TR BGCOLOR=\"$color[4]\">";
 230         }
 231         echo "<TD WIDTH=\"35%\">".$saved_attributes['saved_folder'][$i]."</TD>"
 232         . "<TD ALIGN=LEFT>".$saved_attributes['saved_what'][$i]."</TD>"
 233         . "<TD ALIGN=CENTER>".$saved_attributes['saved_where'][$i]."</TD>"
 234         . '<TD ALIGN=RIGHT>'
 235         .   '<A HREF=search.php'
 236         .     '?mailbox=' . urlencode($saved_attributes['saved_folder'][$i])
 237         .     '&amp;what=' . urlencode($saved_attributes['saved_what'][$i])
 238         .     '&amp;where=' . urlencode($saved_attributes['saved_where'][$i])
 239         .   '>' . _("edit") . '</A>'
 240         .   '&nbsp;|&nbsp;'
 241         .   '<A HREF=search.php'
 242         .     '?mailbox=' . urlencode($saved_attributes['saved_folder'][$i])
 243         .     '&amp;what=' . urlencode($saved_attributes['saved_what'][$i])
 244         .     '&amp;where=' . urlencode($saved_attributes['saved_where'][$i])
 245         .     '&amp;submit=Search_no_update'
 246         .   '>' . _("search") . '</A>'
 247         .   '&nbsp;|&nbsp;'
 248         .   "<A HREF=search.php?count=$i&amp;submit=delete>"
 249         .     _("delete")
 250         .   '</A>'
 251         . '</TD></TR>';
 252     }
 253     echo "</TABLE></TD></TR></TABLE>\n";
 254 }
 255
 256 /* Recent Search Table */
 257 if ($recent_count > 0) {
 258     echo "<BR>\n"
 259        . "<TABLE WIDTH=\"95%\" BGCOLOR=\"$color[9]\" ALIGN=\"CENTER\" CELLPADDING=1 CELLSPACING=1>\n"
 260        . '<TR><TD ALIGN=CENTER><B>' . _("Recent Searches") . '</B></TD></TR><TR><TD>'
 261        . '<TABLE WIDTH="100%" ALIGN="CENTER" CELLPADDING=0 CELLSPACING=0>';
 262     for ($i=1; $i <= $recent_count; ++$i) {
 263             if (isset($attributes['search_folder'][$i])) {
 264             if ($attributes['search_folder'][$i] == "") {
 265                 $attributes['search_folder'][$i] = "INBOX";
 266             }
 267             }
 268             if ($i % 2) {
 269                 echo "<TR BGCOLOR=\"$color[0]\">";
 270             } else {
 271                 echo "<TR BGCOLOR=\"$color[4]\">";
 272             }
 273             if (isset($attributes['search_what'][$i]) &&
 274                 !empty($attributes['search_what'][$i])) {
 275             echo "<TD WIDTH=35%>".$attributes['search_folder'][$i]."</TD>"
 276                . "<TD ALIGN=LEFT>".$attributes['search_what'][$i]."</TD>"
 277                . "<TD ALIGN=CENTER>".$attributes['search_where'][$i]."</TD>"
 278                . '<TD ALIGN=RIGHT>'
 279                .   "<A HREF=search.php?count=$i&amp;submit=save>"
 280                .     _("save")
 281                .   '</A>'
 282                .   '&nbsp;|&nbsp;'
 283                .   '<A HREF=search.php'
 284                .     '?mailbox=' . urlencode($attributes['search_folder'][$i])
 285                .     '&amp;what=' . urlencode($attributes['search_what'][$i])
 286                .     '&amp;where=' . urlencode($attributes['search_where'][$i])
 287                .     '&amp;submit=Search_no_update'
 288                .   '>' . _("search") . '</A>'
 289                .   '&nbsp;|&nbsp;'
 290                .   "<A HREF=search.php?count=$i&amp;submit=forget>"
 291                .     _("forget")
 292                .   '</A>'
 293                . '</TD></TR>';
 294         }
 295         }
 296     echo '</TABLE></TD></TR></TABLE><BR>';
 297 }
 298
 299 /* Search Form */
 300 echo '<B>' . _("Current Search") . '</B>'
 301    . '<FORM ACTION="search.php" NAME=s>'
 302    . '   <TABLE WIDTH="95%" CELLPADDING=0 CELLSPACING=0>'
 303    . '     <TR>'
 304    . '       <TD><SELECT NAME="mailbox">';
 305 for ($i = 0; $i < count($boxes); $i++) {
 306     if (!in_array('noselect', $boxes[$i]['flags'])) {
 307         $box = $boxes[$i]['unformatted'];
 308         $box2 = str_replace(' ', '&nbsp;', $boxes[$i]['unformatted-disp']);
 309         if( $box2 == 'INBOX' ) {
 310             $box2 = _("INBOX");
 311         }
 312         if ($mailbox == $box) {
 313             echo "         <OPTION VALUE=\"$box\" SELECTED>$box2</OPTION>\n";
 314         }
 315         else {
 316             echo "         <OPTION VALUE=\"$box\">$box2</OPTION>\n";
 317         }
 318     }
 319 }
 320         echo "<OPTION VALUE=\"All Folders\"";
 321         if ($mailbox == "All Folders") {
 322             echo "SELECTED";
 323         }
 324         echo ">All folders</OPTION>\n";
 325 echo '         </SELECT>'.
 326      "       </TD>\n".
 327      "        <TD ALIGN=\"CENTER\">\n";
 328 if ( !isset( $what ) ) {
 329     $what = '';
 330 }
 331 $what_disp = str_replace(',', ' ', $what);
 332 $what_disp = str_replace('\\\\', '\\', $what_disp);
 333 $what_disp = str_replace('\\"', '"', $what_disp);
 334 $what_disp = str_replace('"', '&quot;', $what_disp);
 335 echo "          <INPUT TYPE=\"TEXT\" SIZE=\"35\" NAME=\"what\" VALUE=\"$what_disp\">\n".
 336      "        </TD>\n".
 337      "<TD ALIGN=\"RIGHT\">\n".
 338      "<SELECT NAME=\"where\">";
 339 s_opt( 'BODY', $where, _("Body") );
 340 s_opt( 'TEXT', $where, _("Everywhere") );
 341 s_opt( 'SUBJECT', $where, _("Subject") );
 342 s_opt( 'FROM', $where, _("From") );
 343 s_opt( 'CC', $where, _("Cc") );
 344 s_opt( 'TO', $where, _("To") );
 345 echo "         </SELECT>\n" .
 346      "        </TD>\n".
 347      "       <TD COLSPAN=\"3\" ALIGN=\"CENTER\">\n".
 348      "         <INPUT TYPE=\"submit\" NAME=\"submit\" VALUE=\"" . _("Search") . "\">\n".
 349      "       </TD>\n".
 350      "     </TR>\n".
 351      "</FORM>\n".
 352      "   </TABLE>\n".
 353      "</TD></TR></TABLE>\n";
 354
 355
 356 do_hook('search_after_form');
 357
 358 /*
 359     search all folders option still in the works. returns a table for each
 360     folder it finds a match in.
 361 */
 362
 363 $old_value = 0;
 364 if ($allow_thread_sort == true) {
 365     $old_value = $allow_thread_sort;
 366     $allow_thread_sort = false;
 367 }
 368
 369 if ($search_all == 'all') {
 370     $mailbox == '';
 371     $boxcount = count($boxes);
 372     echo '<BR><CENTER><B>' .
 373          _("Search Results") .
 374          "</B><CENTER><BR>\n";
 375     for ($x=0;$x<$boxcount;$x++) {
 376         if (!in_array('noselect', $boxes[$x]['flags'])) {
 377             $mailbox = $boxes[$x]['unformatted'];
 378         }
 379         if (($submit == _("Search") || $submit == 'Search_no_update') && !empty($what)) {
 380             sqimap_mailbox_select($imapConnection, $mailbox);
 381             $count_all = sqimap_search($imapConnection, $where, $what, $mailbox, $color, 0, $search_all, $count_all);
 382         array_push($perbox_count, $count_all);
 383         }
 384     }
 385     for ($i=0;$i<count($perbox_count);$i++) {
 386         if ($perbox_count[$i] != "") {
 387            break;
 388         }
 389         $count_all = "none";
 390     }
 391     if ($count_all == "none") {
 392         echo '<br><b>' .
 393              _("No Messages found") .
 394              '</b><br>';
 395     }
 396 }
 397
 398 /*  search one folder option  */
 399 else {
 400     if (($submit == _("Search") || $submit == 'Search_no_update') && !empty($what)) {
 401         echo '<BR><CENTER><B>' .
 402              _("Search Results") .
 403              "</B></CENTER>\n";
 404         sqimap_mailbox_select($imapConnection, $mailbox);
 405         sqimap_search($imapConnection, $where, $what, $mailbox, $color, 0, $search_all, $count_all);
 406     }
 407 }
 408
 409 /*  must have search terms to search  */
 410 if ($submit == _("Search") && empty($what)) {
 411     echo "<BR><CENTER><B>Please enter something to search for</B></CENTER>\n";
 412 }
 413
 414 $allow_thread_sort = $old_value;
 415
 416 do_hook('search_bottom');
 417 sqimap_logout ($imapConnection);
 418 echo '</body></html>';
 419
 420 ?>