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 function printSearchMessages($msgs,$mailbox, $cnt, $imapConnection, $usecache = false, $newsort = false) {
 163     global $sort, $color;
 164
 165     $msort = calc_msort($msgs, $sort, $cnt, true);
 166
 167     if ($cnt > 0) {
 168        if ( $mailbox == 'INBOX' ) {
 169            $showbox = _("INBOX");
 170        } else {
 171             $showbox = imap_utf7_decode_local($mailbox);
 172        }
 173        echo html_tag( 'div', '<b><big>' . _("Folder:") . ' '. $showbox.'</big></b>','center') . "\n";
 174
 175        displayMessageArray($imapConnection, $cnt, 1,
 176                              $msgs, $msort, $mailbox, $sort, $color,
 177                              $cnt, true);
 178
 179     }
 180 }
 181
 182 /* ------------------------ main ------------------------ */
 183
 184 /*  reset these arrays on each page load just in case  */
 185 $attributes = array ();
 186 $saved_attributes = array ();
 187 $search_all = 'none';
 188 $perbox_count = array ();
 189 $recent_count = getPref($data_dir, $username, 'search_memory', 0);
 190
 191
 192 /*  get mailbox names  */
 193 $imapConnection = sqimap_login($username, $key, $imapServerAddress, $imapPort, 0);
 194 $boxes = sqimap_mailbox_list($imapConnection);
 195
 196 /*  set current mailbox to INBOX if none was selected or if page
 197     was called to search all folders.  */
 198 if ( !isset($mailbox) || $mailbox == 'None' || $mailbox == '' ) {
 199     $mailbox = $boxes[0]['unformatted'];
 200 }
 201 if ($mailbox == 'All Folders') {
 202     $search_all = 'all';
 203 }
 204
 205 if (isset($composenew) && $composenew) {
 206     $comp_uri = "../src/compose.php?mailbox=". urlencode($mailbox).
 207                 "&amp;session=$composesession&amp;attachedmessages=true&amp";
 208     displayPageHeader($color, $mailbox, "comp_in_new(false,'$comp_uri');", false);
 209 } else {
 210     displayPageHeader($color, $mailbox);
 211 }
 212 /*  See how the page was called and fire off correct function  */
 213 if ((!isset($submit) || empty($submit)) && !empty($what)) {
 214     $submit = _("Search");
 215 }
 216 if ( !isset( $submit ) ) {
 217     $submit = '';
 218 } else if ($submit == _("Search") && !empty($what)) {
 219     if ($recent_count > 0) {
 220         update_recent($what, $where, $mailbox, $username, $data_dir);
 221     }
 222 }
 223 elseif ($submit == 'forget') {
 224     forget_recent($count, $username, $data_dir);
 225 }
 226 elseif ($submit == 'save') {
 227     save_recent($count, $username, $data_dir);
 228 }
 229 elseif ($submit == 'delete') {
 230     delete_saved($count, $username, $data_dir);
 231 }
 232
 233 do_hook('search_before_form');
 234
 235 echo "<br>\n".
 236      html_tag( 'table',
 237          html_tag( 'tr', "\n" .
 238              html_tag( 'td', '<b>' . _("Search") . '</b>', 'center', $color[0] )
 239          ) ,
 240      '', '', 'width="100%"') . "\n";
 241
 242 /*  update the recent and saved searches from the pref files  */
 243 $attributes = get_recent($username, $data_dir);
 244 $saved_attributes = get_saved($username, $data_dir);
 245 $saved_count = count($saved_attributes['saved_what']);
 246 $count_all = 0;
 247
 248 /* Saved Search Table */
 249 if ($saved_count > 0) {
 250     echo "<br>\n"
 251     . html_tag( 'table', '', 'center', $color[9], 'width="95%" cellpadding="1" cellspacing="1" border="0"' )
 252     . html_tag( 'tr',
 253           html_tag( 'td', '<b>Saved Searches</b>', 'center' )
 254       )
 255     . html_tag( 'tr' )
 256     . html_tag( 'td' )
 257     . html_tag( 'table', '', 'center', '', 'width="100%" cellpadding="2" cellspacing="2" border="0"' );
 258     for ($i=0; $i < $saved_count; ++$i) {
 259         if ($i % 2) {
 260             echo html_tag( 'tr', '', '', $color[0] );
 261         } else {
 262             echo html_tag( 'tr', '', '', $color[4] );
 263         }
 264         echo html_tag( 'td', $saved_attributes['saved_folder'][$i], 'left', '', 'width="35%"' )
 265         . html_tag( 'td', $saved_attributes['saved_what'][$i], 'left' )
 266         . html_tag( 'td', $saved_attributes['saved_where'][$i], 'center' )
 267         . html_tag( 'td', '', 'right' )
 268         .   '<a href=search.php'
 269         .     '?mailbox=' . urlencode($saved_attributes['saved_folder'][$i])
 270         .     '&amp;what=' . urlencode($saved_attributes['saved_what'][$i])
 271         .     '&amp;where=' . urlencode($saved_attributes['saved_where'][$i])
 272         .   '>' . _("edit") . '</a>'
 273         .   '&nbsp;|&nbsp;'
 274         .   '<a href=search.php'
 275         .     '?mailbox=' . urlencode($saved_attributes['saved_folder'][$i])
 276         .     '&amp;what=' . urlencode($saved_attributes['saved_what'][$i])
 277         .     '&amp;where=' . urlencode($saved_attributes['saved_where'][$i])
 278         .     '&amp;submit=Search_no_update'
 279         .   '>' . _("search") . '</a>'
 280         .   '&nbsp;|&nbsp;'
 281         .   "<a href=search.php?count=$i&amp;submit=delete>"
 282         .     _("delete")
 283         .   '</a>'
 284         . '</td></tr>';
 285     }
 286     echo "</table></td></tr></table>\n";
 287 }
 288
 289 if ($recent_count > 0) {
 290     echo "<br>\n"
 291        . html_tag( 'table', '', 'center', $color[9], 'width="95%" cellpadding="1" cellspacing="1" border="0"' )
 292        . html_tag( 'tr',
 293              html_tag( 'td', '<b>' . _("Recent Searches") . '</b>', 'center' )
 294          )
 295        . html_tag( 'tr' )
 296        . html_tag( 'td' )
 297        . html_tag( 'table', '', 'center', '', 'width="100%" cellpadding="0" cellspacing="0" border="0"' );
 298     for ($i=1; $i <= $recent_count; ++$i) {
 299             if (isset($attributes['search_folder'][$i])) {
 300             if ($attributes['search_folder'][$i] == "") {
 301                 $attributes['search_folder'][$i] = "INBOX";
 302             }
 303             }
 304             if ($i % 2) {
 305                 echo html_tag( 'tr', '', '', $color[0] );
 306             } else {
 307                 echo html_tag( 'tr', '', '', $color[0] );
 308             }
 309             if (isset($attributes['search_what'][$i]) &&
 310                 !empty($attributes['search_what'][$i])) {
 311             echo html_tag( 'td', $attributes['search_folder'][$i], 'left', '', 'width="35%"' )
 312                . html_tag( 'td', $attributes['search_what'][$i], 'left' )
 313                . html_tag( 'td', $attributes['search_where'][$i], 'center' )
 314                . html_tag( 'td', '', 'right' )
 315                .   "<a href=search.php?count=$i&amp;submit=save>"
 316                .     _("save")
 317                .   '</a>'
 318                .   '&nbsp;|&nbsp;'
 319                .   '<a href=search.php'
 320                .     '?mailbox=' . urlencode($attributes['search_folder'][$i])
 321                .     '&amp;what=' . urlencode($attributes['search_what'][$i])
 322                .     '&amp;where=' . urlencode($attributes['search_where'][$i])
 323                .     '&amp;submit=Search_no_update'
 324                .   '>' . _("search") . '</a>'
 325                .   '&nbsp;|&nbsp;'
 326                .   "<a href=search.php?count=$i&amp;submit=forget>"
 327                .     _("forget")
 328                .   '</a>'
 329                . '</td></tr>';
 330         }
 331         }
 332     echo '</table></td></tr></table><br>';
 333 }
 334
 335
 336 if (isset($newsort)) {
 337     $sort = $newsort;
 338     session_register('sort');
 339 }
 340
 341 /*********************************************************************
 342  * Check to see if we can use cache or not. Currently the only time  *
 343  * when you will not use it is when a link on the left hand frame is *
 344  * used. Also check to make sure we actually have the array in the   *
 345  * registered session data.  :)                                      *
 346  *********************************************************************/
 347 if (! isset($use_mailbox_cache)) {
 348     $use_mailbox_cache = 0;
 349 }
 350
 351 /* There is a problem with registered vars in 4.1 */
 352 /*
 353 if( substr( phpversion(), 0, 3 ) == '4.1'  ) {
 354     $use_mailbox_cache = FALSE;
 355 }
 356 */
 357
 358 /* Search Form */
 359 echo html_tag( 'div', '<b>' . _("Current Search") . '</b>', 'left' ) . "\n"
 360    . '<form action="search.php" name="s">'
 361    . html_tag( 'table', '', '', '', 'width="95%" cellpadding="0" cellspacing="0" border="0"' )
 362    . html_tag( 'tr' )
 363    . html_tag( 'td', '', 'left' )
 364    . '<select name="mailbox">';
 365 for ($i = 0; $i < count($boxes); $i++) {
 366     if (!in_array('noselect', $boxes[$i]['flags'])) {
 367         $box = $boxes[$i]['unformatted'];
 368         $box2 = str_replace(' ', '&nbsp;',
 369                          imap_utf7_decode_local($boxes[$i]['unformatted-disp']));
 370         if( $box2 == 'INBOX' ) {
 371             $box2 = _("INBOX");
 372         }
 373         echo '         <option value="' . $box . '"';
 374         if ($mailbox == $box) { echo ' selected'; }
 375         echo '>' . $box2 . '</option>' . "\n";
 376     }
 377 }
 378         echo '<option value="All Folders"';
 379         if ($mailbox == 'All Folders') {
 380             echo ' selected';
 381         }
 382         echo ">All folders</option>\n";
 383 echo '         </select>'.
 384      "       </td>\n";
 385 if ( !isset( $what ) ) {
 386     $what = '';
 387 }
 388 if ( !isset( $where ) ) {
 389     $where = '';
 390 }
 391
 392
 393 $what_disp = str_replace(',', ' ', $what);
 394 $what_disp = str_replace('\\\\', '\\', $what_disp);
 395 $what_disp = str_replace('\\"', '"', $what_disp);
 396 $what_disp = str_replace('"', '&quot;', $what_disp);
 397 echo html_tag( 'td', '<input type="text" size="35" name="what" value="' . $what_disp . '">' . "\n", 'center' )
 398      . html_tag( 'td', '', 'right' )
 399      . "<select name=\"where\">";
 400 s_opt( 'BODY', $where, _("Body") );
 401 s_opt( 'TEXT', $where, _("Everywhere") );
 402 s_opt( 'SUBJECT', $where, _("Subject") );
 403 s_opt( 'FROM', $where, _("From") );
 404 s_opt( 'CC', $where, _("Cc") );
 405 s_opt( 'TO', $where, _("To") );
 406 echo "         </select>\n" .
 407      "        </td>\n".
 408      html_tag( 'td', '<input type="submit" name="submit" value="' . _("Search") . '">' . "\n", 'center', '', 'colspan="3"' ) .
 409      "     </tr>\n".
 410      "</form>\n".
 411      "   </table>\n".
 412      "</td></tr></table>\n";
 413
 414
 415 do_hook('search_after_form');
 416
 417 /*
 418     search all folders option still in the works. returns a table for each
 419     folder it finds a match in.
 420 */
 421
 422 $old_value = 0;
 423 if ($allow_thread_sort == TRUE) {
 424     $old_value = $allow_thread_sort;
 425     $allow_thread_sort = FALSE;
 426 }
 427
 428 if ($search_all == 'all') {
 429     $mailbox == '';
 430     $boxcount = count($boxes);
 431     echo '<BR><CENTER><B>' .
 432          _("Search Results") .
 433          "</B><CENTER><BR>\n";
 434     for ($x=0;$x<$boxcount;$x++) {
 435         if (!in_array('noselect', $boxes[$x]['flags'])) {
 436             $mailbox = $boxes[$x]['unformatted'];
 437         }
 438         if (($submit == _("Search") || $submit == 'Search_no_update') && !empty($what)) {
 439             sqimap_mailbox_select($imapConnection, $mailbox);
 440             $msgs = sqimap_search($imapConnection, $where, $what, $mailbox, $color, 0, $search_all, $count_all);
 441             $count_all = count($msgs);
 442             printSearchMessages($msgs, $mailbox, $count_all, $imapConnection);
 443             array_push($perbox_count, $count_all);
 444         }
 445     }
 446     for ($i=0;$i<count($perbox_count);$i++) {
 447         if ($perbox_count[$i]) {
 448             $count_all = true;
 449             break;
 450         }
 451     }
 452     if (!$count_all) {
 453        echo '<br><center>' . _("No Messages Found") . '</center>';
 454     }
 455 }
 456
 457 /*  search one folder option  */
 458 else {
 459     if (($submit == _("Search") || $submit == 'Search_no_update') && !empty($what)) {
 460         echo '<br>'
 461         . html_tag( 'div', '<b>' . _("Search Results") . '</b>', 'center' ) . "\n";
 462         sqimap_mailbox_select($imapConnection, $mailbox);
 463         $msgs = sqimap_search($imapConnection, $where, $what, $mailbox, $color, 0, $search_all, $count_all);
 464         if (count($msgs)) {
 465            printSearchMessages($msgs, $mailbox, count($msgs), $imapConnection);
 466         } else {
 467            echo '<br><center>' . _("No Messages Found") . '</center>';
 468         }
 469     }
 470 }
 471
 472 /*  must have search terms to search  */
 473 if ($submit == _("Search") && empty($what)) {
 474         echo '<br>'
 475         . html_tag( 'div', '<b>Please enter something to search for</b>', 'center' ) . "\n";
 476 }
 477
 478 $allow_thread_sort = $old_value;
 479
 480
 481 do_hook('search_bottom');
 482 sqimap_logout ($imapConnection);
 483 echo '</body></html>';
 484
 485 ?>