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