Adding Basque translators' info.
[squirrelmail.git] / functions / imap_general.php
CommitLineData
59177427 1<?php
bccadd02 2
35586184 3/**
a6fd80f5 4 * imap_general.php
35586184 5 *
82d304a0 6 * Copyright (c) 1999-2004 The SquirrelMail Project Team
15e6162e 7 * Licensed under the GNU GPL. For full terms see the file COPYING.
35586184 8 *
15e6162e 9 * This implements all functions that do general imap functions.
35586184 10 *
eb19bc67 11 * @version $Id$
d6c32258 12 * @package squirrelmail
eb19bc67 13 * @subpackage imap
35586184 14 */
15
d6c32258 16/** Includes.. */
b68edc75 17require_once(SM_PATH . 'functions/page_header.php');
47a29326 18require_once(SM_PATH . 'functions/auth.php');
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.
24 * @param bool unique_id
25 * @return string IMAP session id of the form 'A000'.
26 */
2aca19a1 27function sqimap_session_id($unique_id = FALSE) {
28 static $sqimap_session_id = 1;
29
487daa81 30 if (!$unique_id) {
098ea084 31 return( sprintf("A%03d", $sqimap_session_id++) );
487daa81 32 } else {
098ea084 33 return( sprintf("A%03d", $sqimap_session_id++) . ' UID' );
487daa81 34 }
9c737111 35}
36
48af4b64 37/**
3411d4ec 38 * Both send a command and accept the result from the command.
39 * This is to allow proper session number handling.
40 */
487daa81 41function sqimap_run_command_list ($imap_stream, $query, $handle_errors, &$response, &$message, $unique_id = false) {
c5809184 42 if ($imap_stream) {
098ea084 43 $sid = sqimap_session_id($unique_id);
44 fputs ($imap_stream, $sid . ' ' . $query . "\r\n");
bc78cc6e 45 $tag_uid_a = explode(' ',trim($sid));
46 $tag = $tag_uid_a[0];
0dc05a81 47 $read = sqimap_retrieve_imap_response ($imap_stream, $tag, $handle_errors, $response, $message, $query );
bc78cc6e 48 /* get the response and the message */
49 $message = $message[$tag];
50 $response = $response[$tag];
51 return $read[$tag];
c5809184 52 } else {
53 global $squirrelmail_language, $color;
54 set_up_language($squirrelmail_language);
55 require_once(SM_PATH . 'functions/display_messages.php');
56 $string = "<b><font color=$color[2]>\n" .
57 _("ERROR : No available imapstream.") .
58 "</b></font>\n";
59 error_box($string,$color);
098ea084 60 return false;
c5809184 61 }
1c72b151 62}
63
7c7b74b3 64function sqimap_run_command ($imap_stream, $query, $handle_errors, &$response,
65 &$message, $unique_id = false,$filter=false,
66 $outputstream=false,$no_return=false) {
c5809184 67 if ($imap_stream) {
68 $sid = sqimap_session_id($unique_id);
bc78cc6e 69 fputs ($imap_stream, $sid . ' ' . $query . "\r\n");
70 $tag_uid_a = explode(' ',trim($sid));
71 $tag = $tag_uid_a[0];
72
73 $read = sqimap_read_data ($imap_stream, $tag, $handle_errors, $response,
7c7b74b3 74 $message, $query,$filter,$outputstream,$no_return);
ec73f243 75 if (empty($read)) { //Imap server dropped its connection
76 $response = '';
77 $message = '';
78 return false;
79 }
bc78cc6e 80 /* retrieve the response and the message */
81 $response = $response[$tag];
82 $message = $message[$tag];
ec73f243 83
bc78cc6e 84 if (!empty($read[$tag])) {
85 return $read[$tag][0];
86 } else {
87 return $read[$tag];
88 }
c5809184 89 } else {
90 global $squirrelmail_language, $color;
91 set_up_language($squirrelmail_language);
92 require_once(SM_PATH . 'functions/display_messages.php');
93 $string = "<b><font color=$color[2]>\n" .
94 _("ERROR : No available imapstream.") .
95 "</b></font>\n";
96 error_box($string,$color);
098ea084 97 return false;
bc78cc6e 98 }
99}
48af4b64 100
bc78cc6e 101function sqimap_prepare_pipelined_query($new_query,&$tag,&$aQuery,$unique_id) {
102 $sid = sqimap_session_id($unique_id);
103 $tag_uid_a = explode(' ',trim($sid));
104 $tag = $tag_uid_a[0];
0b38d197 105 $query = $sid . ' '.$new_query."\r\n";
bc78cc6e 106 $aQuery[$tag] = $query;
42a07ac1 107}
108
52c8b585 109function sqimap_run_pipelined_command ($imap_stream, $aQueryList, $handle_errors,
bc78cc6e 110 &$aServerResponse, &$aServerMessage, $unique_id = false,
5c300c60 111 $filter=false,$outputstream=false,$no_return=false) {
bc78cc6e 112 $aResponse = false;
5c300c60 113
52c8b585 114 /*
115 Do not fire all calls at once to the imap-server but split the calls up
116 in portions of $iChunkSize. If we do not do that I think we misbehave as
117 IMAP client or should handle BYE calls if the IMAP-server drops the
118 connection because the number of queries is to large. This isn't tested
119 but a wild guess how it could work in the field.
0b38d197 120
c03cba15 121 After testing it on Exchange 2000 we discovered that a chunksize of 32
0b38d197 122 was quicker then when we raised it to 128.
52c8b585 123 */
124 $iQueryCount = count($aQueryList);
125 $iChunkSize = 32;
126 // array_chunk would also do the job but it's supported from php > 4.2
127 $aQueryChunks = array();
128 $iLoops = floor($iQueryCount / $iChunkSize);
129
5c300c60 130 if ($iLoops * $iChunkSize != $iQueryCount) ++$iLoops;
52c8b585 131
132 if (!function_exists('array_chunk')) { // arraychunk replacement
5c300c60 133 reset($aQueryList);
52c8b585 134 for($i=0;$i<$iLoops;++$i) {
5c300c60 135 for($j=0;$j<$iChunkSize;++$j) {
136 $key = key($aQueryList);
137 $aTmp[$key] = $aQueryList[$key];
138 if (next($aQueryList) === false) break;
139 }
140 $aQueryChunks[] = $aTmp;
141 }
52c8b585 142 } else {
143 $aQueryChunks = array_chunk($aQueryList,$iChunkSize,true);
bc78cc6e 144 }
52c8b585 145
146 for ($i=0;$i<$iLoops;++$i) {
147 $aQuery = $aQueryChunks[$i];
148 foreach($aQuery as $tag => $query) {
149 fputs($imap_stream,$query);
150 $aResults[$tag] = false;
151 }
52c8b585 152 foreach($aQuery as $tag => $query) {
5c300c60 153 if ($aResults[$tag] == false) {
0dc05a81 154 $aReturnedResponse = sqimap_retrieve_imap_response ($imap_stream, $tag,
bc78cc6e 155 $handle_errors, $response, $message, $query,
156 $filter,$outputstream,$no_return);
52c8b585 157 foreach ($aReturnedResponse as $returned_tag => $aResponse) {
5c300c60 158 if (!empty($aResponse)) {
52c8b585 159 $aResults[$returned_tag] = $aResponse[0];
5c300c60 160 } else {
161 $aResults[$returned_tag] = $aResponse;
162 }
52c8b585 163 $aServerResponse[$returned_tag] = $response[$returned_tag];
164 $aServerMessage[$returned_tag] = $message[$returned_tag];
165 }
bc78cc6e 166 }
167 }
168 }
b7277e4f 169 return $aResults;
bc78cc6e 170}
9c737111 171
48af4b64 172/**
173 * Custom fgets function: gets a line from the IMAP-server,
174 * no matter how big it may be.
175 * @param stream imap_stream the stream to read from
176 * @return string a line
b8c285ab 177 */
b8c285ab 178function sqimap_fgets($imap_stream) {
179 $read = '';
180 $buffer = 4096;
181 $results = '';
c41daf03 182 $offset = 0;
183 while (strpos($results, "\r\n", $offset) === false) {
b8c285ab 184 if (!($read = fgets($imap_stream, $buffer))) {
329a7ca5 185 /* this happens in case of an error */
186 /* reset $results because it's useless */
187 $results = false;
b8c285ab 188 break;
189 }
c41daf03 190 if ( $results != '' ) {
191 $offset = strlen($results) - 1;
192 }
b8c285ab 193 $results .= $read;
194 }
195 return $results;
196}
197
7c7b74b3 198function sqimap_fread($imap_stream,$iSize,$filter=false,
199 $outputstream=false, $no_return=false) {
200 if (!$filter || !$outputstream) {
201 $iBufferSize = $iSize;
202 } else {
811318c5 203 // see php bug 24033. They changed fread behaviour %$^&$%
977a6085 204 $iBufferSize = 7800; // multiple of 78 in case of base64 decoding.
205 }
206 if ($iSize < $iBufferSize) {
207 $iBufferSize = $iSize;
7c7b74b3 208 }
7c0ec1d8 209
5eba0be2 210 $iRetrieved = 0;
977a6085 211 $results = '';
212 $sRead = $sReadRem = '';
213 // NB: fread can also stop at end of a packet on sockets.
214 while ($iRetrieved < $iSize) {
7c7b74b3 215 $sRead = fread($imap_stream,$iBufferSize);
977a6085 216 $iLength = strlen($sRead);
217 $iRetrieved += $iLength ;
218 $iRemaining = $iSize - $iRetrieved;
219 if ($iRemaining < $iBufferSize) {
220 $iBufferSize = $iRemaining;
221 }
bc78cc6e 222 if (!$sRead) {
7c7b74b3 223 $results = false;
224 break;
225 }
977a6085 226 if ($sReadRem) {
227 $sRead = $sReadRem . $sRead;
228 $sReadRem = '';
229 }
7c0ec1d8 230
977a6085 231 if ($filter && $sRead) {
7c0ec1d8 232 // in case the filter is base64 decoding we return a remainder
233 $sReadRem = $filter($sRead);
7c7b74b3 234 }
977a6085 235 if ($outputstream && $sRead) {
7c7b74b3 236 if (is_resource($outputstream)) {
237 fwrite($outputstream,$sRead);
238 } else if ($outputstream == 'php://stdout') {
239 echo $sRead;
240 }
241 }
242 if ($no_return) {
243 $sRead = '';
977a6085 244 } else {
245 $results .= $sRead;
7c7b74b3 246 }
7c7b74b3 247 }
248 return $results;
249}
977a6085 250
7c0ec1d8 251
48af4b64 252/**
253 * Obsolete function, inform plugins that use it
254 * @deprecated use sqimap_run_command or sqimap_run_command_list instead
255 */
0dc05a81 256function sqimap_read_data_list($imap_stream, $tag, $handle_errors,
257 &$response, &$message, $query = '') {
258 global $color, $squirrelmail_language;
259 set_up_language($squirrelmail_language);
260 require_once(SM_PATH . 'functions/display_messages.php');
261 $string = "<b><font color=$color[2]>\n" .
262 _("ERROR : Bad function call.") .
263 "</b><br>\n" .
264 _("Reason:") . ' '.
265 'There is a plugin installed which make use of the <br>' .
266 'SquirrelMail internal function sqimap_read_data_list.<br>'.
5c300c60 267 'Please adapt the installed plugin and let it use<br>'.
268 'sqimap_run_command or sqimap_run_command_list instead<br><br>'.
269 'The following query was issued:<br>'.
0dc05a81 270 htmlspecialchars($query) . '<br>' . "</font><br>\n";
271 error_box($string,$color);
272 echo '</body></html>';
273 exit;
274}
7c7b74b3 275
48af4b64 276/**
277 * Function to display an error related to an IMAP-query.
278 * @param string title the caption of the error box
279 * @param string query the query that went wrong
ec73f243 280 * @param string message_title optional message title
281 * @param string message optional error message
282 * @param string $link an optional link to try again
48af4b64 283 * @return void
284 */
ec73f243 285function sqimap_error_box($title, $query = '', $message_title = '', $message = '', $link = '')
4974c2a0 286{
287 global $color, $squirrelmail_language;
288
289 set_up_language($squirrelmail_language);
290 require_once(SM_PATH . 'functions/display_messages.php');
291 $string = "<font color=$color[2]><b>\n" . $title . "</b><br>\n";
bf15f116 292 $cmd = explode(' ',$query);
293 $cmd= strtolower($cmd[0]);
294
295 if ($query != '' && $cmd != 'login')
4974c2a0 296 $string .= _("Query:") . ' ' . htmlspecialchars($query) . '<br>';
297 if ($message_title != '')
298 $string .= $message_title;
299 if ($message != '')
300 $string .= htmlspecialchars($message);
301 $string .= "</font><br>\n";
ec73f243 302 if ($link != '')
303 $string .= $link;
4974c2a0 304 error_box($string,$color);
305}
306
48af4b64 307/**
3411d4ec 308 * Reads the output from the IMAP stream. If handle_errors is set to true,
309 * this will also handle all errors that are received. If it is not set,
48af4b64 310 * the errors will be sent back through $response and $message.
bee165ef 311 */
0dc05a81 312function sqimap_retrieve_imap_response($imap_stream, $tag, $handle_errors,
7c7b74b3 313 &$response, &$message, $query = '',
314 $filter = false, $outputstream = false, $no_return = false) {
9c737111 315 global $color, $squirrelmail_language;
9c737111 316 $read = '';
bc78cc6e 317 if (!is_array($message)) $message = array();
318 if (!is_array($response)) $response = array();
ec73f243 319 $aResponse = '';
b8c285ab 320 $resultlist = array();
321 $data = array();
322 $read = sqimap_fgets($imap_stream);
5c300c60 323 $i = $k = 0;
bea3eb1e 324 while ($read) {
325 $char = $read{0};
326 switch ($char)
327 {
15bc7f66 328 case '+':
329 default:
330 $read = sqimap_fgets($imap_stream);
331 break;
332
333 case $tag{0}:
334 {
bea3eb1e 335 /* get the command */
336 $arg = '';
337 $i = strlen($tag)+1;
338 $s = substr($read,$i);
339 if (($j = strpos($s,' ')) || ($j = strpos($s,"\n"))) {
340 $arg = substr($s,0,$j);
341 }
342 $found_tag = substr($read,0,$i-1);
5c300c60 343 if ($found_tag) {
bea3eb1e 344 switch ($arg)
345 {
15bc7f66 346 case 'OK':
347 case 'BAD':
348 case 'NO':
349 case 'BYE':
350 case 'PREAUTH':
bc78cc6e 351 $response[$found_tag] = $arg;
352 $message[$found_tag] = trim(substr($read,$i+strlen($arg)));
353 if (!empty($data)) {
354 $resultlist[] = $data;
355 }
5c300c60 356 $aResponse[$found_tag] = $resultlist;
357 $data = $resultlist = array();
358 if ($found_tag == $tag) {
359 break 3; /* switch switch while */
360 }
361 break;
329a7ca5 362 default:
bea3eb1e 363 /* this shouldn't happen */
bc78cc6e 364 $response[$found_tag] = $arg;
365 $message[$found_tag] = trim(substr($read,$i+strlen($arg)));
366 if (!empty($data)) {
367 $resultlist[] = $data;
368 }
369 $aResponse[$found_tag] = $resultlist;
5c300c60 370 $data = $resultlist = array();
371 if ($found_tag == $tag) {
372 break 3; /* switch switch while */
373 }
bc78cc6e 374 }
bea3eb1e 375 }
5c300c60 376 $read = sqimap_fgets($imap_stream);
377 if ($read === false) { /* error */
378 break 3; /* switch switch while */
379 }
380 break;
15bc7f66 381 } // end case $tag{0}
382
383 case '*':
384 {
bea3eb1e 385 if (preg_match('/^\*\s\d+\sFETCH/',$read)) {
386 /* check for literal */
387 $s = substr($read,-3);
388 $fetch_data = array();
389 do { /* outer loop, continue until next untagged fetch
390 or tagged reponse */
391 do { /* innerloop for fetching literals. with this loop
392 we prohibid that literal responses appear in the
393 outer loop so we can trust the untagged and
394 tagged info provided by $read */
395 if ($s === "}\r\n") {
396 $j = strrpos($read,'{');
397 $iLit = substr($read,$j+1,-3);
398 $fetch_data[] = $read;
7c7b74b3 399 $sLiteral = sqimap_fread($imap_stream,$iLit,$filter,$outputstream,$no_return);
329a7ca5 400 if ($sLiteral === false) { /* error */
401 break 4; /* while while switch while */
402 }
bea3eb1e 403 /* backwards compattibility */
404 $aLiteral = explode("\n", $sLiteral);
405 /* release not neaded data */
406 unset($sLiteral);
407 foreach ($aLiteral as $line) {
408 $fetch_data[] = $line ."\n";
409 }
410 /* release not neaded data */
411 unset($aLiteral);
412 /* next fgets belongs to this fetch because
413 we just got the exact literalsize and there
414 must follow data to complete the response */
329a7ca5 415 $read = sqimap_fgets($imap_stream);
416 if ($read === false) { /* error */
417 break 4; /* while while switch while */
418 }
c0b23345 419 $fetch_data[] = $read;
bea3eb1e 420 } else {
329a7ca5 421 $fetch_data[] = $read;
bea3eb1e 422 }
423 /* retrieve next line and check in the while
424 statements if it belongs to this fetch response */
425 $read = sqimap_fgets($imap_stream);
329a7ca5 426 if ($read === false) { /* error */
427 break 4; /* while while switch while */
428 }
bea3eb1e 429 /* check for next untagged reponse and break */
430 if ($read{0} == '*') break 2;
431 $s = substr($read,-3);
432 } while ($s === "}\r\n");
433 $s = substr($read,-3);
434 } while ($read{0} !== '*' &&
106d4087 435 substr($read,0,strlen($tag)) !== $tag);
329a7ca5 436 $resultlist[] = $fetch_data;
bea3eb1e 437 /* release not neaded data */
438 unset ($fetch_data);
439 } else {
440 $s = substr($read,-3);
441 do {
442 if ($s === "}\r\n") {
443 $j = strrpos($read,'{');
444 $iLit = substr($read,$j+1,-3);
445 $data[] = $read;
329a7ca5 446 $sLiteral = fread($imap_stream,$iLit);
c0b23345 447 if ($sLiteral === false) { /* error */
329a7ca5 448 $read = false;
449 break 3; /* while switch while */
450 }
c0b23345 451 $data[] = $sLiteral;
b7277e4f 452 $data[] = sqimap_fgets($imap_stream);
bea3eb1e 453 } else {
329a7ca5 454 $data[] = $read;
bea3eb1e 455 }
456 $read = sqimap_fgets($imap_stream);
329a7ca5 457 if ($read === false) {
458 break 3; /* while switch while */
459 } else if ($read{0} == '*') {
106d4087 460 break;
461 }
bea3eb1e 462 $s = substr($read,-3);
463 } while ($s === "}\r\n");
464 break 1;
5c300c60 465 }
bea3eb1e 466 break;
15bc7f66 467 } // end case '*'
468 } // end switch
c0b23345 469 } // end while
470
471 /* error processing in case $read is false */
d7542838 472 if ($read === false) {
d3d9ef2d 473 // try to retrieve an untagged bye respons from the results
474 $sResponse = array_pop($data);
d7542838 475 if ($sResponse !== NULL && strpos($sResponse,'* BYE') !== false) {
476 if (!$handle_errors) {
477 $query = '';
478 }
479 sqimap_error_box(_("ERROR : Imap server closed the connection."), $query, _("Server responded:"),$sResponse);
480 echo '</body></html>';
481 exit;
482 } else if ($handle_errors) {
d3d9ef2d 483 unset($data);
ec73f243 484 sqimap_error_box(_("ERROR : Connection dropped by imap-server."), $query);
485 exit;
486 }
b8c285ab 487 }
c0b23345 488
15bc7f66 489 /* Set $resultlist array */
b8c285ab 490 if (!empty($data)) {
bc78cc6e 491 //$resultlist[] = $data;
9c737111 492 }
b8c285ab 493 elseif (empty($resultlist)) {
494 $resultlist[] = array();
495 }
15bc7f66 496
497 /* Return result or handle errors */
bee165ef 498 if ($handle_errors == false) {
bc78cc6e 499 return $aResponse;
dd381002 500 }
4974c2a0 501 switch ($response[$tag]) {
dd381002 502 case 'OK':
bc78cc6e 503 return $aResponse;
329a7ca5 504 break;
dd381002 505 case 'NO':
506 /* ignore this error from M$ exchange, it is not fatal (aka bug) */
6b6c2e06 507 if (strstr($message[$tag], 'command resulted in') === false) {
4974c2a0 508 sqimap_error_box(_("ERROR : Could not complete request."), $query, _("Reason Given: "), $message[$tag]);
329a7ca5 509 echo '</body></html>';
052e0c26 510 exit;
9c737111 511 }
329a7ca5 512 break;
dd381002 513 case 'BAD':
4974c2a0 514 sqimap_error_box(_("ERROR : Bad or malformed request."), $query, _("Server responded: "), $message[$tag]);
329a7ca5 515 echo '</body></html>';
dd381002 516 exit;
517 case 'BYE':
4974c2a0 518 sqimap_error_box(_("ERROR : Imap server closed the connection."), $query, _("Server responded: "), $message[$tag]);
329a7ca5 519 echo '</body></html>';
9c737111 520 exit;
dd381002 521 default:
4974c2a0 522 sqimap_error_box(_("ERROR : Unknown imap response."), $query, _("Server responded: "), $message[$tag]);
329a7ca5 523 /* the error is displayed but because we don't know the reponse we
524 return the result anyway */
bc78cc6e 525 return $aResponse;
329a7ca5 526 break;
9c737111 527 }
9c737111 528}
529
7c7b74b3 530function sqimap_read_data ($imap_stream, $tag_uid, $handle_errors,
531 &$response, &$message, $query = '',
532 $filter=false,$outputstream=false,$no_return=false) {
bc78cc6e 533
534 $tag_uid_a = explode(' ',trim($tag_uid));
535 $tag = $tag_uid_a[0];
536
0dc05a81 537 $res = sqimap_retrieve_imap_response($imap_stream, $tag, $handle_errors,
7c7b74b3 538 $response, $message, $query,$filter,$outputstream,$no_return);
863936bb 539 /* sqimap_read_data should be called for one response
0dc05a81 540 but since it just calls sqimap_retrieve_imap_response which
863936bb 541 handles multiple responses we need to check for that
542 and merge the $res array IF they are seperated and
543 IF it was a FETCH response. */
544
ba8f367a 545// if (isset($res[1]) && is_array($res[1]) && isset($res[1][0])
546// && preg_match('/^\* \d+ FETCH/', $res[1][0])) {
547// $result = array();
548// foreach($res as $index=>$value) {
549// $result = array_merge($result, $res["$index"]);
550// }
551// }
863936bb 552 if (isset($result)) {
bc78cc6e 553 return $result[$tag];
56afb33f 554 }
56afb33f 555 else {
bc78cc6e 556 return $res;
56afb33f 557 }
9c737111 558}
559
48af4b64 560/**
b98732e8 561 * Connects to the IMAP server and returns a resource identifier for use with
562 * the other SquirrelMail IMAP functions. Does NOT login!
48af4b64 563 * @param string server hostname of IMAP server
564 * @param int port port number to connect to
565 * @param bool tls whether to use TLS when connecting.
566 * @return imap-stream resource identifier
b98732e8 567 */
568function sqimap_create_stream($server,$port,$tls=false) {
569 global $username, $use_imap_tls;
570
57ffe0af 571 if ($tls == true) {
b98732e8 572 if ((check_php_version(4,3)) and (extension_loaded('openssl'))) {
573 /* Use TLS by prefixing "tls://" to the hostname */
57ffe0af 574 $server = 'tls://' . $server;
b98732e8 575 } else {
576 require_once(SM_PATH . 'functions/display_messages.php');
577 $string = "Unable to connect to IMAP server!<br>TLS is enabled, but this " .
578 "version of PHP does not support TLS sockets, or is missing the openssl " .
579 "extension.<br><br>Please contact your system administrator.";
580 logout_error($string,$color);
581 }
582 }
583
584 $imap_stream = fsockopen($server, $port, $error_number, $error_string, 15);
585
586 /* Do some error correction */
587 if (!$imap_stream) {
588 set_up_language($squirrelmail_language, true);
589 require_once(SM_PATH . 'functions/display_messages.php');
590 $string = sprintf (_("Error connecting to IMAP server: %s.") .
591 "<br>\r\n", $server) .
592 "$error_number : $error_string<br>\r\n";
593 logout_error($string,$color);
594 exit;
595 }
596 $server_info = fgets ($imap_stream, 1024);
597 return $imap_stream;
598}
599
48af4b64 600/**
3411d4ec 601 * Logs the user into the imap server. If $hide is set, no error messages
602 * will be displayed. This function returns the imap connection handle.
603 */
9c737111 604function sqimap_login ($username, $password, $imap_server_address, $imap_port, $hide) {
fe55c7c7 605 global $color, $squirrelmail_language, $onetimepad, $use_imap_tls,
606 $imap_auth_mech, $sqimap_capabilities;
85fc999e 607
eb2f6102 608 if (!isset($onetimepad) || empty($onetimepad)) {
609 sqgetglobalvar('onetimepad' , $onetimepad , SQ_SESSION );
610 }
fe55c7c7 611 if (!isset($sqimap_capabilities)) {
612 sqgetglobalvar('sqimap_capabilities' , $capability , SQ_SESSION );
613 }
614
b98732e8 615 $host = $imap_server_address;
bd9829d7 616 $imap_server_address = sqimap_get_user_server($imap_server_address, $username);
fe55c7c7 617
b98732e8 618 $imap_stream = sqimap_create_stream($imap_server_address,$imap_port,$use_imap_tls);
fe55c7c7 619
2f1f7a12 620 /* Decrypt the password */
621 $password = OneTimePadDecrypt($password, $onetimepad);
622
b98732e8 623 if (($imap_auth_mech == 'cram-md5') OR ($imap_auth_mech == 'digest-md5')) {
624 // We're using some sort of authentication OTHER than plain or login
625 $tag=sqimap_session_id(false);
626 if ($imap_auth_mech == 'digest-md5') {
098ea084 627 $query = $tag . " AUTHENTICATE DIGEST-MD5\r\n";
b98732e8 628 } elseif ($imap_auth_mech == 'cram-md5') {
098ea084 629 $query = $tag . " AUTHENTICATE CRAM-MD5\r\n";
b98732e8 630 }
631 fputs($imap_stream,$query);
632 $answer=sqimap_fgets($imap_stream);
633 // Trim the "+ " off the front
634 $response=explode(" ",$answer,3);
635 if ($response[0] == '+') {
098ea084 636 // Got a challenge back
b98732e8 637 $challenge=$response[1];
638 if ($imap_auth_mech == 'digest-md5') {
639 $reply = digest_md5_response($username,$password,$challenge,'imap',$host);
640 } elseif ($imap_auth_mech == 'cram-md5') {
641 $reply = cram_md5_response($username,$password,$challenge);
642 }
643 fputs($imap_stream,$reply);
644 $read=sqimap_fgets($imap_stream);
645 if ($imap_auth_mech == 'digest-md5') {
646 // DIGEST-MD5 has an extra step..
647 if (substr($read,0,1) == '+') { // OK so far..
098ea084 648 fputs($imap_stream,"\r\n");
649 $read=sqimap_fgets($imap_stream);
098ea084 650 }
b98732e8 651 }
652 $results=explode(" ",$read,3);
653 $response=$results[1];
654 $message=$results[2];
655 } else {
656 // Fake the response, so the error trap at the bottom will work
657 $response="BAD";
658 $message='IMAP server does not appear to support the authentication method selected.';
659 $message .= ' Please contact your system administrator.';
660 }
fe0b18b3 661 } elseif ($imap_auth_mech == 'login') {
b98732e8 662 // Original IMAP login code
663 $query = 'LOGIN "' . quoteimap($username) . '" "' . quoteimap($password) . '"';
664 $read = sqimap_run_command ($imap_stream, $query, false, $response, $message);
1e7fc1cb 665 } elseif ($imap_auth_mech == 'plain') {
fe55c7c7 666 /***
667 * SASL PLAIN
668 *
669 * RFC 2595 Chapter 6
670 *
671 * The mechanism consists of a single message from the client to the
672 * server. The client sends the authorization identity (identity to
673 * login as), followed by a US-ASCII NUL character, followed by the
674 * authentication identity (identity whose password will be used),
675 * followed by a US-ASCII NUL character, followed by the clear-text
676 * password. The client may leave the authorization identity empty to
677 * indicate that it is the same as the authentication identity.
678 *
679 **/
b98732e8 680 $tag=sqimap_session_id(false);
2bd6b461 681 $sasl = (isset($capability['SASL-IR']) && $capability['SASL-IR']) ? true : false;
b98732e8 682 $auth = base64_encode("$username\0$username\0$password");
fe55c7c7 683 if ($sasl) {
684 // IMAP Extension for SASL Initial Client Response
2bd6b461 685 // <draft-siemborski-imap-sasl-initial-response-01b.txt>
fe55c7c7 686 $query = $tag . " AUTHENTICATE PLAIN $auth\r\n";
687 fputs($imap_stream, $query);
b98732e8 688 $read = sqimap_fgets($imap_stream);
fe55c7c7 689 } else {
690 $query = $tag . " AUTHENTICATE PLAIN\r\n";
691 fputs($imap_stream, $query);
692 $read=sqimap_fgets($imap_stream);
693 if (substr($read,0,1) == '+') { // OK so far..
694 fputs($imap_stream, "$auth\r\n");
695 $read = sqimap_fgets($imap_stream);
696 }
098ea084 697 }
b98732e8 698 $results=explode(" ",$read,3);
699 $response=$results[1];
700 $message=$results[2];
701 } else {
702 $response="BAD";
703 $message="Internal SquirrelMail error - unknown IMAP authentication method chosen. Please contact the developers.";
704 }
fe55c7c7 705
b98732e8 706 /* If the connection was not successful, lets see why */
9c737111 707 if ($response != 'OK') {
708 if (!$hide) {
74424a43 709 if ($response != 'NO') {
3411d4ec 710 /* "BAD" and anything else gets reported here. */
098ea084 711 $message = htmlspecialchars($message);
9c737111 712 set_up_language($squirrelmail_language, true);
098ea084 713 require_once(SM_PATH . 'functions/display_messages.php');
9c737111 714 if ($response == 'BAD') {
bea3eb1e 715 $string = sprintf (_("Bad request: %s")."<br>\r\n", $message);
9c737111 716 } else {
bea3eb1e 717 $string = sprintf (_("Unknown error: %s") . "<br>\n", $message);
9c737111 718 }
1e7fc1cb 719 if (isset($read) && is_array($read)) {
bea3eb1e 720 $string .= '<br>' . _("Read data:") . "<br>\n";
9c737111 721 foreach ($read as $line) {
1f720b34 722 $string .= htmlspecialchars($line) . "<br>\n";
9c737111 723 }
724 }
098ea084 725 error_box($string,$color);
9c737111 726 exit;
165e24a7 727 } else {
3411d4ec 728 /*
729 * If the user does not log in with the correct
1c72b151 730 * username and password it is not possible to get the
731 * correct locale from the user's preferences.
732 * Therefore, apply the same hack as on the login
733 * screen.
3411d4ec 734 *
735 * $squirrelmail_language is set by a cookie when
1c72b151 736 * the user selects language and logs out
bee165ef 737 */
fe55c7c7 738
9c737111 739 set_up_language($squirrelmail_language, true);
bd9c880b 740 include_once(SM_PATH . 'functions/display_messages.php' );
098ea084 741 sqsession_destroy();
bd9c880b 742 logout_error( _("Unknown user or password incorrect.") );
9c737111 743 exit;
052e0c26 744 }
9c737111 745 } else {
052e0c26 746 exit;
9c737111 747 }
748 }
9c737111 749 return $imap_stream;
750}
f1e6f580 751
48af4b64 752/**
753 * Simply logs out the IMAP session
754 * @param stream imap_stream the IMAP connection to log out.
755 * @return void
756 */
9c737111 757function sqimap_logout ($imap_stream) {
8d936b0c 758 /* Logout is not valid until the server returns 'BYE'
759 * If we don't have an imap_ stream we're already logged out */
26a2cc8b 760 if(isset($imap_stream) && $imap_stream)
8d936b0c 761 sqimap_run_command($imap_stream, 'LOGOUT', false, $response, $message);
9c737111 762}
763
48af4b64 764/**
765 * Retreive the CAPABILITY string from the IMAP server.
766 * If capability is set, returns only that specific capability,
767 * else returns array of all capabilities.
768 */
487daa81 769function sqimap_capability($imap_stream, $capability='') {
9c737111 770 global $sqimap_capabilities;
9c737111 771 if (!is_array($sqimap_capabilities)) {
1c72b151 772 $read = sqimap_run_command($imap_stream, 'CAPABILITY', true, $a, $b);
773
9c737111 774 $c = explode(' ', $read[0]);
775 for ($i=2; $i < count($c); $i++) {
776 $cap_list = explode('=', $c[$i]);
3411d4ec 777 if (isset($cap_list[1])) {
ecc92309 778 // FIX ME. capabilities can occure multiple times.
779 // THREAD=REFERENCES THREAD=ORDEREDSUBJECT
9c737111 780 $sqimap_capabilities[$cap_list[0]] = $cap_list[1];
3411d4ec 781 } else {
9c737111 782 $sqimap_capabilities[$cap_list[0]] = TRUE;
3411d4ec 783 }
f1e6f580 784 }
9c737111 785 }
487daa81 786 if ($capability) {
098ea084 787 if (isset($sqimap_capabilities[$capability])) {
788 return $sqimap_capabilities[$capability];
789 } else {
790 return false;
791 }
f1e6f580 792 }
487daa81 793 return $sqimap_capabilities;
9c737111 794}
795
48af4b64 796/**
797 * Returns the delimeter between mailboxes: INBOX/Test, or INBOX.Test
798 */
9c737111 799function sqimap_get_delimiter ($imap_stream = false) {
3411d4ec 800 global $sqimap_delimiter, $optional_delimiter;
85fc999e 801
9c737111 802 /* Use configured delimiter if set */
803 if((!empty($optional_delimiter)) && $optional_delimiter != 'detect') {
804 return $optional_delimiter;
805 }
85fc999e 806
9c737111 807 /* Do some caching here */
808 if (!$sqimap_delimiter) {
809 if (sqimap_capability($imap_stream, 'NAMESPACE')) {
3411d4ec 810 /*
811 * According to something that I can't find, this is supposed to work on all systems
812 * OS: This won't work in Courier IMAP.
813 * OS: According to rfc2342 response from NAMESPACE command is:
814 * OS: * NAMESPACE (PERSONAL NAMESPACES) (OTHER_USERS NAMESPACE) (SHARED NAMESPACES)
815 * OS: We want to lookup all personal NAMESPACES...
816 */
1c72b151 817 $read = sqimap_run_command($imap_stream, 'NAMESPACE', true, $a, $b);
f1e6f580 818 if (eregi('\\* NAMESPACE +(\\( *\\(.+\\) *\\)|NIL) +(\\( *\\(.+\\) *\\)|NIL) +(\\( *\\(.+\\) *\\)|NIL)', $read[0], $data)) {
9c737111 819 if (eregi('^\\( *\\((.*)\\) *\\)', $data[1], $data2)) {
f1e6f580 820 $pn = $data2[1];
9c737111 821 }
f1e6f580 822 $pna = explode(')(', $pn);
9c737111 823 while (list($k, $v) = each($pna)) {
862ff2d3 824 $lst = explode('"', $v);
825 if (isset($lst[3])) {
826 $pn[$lst[1]] = $lst[3];
827 } else {
74424a43 828 $pn[$lst[1]] = '';
862ff2d3 829 }
f1e6f580 830 }
831 }
832 $sqimap_delimiter = $pn[0];
833 } else {
834 fputs ($imap_stream, ". LIST \"INBOX\" \"\"\r\n");
835 $read = sqimap_read_data($imap_stream, '.', true, $a, $b);
6a15a16b 836 $read = $read['.'][0]; //sqimap_read_data() now returns a tag array of response array
f1e6f580 837 $quote_position = strpos ($read[0], '"');
838 $sqimap_delimiter = substr ($read[0], $quote_position+1, 1);
839 }
840 }
841 return $sqimap_delimiter;
9c737111 842}
052e0c26 843
48af4b64 844/**
845 * This encodes a mailbox name for use in IMAP commands.
846 * @param string what the mailbox to encode
847 * @return string the encoded mailbox string
848 */
b2306cbe 849function sqimap_encode_mailbox_name($what)
850{
851 if (ereg("[\"\\\r\n]", $what))
852 return '{' . strlen($what) . "}\r\n" . $what; /* 4.3 literal form */
853 return '"' . $what . '"'; /* 4.3 quoted string form */
854}
855
856
48af4b64 857/**
858 * Gets the number of messages in the current mailbox.
859 */
9c737111 860function sqimap_get_num_messages ($imap_stream, $mailbox) {
b2306cbe 861 $read_ary = sqimap_run_command ($imap_stream, 'EXAMINE ' . sqimap_encode_mailbox_name($mailbox), false, $result, $message);
9c737111 862 for ($i = 0; $i < count($read_ary); $i++) {
85fc999e 863 if (ereg("[^ ]+ +([^ ]+) +EXISTS", $read_ary[$i], $regs)) {
864 return $regs[1];
865 }
9c737111 866 }
1f720b34 867 return false; //"BUG! Couldn't get number of messages in $mailbox!";
9c737111 868}
869
91688e5f 870function parseAddress($address, $max=0) {
871 $aTokens = array();
872 $aAddress = array();
873 $iCnt = strlen($address);
874 $aSpecials = array('(' ,'<' ,',' ,';' ,':');
875 $aReplace = array(' (',' <',' ,',' ;',' :');
876 $address = str_replace($aSpecials,$aReplace,$address);
bc78cc6e 877 $i = $iAddrFound = $bGroup = 0;
91688e5f 878 while ($i < $iCnt) {
879 $cChar = $address{$i};
880 switch($cChar)
329a7ca5 881 {
882 case '<':
883 $iEnd = strpos($address,'>',$i+1);
884 if (!$iEnd) {
885 $sToken = substr($address,$i);
886 $i = $iCnt;
887 } else {
888 $sToken = substr($address,$i,$iEnd - $i +1);
889 $i = $iEnd;
890 }
891 $sToken = str_replace($aReplace, $aSpecials,$sToken);
892 $aTokens[] = $sToken;
893 break;
894 case '"':
895 $iEnd = strpos($address,$cChar,$i+1);
da1e42a1 896 if ($iEnd) {
897 // skip escaped quotes
898 $prev_char = $address{$iEnd-1};
899 while ($prev_char === '\\' && substr($address,$iEnd-2,2) !== '\\\\') {
900 $iEnd = strpos($address,$cChar,$iEnd+1);
901 if ($iEnd) {
902 $prev_char = $address{$iEnd-1};
903 } else {
904 $prev_char = false;
905 }
906 }
907 }
329a7ca5 908 if (!$iEnd) {
909 $sToken = substr($address,$i);
910 $i = $iCnt;
911 } else {
912 // also remove the surrounding quotes
913 $sToken = substr($address,$i+1,$iEnd - $i -1);
914 $i = $iEnd;
915 }
916 $sToken = str_replace($aReplace, $aSpecials,$sToken);
76c3ee28 917 if ($sToken) $aTokens[] = $sToken;
329a7ca5 918 break;
919 case '(':
920 $iEnd = strpos($address,')',$i);
921 if (!$iEnd) {
922 $sToken = substr($address,$i);
923 $i = $iCnt;
924 } else {
925 $sToken = substr($address,$i,$iEnd - $i + 1);
926 $i = $iEnd;
927 }
928 $sToken = str_replace($aReplace, $aSpecials,$sToken);
929 $aTokens[] = $sToken;
930 break;
931 case ',':
bc78cc6e 932 ++$iAddrFound;
329a7ca5 933 case ';':
bc78cc6e 934 if (!$bGroup) {
935 ++$iAddrFound;
936 } else {
937 $bGroup = false;
938 }
939 if ($max && $max == $iAddrFound) {
940 break 2;
941 } else {
942 $aTokens[] = $cChar;
943 break;
944 }
945 case ':':
946 $bGroup = true;
329a7ca5 947 case ' ':
948 $aTokens[] = $cChar;
949 break;
91688e5f 950 default:
329a7ca5 951 $iEnd = strpos($address,' ',$i+1);
952 if ($iEnd) {
953 $sToken = trim(substr($address,$i,$iEnd - $i));
954 $i = $iEnd-1;
91688e5f 955 } else {
329a7ca5 956 $sToken = trim(substr($address,$i));
957 $i = $iCnt;
91688e5f 958 }
329a7ca5 959 if ($sToken) $aTokens[] = $sToken;
91688e5f 960 }
329a7ca5 961 ++$i;
9c737111 962 }
91688e5f 963 $sPersonal = $sEmail = $sComment = $sGroup = '';
964 $aStack = $aComment = array();
965 foreach ($aTokens as $sToken) {
966 if ($max && $max == count($aAddress)) {
329a7ca5 967 return $aAddress;
092d4f2c 968 }
329a7ca5 969 $cChar = $sToken{0};
91688e5f 970 switch ($cChar)
329a7ca5 971 {
972 case '=':
973 case '"':
974 case ' ':
975 $aStack[] = $sToken;
976 break;
977 case '(':
978 $aComment[] = substr($sToken,1,-1);
979 break;
980 case ';':
981 if ($sGroup) {
982 $sEmail = trim(implode(' ',$aStack));
983 $aAddress[] = array($sGroup,$sEmail);
984 $aStack = $aComment = array();
985 $sGroup = '';
986 break;
987 }
988 case ',':
989 if (!$sEmail) {
990 while (count($aStack) && !$sEmail) {
991 $sEmail = trim(array_pop($aStack));
992 }
993 }
994 if (count($aStack)) {
995 $sPersonal = trim(implode('',$aStack));
996 } else {
997 $sPersonal = '';
bea3eb1e 998 }
329a7ca5 999 if (!$sPersonal && count($aComment)) {
1000 $sComment = implode(' ',$aComment);
1001 $sPersonal .= $sComment;
1002 }
1003 $aAddress[] = array($sEmail,$sPersonal);
1004 $sPersonal = $sComment = $sEmail = '';
1005 $aStack = $aComment = array();
1006 break;
1007 case ':':
1008 $sGroup = implode(' ',$aStack); break;
1009 $aStack = array();
1010 break;
1011 case '<':
1012 $sEmail = trim(substr($sToken,1,-1));
1013 break;
1014 case '>':
1015 /* skip */
1016 break;
1017 default: $aStack[] = $sToken; break;
33565ec4 1018 }
7e3de682 1019 }
91688e5f 1020 /* now do the action again for the last address */
1021 if (!$sEmail) {
1022 while (count($aStack) && !$sEmail) {
329a7ca5 1023 $sEmail = trim(array_pop($aStack));
91688e5f 1024 }
7e3de682 1025 }
91688e5f 1026 if (count($aStack)) {
329a7ca5 1027 $sPersonal = trim(implode('',$aStack));
098ea084 1028 } else {
91688e5f 1029 $sPersonal = '';
9c737111 1030 }
329a7ca5 1031 if (!$sPersonal && count($aComment)) {
91688e5f 1032 $sComment = implode(' ',$aComment);
329a7ca5 1033 $sPersonal .= $sComment;
91688e5f 1034 }
1035 $aAddress[] = array($sEmail,$sPersonal);
1036 return $aAddress;
1037}
1038
1039
48af4b64 1040/**
1041 * Returns the number of unseen messages in this folder.
3411d4ec 1042 */
9c737111 1043function sqimap_unseen_messages ($imap_stream, $mailbox) {
b2306cbe 1044 $read_ary = sqimap_run_command ($imap_stream, 'STATUS ' . sqimap_encode_mailbox_name($mailbox) . ' (UNSEEN)', false, $result, $message);
ea7ff111 1045 $i = 0;
1f720b34 1046 $regs = array(false, false);
ea7ff111 1047 while (isset($read_ary[$i])) {
1048 if (ereg("UNSEEN ([0-9]+)", $read_ary[$i], $regs)) {
1049 break;
1050 }
1051 $i++;
1052 }
9c737111 1053 return $regs[1];
1054}
1055
48af4b64 1056/**
4974c2a0 1057 * Returns the number of total/unseen/recent messages in this folder
1f720b34 1058 */
1059function sqimap_status_messages ($imap_stream, $mailbox) {
b2306cbe 1060 $read_ary = sqimap_run_command ($imap_stream, 'STATUS ' . sqimap_encode_mailbox_name($mailbox) . ' (MESSAGES UNSEEN RECENT)', false, $result, $message);
1f720b34 1061 $i = 0;
b8ec18ef 1062 $messages = $unseen = $recent = false;
1f720b34 1063 $regs = array(false,false);
1064 while (isset($read_ary[$i])) {
1065 if (preg_match('/UNSEEN\s+([0-9]+)/i', $read_ary[$i], $regs)) {
098ea084 1066 $unseen = $regs[1];
1067 }
1f720b34 1068 if (preg_match('/MESSAGES\s+([0-9]+)/i', $read_ary[$i], $regs)) {
098ea084 1069 $messages = $regs[1];
1070 }
b8ec18ef 1071 if (preg_match('/RECENT\s+([0-9]+)/i', $read_ary[$i], $regs)) {
098ea084 1072 $recent = $regs[1];
1073 }
1f720b34 1074 $i++;
1075 }
b8ec18ef 1076 return array('MESSAGES' => $messages, 'UNSEEN'=>$unseen, 'RECENT' => $recent);
1f720b34 1077}
1078
9c737111 1079
48af4b64 1080/**
1081 * Saves a message to a given folder -- used for saving sent messages
3411d4ec 1082 */
9c737111 1083function sqimap_append ($imap_stream, $sent_folder, $length) {
b2306cbe 1084 fputs ($imap_stream, sqimap_session_id() . ' APPEND ' . sqimap_encode_mailbox_name($sent_folder) . " (\\Seen) \{$length}\r\n");
85fc999e 1085 $tmp = fgets ($imap_stream, 1024);
9c737111 1086}
1087
8813fb15 1088function sqimap_append_done ($imap_stream, $folder='') {
1f720b34 1089 global $squirrelmail_language, $color;
9c737111 1090 fputs ($imap_stream, "\r\n");
1091 $tmp = fgets ($imap_stream, 1024);
69146537 1092 if (preg_match("/(.*)(BAD|NO)(.*)$/", $tmp, $regs)) {
1093 set_up_language($squirrelmail_language);
1f720b34 1094 require_once(SM_PATH . 'functions/display_messages.php');
098ea084 1095 $reason = $regs[3];
1096 if ($regs[2] == 'NO') {
1097 $string = "<b><font color=$color[2]>\n" .
1098 _("ERROR : Could not append message to") ." $folder." .
1099 "</b><br>\n" .
1100 _("Server responded: ") .
1101 $reason . "<br>\n";
1102 if (preg_match("/(.*)(quota)(.*)$/i", $reason, $regs)) {
1103 $string .= _("Solution: ") .
1104 _("Remove unneccessary messages from your folder and start with your Trash folder.")
1105 ."<br>\n";
1106 }
1107 $string .= "</font>\n";
1108 error_box($string,$color);
1109 } else {
8813fb15 1110 $string = "<b><font color=$color[2]>\n" .
098ea084 1111 _("ERROR : Bad or malformed request.") .
1112 "</b><br>\n" .
1113 _("Server responded: ") .
1114 $tmp . "</font><br>\n";
1115 error_box($string,$color);
8813fb15 1116 exit;
098ea084 1117 }
69146537 1118 }
9c737111 1119}
85fc999e 1120
bd9829d7 1121function sqimap_get_user_server ($imap_server, $username) {
bd9829d7 1122 if (substr($imap_server, 0, 4) != "map:") {
1123 return $imap_server;
1124 }
bd9829d7 1125 $function = substr($imap_server, 4);
1126 return $function($username);
1127}
1128
48af4b64 1129/**
1130 * This is an example that gets imapservers from yellowpages (NIS).
bd9829d7 1131 * you can simple put map:map_yp_alias in your $imap_server_address
1132 * in config.php use your own function instead map_yp_alias to map your
48af4b64 1133 * LDAP whatever way to find the users imapserver.
1134 */
bd9829d7 1135function map_yp_alias($username) {
1136 $yp = `ypmatch $username aliases`;
1137 return chop(substr($yp, strlen($username)+1));
1138}
1139
15e6162e 1140?>