* * See the enclosed file COPYING for license information (GPL). If you * did not receive this file, see http://www.fsf.org/copyleft/gpl.html. */ // TODO before next release: remove ::status() and dependencies define ("F_NO", 0); define ("F_OK", 1); define ("F_DATA", 2); define ("F_HEAD", 3); define ("EC_NOT_LOGGED_IN", 0); define ("EC_QUOTA", 10); define ("EC_NOSCRIPTS", 20); define ("EC_UNKNOWN", 255); /* SIEVE-PHP.LIB VERSION 0.0.8 (C) 2001 Dan Ellis. PLEASE READ THE README FILE FOR MORE INFORMATION. Basically, this is the first re-release. Things are much better than before. Notes: This program/libary has bugs. . This was quickly hacked out, so please let me know what is wrong and if you feel ambitious submit a patch :). Todo: . Provide better error diagnostics. (mostly done with ver 0.0.5) . Allow other auth mechanisms besides plain (in progress) . Have timing mechanism when port problems arise. (not done yet) . Maybe add the NOOP function. (not done yet) . Other top secret stuff.... (some done, believe me?) Dan Ellis (danellis@rushmore.com) This program is released under the GNU Public License. You should have received a copy of the GNU Public License along with this package; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. See CHANGES for updates since last release Contributers of patches: Atif Ghaffar Andrew Sterling Hanenkamp */ class sieve { var $host; var $port; var $user; var $pass; var $auth_types; /* a comma seperated list of allowed auth types, in order of preference */ var $auth_in_use; /* type of authentication attempted */ var $line; var $fp; var $retval; var $tmpfile; var $fh; var $len; var $script; var $loggedin; var $capabilities; var $error; var $error_raw; var $responses; //maybe we should add an errorlvl that the user will pass to new sieve = sieve(,,,,E_WARN) //so we can decide how to handle certain errors?!? //also add a connection type, like PLAIN, MD5, etc... function get_response() { if($this->loggedin == false or feof($this->fp)){ $this->error = EC_NOT_LOGGED_IN; $this->error_raw = "You are not logged in."; return false; } unset($this->response); unset($this->error); unset($this->error_raw); $this->line=fgets($this->fp,1024); $this->token = split(" ", $this->line, 2); if($this->token[0] == "NO"){ /* we need to try and extract the error code from here. There are two possibilites: one, that it will take the form of: NO ("yyyyy") "zzzzzzz" or, two, NO {yyyyy} "zzzzzzzzzzz" */ $this->x = 0; list($this->ltoken, $this->mtoken, $this->rtoken) = split(" ", $this->line." ", 3); if($this->mtoken[0] == "{"){ while($this->mtoken[$this->x] != "}" or $this->err_len < 1){ $this->err_len = substr($this->mtoken, 1, $this->x); $this->x++; } //print "
Trying to receive $this->err_len bytes for result
"; $this->line = fgets($this->fp,$this->err_len); $this->error_raw[]=substr($this->line, 0, strlen($this->line) -2); //we want to be nice and strip crlf's $this->err_recv = strlen($this->line); while($this->err_recv < $this->err_len){ //print "
Trying to receive ".($this->err_len-$this->err_recv)." bytes for result
"; $this->line = fgets($this->fp, ($this->err_len-$this->err_recv)); $this->error_raw[]=substr($this->line, 0, strlen($this->line) -2); //we want to be nice and strip crlf's $this->err_recv += strlen($this->line); } /* end while */ $this->line = fgets($this->fp, 1024); //we need to grab the last crlf, i think. this may be a bug... $this->error=EC_UNKNOWN; } /* end if */ elseif($this->mtoken[0] == "("){ switch($this->mtoken){ case "(\"QUOTA\")": $this->error = EC_QUOTA; $this->error_raw=$this->rtoken; break; default: $this->error = EC_UNKNOWN; $this->error_raw=$this->rtoken; break; } /* end switch */ } /* end elseif */ else{ $this->error = EC_UNKNOWN; $this->error_raw = $this->line; } return false; } /* end if */ elseif(substr($this->token[0],0,-2) == "OK"){ return true; } /* end elseif */ elseif($this->token[0][0] == "{"){ /* Unable wild assumption: that the only function that gets here is the get_script(), doesn't really matter though */ /* the first line is the len field {xx}, which we don't care about at this point */ $this->line = fgets($this->fp,1024); while(substr($this->line,0,2) != "OK" and substr($this->line,0,2) != "NO"){ $this->response[]=$this->line; $this->line = fgets($this->fp, 1024); } if(substr($this->line,0,2) == "OK") return true; else return false; } /* end elseif */ elseif($this->token[0][0] == "\""){ /* I'm going under the _assumption_ that the only function that will get here is the listscripts(). I could very well be mistaken here, if I am, this part needs some rework */ $this->found_script=false; while(substr($this->line,0,2) != "OK" and substr($this->line,0,2) != "NO"){ $this->found_script=true; list($this->ltoken, $this->rtoken) = explode(" ", $this->line." ",2); //hmmm, a bug in php, if there is no space on explode line, a warning is generated... if(strcmp(rtrim($this->rtoken), "ACTIVE")==0){ $this->response["ACTIVE"] = substr(rtrim($this->ltoken),1,-1); } else $this->response[] = substr(rtrim($this->ltoken),1,-1); $this->line = fgets($this->fp, 1024); } /* end while */ return true; } /* end elseif */ else{ $this->error = EC_UNKNOWN; $this->error_raw = $this->line; print "UNKNOWN ERROR (Please report this line to danellis@rushmore.com to include in future releases): $this->line
"; return false; } /* end else */ } /* end get_response() */ function sieve($host, $port, $user, $pass, $auth="", $auth_types="PLAIN DIGEST-MD5") { $this->host=$host; $this->port=$port; $this->user=$user; $this->pass=$pass; if(!strcmp($auth, "")) /* If there is no auth user, we deem the user itself to be the auth'd user */ $this->auth = $this->user; else $this->auth = $auth; $this->auth_types=$auth_types; /* Allowed authentication types */ $this->fp=0; $this->line=""; $this->retval=""; $this->tmpfile=""; $this->fh=0; $this->len=0; $this->capabilities=""; $this->loggedin=false; $this->error= ""; $this->error_raw=""; } function parse_for_quotes($string) { /* This function tokenizes a line of input by quote marks and returns them as an array */ $start = -1; $index = 0; for($ptr = 0; $ptr < strlen($string); $ptr++){ if($string[$ptr] == '"' and $string[$ptr] != '\\'){ if($start == -1){ $start = $ptr; } /* end if */ else{ $token[$index++] = substr($string, $start + 1, $ptr - $start - 1); $found = true; $start = -1; } /* end else */ } /* end if */ } /* end for */ if(isset($token)) return $token; else return false; } /* end function */ function status($string) { //this should probably be replaced by a smarter parser. /* Need to remove this and all dependencies from the class */ switch (substr($string, 0,2)){ case "NO": return F_NO; //there should be some function to extract the error code from this line //NO ("quota") "You are oly allowed x number of scripts" break; case "OK": return F_OK; break; default: switch ($string[0]){ case "{": //do parse here for {}'s maybe modify parse_for_quotes to handle any parse delimiter? return F_HEAD; break; default: return F_DATA; break; } /* end switch */ } /* end switch */ } /* end status() */ function sieve_login() { $this->fp=fsockopen($this->host,$this->port); if($this->fp == false) return false; $this->line=fgets($this->fp,1024); //Hack for older versions of Sieve Server. They do not respond with the Cyrus v2. standard //response. They repsond as follows: "Cyrus timsieved v1.0.0" "SASL={PLAIN,........}" //So, if we see IMLEMENTATION in the first line, then we are done. if(ereg("IMPLEMENTATION",$this->line)) { //we're on the Cyrus V2 sieve server while(sieve::status($this->line) == F_DATA){ $this->item = sieve::parse_for_quotes($this->line); if(strcmp($this->item[0], "IMPLEMENTATION") == 0) $this->capabilities["implementation"] = $this->item[1]; elseif(strcmp($this->item[0], "SIEVE") == 0 or strcmp($this->item[0], "SASL") == 0){ if(strcmp($this->item[0], "SIEVE") == 0) $this->cap_type="modules"; else $this->cap_type="auth"; $this->modules = split(" ", $this->item[1]); if(is_array($this->modules)){ foreach($this->modules as $this->module) $this->capabilities[$this->cap_type][$this->module]=true; } /* end if */ elseif(is_string($this->modules)) $this->capabilites[$this->cap_type][$this->modules]=true; } else{ $this->capabilities["unknown"][]=$this->line; } $this->line=fgets($this->fp,1024); }// end while } else { //we're on the older Cyrus V1. server //this version does not support module reporting. We only have auth types. $this->cap_type="auth"; //break apart at the "Cyrus timsieve...." "SASL={......}" $this->item = sieve::parse_for_quotes($this->line); $this->capabilities["implementation"] = $this->item[0]; //we should have "SASL={..........}" now. Break out the {xx,yyy,zzzz} $this->modules = substr($this->item[1], strpos($this->item[1], "{"),strlen($this->item[1])-1); //then split again at the ", " stuff. $this->modules = split($this->modules, ", "); //fill up our $this->modules property if(is_array($this->modules)){ foreach($this->modules as $this->module) $this->capabilities[$this->cap_type][$this->module]=true; } /* end if */ elseif(is_string($this->modules)) $this->capabilites[$this->cap_type][$this->module]=true; } if(sieve::status($this->line) == F_NO){ //here we should do some returning of error codes? $this->error=EC_UNKNOWN; $this->error_raw = "Server not allowing connections."; return false; } /* decision login to decide what type of authentication to use... */ /* Loop through each allowed authentication type and see if the server allows the type */ foreach(split(" ",$this->auth_types) as $auth_type) { if ($this->capabilities["auth"][$auth_type]) { /* We found an auth type that is allowed. */ $this->auth_in_use = $auth_type; break; } } /* Fill error message if no auth types are present */ if (!isset($this->capabilities["auth"])){ $this->error=EC_UNKNOWN; $this->error_raw = "No authentication methods found - please check your sieve setup for missing sasl modules"; return false; } /* call our authentication program */ return sieve::authenticate(); } function sieve_logout() { if($this->loggedin==false) return false; fputs($this->fp,"LOGOUT\r\n"); fclose($this->fp); $this->loggedin=false; return true; } function sieve_sendscript($scriptname, $script) { if($this->loggedin==false) return false; $this->script=stripslashes($script); $len=strlen($this->script); fputs($this->fp, "PUTSCRIPT \"$scriptname\" {".$len."+}\r\n"); fputs($this->fp, "$this->script\r\n"); return sieve::get_response(); } //it appears the timsieved does not honor the NUMBER type. see lex.c in timsieved src. //don't expect this function to work yet. I might have messed something up here, too. function sieve_havespace($scriptname, $scriptsize) { if($this->loggedin==false) return false; fputs($this->fp, "HAVESPACE \"$scriptname\" $scriptsize\r\n"); return sieve::get_response(); } function sieve_setactivescript($scriptname) { if($this->loggedin==false) return false; fputs($this->fp, "SETACTIVE \"$scriptname\"\r\n"); return sieve::get_response(); } function sieve_getscript($scriptname) { unset($this->script); if($this->loggedin==false) return false; fputs($this->fp, "GETSCRIPT \"$scriptname\"\r\n"); return sieve::get_response(); } function sieve_deletescript($scriptname) { if($this->loggedin==false) return false; fputs($this->fp, "DELETESCRIPT \"$scriptname\"\r\n"); return sieve::get_response(); } function sieve_listscripts() { fputs($this->fp, "LISTSCRIPTS\r\n"); sieve::get_response(); //should always return true, even if there are no scripts... if(isset($this->found_script) and $this->found_script) return true; else{ $this->error=EC_NOSCRIPTS; //sieve::getresponse has no way of telling wether a script was found... $this->error_raw="No scripts found for this account."; return false; } } function sieve_alive() { if(!isset($this->fp) or $this->fp==0){ $this->error = EC_NOT_LOGGED_IN; return false; } elseif(feof($this->fp)){ $this->error = EC_NOT_LOGGED_IN; return false; } else return true; } function authenticate() { switch ($this->auth_in_use) { case "PLAIN": $auth=base64_encode("$this->user\0$this->auth\0$this->pass"); $this->len=strlen($auth); fputs($this->fp, "AUTHENTICATE \"PLAIN\" {".$this->len."+}\r\n"); fputs($this->fp, "$auth\r\n"); $this->line=fgets($this->fp,1024); while(sieve::status($this->line) == F_DATA) $this->line=fgets($this->fp,1024); if(sieve::status($this->line) == F_NO) return false; $this->loggedin=true; return true; break; default: return false; break; }//end switch }//end authenticate() } ?>