59177427 |
1 | <?php |
bccadd02 |
2 | |
35586184 |
3 | /** |
a6fd80f5 |
4 | * imap_general.php |
35586184 |
5 | * |
0e1a248b |
6 | * This implements all functions that do general IMAP functions. |
35586184 |
7 | * |
47ccfad4 |
8 | * @copyright © 1999-2006 The SquirrelMail Project Team |
4b4abf93 |
9 | * @license http://opensource.org/licenses/gpl-license.php GNU Public License |
eb19bc67 |
10 | * @version $Id$ |
d6c32258 |
11 | * @package squirrelmail |
eb19bc67 |
12 | * @subpackage imap |
35586184 |
13 | */ |
14 | |
d6c32258 |
15 | /** Includes.. */ |
b68edc75 |
16 | require_once(SM_PATH . 'functions/page_header.php'); |
47a29326 |
17 | require_once(SM_PATH . 'functions/auth.php'); |
938d39ca |
18 | include_once(SM_PATH . 'functions/rfc822address.php'); |
47a29326 |
19 | |
35586184 |
20 | |
48af4b64 |
21 | /** |
22 | * Generates a new session ID by incrementing the last one used; |
23 | * this ensures that each command has a unique ID. |
0e1a248b |
24 | * @param bool $unique_id (since 1.3.0) controls use of unique |
b35a5862 |
25 | * identifiers/message sequence numbers in IMAP commands. See IMAP |
26 | * rfc 'UID command' chapter. |
48af4b64 |
27 | * @return string IMAP session id of the form 'A000'. |
b35a5862 |
28 | * @since 1.2.0 |
48af4b64 |
29 | */ |
2aca19a1 |
30 | function sqimap_session_id($unique_id = FALSE) { |
31 | static $sqimap_session_id = 1; |
32 | |
487daa81 |
33 | if (!$unique_id) { |
098ea084 |
34 | return( sprintf("A%03d", $sqimap_session_id++) ); |
487daa81 |
35 | } else { |
098ea084 |
36 | return( sprintf("A%03d", $sqimap_session_id++) . ' UID' ); |
487daa81 |
37 | } |
9c737111 |
38 | } |
39 | |
48af4b64 |
40 | /** |
3411d4ec |
41 | * Both send a command and accept the result from the command. |
42 | * This is to allow proper session number handling. |
95e3afc1 |
43 | * @param stream $imap_stream imap connection resource |
b35a5862 |
44 | * @param string $query imap command |
45 | * @param boolean $handle_errors see sqimap_retrieve_imap_response() |
95e3afc1 |
46 | * @param array $response |
47 | * @param array $message |
48 | * @param boolean $unique_id (since 1.3.0) see sqimap_session_id(). |
0e1a248b |
49 | * @return mixed returns false on imap error. displays error message |
b35a5862 |
50 | * if imap stream is not available. |
51 | * @since 1.2.3 |
3411d4ec |
52 | */ |
487daa81 |
53 | function sqimap_run_command_list ($imap_stream, $query, $handle_errors, &$response, &$message, $unique_id = false) { |
c5809184 |
54 | if ($imap_stream) { |
098ea084 |
55 | $sid = sqimap_session_id($unique_id); |
56 | fputs ($imap_stream, $sid . ' ' . $query . "\r\n"); |
bc78cc6e |
57 | $tag_uid_a = explode(' ',trim($sid)); |
58 | $tag = $tag_uid_a[0]; |
0dc05a81 |
59 | $read = sqimap_retrieve_imap_response ($imap_stream, $tag, $handle_errors, $response, $message, $query ); |
bc78cc6e |
60 | /* get the response and the message */ |
61 | $message = $message[$tag]; |
1e0a2f0e |
62 | $response = $response[$tag]; |
bc78cc6e |
63 | return $read[$tag]; |
c5809184 |
64 | } else { |
65 | global $squirrelmail_language, $color; |
66 | set_up_language($squirrelmail_language); |
67 | require_once(SM_PATH . 'functions/display_messages.php'); |
6fd95361 |
68 | $string = "<b><font color=\"$color[2]\">\n" . |
0e1a248b |
69 | _("ERROR: No available IMAP stream.") . |
c5809184 |
70 | "</b></font>\n"; |
71 | error_box($string,$color); |
098ea084 |
72 | return false; |
c5809184 |
73 | } |
1c72b151 |
74 | } |
75 | |
b35a5862 |
76 | /** |
95e3afc1 |
77 | * @param stream $imap_stream imap connection resource |
b35a5862 |
78 | * @param string $query imap command |
79 | * @param boolean $handle_errors see sqimap_retrieve_imap_response() |
95e3afc1 |
80 | * @param array $response empty string, if return = false |
81 | * @param array $message empty string, if return = false |
82 | * @param boolean $unique_id (since 1.3.0) see sqimap_session_id() |
83 | * @param boolean $filter (since 1.4.1 and 1.5.0) see sqimap_fread() |
84 | * @param mixed $outputstream (since 1.4.1 and 1.5.0) see sqimap_fread() |
85 | * @param boolean $no_return (since 1.4.1 and 1.5.0) see sqimap_fread() |
0e1a248b |
86 | * @return mixed returns false on imap error. displays error message |
b35a5862 |
87 | * if imap stream is not available. |
88 | * @since 1.2.3 |
89 | */ |
1e0a2f0e |
90 | function sqimap_run_command ($imap_stream, $query, $handle_errors, &$response, |
7c7b74b3 |
91 | &$message, $unique_id = false,$filter=false, |
92 | $outputstream=false,$no_return=false) { |
c5809184 |
93 | if ($imap_stream) { |
94 | $sid = sqimap_session_id($unique_id); |
1e0a2f0e |
95 | fputs ($imap_stream, $sid . ' ' . $query . "\r\n"); |
bc78cc6e |
96 | $tag_uid_a = explode(' ',trim($sid)); |
97 | $tag = $tag_uid_a[0]; |
1e0a2f0e |
98 | |
bc78cc6e |
99 | $read = sqimap_read_data ($imap_stream, $tag, $handle_errors, $response, |
7c7b74b3 |
100 | $message, $query,$filter,$outputstream,$no_return); |
0e1a248b |
101 | if (empty($read)) { //IMAP server dropped its connection |
ec73f243 |
102 | $response = ''; |
103 | $message = ''; |
104 | return false; |
105 | } |
bc78cc6e |
106 | /* retrieve the response and the message */ |
107 | $response = $response[$tag]; |
108 | $message = $message[$tag]; |
1e0a2f0e |
109 | |
bc78cc6e |
110 | if (!empty($read[$tag])) { |
111 | return $read[$tag][0]; |
112 | } else { |
113 | return $read[$tag]; |
114 | } |
c5809184 |
115 | } else { |
116 | global $squirrelmail_language, $color; |
117 | set_up_language($squirrelmail_language); |
118 | require_once(SM_PATH . 'functions/display_messages.php'); |
6fd95361 |
119 | $string = "<b><font color=\"$color[2]\">\n" . |
0e1a248b |
120 | _("ERROR: No available IMAP stream.") . |
c5809184 |
121 | "</b></font>\n"; |
122 | error_box($string,$color); |
098ea084 |
123 | return false; |
1e0a2f0e |
124 | } |
bc78cc6e |
125 | } |
48af4b64 |
126 | |
0022f6db |
127 | /** |
128 | * @param mixed $new_query |
129 | * @param string $tag |
130 | * @param array $aQuery |
95e3afc1 |
131 | * @param boolean $unique_id see sqimap_session_id() |
0022f6db |
132 | * @since 1.5.0 |
133 | */ |
bc78cc6e |
134 | function sqimap_prepare_pipelined_query($new_query,&$tag,&$aQuery,$unique_id) { |
135 | $sid = sqimap_session_id($unique_id); |
136 | $tag_uid_a = explode(' ',trim($sid)); |
137 | $tag = $tag_uid_a[0]; |
0b38d197 |
138 | $query = $sid . ' '.$new_query."\r\n"; |
bc78cc6e |
139 | $aQuery[$tag] = $query; |
42a07ac1 |
140 | } |
141 | |
0022f6db |
142 | /** |
95e3afc1 |
143 | * @param stream $imap_stream imap stream |
0022f6db |
144 | * @param array $aQueryList |
145 | * @param boolean $handle_errors |
146 | * @param array $aServerResponse |
147 | * @param array $aServerMessage |
95e3afc1 |
148 | * @param boolean $unique_id see sqimap_session_id() |
149 | * @param boolean $filter see sqimap_fread() |
150 | * @param mixed $outputstream see sqimap_fread() |
151 | * @param boolean $no_return see sqimap_fread() |
0022f6db |
152 | * @since 1.5.0 |
153 | */ |
1e0a2f0e |
154 | function sqimap_run_pipelined_command ($imap_stream, $aQueryList, $handle_errors, |
bc78cc6e |
155 | &$aServerResponse, &$aServerMessage, $unique_id = false, |
1e0a2f0e |
156 | $filter=false,$outputstream=false,$no_return=false) { |
bc78cc6e |
157 | $aResponse = false; |
5c300c60 |
158 | |
1e0a2f0e |
159 | /* |
0e1a248b |
160 | Do not fire all calls at once to the IMAP server but split the calls up |
1e0a2f0e |
161 | in portions of $iChunkSize. If we do not do that I think we misbehave as |
0e1a248b |
162 | IMAP client or should handle BYE calls if the IMAP server drops the |
52c8b585 |
163 | connection because the number of queries is to large. This isn't tested |
164 | but a wild guess how it could work in the field. |
1e0a2f0e |
165 | |
166 | After testing it on Exchange 2000 we discovered that a chunksize of 32 |
0b38d197 |
167 | was quicker then when we raised it to 128. |
52c8b585 |
168 | */ |
169 | $iQueryCount = count($aQueryList); |
170 | $iChunkSize = 32; |
171 | // array_chunk would also do the job but it's supported from php > 4.2 |
172 | $aQueryChunks = array(); |
173 | $iLoops = floor($iQueryCount / $iChunkSize); |
174 | |
5c300c60 |
175 | if ($iLoops * $iChunkSize != $iQueryCount) ++$iLoops; |
52c8b585 |
176 | |
177 | if (!function_exists('array_chunk')) { // arraychunk replacement |
5c300c60 |
178 | reset($aQueryList); |
52c8b585 |
179 | for($i=0;$i<$iLoops;++$i) { |
5c300c60 |
180 | for($j=0;$j<$iChunkSize;++$j) { |
181 | $key = key($aQueryList); |
182 | $aTmp[$key] = $aQueryList[$key]; |
183 | if (next($aQueryList) === false) break; |
184 | } |
185 | $aQueryChunks[] = $aTmp; |
1e0a2f0e |
186 | } |
52c8b585 |
187 | } else { |
188 | $aQueryChunks = array_chunk($aQueryList,$iChunkSize,true); |
bc78cc6e |
189 | } |
1e0a2f0e |
190 | |
52c8b585 |
191 | for ($i=0;$i<$iLoops;++$i) { |
192 | $aQuery = $aQueryChunks[$i]; |
193 | foreach($aQuery as $tag => $query) { |
194 | fputs($imap_stream,$query); |
195 | $aResults[$tag] = false; |
196 | } |
52c8b585 |
197 | foreach($aQuery as $tag => $query) { |
5c300c60 |
198 | if ($aResults[$tag] == false) { |
1e0a2f0e |
199 | $aReturnedResponse = sqimap_retrieve_imap_response ($imap_stream, $tag, |
bc78cc6e |
200 | $handle_errors, $response, $message, $query, |
201 | $filter,$outputstream,$no_return); |
52c8b585 |
202 | foreach ($aReturnedResponse as $returned_tag => $aResponse) { |
5c300c60 |
203 | if (!empty($aResponse)) { |
52c8b585 |
204 | $aResults[$returned_tag] = $aResponse[0]; |
5c300c60 |
205 | } else { |
206 | $aResults[$returned_tag] = $aResponse; |
207 | } |
52c8b585 |
208 | $aServerResponse[$returned_tag] = $response[$returned_tag]; |
209 | $aServerMessage[$returned_tag] = $message[$returned_tag]; |
210 | } |
bc78cc6e |
211 | } |
212 | } |
213 | } |
b7277e4f |
214 | return $aResults; |
bc78cc6e |
215 | } |
9c737111 |
216 | |
1e0a2f0e |
217 | /** |
0e1a248b |
218 | * Custom fgets function: gets a line from the IMAP server, |
48af4b64 |
219 | * no matter how big it may be. |
95e3afc1 |
220 | * @param stream $imap_stream the stream to read from |
48af4b64 |
221 | * @return string a line |
0022f6db |
222 | * @since 1.2.8 |
b8c285ab |
223 | */ |
b8c285ab |
224 | function sqimap_fgets($imap_stream) { |
225 | $read = ''; |
226 | $buffer = 4096; |
227 | $results = ''; |
c41daf03 |
228 | $offset = 0; |
229 | while (strpos($results, "\r\n", $offset) === false) { |
b8c285ab |
230 | if (!($read = fgets($imap_stream, $buffer))) { |
329a7ca5 |
231 | /* this happens in case of an error */ |
232 | /* reset $results because it's useless */ |
233 | $results = false; |
b8c285ab |
234 | break; |
235 | } |
c41daf03 |
236 | if ( $results != '' ) { |
237 | $offset = strlen($results) - 1; |
238 | } |
b8c285ab |
239 | $results .= $read; |
240 | } |
241 | return $results; |
242 | } |
243 | |
0022f6db |
244 | /** |
245 | * @param stream $imap_stream |
246 | * @param integer $iSize |
95e3afc1 |
247 | * @param boolean $filter |
248 | * @param mixed $outputstream stream or 'php://stdout' string |
0e1a248b |
249 | * @param boolean $no_return controls data returned by function |
0022f6db |
250 | * @return string |
251 | * @since 1.4.1 |
252 | */ |
7c7b74b3 |
253 | function sqimap_fread($imap_stream,$iSize,$filter=false, |
254 | $outputstream=false, $no_return=false) { |
255 | if (!$filter || !$outputstream) { |
256 | $iBufferSize = $iSize; |
257 | } else { |
811318c5 |
258 | // see php bug 24033. They changed fread behaviour %$^&$% |
977a6085 |
259 | $iBufferSize = 7800; // multiple of 78 in case of base64 decoding. |
260 | } |
261 | if ($iSize < $iBufferSize) { |
262 | $iBufferSize = $iSize; |
7c7b74b3 |
263 | } |
7c0ec1d8 |
264 | |
5eba0be2 |
265 | $iRetrieved = 0; |
977a6085 |
266 | $results = ''; |
267 | $sRead = $sReadRem = ''; |
1e0a2f0e |
268 | // NB: fread can also stop at end of a packet on sockets. |
977a6085 |
269 | while ($iRetrieved < $iSize) { |
7c7b74b3 |
270 | $sRead = fread($imap_stream,$iBufferSize); |
977a6085 |
271 | $iLength = strlen($sRead); |
272 | $iRetrieved += $iLength ; |
273 | $iRemaining = $iSize - $iRetrieved; |
274 | if ($iRemaining < $iBufferSize) { |
275 | $iBufferSize = $iRemaining; |
276 | } |
13aabbcf |
277 | if ($sRead == '') { |
7c7b74b3 |
278 | $results = false; |
279 | break; |
280 | } |
13aabbcf |
281 | if ($sReadRem != '') { |
977a6085 |
282 | $sRead = $sReadRem . $sRead; |
283 | $sReadRem = ''; |
284 | } |
7c0ec1d8 |
285 | |
13aabbcf |
286 | if ($filter && $sRead != '') { |
1e0a2f0e |
287 | // in case the filter is base64 decoding we return a remainder |
7c0ec1d8 |
288 | $sReadRem = $filter($sRead); |
7c7b74b3 |
289 | } |
13aabbcf |
290 | if ($outputstream && $sRead != '') { |
7c7b74b3 |
291 | if (is_resource($outputstream)) { |
292 | fwrite($outputstream,$sRead); |
293 | } else if ($outputstream == 'php://stdout') { |
294 | echo $sRead; |
295 | } |
296 | } |
297 | if ($no_return) { |
298 | $sRead = ''; |
1e0a2f0e |
299 | } else { |
977a6085 |
300 | $results .= $sRead; |
7c7b74b3 |
301 | } |
7c7b74b3 |
302 | } |
1e0a2f0e |
303 | return $results; |
304 | } |
977a6085 |
305 | |
7c0ec1d8 |
306 | |
48af4b64 |
307 | /** |
308 | * Obsolete function, inform plugins that use it |
95e3afc1 |
309 | * @param stream $imap_stream |
310 | * @param string $tag |
311 | * @param boolean $handle_errors |
312 | * @param array $response |
313 | * @param array $message |
314 | * @param string $query |
b35a5862 |
315 | * @since 1.1.3 |
316 | * @deprecated (since 1.5.0) use sqimap_run_command or sqimap_run_command_list instead |
48af4b64 |
317 | */ |
1e0a2f0e |
318 | function sqimap_read_data_list($imap_stream, $tag, $handle_errors, |
0dc05a81 |
319 | &$response, &$message, $query = '') { |
320 | global $color, $squirrelmail_language; |
321 | set_up_language($squirrelmail_language); |
322 | require_once(SM_PATH . 'functions/display_messages.php'); |
6fd95361 |
323 | $string = "<b><font color=\"$color[2]\">\n" . |
0e1a248b |
324 | _("ERROR: Bad function call.") . |
6fd95361 |
325 | "</b><br />\n" . |
0dc05a81 |
326 | _("Reason:") . ' '. |
6fd95361 |
327 | 'There is a plugin installed which make use of the <br />' . |
328 | 'SquirrelMail internal function sqimap_read_data_list.<br />'. |
329 | 'Please adapt the installed plugin and let it use<br />'. |
330 | 'sqimap_run_command or sqimap_run_command_list instead<br /><br />'. |
331 | 'The following query was issued:<br />'. |
332 | htmlspecialchars($query) . '<br />' . "</font><br />\n"; |
0dc05a81 |
333 | error_box($string,$color); |
1e0a2f0e |
334 | echo '</body></html>'; |
335 | exit; |
0dc05a81 |
336 | } |
7c7b74b3 |
337 | |
48af4b64 |
338 | /** |
0e1a248b |
339 | * Function to display an error related to an IMAP query. |
48af4b64 |
340 | * @param string title the caption of the error box |
341 | * @param string query the query that went wrong |
ec73f243 |
342 | * @param string message_title optional message title |
343 | * @param string message optional error message |
344 | * @param string $link an optional link to try again |
48af4b64 |
345 | * @return void |
0022f6db |
346 | * @since 1.5.0 |
48af4b64 |
347 | */ |
ec73f243 |
348 | function sqimap_error_box($title, $query = '', $message_title = '', $message = '', $link = '') |
4974c2a0 |
349 | { |
350 | global $color, $squirrelmail_language; |
351 | |
352 | set_up_language($squirrelmail_language); |
353 | require_once(SM_PATH . 'functions/display_messages.php'); |
6fd95361 |
354 | $string = "<font color=\"$color[2]\"><b>\n" . $title . "</b><br />\n"; |
bf15f116 |
355 | $cmd = explode(' ',$query); |
356 | $cmd= strtolower($cmd[0]); |
357 | |
358 | if ($query != '' && $cmd != 'login') |
6fd95361 |
359 | $string .= _("Query:") . ' ' . htmlspecialchars($query) . '<br />'; |
4974c2a0 |
360 | if ($message_title != '') |
361 | $string .= $message_title; |
362 | if ($message != '') |
363 | $string .= htmlspecialchars($message); |
6fd95361 |
364 | $string .= "</font><br />\n"; |
ec73f243 |
365 | if ($link != '') |
366 | $string .= $link; |
4974c2a0 |
367 | error_box($string,$color); |
368 | } |
369 | |
48af4b64 |
370 | /** |
3411d4ec |
371 | * Reads the output from the IMAP stream. If handle_errors is set to true, |
372 | * this will also handle all errors that are received. If it is not set, |
48af4b64 |
373 | * the errors will be sent back through $response and $message. |
95e3afc1 |
374 | * @param stream $imap_stream imap stream |
375 | * @param string $tag |
376 | * @param boolean $handle_errors handle errors internally or send them in $response and $message. |
0022f6db |
377 | * @param array $response |
378 | * @param array $message |
95e3afc1 |
379 | * @param string $query command that can be printed if something fails |
380 | * @param boolean $filter see sqimap_fread() |
381 | * @param mixed $outputstream see sqimap_fread() |
382 | * @param boolean $no_return see sqimap_fread() |
0022f6db |
383 | * @since 1.5.0 |
bee165ef |
384 | */ |
1e0a2f0e |
385 | function sqimap_retrieve_imap_response($imap_stream, $tag, $handle_errors, |
7c7b74b3 |
386 | &$response, &$message, $query = '', |
387 | $filter = false, $outputstream = false, $no_return = false) { |
9c737111 |
388 | global $color, $squirrelmail_language; |
9c737111 |
389 | $read = ''; |
bc78cc6e |
390 | if (!is_array($message)) $message = array(); |
391 | if (!is_array($response)) $response = array(); |
ec73f243 |
392 | $aResponse = ''; |
b8c285ab |
393 | $resultlist = array(); |
394 | $data = array(); |
395 | $read = sqimap_fgets($imap_stream); |
8d8da447 |
396 | $i = 0; |
bea3eb1e |
397 | while ($read) { |
398 | $char = $read{0}; |
399 | switch ($char) |
400 | { |
15bc7f66 |
401 | case '+': |
402 | default: |
403 | $read = sqimap_fgets($imap_stream); |
404 | break; |
405 | |
406 | case $tag{0}: |
407 | { |
bea3eb1e |
408 | /* get the command */ |
409 | $arg = ''; |
410 | $i = strlen($tag)+1; |
411 | $s = substr($read,$i); |
412 | if (($j = strpos($s,' ')) || ($j = strpos($s,"\n"))) { |
413 | $arg = substr($s,0,$j); |
414 | } |
415 | $found_tag = substr($read,0,$i-1); |
5c300c60 |
416 | if ($found_tag) { |
bea3eb1e |
417 | switch ($arg) |
418 | { |
15bc7f66 |
419 | case 'OK': |
420 | case 'BAD': |
421 | case 'NO': |
422 | case 'BYE': |
423 | case 'PREAUTH': |
bc78cc6e |
424 | $response[$found_tag] = $arg; |
425 | $message[$found_tag] = trim(substr($read,$i+strlen($arg))); |
426 | if (!empty($data)) { |
427 | $resultlist[] = $data; |
428 | } |
5c300c60 |
429 | $aResponse[$found_tag] = $resultlist; |
430 | $data = $resultlist = array(); |
431 | if ($found_tag == $tag) { |
432 | break 3; /* switch switch while */ |
433 | } |
434 | break; |
1e0a2f0e |
435 | default: |
bea3eb1e |
436 | /* this shouldn't happen */ |
bc78cc6e |
437 | $response[$found_tag] = $arg; |
438 | $message[$found_tag] = trim(substr($read,$i+strlen($arg))); |
439 | if (!empty($data)) { |
440 | $resultlist[] = $data; |
441 | } |
442 | $aResponse[$found_tag] = $resultlist; |
5c300c60 |
443 | $data = $resultlist = array(); |
444 | if ($found_tag == $tag) { |
445 | break 3; /* switch switch while */ |
446 | } |
bc78cc6e |
447 | } |
bea3eb1e |
448 | } |
5c300c60 |
449 | $read = sqimap_fgets($imap_stream); |
450 | if ($read === false) { /* error */ |
4920e1e0 |
451 | break 2; /* switch while */ |
5c300c60 |
452 | } |
453 | break; |
15bc7f66 |
454 | } // end case $tag{0} |
455 | |
456 | case '*': |
457 | { |
bea3eb1e |
458 | if (preg_match('/^\*\s\d+\sFETCH/',$read)) { |
459 | /* check for literal */ |
460 | $s = substr($read,-3); |
461 | $fetch_data = array(); |
462 | do { /* outer loop, continue until next untagged fetch |
463 | or tagged reponse */ |
464 | do { /* innerloop for fetching literals. with this loop |
465 | we prohibid that literal responses appear in the |
466 | outer loop so we can trust the untagged and |
467 | tagged info provided by $read */ |
468 | if ($s === "}\r\n") { |
469 | $j = strrpos($read,'{'); |
470 | $iLit = substr($read,$j+1,-3); |
471 | $fetch_data[] = $read; |
7c7b74b3 |
472 | $sLiteral = sqimap_fread($imap_stream,$iLit,$filter,$outputstream,$no_return); |
329a7ca5 |
473 | if ($sLiteral === false) { /* error */ |
474 | break 4; /* while while switch while */ |
475 | } |
bea3eb1e |
476 | /* backwards compattibility */ |
477 | $aLiteral = explode("\n", $sLiteral); |
478 | /* release not neaded data */ |
479 | unset($sLiteral); |
480 | foreach ($aLiteral as $line) { |
481 | $fetch_data[] = $line ."\n"; |
482 | } |
483 | /* release not neaded data */ |
1e0a2f0e |
484 | unset($aLiteral); |
bea3eb1e |
485 | /* next fgets belongs to this fetch because |
486 | we just got the exact literalsize and there |
487 | must follow data to complete the response */ |
329a7ca5 |
488 | $read = sqimap_fgets($imap_stream); |
489 | if ($read === false) { /* error */ |
490 | break 4; /* while while switch while */ |
491 | } |
c0b23345 |
492 | $fetch_data[] = $read; |
bea3eb1e |
493 | } else { |
329a7ca5 |
494 | $fetch_data[] = $read; |
bea3eb1e |
495 | } |
496 | /* retrieve next line and check in the while |
497 | statements if it belongs to this fetch response */ |
498 | $read = sqimap_fgets($imap_stream); |
329a7ca5 |
499 | if ($read === false) { /* error */ |
500 | break 4; /* while while switch while */ |
501 | } |
bea3eb1e |
502 | /* check for next untagged reponse and break */ |
503 | if ($read{0} == '*') break 2; |
504 | $s = substr($read,-3); |
505 | } while ($s === "}\r\n"); |
506 | $s = substr($read,-3); |
507 | } while ($read{0} !== '*' && |
106d4087 |
508 | substr($read,0,strlen($tag)) !== $tag); |
329a7ca5 |
509 | $resultlist[] = $fetch_data; |
bea3eb1e |
510 | /* release not neaded data */ |
511 | unset ($fetch_data); |
512 | } else { |
513 | $s = substr($read,-3); |
514 | do { |
515 | if ($s === "}\r\n") { |
516 | $j = strrpos($read,'{'); |
517 | $iLit = substr($read,$j+1,-3); |
518 | $data[] = $read; |
329a7ca5 |
519 | $sLiteral = fread($imap_stream,$iLit); |
c0b23345 |
520 | if ($sLiteral === false) { /* error */ |
329a7ca5 |
521 | $read = false; |
522 | break 3; /* while switch while */ |
523 | } |
c0b23345 |
524 | $data[] = $sLiteral; |
b7277e4f |
525 | $data[] = sqimap_fgets($imap_stream); |
bea3eb1e |
526 | } else { |
329a7ca5 |
527 | $data[] = $read; |
bea3eb1e |
528 | } |
529 | $read = sqimap_fgets($imap_stream); |
329a7ca5 |
530 | if ($read === false) { |
531 | break 3; /* while switch while */ |
532 | } else if ($read{0} == '*') { |
106d4087 |
533 | break; |
534 | } |
bea3eb1e |
535 | $s = substr($read,-3); |
536 | } while ($s === "}\r\n"); |
537 | break 1; |
1e0a2f0e |
538 | } |
bea3eb1e |
539 | break; |
15bc7f66 |
540 | } // end case '*' |
541 | } // end switch |
c0b23345 |
542 | } // end while |
1e0a2f0e |
543 | |
c0b23345 |
544 | /* error processing in case $read is false */ |
d7542838 |
545 | if ($read === false) { |
d3d9ef2d |
546 | // try to retrieve an untagged bye respons from the results |
547 | $sResponse = array_pop($data); |
d7542838 |
548 | if ($sResponse !== NULL && strpos($sResponse,'* BYE') !== false) { |
549 | if (!$handle_errors) { |
550 | $query = ''; |
551 | } |
0e1a248b |
552 | sqimap_error_box(_("ERROR: IMAP server closed the connection."), $query, _("Server responded:"),$sResponse); |
d7542838 |
553 | echo '</body></html>'; |
554 | exit; |
555 | } else if ($handle_errors) { |
1e0a2f0e |
556 | unset($data); |
0e1a248b |
557 | sqimap_error_box(_("ERROR: Connection dropped by IMAP server."), $query); |
ec73f243 |
558 | exit; |
559 | } |
b8c285ab |
560 | } |
1e0a2f0e |
561 | |
15bc7f66 |
562 | /* Set $resultlist array */ |
b8c285ab |
563 | if (!empty($data)) { |
bc78cc6e |
564 | //$resultlist[] = $data; |
9c737111 |
565 | } |
b8c285ab |
566 | elseif (empty($resultlist)) { |
1e0a2f0e |
567 | $resultlist[] = array(); |
b8c285ab |
568 | } |
15bc7f66 |
569 | |
570 | /* Return result or handle errors */ |
bee165ef |
571 | if ($handle_errors == false) { |
bc78cc6e |
572 | return $aResponse; |
dd381002 |
573 | } |
4974c2a0 |
574 | switch ($response[$tag]) { |
dd381002 |
575 | case 'OK': |
bc78cc6e |
576 | return $aResponse; |
329a7ca5 |
577 | break; |
1e0a2f0e |
578 | case 'NO': |
dd381002 |
579 | /* ignore this error from M$ exchange, it is not fatal (aka bug) */ |
6b6c2e06 |
580 | if (strstr($message[$tag], 'command resulted in') === false) { |
0e1a248b |
581 | sqimap_error_box(_("ERROR: Could not complete request."), $query, _("Reason Given:") . ' ', $message[$tag]); |
329a7ca5 |
582 | echo '</body></html>'; |
052e0c26 |
583 | exit; |
9c737111 |
584 | } |
329a7ca5 |
585 | break; |
1e0a2f0e |
586 | case 'BAD': |
0e1a248b |
587 | sqimap_error_box(_("ERROR: Bad or malformed request."), $query, _("Server responded:") . ' ', $message[$tag]); |
1e0a2f0e |
588 | echo '</body></html>'; |
589 | exit; |
590 | case 'BYE': |
0e1a248b |
591 | sqimap_error_box(_("ERROR: IMAP server closed the connection."), $query, _("Server responded:") . ' ', $message[$tag]); |
1e0a2f0e |
592 | echo '</body></html>'; |
9c737111 |
593 | exit; |
1e0a2f0e |
594 | default: |
0e1a248b |
595 | sqimap_error_box(_("ERROR: Unknown IMAP response."), $query, _("Server responded:") . ' ', $message[$tag]); |
329a7ca5 |
596 | /* the error is displayed but because we don't know the reponse we |
597 | return the result anyway */ |
1e0a2f0e |
598 | return $aResponse; |
329a7ca5 |
599 | break; |
9c737111 |
600 | } |
9c737111 |
601 | } |
602 | |
0022f6db |
603 | /** |
95e3afc1 |
604 | * @param stream $imap_stream imap string |
0022f6db |
605 | * @param string $tag_uid |
606 | * @param boolean $handle_errors |
607 | * @param array $response |
608 | * @param array $message |
95e3afc1 |
609 | * @param string $query (since 1.2.5) |
610 | * @param boolean $filter (since 1.4.1) see sqimap_fread() |
611 | * @param mixed $outputstream (since 1.4.1) see sqimap_fread() |
612 | * @param boolean $no_return (since 1.4.1) see sqimap_fread() |
0022f6db |
613 | */ |
1e0a2f0e |
614 | function sqimap_read_data ($imap_stream, $tag_uid, $handle_errors, |
7c7b74b3 |
615 | &$response, &$message, $query = '', |
616 | $filter=false,$outputstream=false,$no_return=false) { |
bc78cc6e |
617 | |
618 | $tag_uid_a = explode(' ',trim($tag_uid)); |
619 | $tag = $tag_uid_a[0]; |
620 | |
1e0a2f0e |
621 | $res = sqimap_retrieve_imap_response($imap_stream, $tag, $handle_errors, |
622 | $response, $message, $query,$filter,$outputstream,$no_return); |
623 | return $res; |
9c737111 |
624 | } |
625 | |
48af4b64 |
626 | /** |
b98732e8 |
627 | * Connects to the IMAP server and returns a resource identifier for use with |
a15f9d93 |
628 | * the other SquirrelMail IMAP functions. Does NOT login! |
48af4b64 |
629 | * @param string server hostname of IMAP server |
630 | * @param int port port number to connect to |
a15f9d93 |
631 | * @param integer $tls whether to use plain text(0), TLS(1) or STARTTLS(2) when connecting. |
632 | * Argument was boolean before 1.5.1. |
48af4b64 |
633 | * @return imap-stream resource identifier |
0022f6db |
634 | * @since 1.5.0 (usable only in 1.5.1 or later) |
b98732e8 |
635 | */ |
a15f9d93 |
636 | function sqimap_create_stream($server,$port,$tls=0) { |
ce68b76b |
637 | global $squirrelmail_language; |
b98732e8 |
638 | |
abc4a428 |
639 | if (strstr($server,':') && ! preg_match("/^\[.*\]$/",$server)) { |
640 | // numerical IPv6 address must be enclosed in square brackets |
641 | $server = '['.$server.']'; |
642 | } |
a15f9d93 |
643 | |
644 | if ($tls == 1) { |
b98732e8 |
645 | if ((check_php_version(4,3)) and (extension_loaded('openssl'))) { |
646 | /* Use TLS by prefixing "tls://" to the hostname */ |
57ffe0af |
647 | $server = 'tls://' . $server; |
b98732e8 |
648 | } else { |
649 | require_once(SM_PATH . 'functions/display_messages.php'); |
3b151851 |
650 | logout_error( sprintf(_("Error connecting to IMAP server: %s."), $server). |
651 | '<br />'. |
652 | _("TLS is enabled, but this version of PHP does not support TLS sockets, or is missing the openssl extension."). |
653 | '<br /><br />'. |
0a6be7d1 |
654 | _("Please contact your system administrator and report this error."), |
abc4a428 |
655 | sprintf(_("Error connecting to IMAP server: %s."), $server)); |
b98732e8 |
656 | } |
657 | } |
658 | |
82f403aa |
659 | $imap_stream = @fsockopen($server, $port, $error_number, $error_string, 15); |
b98732e8 |
660 | |
661 | /* Do some error correction */ |
662 | if (!$imap_stream) { |
663 | set_up_language($squirrelmail_language, true); |
664 | require_once(SM_PATH . 'functions/display_messages.php'); |
3b151851 |
665 | logout_error( sprintf(_("Error connecting to IMAP server: %s."), $server). |
0a6be7d1 |
666 | "<br />\r\n$error_number : $error_string<br />\r\n", |
abc4a428 |
667 | sprintf(_("Error connecting to IMAP server: %s."), $server) ); |
b98732e8 |
668 | exit; |
669 | } |
670 | $server_info = fgets ($imap_stream, 1024); |
a15f9d93 |
671 | |
672 | /** |
673 | * Implementing IMAP STARTTLS (rfc2595) in php 5.1.0+ |
674 | * http://www.php.net/stream-socket-enable-crypto |
675 | */ |
676 | if ($tls == 2) { |
677 | if (function_exists('stream_socket_enable_crypto')) { |
678 | // check starttls capability, don't use cached capability version |
679 | if (! sqimap_capability($imap_stream, 'STARTTLS', false)) { |
680 | // imap server does not declare starttls support |
681 | sqimap_error_box(sprintf(_("Error connecting to IMAP server: %s."), $server), |
682 | '','', |
683 | _("IMAP STARTTLS is enabled in SquirrelMail configuration, but used IMAP server does not support STARTTLS.")); |
684 | exit; |
685 | } |
686 | |
687 | // issue starttls command and check response |
688 | sqimap_run_command($imap_stream, 'STARTTLS', false, $starttls_response, $starttls_message); |
689 | // check response |
690 | if ($starttls_response!='OK') { |
691 | // starttls command failed |
692 | sqimap_error_box(sprintf(_("Error connecting to IMAP server: %s."), $server), |
693 | 'STARTTLS', |
3c021d16 |
694 | _("Server replied:") . ' ', |
a15f9d93 |
695 | $starttls_message); |
696 | exit(); |
697 | } |
698 | |
699 | // start crypto on connection. suppress function errors. |
700 | if (@stream_socket_enable_crypto($imap_stream,true,STREAM_CRYPTO_METHOD_TLS_CLIENT)) { |
701 | // starttls was successful |
702 | |
703 | /** |
4ae9beb7 |
704 | * RFC 2595 requires to discard CAPABILITY information after successful |
705 | * STARTTLS command. We don't follow RFC, because SquirrelMail stores CAPABILITY |
706 | * information only after successful login (src/redirect.php) and cached information |
707 | * is used only in other php script connections after successful STARTTLS. If script |
708 | * issues sqimap_capability() call before sqimap_login() and wants to get initial |
709 | * capability response, script should set third sqimap_capability() argument to false. |
a15f9d93 |
710 | */ |
4ae9beb7 |
711 | //sqsession_unregister('sqimap_capabilities'); |
a15f9d93 |
712 | } else { |
713 | /** |
714 | * stream_socket_enable_crypto() call failed. Possible issues: |
715 | * - broken ssl certificate (uw drops connection, error is in syslog mail facility) |
4ae9beb7 |
716 | * - some ssl error (can reproduce with STREAM_CRYPTO_METHOD_SSLv3_CLIENT, PHP E_WARNING |
a15f9d93 |
717 | * suppressed in stream_socket_enable_crypto() call) |
718 | */ |
719 | sqimap_error_box(sprintf(_("Error connecting to IMAP server: %s."), $server), |
720 | '','', |
721 | _("Unable to start TLS.")); |
722 | /** |
4ae9beb7 |
723 | * Bug: stream_socket_enable_crypto() does not register SSL errors in |
724 | * openssl_error_string() or stream notification wrapper and displays |
725 | * them in E_WARNING level message. It is impossible to retrieve error |
a15f9d93 |
726 | * message without own error handler. |
727 | */ |
728 | exit; |
729 | } |
730 | } else { |
731 | // php install does not support stream_socket_enable_crypto() function |
732 | sqimap_error_box(sprintf(_("Error connecting to IMAP server: %s."), $server), |
733 | '','', |
734 | _("IMAP STARTTLS is enabled in SquirrelMail configuration, but used PHP version does not support functions that allow to enable encryption on open socket.")); |
735 | exit; |
736 | } |
737 | } |
b98732e8 |
738 | return $imap_stream; |
739 | } |
740 | |
48af4b64 |
741 | /** |
0e1a248b |
742 | * Logs the user into the IMAP server. If $hide is set, no error messages |
743 | * will be displayed. This function returns the IMAP connection handle. |
0022f6db |
744 | * @param string $username user name |
745 | * @param string $password encrypted password |
746 | * @param string $imap_server_address address of imap server |
747 | * @param integer $imap_port port of imap server |
748 | * @param boolean $hide controls display connection errors |
749 | * @return stream |
3411d4ec |
750 | */ |
9c737111 |
751 | function sqimap_login ($username, $password, $imap_server_address, $imap_port, $hide) { |
fe55c7c7 |
752 | global $color, $squirrelmail_language, $onetimepad, $use_imap_tls, |
753 | $imap_auth_mech, $sqimap_capabilities; |
85fc999e |
754 | |
eb2f6102 |
755 | if (!isset($onetimepad) || empty($onetimepad)) { |
756 | sqgetglobalvar('onetimepad' , $onetimepad , SQ_SESSION ); |
757 | } |
fe55c7c7 |
758 | if (!isset($sqimap_capabilities)) { |
759 | sqgetglobalvar('sqimap_capabilities' , $capability , SQ_SESSION ); |
760 | } |
761 | |
b98732e8 |
762 | $host = $imap_server_address; |
bd9829d7 |
763 | $imap_server_address = sqimap_get_user_server($imap_server_address, $username); |
fe55c7c7 |
764 | |
b98732e8 |
765 | $imap_stream = sqimap_create_stream($imap_server_address,$imap_port,$use_imap_tls); |
fe55c7c7 |
766 | |
2f1f7a12 |
767 | /* Decrypt the password */ |
768 | $password = OneTimePadDecrypt($password, $onetimepad); |
769 | |
b98732e8 |
770 | if (($imap_auth_mech == 'cram-md5') OR ($imap_auth_mech == 'digest-md5')) { |
3b151851 |
771 | // We're using some sort of authentication OTHER than plain or login |
b98732e8 |
772 | $tag=sqimap_session_id(false); |
773 | if ($imap_auth_mech == 'digest-md5') { |
098ea084 |
774 | $query = $tag . " AUTHENTICATE DIGEST-MD5\r\n"; |
b98732e8 |
775 | } elseif ($imap_auth_mech == 'cram-md5') { |
098ea084 |
776 | $query = $tag . " AUTHENTICATE CRAM-MD5\r\n"; |
b98732e8 |
777 | } |
778 | fputs($imap_stream,$query); |
779 | $answer=sqimap_fgets($imap_stream); |
780 | // Trim the "+ " off the front |
781 | $response=explode(" ",$answer,3); |
782 | if ($response[0] == '+') { |
098ea084 |
783 | // Got a challenge back |
b98732e8 |
784 | $challenge=$response[1]; |
785 | if ($imap_auth_mech == 'digest-md5') { |
786 | $reply = digest_md5_response($username,$password,$challenge,'imap',$host); |
787 | } elseif ($imap_auth_mech == 'cram-md5') { |
788 | $reply = cram_md5_response($username,$password,$challenge); |
789 | } |
790 | fputs($imap_stream,$reply); |
791 | $read=sqimap_fgets($imap_stream); |
792 | if ($imap_auth_mech == 'digest-md5') { |
3b151851 |
793 | // DIGEST-MD5 has an extra step.. |
b98732e8 |
794 | if (substr($read,0,1) == '+') { // OK so far.. |
098ea084 |
795 | fputs($imap_stream,"\r\n"); |
796 | $read=sqimap_fgets($imap_stream); |
098ea084 |
797 | } |
b98732e8 |
798 | } |
799 | $results=explode(" ",$read,3); |
800 | $response=$results[1]; |
801 | $message=$results[2]; |
802 | } else { |
3b151851 |
803 | // Fake the response, so the error trap at the bottom will work |
b98732e8 |
804 | $response="BAD"; |
805 | $message='IMAP server does not appear to support the authentication method selected.'; |
806 | $message .= ' Please contact your system administrator.'; |
807 | } |
fe0b18b3 |
808 | } elseif ($imap_auth_mech == 'login') { |
b98732e8 |
809 | // Original IMAP login code |
810 | $query = 'LOGIN "' . quoteimap($username) . '" "' . quoteimap($password) . '"'; |
811 | $read = sqimap_run_command ($imap_stream, $query, false, $response, $message); |
1e7fc1cb |
812 | } elseif ($imap_auth_mech == 'plain') { |
fe55c7c7 |
813 | /*** |
814 | * SASL PLAIN |
815 | * |
816 | * RFC 2595 Chapter 6 |
817 | * |
818 | * The mechanism consists of a single message from the client to the |
819 | * server. The client sends the authorization identity (identity to |
820 | * login as), followed by a US-ASCII NUL character, followed by the |
821 | * authentication identity (identity whose password will be used), |
822 | * followed by a US-ASCII NUL character, followed by the clear-text |
823 | * password. The client may leave the authorization identity empty to |
824 | * indicate that it is the same as the authentication identity. |
825 | * |
826 | **/ |
b98732e8 |
827 | $tag=sqimap_session_id(false); |
2bd6b461 |
828 | $sasl = (isset($capability['SASL-IR']) && $capability['SASL-IR']) ? true : false; |
b98732e8 |
829 | $auth = base64_encode("$username\0$username\0$password"); |
fe55c7c7 |
830 | if ($sasl) { |
831 | // IMAP Extension for SASL Initial Client Response |
2bd6b461 |
832 | // <draft-siemborski-imap-sasl-initial-response-01b.txt> |
fe55c7c7 |
833 | $query = $tag . " AUTHENTICATE PLAIN $auth\r\n"; |
834 | fputs($imap_stream, $query); |
b98732e8 |
835 | $read = sqimap_fgets($imap_stream); |
fe55c7c7 |
836 | } else { |
837 | $query = $tag . " AUTHENTICATE PLAIN\r\n"; |
838 | fputs($imap_stream, $query); |
839 | $read=sqimap_fgets($imap_stream); |
840 | if (substr($read,0,1) == '+') { // OK so far.. |
841 | fputs($imap_stream, "$auth\r\n"); |
842 | $read = sqimap_fgets($imap_stream); |
843 | } |
098ea084 |
844 | } |
b98732e8 |
845 | $results=explode(" ",$read,3); |
846 | $response=$results[1]; |
847 | $message=$results[2]; |
848 | } else { |
849 | $response="BAD"; |
850 | $message="Internal SquirrelMail error - unknown IMAP authentication method chosen. Please contact the developers."; |
851 | } |
fe55c7c7 |
852 | |
b98732e8 |
853 | /* If the connection was not successful, lets see why */ |
9c737111 |
854 | if ($response != 'OK') { |
855 | if (!$hide) { |
74424a43 |
856 | if ($response != 'NO') { |
3411d4ec |
857 | /* "BAD" and anything else gets reported here. */ |
098ea084 |
858 | $message = htmlspecialchars($message); |
9c737111 |
859 | set_up_language($squirrelmail_language, true); |
098ea084 |
860 | require_once(SM_PATH . 'functions/display_messages.php'); |
9c737111 |
861 | if ($response == 'BAD') { |
6fd95361 |
862 | $string = sprintf (_("Bad request: %s")."<br />\r\n", $message); |
9c737111 |
863 | } else { |
6fd95361 |
864 | $string = sprintf (_("Unknown error: %s") . "<br />\n", $message); |
9c737111 |
865 | } |
1e7fc1cb |
866 | if (isset($read) && is_array($read)) { |
6fd95361 |
867 | $string .= '<br />' . _("Read data:") . "<br />\n"; |
9c737111 |
868 | foreach ($read as $line) { |
6fd95361 |
869 | $string .= htmlspecialchars($line) . "<br />\n"; |
9c737111 |
870 | } |
871 | } |
098ea084 |
872 | error_box($string,$color); |
9c737111 |
873 | exit; |
165e24a7 |
874 | } else { |
3411d4ec |
875 | /* |
876 | * If the user does not log in with the correct |
1c72b151 |
877 | * username and password it is not possible to get the |
878 | * correct locale from the user's preferences. |
879 | * Therefore, apply the same hack as on the login |
880 | * screen. |
3411d4ec |
881 | * |
882 | * $squirrelmail_language is set by a cookie when |
1c72b151 |
883 | * the user selects language and logs out |
bee165ef |
884 | */ |
fe55c7c7 |
885 | |
9c737111 |
886 | set_up_language($squirrelmail_language, true); |
bd9c880b |
887 | include_once(SM_PATH . 'functions/display_messages.php' ); |
098ea084 |
888 | sqsession_destroy(); |
d5c472f1 |
889 | /* terminate the session nicely */ |
890 | sqimap_logout($imap_stream); |
bd9c880b |
891 | logout_error( _("Unknown user or password incorrect.") ); |
9c737111 |
892 | exit; |
052e0c26 |
893 | } |
9c737111 |
894 | } else { |
052e0c26 |
895 | exit; |
9c737111 |
896 | } |
897 | } |
1d20443c |
898 | |
899 | /* Special error case: |
900 | * Login referrals. The server returns: |
0e1a248b |
901 | * ? OK [REFERRAL <imap url>] |
902 | * Check RFC 2221 for details. Since we do not support login referrals yet |
903 | * we log the user out. |
904 | */ |
2da1524c |
905 | if ( stristr($message, 'REFERRAL imap') === TRUE ) { |
0e1a248b |
906 | sqimap_logout($imap_stream); |
1d20443c |
907 | set_up_language($squirrelmail_language, true); |
908 | include_once(SM_PATH . 'functions/display_messages.php' ); |
909 | sqsession_destroy(); |
edde1f5c |
910 | logout_error( _("Your mailbox is not located at this server. Try a different server or consult your system administrator") ); |
1d20443c |
911 | exit; |
912 | } |
0e1a248b |
913 | |
9c737111 |
914 | return $imap_stream; |
915 | } |
f1e6f580 |
916 | |
48af4b64 |
917 | /** |
918 | * Simply logs out the IMAP session |
95e3afc1 |
919 | * @param stream $imap_stream the IMAP connection to log out. |
48af4b64 |
920 | * @return void |
921 | */ |
9c737111 |
922 | function sqimap_logout ($imap_stream) { |
8d936b0c |
923 | /* Logout is not valid until the server returns 'BYE' |
924 | * If we don't have an imap_ stream we're already logged out */ |
26a2cc8b |
925 | if(isset($imap_stream) && $imap_stream) |
8d936b0c |
926 | sqimap_run_command($imap_stream, 'LOGOUT', false, $response, $message); |
9c737111 |
927 | } |
928 | |
48af4b64 |
929 | /** |
95e3afc1 |
930 | * Retrieve the CAPABILITY string from the IMAP server. |
48af4b64 |
931 | * If capability is set, returns only that specific capability, |
932 | * else returns array of all capabilities. |
95e3afc1 |
933 | * @param stream $imap_stream |
a15f9d93 |
934 | * @param string $capability (since 1.3.0) |
4ae9beb7 |
935 | * @param boolean $bUseCache (since 1.5.1) Controls use of capability data stored in session |
0e1a248b |
936 | * @return mixed (string if $capability is set and found, |
0022f6db |
937 | * false, if $capability is set and not found, |
938 | * array if $capability not set) |
48af4b64 |
939 | */ |
a15f9d93 |
940 | function sqimap_capability($imap_stream, $capability='', $bUseCache=true) { |
941 | // sqgetGlobalVar('sqimap_capabilities', $sqimap_capabilities, SQ_SESSION); |
0493ed11 |
942 | |
a15f9d93 |
943 | if (!$bUseCache || ! sqgetGlobalVar('sqimap_capabilities', $sqimap_capabilities, SQ_SESSION)) { |
1c72b151 |
944 | $read = sqimap_run_command($imap_stream, 'CAPABILITY', true, $a, $b); |
945 | |
9c737111 |
946 | $c = explode(' ', $read[0]); |
947 | for ($i=2; $i < count($c); $i++) { |
948 | $cap_list = explode('=', $c[$i]); |
3411d4ec |
949 | if (isset($cap_list[1])) { |
3cfa833d |
950 | $sqimap_capabilities[trim($cap_list[0])][] = $cap_list[1]; |
3411d4ec |
951 | } else { |
3cfa833d |
952 | $sqimap_capabilities[trim($cap_list[0])] = TRUE; |
3411d4ec |
953 | } |
f1e6f580 |
954 | } |
9c737111 |
955 | } |
487daa81 |
956 | if ($capability) { |
098ea084 |
957 | if (isset($sqimap_capabilities[$capability])) { |
958 | return $sqimap_capabilities[$capability]; |
959 | } else { |
960 | return false; |
961 | } |
f1e6f580 |
962 | } |
487daa81 |
963 | return $sqimap_capabilities; |
9c737111 |
964 | } |
965 | |
48af4b64 |
966 | /** |
95e3afc1 |
967 | * Returns the delimiter between mailboxes: INBOX/Test, or INBOX.Test |
0022f6db |
968 | * @param stream $imap_stream |
969 | * @return string |
48af4b64 |
970 | */ |
9c737111 |
971 | function sqimap_get_delimiter ($imap_stream = false) { |
3411d4ec |
972 | global $sqimap_delimiter, $optional_delimiter; |
85fc999e |
973 | |
9c737111 |
974 | /* Use configured delimiter if set */ |
975 | if((!empty($optional_delimiter)) && $optional_delimiter != 'detect') { |
976 | return $optional_delimiter; |
977 | } |
85fc999e |
978 | |
7eb6261e |
979 | /* Delimiter is stored in the session from redirect. Try fetching from there first */ |
cc54580f |
980 | if (empty($sqimap_delimiter)) { |
7eb6261e |
981 | sqgetGlobalVar('delimiter',$sqimap_delimiter,SQ_SESSION); |
982 | } |
983 | |
9c737111 |
984 | /* Do some caching here */ |
985 | if (!$sqimap_delimiter) { |
986 | if (sqimap_capability($imap_stream, 'NAMESPACE')) { |
3411d4ec |
987 | /* |
988 | * According to something that I can't find, this is supposed to work on all systems |
989 | * OS: This won't work in Courier IMAP. |
990 | * OS: According to rfc2342 response from NAMESPACE command is: |
991 | * OS: * NAMESPACE (PERSONAL NAMESPACES) (OTHER_USERS NAMESPACE) (SHARED NAMESPACES) |
992 | * OS: We want to lookup all personal NAMESPACES... |
993 | */ |
1c72b151 |
994 | $read = sqimap_run_command($imap_stream, 'NAMESPACE', true, $a, $b); |
f1e6f580 |
995 | if (eregi('\\* NAMESPACE +(\\( *\\(.+\\) *\\)|NIL) +(\\( *\\(.+\\) *\\)|NIL) +(\\( *\\(.+\\) *\\)|NIL)', $read[0], $data)) { |
9c737111 |
996 | if (eregi('^\\( *\\((.*)\\) *\\)', $data[1], $data2)) { |
f1e6f580 |
997 | $pn = $data2[1]; |
9c737111 |
998 | } |
f1e6f580 |
999 | $pna = explode(')(', $pn); |
9c737111 |
1000 | while (list($k, $v) = each($pna)) { |
862ff2d3 |
1001 | $lst = explode('"', $v); |
1002 | if (isset($lst[3])) { |
1003 | $pn[$lst[1]] = $lst[3]; |
1004 | } else { |
74424a43 |
1005 | $pn[$lst[1]] = ''; |
862ff2d3 |
1006 | } |
f1e6f580 |
1007 | } |
1008 | } |
1009 | $sqimap_delimiter = $pn[0]; |
1010 | } else { |
1011 | fputs ($imap_stream, ". LIST \"INBOX\" \"\"\r\n"); |
1012 | $read = sqimap_read_data($imap_stream, '.', true, $a, $b); |
91e0dccc |
1013 | $read = $read['.'][0]; //sqimap_read_data() now returns a tag array of response array |
f1e6f580 |
1014 | $quote_position = strpos ($read[0], '"'); |
1015 | $sqimap_delimiter = substr ($read[0], $quote_position+1, 1); |
1016 | } |
1017 | } |
1018 | return $sqimap_delimiter; |
9c737111 |
1019 | } |
052e0c26 |
1020 | |
48af4b64 |
1021 | /** |
1022 | * This encodes a mailbox name for use in IMAP commands. |
95e3afc1 |
1023 | * @param string $what the mailbox to encode |
48af4b64 |
1024 | * @return string the encoded mailbox string |
0022f6db |
1025 | * @since 1.5.0 |
48af4b64 |
1026 | */ |
b2306cbe |
1027 | function sqimap_encode_mailbox_name($what) |
1028 | { |
91e0dccc |
1029 | if (ereg("[\"\\\r\n]", $what)) |
1030 | return '{' . strlen($what) . "}\r\n" . $what; /* 4.3 literal form */ |
1031 | return '"' . $what . '"'; /* 4.3 quoted string form */ |
b2306cbe |
1032 | } |
1033 | |
48af4b64 |
1034 | /** |
1035 | * Gets the number of messages in the current mailbox. |
1e0a2f0e |
1036 | * |
1037 | * OBSOLETE use sqimap_status_messages instead. |
95e3afc1 |
1038 | * @param stream $imap_stream imap stream |
1039 | * @param string $mailbox |
1040 | * @deprecated |
48af4b64 |
1041 | */ |
9c737111 |
1042 | function sqimap_get_num_messages ($imap_stream, $mailbox) { |
48879ef0 |
1043 | $aStatus = sqimap_status_messages($imap_stream,$mailbox,array('MESSAGES')); |
1044 | return $aStatus['MESSAGES']; |
9c737111 |
1045 | } |
95e3afc1 |
1046 | |
1e0a2f0e |
1047 | /** |
1048 | * OBSOLETE FUNCTION should be removed after mailbox_display, |
1049 | * printMessage function is adapted |
95e3afc1 |
1050 | * $addr_ar = array(), $group = '' and $host='' arguments are used in 1.4.0 |
1051 | * @param string $address |
1052 | * @param integer $max |
1053 | * @since 1.4.0 |
1054 | * @deprecated See Rfc822Address.php |
1e0a2f0e |
1055 | */ |
91688e5f |
1056 | function parseAddress($address, $max=0) { |
1e0a2f0e |
1057 | $aAddress = parseRFC822Address($address,array('limit'=> $max)); |
1058 | /* |
1059 | * Because the expected format of the array element is changed we adapt it now. |
1060 | * This also implies that this function is obsolete and should be removed after the |
1061 | * rest of the source is adapted. See Rfc822Address.php for the new function. |
1062 | */ |
1063 | array_walk($aAddress, '_adaptAddress'); |
1064 | return $aAddress; |
1065 | } |
91688e5f |
1066 | |
1e0a2f0e |
1067 | /** |
1068 | * OBSOLETE FUNCTION should be removed after mailbox_display, |
1069 | * printMessage function is adapted |
95e3afc1 |
1070 | * |
0e1a248b |
1071 | * callback function used for formating of addresses array in |
95e3afc1 |
1072 | * parseAddress() function |
1073 | * @param array $aAddr |
1074 | * @param integer $k array key |
1075 | * @since 1.5.1 |
1076 | * @deprecated |
1e0a2f0e |
1077 | */ |
1078 | function _adaptAddress(&$aAddr,$k) { |
1079 | $sPersonal = (isset($aAddr[SQM_ADDR_PERSONAL]) && $aAddr[SQM_ADDR_PERSONAL]) ? |
1080 | $aAddr[SQM_ADDR_PERSONAL] : ''; |
1081 | $sEmail = ($aAddr[SQM_ADDR_HOST]) ? |
3cd52f38 |
1082 | $aAddr[SQM_ADDR_MAILBOX] . '@'.$aAddr[SQM_ADDR_HOST] : |
1083 | $aAddr[SQM_ADDR_MAILBOX]; |
1e0a2f0e |
1084 | $aAddr = array($sEmail,$sPersonal); |
1085 | } |
91688e5f |
1086 | |
48af4b64 |
1087 | /** |
1088 | * Returns the number of unseen messages in this folder. |
26e90c74 |
1089 | * obsoleted by sqimap_status_messages ! |
95e3afc1 |
1090 | * Arguments differ in 1.0.x |
1091 | * @param stream $imap_stream |
1092 | * @param string $mailbox |
1093 | * @return integer |
1094 | * @deprecated |
3411d4ec |
1095 | */ |
9c737111 |
1096 | function sqimap_unseen_messages ($imap_stream, $mailbox) { |
26e90c74 |
1097 | $aStatus = sqimap_status_messages($imap_stream,$mailbox,array('UNSEEN')); |
1098 | return $aStatus['UNSEEN']; |
9c737111 |
1099 | } |
1100 | |
48af4b64 |
1101 | /** |
26e90c74 |
1102 | * Returns the status items of a mailbox. |
1103 | * Default it returns MESSAGES,UNSEEN and RECENT |
0e1a248b |
1104 | * Supported status items are MESSAGES, UNSEEN, RECENT (since 1.4.0), |
95e3afc1 |
1105 | * UIDNEXT (since 1.5.1) and UIDVALIDITY (since 1.5.1) |
1106 | * @param stream $imap_stream imap stream |
1107 | * @param string $mailbox mail folder |
1108 | * @param array $aStatusItems status items |
1109 | * @return array |
1110 | * @since 1.3.2 |
1f720b34 |
1111 | */ |
1e0a2f0e |
1112 | function sqimap_status_messages ($imap_stream, $mailbox, |
26e90c74 |
1113 | $aStatusItems = array('MESSAGES','UNSEEN','RECENT')) { |
1114 | |
3fedd15b |
1115 | $aStatusItems = implode(' ',$aStatusItems); |
26e90c74 |
1116 | $read_ary = sqimap_run_command ($imap_stream, 'STATUS ' . sqimap_encode_mailbox_name($mailbox) . |
1117 | " ($aStatusItems)", false, $result, $message); |
1f720b34 |
1118 | $i = 0; |
26e90c74 |
1119 | $messages = $unseen = $recent = $uidnext = $uidvalidity = false; |
1f720b34 |
1120 | $regs = array(false,false); |
1121 | while (isset($read_ary[$i])) { |
1122 | if (preg_match('/UNSEEN\s+([0-9]+)/i', $read_ary[$i], $regs)) { |
098ea084 |
1123 | $unseen = $regs[1]; |
1124 | } |
1f720b34 |
1125 | if (preg_match('/MESSAGES\s+([0-9]+)/i', $read_ary[$i], $regs)) { |
098ea084 |
1126 | $messages = $regs[1]; |
1127 | } |
b8ec18ef |
1128 | if (preg_match('/RECENT\s+([0-9]+)/i', $read_ary[$i], $regs)) { |
098ea084 |
1129 | $recent = $regs[1]; |
1e0a2f0e |
1130 | } |
26e90c74 |
1131 | if (preg_match('/UIDNEXT\s+([0-9]+)/i', $read_ary[$i], $regs)) { |
1132 | $uidnext = $regs[1]; |
1e0a2f0e |
1133 | } |
26e90c74 |
1134 | if (preg_match('/UIDVALIDITY\s+([0-9]+)/i', $read_ary[$i], $regs)) { |
1135 | $uidvalidity = $regs[1]; |
1e0a2f0e |
1136 | } |
1f720b34 |
1137 | $i++; |
1138 | } |
48879ef0 |
1139 | |
1140 | $status=array('MESSAGES' => $messages, |
1e0a2f0e |
1141 | 'UNSEEN'=>$unseen, |
26e90c74 |
1142 | 'RECENT' => $recent, |
1143 | 'UIDNEXT' => $uidnext, |
1144 | 'UIDVALIDITY' => $uidvalidity); |
48879ef0 |
1145 | |
1146 | if (!empty($messages)) { $hook_status['MESSAGES']=$messages; } |
1147 | if (!empty($unseen)) { $hook_status['UNSEEN']=$unseen; } |
1148 | if (!empty($recent)) { $hook_status['RECENT']=$recent; } |
81de00c0 |
1149 | if (!empty($hook_status)) { |
48879ef0 |
1150 | $hook_status['MAILBOX']=$mailbox; |
1151 | $hook_status['CALLER']='sqimap_status_messages'; |
1152 | do_hook_function('folder_status',$hook_status); |
1153 | } |
1154 | return $status; |
1f720b34 |
1155 | } |
1156 | |
9c737111 |
1157 | |
48af4b64 |
1158 | /** |
1159 | * Saves a message to a given folder -- used for saving sent messages |
95e3afc1 |
1160 | * @param stream $imap_stream |
1161 | * @param string $sent_folder |
1162 | * @param $length |
81de00c0 |
1163 | * @return string $sid |
3411d4ec |
1164 | */ |
81de00c0 |
1165 | function sqimap_append ($imap_stream, $sMailbox, $length) { |
1166 | $sid = sqimap_session_id(); |
1167 | $query = $sid . ' APPEND ' . sqimap_encode_mailbox_name($sMailbox) . " (\\Seen) {".$length."}"; |
1168 | fputs ($imap_stream, "$query\r\n"); |
85fc999e |
1169 | $tmp = fgets ($imap_stream, 1024); |
81de00c0 |
1170 | sqimap_append_checkresponse($tmp, $sMailbox,$sid, $query); |
1171 | return $sid; |
9c737111 |
1172 | } |
1173 | |
95e3afc1 |
1174 | /** |
1175 | * @param stream imap_stream |
1176 | * @param string $folder (since 1.3.2) |
1177 | */ |
81de00c0 |
1178 | function sqimap_append_done ($imap_stream, $sMailbox='') { |
9c737111 |
1179 | fputs ($imap_stream, "\r\n"); |
1180 | $tmp = fgets ($imap_stream, 1024); |
81de00c0 |
1181 | while (!sqimap_append_checkresponse($tmp, $sMailbox)) { |
1182 | $tmp = fgets ($imap_stream, 1024); |
1183 | } |
7ec3a6b9 |
1184 | } |
1185 | |
95e3afc1 |
1186 | /** |
0e1a248b |
1187 | * Displays error messages, if there are errors in responses to |
95e3afc1 |
1188 | * commands issues by sqimap_append() and sqimap_append_done() functions. |
1189 | * @param string $response |
81de00c0 |
1190 | * @param string $sMailbox |
1191 | * @return bool $bDone |
9948500c |
1192 | * @since 1.5.1 and 1.4.5 |
95e3afc1 |
1193 | */ |
81de00c0 |
1194 | function sqimap_append_checkresponse($response, $sMailbox, $sid='', $query='') { |
1195 | global $color; |
1196 | // static vars to keep them available when sqimap_append_done calls this function. |
1197 | static $imapquery, $imapsid; |
7ec3a6b9 |
1198 | |
81de00c0 |
1199 | $bDone = false; |
1200 | |
1201 | if ($query) { |
1202 | $imapquery = $query; |
1203 | } |
1204 | if ($sid) { |
1205 | $imapsid = $sid; |
1206 | } |
1207 | if ($response{0} == '+') { |
1208 | // continuation request triggerd by sqimap_append() |
1209 | $bDone = true; |
1210 | } else { |
1211 | $i = strpos($response, ' '); |
1212 | $sRsp = substr($response,0,$i); |
1213 | $sMsg = substr($response,$i+1); |
1214 | $aExtra = array('MAILBOX' => $sMailbox); |
1215 | switch ($sRsp) { |
1216 | case '*': //untagged response |
1217 | $i = strpos($sMsg, ' '); |
1218 | $sRsp = strtoupper(substr($sMsg,0,$i)); |
1219 | $sMsg = substr($sMsg,$i+1); |
1220 | if ($sRsp == 'NO' || $sRsp == 'BAD') { |
1221 | // for the moment disabled. Enable after 1.5.1 release. |
1222 | // Notices could give valueable information about the mailbox |
1223 | // sqm_trigger_imap_error('SQM_IMAP_APPEND_NOTICE',$imapquery,$sRsp,$sMsg); |
1224 | } |
1225 | $bDone = false; |
1226 | case $imapsid: |
1227 | // A001 OK message |
1228 | // $imapsid<space>$sRsp<space>$sMsg |
1229 | $bDone = true; |
1230 | $i = strpos($sMsg, ' '); |
1231 | $sRsp = strtoupper(substr($sMsg,0,$i)); |
1232 | $sMsg = substr($sMsg,$i+1); |
1233 | switch ($sRsp) { |
1234 | case 'NO': |
1235 | if (preg_match("/(.*)(quota)(.*)$/i", $sMsg, $aMatch)) { |
1236 | sqm_trigger_imap_error('SQM_IMAP_APPEND_QUOTA_ERROR',$imapquery,$sRsp,$sMsg,$aExtra); |
1237 | } else { |
1238 | sqm_trigger_imap_error('SQM_IMAP_APPEND_ERROR',$imapquery,$sRsp,$sMsg,$aExtra); |
1239 | } |
1240 | break; |
1241 | case 'BAD': |
1242 | sqm_trigger_imap_error('SQM_IMAP_ERROR',$imapquery,$sRsp,$sMsg,$aExtra); |
1243 | break; |
1244 | case 'BYE': |
1245 | sqm_trigger_imap_error('SQM_IMAP_BYE',$imapquery,$sRsp,$sMsg,$aExtra); |
1246 | break; |
1247 | case 'OK': |
1248 | break; |
1249 | default: |
1250 | break; |
1251 | } |
1252 | break; |
1253 | default: |
1254 | // should be false because of the unexpected response but i'm not sure if |
1255 | // that will cause an endless loop in sqimap_append_done |
1256 | $bDone = true; |
098ea084 |
1257 | } |
69146537 |
1258 | } |
81de00c0 |
1259 | return $bDone; |
9c737111 |
1260 | } |
85fc999e |
1261 | |
95e3afc1 |
1262 | /** |
0e1a248b |
1263 | * Allows mapping of IMAP server address with custom function |
95e3afc1 |
1264 | * see map_yp_alias() |
1265 | * @param string $imap_server imap server address or mapping |
1266 | * @param string $username |
1267 | * @return string |
1268 | * @since 1.3.0 |
1269 | */ |
bd9829d7 |
1270 | function sqimap_get_user_server ($imap_server, $username) { |
bd9829d7 |
1271 | if (substr($imap_server, 0, 4) != "map:") { |
1272 | return $imap_server; |
1273 | } |
bd9829d7 |
1274 | $function = substr($imap_server, 4); |
1275 | return $function($username); |
1276 | } |
1277 | |
48af4b64 |
1278 | /** |
0e1a248b |
1279 | * This is an example that gets IMAP servers from yellowpages (NIS). |
1e0a2f0e |
1280 | * you can simple put map:map_yp_alias in your $imap_server_address |
bd9829d7 |
1281 | * in config.php use your own function instead map_yp_alias to map your |
0e1a248b |
1282 | * LDAP whatever way to find the users IMAP server. |
1283 | * |
95e3afc1 |
1284 | * Requires access to external ypmatch program |
1285 | * FIXME: it can be implemented in php yp extension or pecl (since php 5.1.0) |
1286 | * @param string $username |
1287 | * @return string |
1288 | * @since 1.3.0 |
48af4b64 |
1289 | */ |
bd9829d7 |
1290 | function map_yp_alias($username) { |
1291 | $yp = `ypmatch $username aliases`; |
1292 | return chop(substr($yp, strlen($username)+1)); |
1e0a2f0e |
1293 | } |
bd9829d7 |
1294 | |
3c021d16 |
1295 | ?> |