trunk/gosa-plugins/mail/personal/mail/sieve/class_sieve.inc

   1 <?php
   2
   3 /*
   4  * $Id: class_sieve.inc,v 1.1 2005/02/21 09:33:01 cajus Exp $
   5  *
   6  * Copyright 2001 Dan Ellis <danellis@rushmore.com>
   7  *
   8  * See the enclosed file COPYING for license information (GPL).  If you
   9  * did not receive this file, see http://www.fsf.org/copyleft/gpl.html.
  10  */
  11
  12 // TODO before next release:    remove ::status() and dependencies
  13
  14
  15 define ("F_NO", 0);
  16 define ("F_OK", 1);
  17 define ("F_DATA", 2);
  18 define ("F_HEAD", 3);
  19
  20 define ("EC_NOT_LOGGED_IN", 0);
  21 define ("EC_QUOTA", 10);
  22 define ("EC_NOSCRIPTS", 20);
  23 define ("EC_UNKNOWN", 255);
  24 /*
  25
  26    SIEVE-PHP.LIB VERSION 0.0.8
  27
  28    (C) 2001 Dan Ellis.
  29
  30    PLEASE READ THE README FILE FOR MORE INFORMATION.
  31
  32    Basically, this is the first re-release.  Things are much better than before.
  33
  34 Notes:
  35 This program/libary has bugs.
  36 .       This was quickly hacked out, so please let me know what is wrong and if you feel ambitious submit
  37 a patch :).
  38
  39 Todo:
  40 .       Provide better error diagnostics.                       (mostly done with ver 0.0.5)
  41 .       Allow other auth mechanisms besides plain               (in progress)
  42 .       Have timing mechanism when port problems arise.         (not done yet)
  43 .       Maybe add the NOOP function.                            (not done yet)
  44 .       Other top secret stuff....                              (some done, believe me?)
  45
  46 Dan Ellis (danellis@rushmore.com)
  47
  48 This program is released under the GNU Public License.
  49
  50 You should have received a copy of the GNU Public
  51 License along with this package; if not, write to the
  52 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  53 Boston, MA 02111-1307, USA.
  54
  55 See CHANGES for updates since last release
  56
  57 Contributers of patches:
  58 Atif Ghaffar
  59 Andrew Sterling Hanenkamp <sterling@hanenkamp.com>
  60  */
  61
  62
  63 class sieve
  64 {
  65   var $host;
  66   var $port;
  67   var $user;
  68   var $pass;
  69   var $auth_types;              /* a comma seperated list of allowed auth types, in order of preference */
  70   var $auth_in_use;             /* type of authentication attempted */
  71
  72   var $line;
  73   var $fp;
  74   var $retval;
  75   var $tmpfile;
  76   var $fh;
  77   var $len;
  78   var $script;
  79
  80   var $loggedin;
  81   var $capabilities;
  82   var $error;
  83   var $error_raw;
  84   var $responses;
  85   var $options = "";
  86
  87   //maybe we should add an errorlvl that the user will pass to new sieve = sieve(,,,,E_WARN)
  88   //so we can decide how to handle certain errors?!?
  89
  90   //also add a connection type, like PLAIN, MD5, etc...
  91
  92
  93   function get_response()
  94   {
  95     if($this->loggedin == false or feof($this->fp)){
  96       $this->error = EC_NOT_LOGGED_IN;
  97       $this->error_raw = "You are not logged in.";
  98       return false;
  99     }
 100
 101     unset($this->response);
 102     unset($this->error);
 103     unset($this->error_raw);
 104
 105     $this->line=fgets($this->fp,1024);
 106     $this->token = split(" ", $this->line, 2);
 107
 108     if($this->token[0] == "NO"){
 109       /* we need to try and extract the error code from here.  There are two possibilites: one, that it will take the form of:
 110          NO ("yyyyy") "zzzzzzz" or, two, NO {yyyyy} "zzzzzzzzzzz" */
 111       $this->x = 0;
 112       list($this->ltoken, $this->mtoken, $this->rtoken) = split(" ", $this->line." ", 3);
 113       if($this->mtoken[0] == "{"){
 114         while($this->mtoken[$this->x] != "}" or $this->err_len < 1){
 115           $this->err_len = substr($this->mtoken, 1, $this->x);
 116           $this->x++;
 117         }
 118 #print "<br>Trying to receive $this->err_len bytes for result<br>";
 119         $this->line = fgets($this->fp,$this->err_len);
 120         $this->error_raw[]=substr($this->line, 0, strlen($this->line) -2);    //we want to be nice and strip crlf's
 121         $this->err_recv = strlen($this->line);
 122
 123         /* Ensure max loop of 1000, to keep the ui from freezing */
 124         $max = 1000;
 125         $cur = 0;
 126
 127         while($this->err_recv < ($this->err_len) && ($cur < $max)){
 128
 129           $cur ++;
 130           $this->line    = fgets($this->fp,4096);
 131           $this->err_recv += strlen($this->line);
 132           $this->error_raw[]=preg_replace("/\r\n/","",$this->line);    //we want to be nice and strip crlf'
 133         }
 134       } /* end if */
 135       elseif($this->mtoken[0] == "("){
 136         switch($this->mtoken){
 137           case "(\"QUOTA\")":
 138             $this->error = EC_QUOTA;
 139           $this->error_raw=$this->rtoken;
 140           break;
 141           default:
 142           $this->error = EC_UNKNOWN;
 143           $this->error_raw=$this->rtoken;
 144           break;
 145         } /* end switch */
 146       } /* end elseif */
 147       else{
 148         $this->error = EC_UNKNOWN;
 149         $this->error_raw = $this->line;
 150       }
 151       return false;
 152
 153     } /* end if */
 154     elseif(substr($this->token[0],0,-2) == "OK"){
 155       return true;
 156     } /* end elseif */
 157     elseif($this->token[0][0] == "{"){
 158
 159       /* Unable wild assumption:  that the only function that gets here is the get_script(), doesn't really matter though */
 160
 161       /* the first line is the len field {xx}, which we don't care about at this point */
 162       $this->line = fgets($this->fp,1024);
 163       while(substr($this->line,0,2) != "OK" and substr($this->line,0,2) != "NO"){
 164         $this->response[]=$this->line;
 165         $this->line = fgets($this->fp, 1024);
 166       }
 167       if(substr($this->line,0,2) == "OK")
 168         return true;
 169       else
 170         return false;
 171     } /* end elseif */
 172     elseif($this->token[0][0] == "\""){
 173
 174       /* I'm going under the _assumption_ that the only function that will get here is the listscripts().
 175          I could very well be mistaken here, if I am, this part needs some rework */
 176
 177       $this->found_script=false;
 178
 179       while(substr($this->line,0,2) != "OK" and substr($this->line,0,2) != "NO"){
 180         $this->found_script=true;
 181         list($this->ltoken, $this->rtoken) = explode(" ", $this->line." ",2);
 182         //hmmm, a bug in php, if there is no space on explode line, a warning is generated...
 183
 184         if(strcmp(rtrim($this->rtoken), "ACTIVE")==0){
 185           $this->response["ACTIVE"] = substr(rtrim($this->ltoken),1,-1);
 186         }
 187         else
 188           $this->response[] = substr(rtrim($this->ltoken),1,-1);
 189         $this->line = fgets($this->fp, 1024);
 190       } /* end while */
 191
 192       return true;
 193
 194     } /* end elseif */
 195     else{
 196       $this->error = EC_UNKNOWN;
 197       $this->error_raw = $this->line;
 198       print "<b><i>UNKNOWN ERROR (Please report this line to danellis@rushmore.com to include in future releases): $this->line</i></b><br>";
 199       return false;
 200     } /* end else */
 201   } /* end get_response() */
 202
 203   function sieve($host, $port, $user, $pass, $auth="",$options ="", $auth_types="PLAIN DIGEST-MD5")
 204   {
 205     $this->host=$host;
 206     $this->port=$port;
 207     $this->user=$user;
 208     $this->pass=$pass;
 209     if(!strcmp($auth, ""))              /* If there is no auth user, we deem the user itself to be the auth'd user */
 210       $this->auth = $this->user;
 211     else
 212       $this->auth = $auth;
 213     $this->auth_types=$auth_types;      /* Allowed authentication types */
 214     $this->fp=0;
 215     $this->line="";
 216     $this->retval="";
 217     $this->tmpfile="";
 218     $this->fh=0;
 219     $this->len=0;
 220     $this->capabilities="";
 221     $this->loggedin=false;
 222     $this->error= "";
 223     $this->error_raw="";
 224     $this->options = $options;
 225
 226     @DEBUG (DEBUG_MAIL, __LINE__, __FUNCTION__, __FILE__, $this->error_raw,
 227         "<b>SIEVE: Host: $host:$port. Options: $options - Auth Types: $auth_types </b>");
 228   }
 229
 230   function parse_for_quotes($string)
 231   {
 232     /* This function tokenizes a line of input by quote marks and returns them as an array */
 233
 234     $start = -1;
 235     $index = 0;
 236
 237     for($ptr = 0; $ptr < strlen($string); $ptr++){
 238       if($string[$ptr] == '"' and $string[$ptr] != '\\'){
 239         if($start == -1){
 240           $start = $ptr;
 241         } /* end if */
 242         else{
 243           $token[$index++] = substr($string, $start + 1, $ptr - $start - 1);
 244           $found = true;
 245           $start = -1;
 246         } /* end else */
 247
 248       } /* end if */
 249
 250     } /* end for */
 251
 252     if(isset($token))
 253       return $token;
 254     else
 255       return false;
 256   } /* end function */
 257
 258   function status($string)
 259   {
 260     //this should probably be replaced by a smarter parser.
 261
 262     /*  Need to remove this and all dependencies from the class */
 263
 264     switch (substr($string, 0,2)){
 265       case "NO":
 266         return F_NO;            //there should be some function to extract the error code from this line
 267       //NO ("quota") "You are oly allowed x number of scripts"
 268       break;
 269       case "OK":
 270         return F_OK;
 271       break;
 272       default:
 273       switch ($string[0]){
 274         case "{":
 275           //do parse here for {}'s  maybe modify parse_for_quotes to handle any parse delimiter?
 276           return F_HEAD;
 277         break;
 278         default:
 279         return F_DATA;
 280         break;
 281       } /* end switch */
 282     } /* end switch */
 283   } /* end status() */
 284
 285   function sieve_login()
 286   {
 287
 288     $this->fp=@fsockopen($this->host,$this->port,$err_id,$err_str);
 289     if($this->fp == false){
 290
 291       @DEBUG (DEBUG_MAIL, __LINE__, __FUNCTION__, __FILE__,$this->error_raw,
 292           "<b>SIEVE: Socket connection failed. (".$this->host.":".$this->port.")</b>");
 293
 294       $this->error_raw = $err_str;
 295       return false;
 296     }
 297
 298     $this->line=fgets($this->fp,1024);
 299
 300     //Hack for older versions of Sieve Server.  They do not respond with the Cyrus v2. standard
 301     //response.  They repsond as follows: "Cyrus timsieved v1.0.0" "SASL={PLAIN,........}"
 302     //So, if we see IMLEMENTATION in the first line, then we are done.
 303
 304     if(ereg("IMPLEMENTATION",$this->line))
 305     {
 306       //we're on the Cyrus V2 sieve server
 307       while(sieve::status($this->line) == F_DATA){
 308
 309         $this->item = sieve::parse_for_quotes($this->line);
 310
 311         if(strcmp($this->item[0], "IMPLEMENTATION") == 0)
 312           $this->capabilities["implementation"] = $this->item[1];
 313
 314         elseif(strcmp($this->item[0], "SIEVE") == 0 or strcmp($this->item[0], "SASL") == 0){
 315
 316           if(strcmp($this->item[0], "SIEVE") == 0){
 317             $this->cap_type="modules";
 318           }else{
 319             $this->cap_type="auth";
 320           }
 321
 322           $this->modules = split(" ", $this->item[1]);
 323           if(is_array($this->modules)){
 324             foreach($this->modules as $this->module)
 325               $this->capabilities[$this->cap_type][$this->module]=true;
 326           } /* end if */
 327           elseif(is_string($this->modules))
 328             $this->capabilites[$this->cap_type][$this->modules]=true;
 329         }
 330         else{
 331           $this->capabilities["unknown"][]=$this->line;
 332         }
 333         $this->line=fgets($this->fp,1024);
 334
 335       }// end while
 336     }
 337     else
 338     {
 339       //we're on the older Cyrus V1. server
 340       //this version does not support module reporting.  We only have auth types.
 341       $this->cap_type="auth";
 342
 343       //break apart at the "Cyrus timsieve...." "SASL={......}"
 344       $this->item = sieve::parse_for_quotes($this->line);
 345
 346       $this->capabilities["implementation"] = $this->item[0];
 347
 348       //we should have "SASL={..........}" now.  Break out the {xx,yyy,zzzz}
 349       $this->modules = substr($this->item[1], strpos($this->item[1], "{"),strlen($this->item[1])-1);
 350
 351       //then split again at the ", " stuff.
 352       $this->modules = split($this->modules, ", ");
 353
 354       //fill up our $this->modules property
 355       if(is_array($this->modules)){
 356         foreach($this->modules as $this->module)
 357           $this->capabilities[$this->cap_type][$this->module]=true;
 358       } /* end if */
 359       elseif(is_string($this->modules))
 360         $this->capabilites[$this->cap_type][$this->module]=true;
 361     }
 362
 363
 364
 365
 366     if(sieve::status($this->line) == F_NO){             //here we should do some returning of error codes?
 367       $this->error=EC_UNKNOWN;
 368
 369       @DEBUG (DEBUG_MAIL, __LINE__, __FUNCTION__, __FILE__,$this->error_raw,
 370           "<b>SIEVE: Unknown sieve response, giving up.</b>");
 371
 372       $this->error_raw = "Server not allowing connections.";
 373       return false;
 374     }
 375
 376     /* Loop through each allowed authentication type and see if the server allows the type */
 377     foreach(split(" ",$this->auth_types) as $auth_type)
 378     {
 379       if ($this->capabilities["auth"][$auth_type])
 380       {
 381         /* We found an auth type that is allowed. */
 382         $this->auth_in_use = $auth_type;
 383         break;
 384       }
 385     }
 386
 387     /* Fill error message if no auth types are present */
 388     if (!isset($this->capabilities["auth"])){
 389       $this->error=EC_UNKNOWN;
 390       $this->error_raw = "No authentication methods found - please check your sieve setup for missing sasl modules";
 391       return false;
 392     }
 393
 394     /* DEBUG */
 395     $imp = "";
 396     if(isset($this->capabilities['implementation'])){
 397       $imp = $this->capabilities['implementation'];
 398     }
 399     @DEBUG (DEBUG_MAIL, __LINE__, __FUNCTION__, __FILE__,$imp,
 400         "<b>SIEVE: Socket connection established. </b>");
 401
 402     /* call our authentication program */
 403     return sieve::authenticate();
 404
 405   }
 406
 407   function sieve_logout()
 408   {
 409     if($this->loggedin==false)
 410       return false;
 411
 412     fputs($this->fp,"LOGOUT\r\n");
 413     fclose($this->fp);
 414
 415     @DEBUG (DEBUG_MAIL, __LINE__, __FUNCTION__, __FILE__,"",
 416         "<b>SIEVE: Logout!</b>");
 417
 418     $this->loggedin=false;
 419     return true;
 420   }
 421
 422   function sieve_sendscript($scriptname, $script)
 423   {
 424     if($this->loggedin==false)
 425       return false;
 426     $this->script=stripslashes($script);
 427     $len=strlen($this->script);
 428     fputs($this->fp, "PUTSCRIPT \"$scriptname\" {".$len."+}\r\n");
 429     fputs($this->fp, "$this->script\r\n");
 430
 431     if(sieve::get_response()){
 432       @DEBUG (DEBUG_MAIL, __LINE__, __FUNCTION__, __FILE__,"",
 433           "<b>SIEVE: Script '".$scriptname."' successfully send!</b>");
 434       return(TRUE);
 435     }else{
 436       @DEBUG (DEBUG_MAIL, __LINE__, __FUNCTION__, __FILE__,trim($this->error_raw),
 437           "<b>SIEVE: Script couldn't be send!</b>");
 438       return(FALSE);
 439     }
 440   }
 441
 442   //it appears the timsieved does not honor the NUMBER type.  see lex.c in timsieved src.
 443   //don't expect this function to work yet.  I might have messed something up here, too.
 444   function sieve_havespace($scriptname, $scriptsize)
 445   {
 446     if($this->loggedin==false)
 447       return false;
 448     fputs($this->fp, "HAVESPACE \"$scriptname\" $scriptsize\r\n");
 449     return sieve::get_response();
 450
 451   }
 452
 453   function sieve_setactivescript($scriptname)
 454   {
 455     if($this->loggedin==false)
 456       return false;
 457
 458     fputs($this->fp, "SETACTIVE \"$scriptname\"\r\n");
 459
 460     if(sieve::get_response()){
 461       @DEBUG (DEBUG_MAIL, __LINE__, __FUNCTION__, __FILE__,"",
 462           "<b>SIEVE: Set active script '".$scriptname."' was successful!</b>");
 463       return(TRUE);
 464     }else{
 465       @DEBUG (DEBUG_MAIL, __LINE__, __FUNCTION__, __FILE__,trim($this->error_raw),
 466           "<b>SIEVE: Set active script '".$scriptname."' failed!</b>");
 467       return(FALSE);
 468     }
 469   }
 470
 471   function sieve_getscript($scriptname)
 472   {
 473     unset($this->script);
 474     if($this->loggedin==false)
 475       return false;
 476
 477     fputs($this->fp, "GETSCRIPT \"$scriptname\"\r\n");
 478
 479     if(sieve::get_response()){
 480       @DEBUG (DEBUG_MAIL, __LINE__, __FUNCTION__, __FILE__,"",
 481           "<b>SIEVE: Get script '".$scriptname."' was successful!</b>");
 482       return(TRUE);
 483     }else{
 484       @DEBUG (DEBUG_MAIL, __LINE__, __FUNCTION__, __FILE__,trim($this->error_raw),
 485           "<b>SIEVE: Get script '".$scriptname."' failed!</b>");
 486       return(FALSE);
 487     }
 488   }
 489
 490
 491   function sieve_deletescript($scriptname)
 492   {
 493     if($this->loggedin==false)
 494       return false;
 495
 496     fputs($this->fp, "DELETESCRIPT \"$scriptname\"\r\n");
 497
 498     if(sieve::get_response()){
 499       @DEBUG (DEBUG_MAIL, __LINE__, __FUNCTION__, __FILE__,"",
 500           "<b>SIEVE: Delete script '".$scriptname."' was successful!</b>");
 501       return(TRUE);
 502     }else{
 503       @DEBUG (DEBUG_MAIL, __LINE__, __FUNCTION__, __FILE__,trim($this->error_raw),
 504           "<b>SIEVE: Delete  script '".$scriptname."' failed!</b>");
 505       return(FALSE);
 506     }
 507   }
 508
 509
 510   function sieve_listscripts()
 511   {
 512     fputs($this->fp, "LISTSCRIPTS\r\n");
 513     sieve::get_response();              //should always return true, even if there are no scripts...
 514     if(isset($this->found_script) and $this->found_script){
 515       @DEBUG (DEBUG_MAIL, __LINE__, __FUNCTION__, __FILE__, implode($this->response,", "),
 516           "<b>SIEVE: List scripts was successful!</b>");
 517       return true;
 518     }else{
 519       $this->error=EC_NOSCRIPTS;        //sieve::getresponse has no way of telling wether a script was found...
 520       $this->error_raw="No scripts found for this account.";
 521       @DEBUG (DEBUG_MAIL, __LINE__, __FUNCTION__, __FILE__, $this->error_raw,
 522           "<b>SIEVE: List scripts returned no scripts</b>");
 523       return false;
 524     }
 525   }
 526
 527   function sieve_alive()
 528   {
 529     if(!isset($this->fp) or $this->fp==0){
 530       $this->error = EC_NOT_LOGGED_IN;
 531       return false;
 532     }
 533     elseif(feof($this->fp)){
 534       $this->error = EC_NOT_LOGGED_IN;
 535       return false;
 536     }
 537     else
 538       return true;
 539   }
 540
 541
 542   function authenticate()
 543   {
 544
 545     /* Check if a TLS bases connection is required
 546      */
 547     if($this->options == "tls"){
 548
 549       /* Check if PHP supports TLS encryption for sockets
 550        */
 551       if(function_exists("stream_socket_enable_crypto")){
 552
 553         /* Initiate TLS and get response
 554          */
 555         if (@ fputs ($this->fp, "STARTTLS\r\n") === false) {
 556           @DEBUG (DEBUG_MAIL, __LINE__, __FUNCTION__, __FILE__,"couldn't send data to socket.",
 557               "<b>SIEVE: TLS couldn't be initiated. </b>");
 558           $this->error_raw = "fputs() returned 'false'"; return (false);
 559         }
 560         @ $linha = fgets ($this->fp, 1024);
 561         if ($linha === false) {
 562           $this->error_raw = "fgets() returned 'false'";
 563           @DEBUG (DEBUG_MAIL, __LINE__, __FUNCTION__, __FILE__,"couldn't read data from socket.",
 564               "<b>SIEVE: TLS couldn't be initiated. </b>");
 565           return (false);
 566         }
 567         if (! preg_match ("/\\s*OK\\s/i", $linha)) {
 568           @DEBUG (DEBUG_MAIL, __LINE__, __FUNCTION__, __FILE__,"server returned '".trim ($linha)."' instead of 'OK'",
 569               "<b>SIEVE: TLS couldn't be initiated. </b>");
 570           $this->error_raw = "expected an 'OK', but server replied: '" . trim ($linha) . "'";
 571           return (false);
 572         }
 573         if (! @ stream_socket_enable_crypto ($this->fp, true, STREAM_CRYPTO_METHOD_TLS_CLIENT)) {
 574           @DEBUG (DEBUG_MAIL, __LINE__, __FUNCTION__, __FILE__,
 575               "The socket doesn't seem to support STREAM_CRYPTO_METHOD_TLS_CLIENT",
 576               "<b>SIEVE: TLS couldn't be initiated. </b>");
 577           $this->error_raw = "stream_socket_enable_crypto() returned 'false'";
 578           return (false);
 579         }
 580         @DEBUG (DEBUG_MAIL, __LINE__, __FUNCTION__, __FILE__,"",
 581             "<b>SIEVE: TLS successfully initiated. </b>");
 582       }
 583     }
 584
 585     switch ($this->auth_in_use) {
 586
 587       case "PLAIN":
 588       {
 589         $auth=base64_encode("$this->user\0$this->auth\0$this->pass");
 590
 591         $this->len=strlen($auth);
 592         fputs($this->fp, "AUTHENTICATE \"PLAIN\" {".$this->len."+}\r\n");
 593         fputs($this->fp, "$auth\r\n");
 594
 595         $this->line=fgets($this->fp,1024);
 596         while(sieve::status($this->line) == F_DATA)
 597           $this->line=fgets($this->fp,1024);
 598
 599         if(sieve::status($this->line) == F_NO){
 600           $this->error_raw = $this->line;
 601           @DEBUG (DEBUG_MAIL, __LINE__, __FUNCTION__, __FILE__,trim($this->error_raw),
 602               "<b>SIEVE: Authentication for '".$this->user."-".$this->auth_in_use."' failed.</b>");
 603
 604           return false;
 605         }
 606
 607         @DEBUG (DEBUG_MAIL, __LINE__, __FUNCTION__, __FILE__,"",
 608             "<b>SIEVE: Authentication for '".$this->user."-".$this->auth_in_use."' was successful.</b>");
 609         $this->loggedin=true;
 610         return true;
 611       }break;
 612
 613       default:
 614       {
 615         @DEBUG (DEBUG_MAIL, __LINE__, __FUNCTION__, __FILE__,"Unsupported authentication method '".$this->auth_in_use."'!",
 616             "<b>SIEVE: Authentication for '".$this->user."' with type '".$this->auth_in_use."' failed.</b>");
 617
 618         $this->error_raw = "Unsupported authentication method '".$this->auth_in_use."'!";
 619         return false;
 620       }   break;
 621
 622     }//end switch
 623
 624
 625   }//end authenticate()
 626
 627
 628 }
 629
 630
 631 // vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler:
 632 ?>