1 <?php
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 */
12 // TODO before next release: remove ::status() and dependencies
15 define ("F_NO", 0);
16 define ("F_OK", 1);
17 define ("F_DATA", 2);
18 define ("F_HEAD", 3);
20 define ("EC_NOT_LOGGED_IN", 0);
21 define ("EC_QUOTA", 10);
22 define ("EC_NOSCRIPTS", 20);
23 define ("EC_UNKNOWN", 255);
24 /*
26 SIEVE-PHP.LIB VERSION 0.0.8
28 (C) 2001 Dan Ellis.
30 PLEASE READ THE README FILE FOR MORE INFORMATION.
32 Basically, this is the first re-release. Things are much better than before.
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 :).
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?)
46 Dan Ellis (danellis@rushmore.com)
48 This program is released under the GNU Public License.
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.
55 See CHANGES for updates since last release
57 Contributers of patches:
58 Atif Ghaffar
59 Andrew Sterling Hanenkamp <sterling@hanenkamp.com>
60 */
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 */
72 var $line;
73 var $fp;
74 var $retval;
75 var $tmpfile;
76 var $fh;
77 var $len;
78 var $script;
80 var $loggedin;
81 var $capabilities;
82 var $error;
83 var $error_raw;
84 var $responses;
85 var $options = "";
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?!?
90 //also add a connection type, like PLAIN, MD5, etc...
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 }
101 unset($this->response);
102 unset($this->error);
103 unset($this->error_raw);
105 $this->line=fgets($this->fp,1024);
106 $this->token = split(" ", $this->line, 2);
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);
123 /* Ensure max loop of 1000, to keep the ui from freezing */
124 $max = 1000;
125 $cur = 0;
127 while($this->err_recv < ($this->err_len) && ($cur < $max)){
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;
153 } /* end if */
154 elseif(substr($this->token[0],0,-2) == "OK"){
155 return true;
156 } /* end elseif */
157 elseif($this->token[0][0] == "{"){
159 /* Unable wild assumption: that the only function that gets here is the get_script(), doesn't really matter though */
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] == "\""){
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 */
177 $this->found_script=false;
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...
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 */
192 return true;
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() */
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 }
227 function parse_for_quotes($string)
228 {
229 /* This function tokenizes a line of input by quote marks and returns them as an array */
231 $start = -1;
232 $index = 0;
234 for($ptr = 0; $ptr < strlen($string); $ptr++){
235 if($string[$ptr] == '"' and $string[$ptr] != '\\'){
236 if($start == -1){
237 $start = $ptr;
238 } /* end if */
239 else{
240 $token[$index++] = substr($string, $start + 1, $ptr - $start - 1);
241 $found = true;
242 $start = -1;
243 } /* end else */
245 } /* end if */
247 } /* end for */
249 if(isset($token))
250 return $token;
251 else
252 return false;
253 } /* end function */
255 function status($string)
256 {
257 //this should probably be replaced by a smarter parser.
259 /* Need to remove this and all dependencies from the class */
261 switch (substr($string, 0,2)){
262 case "NO":
263 return F_NO; //there should be some function to extract the error code from this line
264 //NO ("quota") "You are oly allowed x number of scripts"
265 break;
266 case "OK":
267 return F_OK;
268 break;
269 default:
270 switch ($string[0]){
271 case "{":
272 //do parse here for {}'s maybe modify parse_for_quotes to handle any parse delimiter?
273 return F_HEAD;
274 break;
275 default:
276 return F_DATA;
277 break;
278 } /* end switch */
279 } /* end switch */
280 } /* end status() */
282 function sieve_login()
283 {
285 $this->fp=@fsockopen($this->host,$this->port);
286 if($this->fp == false)
287 return false;
289 $this->line=fgets($this->fp,1024);
291 //Hack for older versions of Sieve Server. They do not respond with the Cyrus v2. standard
292 //response. They repsond as follows: "Cyrus timsieved v1.0.0" "SASL={PLAIN,........}"
293 //So, if we see IMLEMENTATION in the first line, then we are done.
295 if(ereg("IMPLEMENTATION",$this->line))
296 {
297 //we're on the Cyrus V2 sieve server
298 while(sieve::status($this->line) == F_DATA){
300 $this->item = sieve::parse_for_quotes($this->line);
302 if(strcmp($this->item[0], "IMPLEMENTATION") == 0)
303 $this->capabilities["implementation"] = $this->item[1];
305 elseif(strcmp($this->item[0], "SIEVE") == 0 or strcmp($this->item[0], "SASL") == 0){
307 if(strcmp($this->item[0], "SIEVE") == 0)
308 $this->cap_type="modules";
309 else
310 $this->cap_type="auth";
312 $this->modules = split(" ", $this->item[1]);
313 if(is_array($this->modules)){
314 foreach($this->modules as $this->module)
315 $this->capabilities[$this->cap_type][$this->module]=true;
316 } /* end if */
317 elseif(is_string($this->modules))
318 $this->capabilites[$this->cap_type][$this->modules]=true;
319 }
320 else{
321 $this->capabilities["unknown"][]=$this->line;
322 }
323 $this->line=fgets($this->fp,1024);
325 }// end while
326 }
327 else
328 {
329 //we're on the older Cyrus V1. server
330 //this version does not support module reporting. We only have auth types.
331 $this->cap_type="auth";
333 //break apart at the "Cyrus timsieve...." "SASL={......}"
334 $this->item = sieve::parse_for_quotes($this->line);
336 $this->capabilities["implementation"] = $this->item[0];
338 //we should have "SASL={..........}" now. Break out the {xx,yyy,zzzz}
339 $this->modules = substr($this->item[1], strpos($this->item[1], "{"),strlen($this->item[1])-1);
341 //then split again at the ", " stuff.
342 $this->modules = split($this->modules, ", ");
344 //fill up our $this->modules property
345 if(is_array($this->modules)){
346 foreach($this->modules as $this->module)
347 $this->capabilities[$this->cap_type][$this->module]=true;
348 } /* end if */
349 elseif(is_string($this->modules))
350 $this->capabilites[$this->cap_type][$this->module]=true;
351 }
356 if(sieve::status($this->line) == F_NO){ //here we should do some returning of error codes?
357 $this->error=EC_UNKNOWN;
358 $this->error_raw = "Server not allowing connections.";
359 return false;
360 }
362 /* decision login to decide what type of authentication to use... */
364 /* Loop through each allowed authentication type and see if the server allows the type */
365 foreach(split(" ",$this->auth_types) as $auth_type)
366 {
367 if ($this->capabilities["auth"][$auth_type])
368 {
369 /* We found an auth type that is allowed. */
370 $this->auth_in_use = $auth_type;
371 break;
372 }
373 }
375 /* Fill error message if no auth types are present */
376 if (!isset($this->capabilities["auth"])){
377 $this->error=EC_UNKNOWN;
378 $this->error_raw = "No authentication methods found - please check your sieve setup for missing sasl modules";
379 return false;
380 }
382 /* call our authentication program */
383 return sieve::authenticate();
385 }
387 function sieve_logout()
388 {
389 if($this->loggedin==false)
390 return false;
392 fputs($this->fp,"LOGOUT\r\n");
393 fclose($this->fp);
394 $this->loggedin=false;
395 return true;
396 }
398 function sieve_sendscript($scriptname, $script)
399 {
400 if($this->loggedin==false)
401 return false;
402 $this->script=stripslashes($script);
403 $len=strlen($this->script);
404 fputs($this->fp, "PUTSCRIPT \"$scriptname\" {".$len."+}\r\n");
405 fputs($this->fp, "$this->script\r\n");
407 return sieve::get_response();
409 }
411 //it appears the timsieved does not honor the NUMBER type. see lex.c in timsieved src.
412 //don't expect this function to work yet. I might have messed something up here, too.
413 function sieve_havespace($scriptname, $scriptsize)
414 {
415 if($this->loggedin==false)
416 return false;
417 fputs($this->fp, "HAVESPACE \"$scriptname\" $scriptsize\r\n");
418 return sieve::get_response();
420 }
422 function sieve_setactivescript($scriptname)
423 {
424 if($this->loggedin==false)
425 return false;
427 fputs($this->fp, "SETACTIVE \"$scriptname\"\r\n");
428 return sieve::get_response();
430 }
432 function sieve_getscript($scriptname)
433 {
434 unset($this->script);
435 if($this->loggedin==false)
436 return false;
438 fputs($this->fp, "GETSCRIPT \"$scriptname\"\r\n");
439 return sieve::get_response();
441 }
444 function sieve_deletescript($scriptname)
445 {
446 if($this->loggedin==false)
447 return false;
449 fputs($this->fp, "DELETESCRIPT \"$scriptname\"\r\n");
451 return sieve::get_response();
452 }
455 function sieve_listscripts()
456 {
457 fputs($this->fp, "LISTSCRIPTS\r\n");
458 sieve::get_response(); //should always return true, even if there are no scripts...
459 if(isset($this->found_script) and $this->found_script)
460 return true;
461 else{
462 $this->error=EC_NOSCRIPTS; //sieve::getresponse has no way of telling wether a script was found...
463 $this->error_raw="No scripts found for this account.";
464 return false;
465 }
466 }
468 function sieve_alive()
469 {
470 if(!isset($this->fp) or $this->fp==0){
471 $this->error = EC_NOT_LOGGED_IN;
472 return false;
473 }
474 elseif(feof($this->fp)){
475 $this->error = EC_NOT_LOGGED_IN;
476 return false;
477 }
478 else
479 return true;
480 }
483 function authenticate()
484 {
486 /* Check if a TLS bases connection is required
487 */
488 if(preg_match("/^tls$/",$this->options)){
490 /* Check if PHP supports TLS encryption for sockets
491 */
492 if(function_exists("stream_socket_enable_crypto")){
494 if (@ fputs ($this->fp, "STARTTLS\r\n") === false) {
495 $this->error_raw = "fputs() returned 'false'"; return (false);
496 } @ $linha = fgets ($this->fp, 1024); if ($linha === false) {
497 $this->error_raw = "fgets() returned 'false'"; return (false);
498 } if (! preg_match ("/\\s*OK\\s/i", $linha)) {
499 $this->error_raw = "expected an 'OK', but server replied: '" . trim ($linha) . "'"; return (false);
500 } if (! @ stream_socket_enable_crypto ($this->fp, true, STREAM_CRYPTO_METHOD_TLS_CLIENT)) {
501 $this->error_raw = "stream_socket_enable_crypto() returned 'false'"; return (false);
502 }else{
503 # echo "Done";
504 }
505 }
506 }
508 switch ($this->auth_in_use) {
510 case "PLAIN":
511 $auth=base64_encode("$this->user\0$this->auth\0$this->pass");
513 $this->len=strlen($auth);
514 fputs($this->fp, "AUTHENTICATE \"PLAIN\" {".$this->len."+}\r\n");
515 fputs($this->fp, "$auth\r\n");
517 $this->line=fgets($this->fp,1024);
518 while(sieve::status($this->line) == F_DATA)
519 $this->line=fgets($this->fp,1024);
521 if(sieve::status($this->line) == F_NO)
522 return false;
523 $this->loggedin=true;
524 return true;
525 break;
527 default:
528 return false;
529 break;
531 }//end switch
534 }//end authenticate()
537 }
541 ?>