functions/imap_general.php

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