Adding a note about squirrelspell.
[squirrelmail.git] / src / search.php
CommitLineData
c61bb006 1<?php
245a6892 2
35586184 3/**
a5ee5ac2 4 * search.php
35586184 5 *
15e6162e 6 * Copyright (c) 1999-2002 The SquirrelMail Project Team
35586184 7 * Licensed under the GNU GPL. For full terms see the file COPYING.
8 *
9 * $Id$
10 */
2d367c68 11
35586184 12require_once('../src/validate.php');
13require_once('../functions/imap.php');
14require_once('../functions/imap_search.php');
15require_once('../functions/array.php');
46d38f78 16require_once('../functions/strings.php');
c61bb006 17
56e0b3b7 18
19// here are some functions, could go in imap_search.php
20// this was here, pretty handy
21
29eb5486 22function s_opt( $val, $sel, $tit ) {
23 echo " <option value=\"$val\"";
0d672ac0 24 if ( $sel == $val ) {
bd9bbfef 25 echo ' selected';
99d2a184 26 }
29eb5486 27 echo ">$tit</option>\n";
28}
99d2a184 29
56e0b3b7 30// function to get the recent searches and put them in arrays
31
32function 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
45function 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
61function 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
75function 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);
83a92ae8 82 array_unshift($what_array, "");
83 array_unshift($where_array, "");
84 array_unshift($folder_array, "");
56e0b3b7 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 }
6c8388a9 93
94// function to delete a saved search
56e0b3b7 95}
96function 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}
6c8388a9 118
119// function to save a search from recent to saved
120
56e0b3b7 121function 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
0d672ac0 137/* ------------------------ main ------------------------ */
138
56e0b3b7 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
29eb5486 151$imapConnection = sqimap_login($username, $key, $imapServerAddress, $imapPort, 0);
c1cb7ba4 152$boxes = sqimap_mailbox_list($imapConnection);
153
56e0b3b7 154
155// set current mailbox to INBOX if none was selected or if page
156// was called to search all folders.
157
158if ($mailbox == 'None' || $mailbox == "" ) {
159 $mailbox = $boxes[0]['unformatted'];
160}
6c8388a9 161if ($mailbox == "All Folders") {
56e0b3b7 162 $search_all = "all";
c1cb7ba4 163}
164
56e0b3b7 165// page headers
166
c1cb7ba4 167displayPageHeader($color, $mailbox);
c61bb006 168
56e0b3b7 169// if the page is called from a search link or button update recent values
170// in pref files here
0d672ac0 171
56e0b3b7 172if ($submit == "Search" && !empty($what)) {
173 update_recent($what_array, $what, "search_what", $username, $data_dir);
174 update_recent($where_array, $where, "search_where", $username, $data_dir);
175 update_recent($folder_array, $mailbox, "search_folder", $username, $data_dir);
176}
177// if the page is called from a "forget recent" link remove search from pref file
178elseif ($submit == "forget") {
179 forget_recent($count, $username, $data_dir);
180}
181// if the page is called from a "save recent" link add search to saved searches
182elseif ($submit == "save") {
183 save_recent($count, $username, $data_dir);
184}
185elseif ($submit == "delete") {
186 delete_saved($count, $username, $data_dir);
187}
188// if the page is called from a "delete saved" link delete saved search
29eb5486 189do_hook('search_before_form');
56e0b3b7 190
191echo "<BR>\n".
82563772 192 " <table width=\"100%\">\n".
56e0b3b7 193 " <TR><td bgcolor=\"$color[0]\">\n".
194 " <CENTER><B>"._("Search")."</B></CENTER>\n".
195 " </TD></TR>\n".
82563772 196 " </TABLE>\n";
197# ' <TR><td align=center>';
c61bb006 198
56e0b3b7 199// update the recent and saved searches from the pref files
a7d0eaf6 200
56e0b3b7 201$what_array = get_recent("search_what", $username, $data_dir);
202$where_array = get_recent("search_where", $username, $data_dir);
203$folder_array = get_recent("search_folder", $username, $data_dir);
204$recent_count = getPref($data_dir, $username, 'search_memory', 0);
205$saved_what_array = get_saved("saved_what", $username, $data_dir);
206$saved_where_array = get_saved("saved_where", $username, $data_dir);
207$saved_folder_array = get_saved("saved_folder", $username, $data_dir);
208$saved_count = count($saved_what_array);
a7d0eaf6 209
56e0b3b7 210// saved search table
211if ($saved_count > 0) {
82563772 212 echo "<BR>\n".
213 "<TABLE WIDTH=\"95%\" BGCOLOR=\"$color[9]\" ALIGN=\"CENTER\" CELLPADDING=1 CELLSPACING=1>\n".
214 "<TR><TD align=center><B>Saved Searches</B></TD></TR><TR><TD>\n".
215 "<TABLE WIDTH=\"100%\" ALIGN=\"CENTER\" CELLPADDING=0 CELLSPACING=0>\n";
56e0b3b7 216 for ($i=0;$i<$saved_count;$i++) {
82563772 217 echo "<TR ";
218 if ($i % 2) {
219 echo "BGCOLOR=\"$color[0]\"";
220 }
221 else { echo "BGCOLOR=\"$color[4]\""; }
222 echo "><TD WIDTH=35%>$saved_folder_array[$i]</TD>\n".
56e0b3b7 223 "<TD ALIGN=LEFT>$saved_what_array[$i]</TD>\n".
224 "<TD ALIGN=RIGHT>$saved_where_array[$i]&nbsp;&nbsp;&nbsp;\n".
225 "<A HREF=search.php?".
226 "mailbox=", urlencode($saved_folder_array[$i]), "&".
227 "what=", urlencode($saved_what_array[$i]), "&".
228 "where=", urlencode($saved_where_array[$i]), ">".
229 "edit</A>\n".
230 "&nbsp;|&nbsp;<A HREF=search.php?".
231 "mailbox=", urlencode($saved_folder_array[$i]), "&".
232 "what=", urlencode($saved_what_array[$i]), "&".
233 "where=", urlencode($saved_where_array[$i]), "&".
234 "submit=Search_no_update>search</A>\n".
235 "&nbsp;|&nbsp;<A HREF=search.php?count=$i&submit=delete>delete</A>".
82563772 236 "&nbsp;&nbsp;</tr>";
56e0b3b7 237 }
82563772 238echo "</TABLE></TD></TR></TABLE>\n";
a7d0eaf6 239}
240
56e0b3b7 241// recent search table
c61bb006 242
56e0b3b7 243if ($recent_count > 0) {
82563772 244 echo "<BR>\n".
245 "<TABLE WIDTH=\"95%\" BGCOLOR=\"$color[9]\" ALIGN=\"CENTER\" CELLPADDING=1 CELLSPACING=1>\n".
246 "<TR><TD align=center><B>Recent Searches</B></TD></TR><tr><td>\n".
247 "<TABLE WIDTH=\"100%\" ALIGN=\"CENTER\" CELLPADDING=0 CELLSPACING=0>\n";
56e0b3b7 248 for ($i=0;$i<$recent_count;$i++) {
249 if (!empty($what_array[$i])) {
250 if ($folder_array[$i] == "") {
251 $folder_array[$i] = "INBOX";
252 }
82563772 253 echo "<TR ";
254 if ($i % 2) {
255 echo "BGCOLOR=\"$color[0]\"";
256 }
257 else { echo "BGCOLOR=\"$color[4]\""; }
7100774e 258 echo "><TD WIDTH=35%>$folder_array[$i]</TD>\n".
56e0b3b7 259 "<TD ALIGN=LEFT>$what_array[$i]</TD>\n".
260 "<TD ALIGN=RIGHT>$where_array[$i]&nbsp;&nbsp;&nbsp;".
261 "<A HREF=search.php?".
262 "count=$i&submit=save".
263 ">save</A>\n".
264 "&nbsp;|&nbsp;<A HREF=search.php?".
265 "mailbox=", urlencode($folder_array[$i]), "&".
266 "what=", urlencode($what_array[$i]), "&".
267 "where=", urlencode($where_array[$i]), "&".
268 "submit=Search_no_update>search</A>\n".
269 "&nbsp;|&nbsp;<A HREF=search.php?count=$i&submit=forget>forget</A>".
270 "&nbsp;&nbsp;</TD></TR>\n";
0d672ac0 271 }
29eb5486 272 }
82563772 273 echo "</table></td></tr></TABLE>\n".
56e0b3b7 274 "<BR>\n";
275}
276// search form
277echo "<B>Current Search</B>";
278echo " <TABLE WIDTH=\"95%\" CELLPADDING=0 CELLSPACING=0>\n";
279echo "<FORM ACTION=\"search.php\" NAME=s>\n".
280 " <TR >\n".
281 ' <TD><SELECT NAME="mailbox">';
282for ($i = 0; $i < count($boxes); $i++) {
283 if (!in_array('noselect', $boxes[$i]['flags'])) {
284 $box = $boxes[$i]['unformatted'];
285 $box2 = str_replace(' ', '&nbsp;', $boxes[$i]['unformatted-disp']);
286 if ($mailbox == $box) {
287 echo " <OPTION VALUE=\"$box\" SELECTED>$box2</OPTION>\n";
0d672ac0 288 }
56e0b3b7 289 else {
290 echo " <OPTION VALUE=\"$box\">$box2</OPTION>\n";
291 }
292 }
293}
6c8388a9 294 echo "<OPTION VALUE=\"All Folders\"";
295 if ($mailbox == "All Folders") {
56e0b3b7 296 echo "SELECTED";
0d672ac0 297 }
56e0b3b7 298 echo ">All folders</OPTION>\n";
299echo ' </SELECT>'.
300 " </TD>\n".
301 " <TD ALIGN=\"CENTER\">\n";
302$what_disp = str_replace(',', ' ', $what);
303$what_disp = str_replace('\\\\', '\\', $what_disp);
304$what_disp = str_replace('\\"', '"', $what_disp);
305$what_disp = str_replace('"', '&quot;', $what_disp);
306echo " <INPUT TYPE=\"TEXT\" SIZE=\"35\" NAME=\"what\" VALUE=\"$what_disp\">\n".
307 " </TD>\n".
308 "<TD ALIGN=\"RIGHT\">\n".
309 "<SELECT NAME=\"where\">";
310s_opt( 'BODY', $where, _("Body") );
311s_opt( 'TEXT', $where, _("Everywhere") );
312s_opt( 'SUBJECT', $where, _("Subject") );
313s_opt( 'FROM', $where, _("From") );
314s_opt( 'CC', $where, _("Cc") );
315s_opt( 'TO', $where, _("To") );
316echo " </SELECT>\n" .
317 " </TD>\n".
318 " <TD COLSPAN=\"3\" ALIGN=\"CENTER\">\n".
319 " <INPUT TYPE=\"submit\" NAME=\"submit\" VALUE=\"Search\">\n".
320 " </TD>\n".
321 " </TR>\n".
322 "</FORM>\n".
323 " </TABLE>\n".
324 "</TD></TR></TABLE>\n";
325
326
29eb5486 327do_hook("search_after_form");
56e0b3b7 328
329// search all folders option still in the works. returns a table for each
330// folder it finds a match in. The toggle all link does not work
331
332
333if ($search_all == "all") {
334 $mailbox == "";
335 $boxcount = count($boxes);
336 echo "<BR><CENTER><B>Search Results</B><CENTER><BR>\n";
337 for ($x=0;$x<$boxcount;$x++) {
338 if (!in_array('noselect', $boxes[$x]['flags'])) {
339 $mailbox = $boxes[$x]['unformatted'];
340 }
341 echo "<BR><CENTER><B>Folder: $mailbox</CENTER></B>";
342 if (($submit == "Search" || $submit == "Search_no_update") && !empty($what)) {
343 sqimap_mailbox_select($imapConnection, $mailbox);
344 sqimap_search($imapConnection, $where, $what, $mailbox, $color, $pos);
345 }
346 }
0d672ac0 347}
0d672ac0 348
56e0b3b7 349// search one folder option
350
351else {
352 if (($submit == "Search" || $submit == "Search_no_update") && !empty($what)) {
353 echo "<BR><CENTER><B>Search Results</B></CENTER>\n";
354 sqimap_mailbox_select($imapConnection, $mailbox);
355 sqimap_search($imapConnection, $where, $what, $mailbox, $color, $pos);
356 }
29eb5486 357}
56e0b3b7 358
359// must have search terms to search
360
361if ($submit == "Search" && empty($what)) {
362 echo "<BR><CENTER><B>Please enter something to search for</B></CENTER>\n";
363}
364
29eb5486 365do_hook("search_bottom");
99d2a184 366
56e0b3b7 367// all done
368
369sqimap_logout ($imapConnection);
29eb5486 370echo '</body></html>';
99d2a184 371
43fdb2a4 372?>