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