* The following table tries to describe the variables schema that is used by * avelsieve. * * VARIABLES * --------- * AVELSIEVE_CREATED * AVELSIEVE_MODIFIED * AVELSIEVE_COMMENT * AVELSIEVE_VERSION * * Condition * * 1 cond // New-style mixed rule, might be anything inside here. The * value is an indexed array with each one describing a condition * * 1 example: cond => array( [0] => array( * 'type' => 'address'|'envelope'|'header'|'size'|'body'|'all' * // For 'header': * 'header' => ... * 'matchtype' => ... * 'headermatch' => ... * // For 'address': * 'address' => ... * 'matchtype' => ... * 'addressmatch' => ... * // For 'envelope': * 'matchtype' => ... * 'matchtype' => ... * 'envelopematch' => ... * // For 'size': * 'sizerel' => ... * 'sizeamount' => ... * 'sizeunit' => ... * // For 'body': * 'matchtype' => ... * 'bodymatch' => ... * // For 'all': nothing! * * 1 // Not implemented yet. * 2 header[$n] // Header Match * 2 matchtype[$n] 'is' | 'contains' | 'matches' | 'lt' | 'regex' | ... * 2 headermatch[$n] string * 2 condition undefined | 'or' | 'and' * 3 sizerel 'bigger' | 'smaller' // Size match * 3 sizeamount int * 3 sizeunit 'kb' | 'mb' * 4 // Always * 10 score int // Spam Rule * 10 tests array * 10 action 'trash' | 'junk' | 'discard' * * Action * * action 1 | 2 | 3 | 4 | 5 | 6 * * 1) // Keep * * 2) // Discard * * 3) // Reject w/ excuse * * excuse string valid only for: action==3 * * 4) // Redirect * * redirectemail string (email) valid only for: action==4 * keep string (email) valid only for: action==4 (?TBC) * * 5) // Fileinto * * folder valid only for: action==5 * * 6) // Vacation * * vac_days int * vac_addresses string * vac_subject string * vac_message string valid only for: action==6 * * * -) // All * * keepdeleted boolean * stop boolean * notify array * 'method' => string * 'id' => string * 'options' => array( [0]=> foo, [1] => bar ) * 'priority' => low|normal|high * 'message' => string * * * @version $Id$ * @author Alexandros Vellis * @copyright 2004-2007 The SquirrelMail Project Team, Alexandros Vellis * @package plugins * @subpackage avelsieve */ /** Include Base Avelsieve Condition class */ include_once(SM_PATH . 'plugins/avelsieve/include/avelsieve_condition.class.php'); /** Include Base Avelsieve Action class */ include_once(SM_PATH . 'plugins/avelsieve/include/avelsieve_action.class.php'); /** * Build a snippet which is used for header, address, envelope rules as well as * spam rule whitelists. Takes arguments in natural English language order: * 'header From contains foo', or 'envelope to contains bar'. * * @param string $name Can be 'header', address', 'envelope', 'body' or empty, * leaving the caller of this function to fill in the approriate value. * @param string $header Header, Address or Envelope-part name. * @param string $matchtype Human readable, as defined in avelsieve constants. * E.g. 'contains', 'is' etc. * @param string $headermatch The desired value. * * @param string $index Number with header index value; only for 'index' capability (RFC5260) * @param string $index_last If equal to "1", enable :last parameter for 'index' option (RFC5260) * * @return array ($out, $text, $terse) * $out: a string with the appropriate SIEVE code. * $text: a (verbose) textual description of the rule. * $terse: a terse description. */ function build_rule_snippet($name, $header, $matchtype, $headermatch, $index = '', $index_last = '') { $out = $text = $terse = ''; switch($name) { case 'header': if($header == 'toorcc') { $text .= sprintf( _("the header %s"), '"To" / "Cc" '); $terse .= sprintf( _("Header %s") , _("To or Cc")); } else { $text .= sprintf( _("the header %s"), ' "'.htmlspecialchars($header).'"'); $terse .= sprintf( _("Header %s"), htmlspecialchars($header)); } // $escapeslashes = false; break; case 'envelope': $text .= sprintf( _("the envelope %s") , '"'.htmlspecialchars($header).'"'); $terse .= sprintf( _("Envelope %s"), htmlspecialchars($header)); break; case 'address': if($header == 'toorcc') { $text .= sprintf( _("the address %s") , '"To" / "Cc" '); $terse .= sprintf( _("Address %s"), _("To or Cc")); } else { $text .= sprintf( _("the address %s") , '"'.htmlspecialchars($header).'"'); $terse .= sprintf( _("Address %s"), htmlspecialchars($header)); } break; case 'body': $text .= _("message body"); $terse .= ("Body"); break; } $text .= ' '; $terse .= ' '; if(($name == 'header' || $name == 'address') && !empty($index) && is_numeric($index)) { $outIndex = ':index '.$index; $text .= sprintf( _("index number %s"), $index); $terse .= sprintf( _("index #%s"), $index); if($index_last == '1') { $outIndex .= ' :last'; $text .= ' ' . _("(counting from last header)"); $terse .= ' ' . _("(from end)"); } $text .= ' '; $terse .= ' '; } $testStart = $name; if(isset($outIndex)) { $testStart .= ' '.$outIndex; } switch ($matchtype) { case 'is': $out .= sprintf('%s :is', $testStart); $text .= _("is"); $terse .= _("is"); break 1; case 'is not': $out .= sprintf("not %s :is", $testStart); $text .= _("is not"); $terse .= _("is not"); break 1; case "contains": $out .= sprintf("%s :contains", $testStart); $text .= _("contains"); $terse .= _("contains"); break 1; case "does not contain": $out .= sprintf("not %s :contains", $testStart); $text .= _("does not contain"); $terse .= _("does not contain"); break 1; case "matches": $out .= sprintf("%s :matches", $testStart); $text .= _("matches"); $terse .= _("matches"); $escapeslashes = true; break 1; case "does not match": $out .= sprintf("not %s :matches", $testStart); $text .= _("does not match"); $terse .= _("does not match"); $escapeslashes = true; break 1; case "gt": $out .= sprintf('%s :value "gt" :comparator "i;ascii-numeric"', $testStart); $text .= _("is greater than"); $terse .= '>'; break 1; case "ge": $out .= sprintf('%s :value "ge" :comparator "i;ascii-numeric"', $testStart); $text .= _("is greater or equal to"); $terse .= '>='; break 1; case "lt": $out .= sprintf('%s :value "lt" :comparator "i;ascii-numeric"', $testStart); $text .= _("is lower than"); $terse .= '<'; break 1; case "le": $out .= sprintf('%s :value "le" :comparator "i;ascii-numeric"', $testStart); $text .= _("is lower or equal to"); $terse .= '<='; break 1; case "eq": $out .= sprintf('%s :value "eq" :comparator "i;ascii-numeric"', $testStart); $text .= _("is equal to"); $terse .= '='; break 1; case "ne": $out .= sprintf('%s :value "ne" :comparator "i;ascii-numeric"', $testStart); $text .= _("is not equal to"); $terse .= '!='; break 1; case 'regex': $out .= sprintf('%s :regex :comparator "i;ascii-casemap"', $testStart); $text .= _("matches the regular expression"); $terse .= _("matches the regular expression"); $escapeslashes = true; break 1; case 'not regex': $out .= sprintf('not %s :regex :comparator "i;ascii-casemap"', $testStart); $text .= _("does not match the regular expression"); $terse .= _("does not match the regular expression"); $escapeslashes = true; break 1; case 'exists': $out .= "exists"; $text .= _("exists"); $terse .= _("exists"); break 1; case 'not exists': $out .= "not exists"; $text .= _("does not exist"); $terse .= _("does not exist"); break 1; default: break 1; } if($header == 'toorcc') { $out .= ' ["to", "cc"]'; } elseif($header) { $out .= ' "' . $header . '"'; } /* Escape slashes and double quotes */ $out .= " \"". avelsieve_addslashes($headermatch) . "\""; $text .= " "". htmlspecialchars($headermatch) . """; $terse .= ' '.htmlspecialchars($headermatch). ' '; return array($out, $text, $terse); } /** * Gets a $rule array and builds a part of a SIEVE script (aka a rule). * * @param $rule A rule array. * @param $mode What to return. Can be one of: * verbose = return a (verbose) textual description of the rule. * terse = return a very terse description * rule = return a string with the appropriate SIEVE code. (Default) * source = return a string with the appropriate SIEVE code in format for * display to the user. * @return string */ function makesinglerule($rule, $mode='rule') { if($mode == 'debug') { include_once(SM_PATH . 'plugins/avelsieve/include/dumpr.php'); return dumpr($rule, true); } global $maxitems, $color, $inconsistent_folders; $out = $text = $terse = ''; /* Step minus one: include any classes that are necessary and initialize them */ // imap4flags extension $actions = array(); if (isset($rule['imapflags']) && isset($rule['imapflags']['flags'])) { include_once(SM_PATH . 'plugins/avelsieve/include/avelsieve_action_imapflags.class.php'); // $sieve variable ??? FIXME $actions['imapflags'] = new avelsieve_action_imapflags($sieve, $rule); } /* Step zero: serialize & encode the rule inside the SIEVE script. Also * check if it is disabled. */ $coded = urlencode(base64_encode(serialize($rule))); if($mode != 'source') { $out = "#START_SIEVE_RULE".$coded."END_SIEVE_RULE\n"; } /* Check for a disabled rule. */ if (isset($rule['disabled']) && $rule['disabled']==1) { if ($mode=='rule') { /* For disabled rules, we only need the sieve comment. */ return $out; } else { $text .= _("This rule is currently DISABLED:").' '; $terse .= '

' . _("DISABLED") . '

'; } } $terse .= '= '10' && $rule['type'] < 100 ) { include_once(SM_PATH . 'plugins/avelsieve/include/sieve_buildrule.'.$rule['type'].'.inc.php'); $res = call_user_func('avelsieve_buildrule_'.$rule['type'], $rule); // Return value is: array($out, $text, $terse, $params) if($res != false) { $out .= $res[0]; $text .= $res[1]; $terse .= $res[2]; if(isset($res[3])) $params = $res[3]; } if(isset($params)) { if(isset($params['skip_further_execution'])) { // FIXME - Ugly copy/paste hack. $terse .= '

'; switch($mode) { case 'terse': return $terse; case 'text': case 'verbose': return $text; case 'source': return '

'. (isset($rule['disabled']) ? ' /* (DISABLED)
' : '' ). str_replace("\n", '
', $out). (isset($rule['disabled']) ? '
*/' : '' ) . '

'; default: if(isset($params['replace_output'])){ // TODO: 'disabled' ???? return "#START_SIEVE_RULE\n".$res[0]."#END_SIEVE_RULE\n"; } return $out; } } } } else { /* Step one: make the if clause */ $text .= ""._("If")." "; $out .= "if "; } if($rule['type'] == "1") { /* New-style 'cond' array for conditions of different types. */ /* Condition ('and' / 'or') */ if(sizeof($rule['cond']) > 1) { switch ($rule['condition']) { case "or": $out .= "anyof ("; $text .= _("any of the following mail headers match: "); // $terse .= "ANY ("; break; default: case "and": $out .= "allof ("; $text .= _("all of the following mail headers match: "); // $terse .= "ALL ("; break; } } else { $lonely = true; } /* Indexed array $rule['cond'] contains a bunch of rule definitions */ for($i=0;$i, "; $terse .= $rule['cond'][$i]['sizeamount']; $out .= $rule['cond'][$i]['sizeamount']; if($rule['cond'][$i]['sizeunit']=="kb") { $out .= "K\n"; $terse .= "K\n"; } elseif($rule['cond'][$i]['sizeunit']=="mb") { $out .= "M\n"; $terse .= "M\n"; } break; case 'body': $aTmp = build_rule_snippet('body', '', $rule['cond'][$i]['matchtype'], $rule['cond'][$i]['bodymatch']); $out .= $aTmp[0]; $text .= $aTmp[1]; $terse .= $aTmp[2]; break; case 'datetime': include_once(SM_PATH . 'plugins/avelsieve/include/avelsieve_condition_datetime.class.php'); $myCondition = new avelsieve_condition_datetime($sieve, $rule, $i, 'date'); $aTmp = $myCondition->generate_sieve(); $out .= $aTmp[0]; $text .= $aTmp[1]; $terse .= $aTmp[2]; break; case 'all': $out .= 'true'; $text .= _("For ALL incoming messages; "); $terse .= _("ALL"); break; } } elseif(isset($rule['cond'][$i]['kind']) && $rule['cond'][$i]['kind'] == 'datetime') { include_once(SM_PATH . 'plugins/avelsieve/include/avelsieve_condition_datetime.class.php'); $myCondition = new avelsieve_condition_datetime($sieve, $rule, $i, 'currentdate'); list($datetimeOut, $datetimeText, $datetimeTerse) = $myCondition->generate_sieve(); $out .= $datetimeOut; $text .= $datetimeText; $terse .= $datetimeTerse; } elseif(isset($rule['cond'][$i]['kind']) && $rule['cond'][$i]['kind'] == 'all') { $out .= 'true'; $text .= _("always"); $terse .= _("Always"); } if(isset($rule['cond'][$i+1])) { /* TODO :Probably add more extensive check for validity of * the next array? In case it is empty? */ $out .= ",\n"; $text .= ", "; if ($rule['condition'] == 'or' ) { $terse .= ' ' . _("or") . '
'; } elseif ($rule['condition'] == 'and' ) { $terse .= ' ' . _("and") . '
'; } } elseif($i == 0 && !isset($rule['cond'][1]['headermatch']) ) { $out .= "\n"; $text .= ", "; } else { $out .= ")\n"; $text .= ", "; } } } elseif($rule['type'] == '4') {/* always */ $out .= "true {\n"; } elseif($rule['type'] != 10) { /* Other type, probably handled by another plugin. */ $args = array($rule, $out, $text, $terse); do_hook('avelsieve_buildrule_condition', $args); } /* step two: make the then clause */ if( $rule['type'] != '4' && $rule['type'] < 10 ) { $out .= "{\n"; $terse .= ''; $text .= ""; $text .= _("then"); $text .= " "; } if(isset($rule['keep'])) { $out .= "keep;\n"; } /* Fallback to default action */ if(!isset($rule['action']) && $rule['type'] < 10) { $rule['action'] = 1; } /* imapflags action: if there is, then there might be more arguments * to 'keep' or 'fileinto' */ $flags_out = $flags_text = $flags_terse = ''; if(isset($actions['imapflags'])) { list($flags_out, $flags_text, $flags_terse) = $actions['imapflags']->generate_sieve_tagged_argument(); } switch ($rule['action']) { case '1': /* keep (default) */ default: $out .= 'keep' . (!empty($flags_out) ? " $flags_out" : '' ) . ';'; $text .= _("keep the message."); $terse .= _("Keep"); if($flags_text) { $text .= ' '.$flags_text; $terse .= '
'.$flags_terse; } break; case '2': /* discard */ $out .= "discard;"; $text .= _("discard the message."); $terse .= _("Discard"); break; case '3': /* reject w/ excuse */ $out .= "reject text:\n".$rule['excuse']."\r\n.\r\n;"; $text .= _("reject it, sending this excuse back to the sender:")." \"".htmlspecialchars($rule['excuse'])."\"."; $terse .= _("Reject"); break; case '4': /* redirect to address */ if(strstr(trim($rule['redirectemail']), ' ')) { $redirectemails = explode(' ', trim($rule['redirectemail'])); } if(!isset($redirectemails)) { if(strstr(trim($rule['redirectemail']), ',')) { $redirectemails = explode(',', trim($rule['redirectemail'])); } } if(isset($redirectemails)) { foreach($redirectemails as $redirectemail) { $out .= 'redirect "'.$redirectemail."\";\n"; $terse .= _("Redirect to").' '.htmlspecialchars($redirectemail). '
'; } $text .= sprintf( _("redirect it to the email addresses: %s."), implode(', ',$redirectemails)); } else { $out .= "redirect \"".$rule['redirectemail']."\";"; $text .= _("redirect it to the email address")." ".htmlspecialchars($rule['redirectemail'])."."; $terse .= _("Redirect to") . ' ' .htmlspecialchars($rule['redirectemail']); } break; case '5': /* fileinto folder */ $out .= 'fileinto '.$flags_out.' "'.$rule['folder'].'";'; if(!empty($inconsistent_folders) && in_array($rule['folder'], $inconsistent_folders)) { $clr = ''; $text .= $clr; $terse .= $clr; } $text .= sprintf( _("file it into the folder %s"), ' ' . htmlspecialchars(imap_utf7_decode_local($rule['folder'])) . ''); $terse .= sprintf( _("File into %s"), htmlspecialchars(imap_utf7_decode_local($rule['folder']))); if(!empty($inconsistent_folders) && in_array($rule['folder'], $inconsistent_folders)) { $cls = '' . _("(Warning: Folder not available)") . ''; $text .= ' '.$cls; $terse .= '
'.$cls; } $text .= '. '; break; case '6': /* vacation message */ $out .= 'vacation :days '.$rule['vac_days']; /* If vacation address does not exist, do not set the :addresses * argument. */ if(isset($rule['vac_addresses']) && trim($rule['vac_addresses'])!="") { $addresses = str_replace(",",'","',str_replace(" ","",$rule['vac_addresses'])); $out .= ' :addresses ["'.$addresses.'"]'; } if(isset($rule['vac_subject']) && trim($rule['vac_subject'])!="") { $out .= ' :subject "'.addslashes($rule['vac_subject']).'" '; } /* FIXME Replace single dot with dot-stuffed line. RFC 3028 2.4.2 */ $out .= " text:\n".$rule['vac_message']."\r\n.\r\n;"; $text .= sprintf( _("reply with a vacation / autoresponder message: "), htmlspecialchars($rule['vac_message'])); $terse .= _("Vacation / Autoresponder"); break; default: $args = array($rule, $out, $text, $terse); do_hook('avelsieve_buildrule_action', $args); break; } if(isset($rule['keep'])) { $text .= ' ' . _("Also keep a local copy."); $terse .= '
' . _("Keep"); } if (isset($rule['keepdeleted'])) { $text .= _(" Also keep a copy in INBOX, marked as deleted."); $out .= "\naddflag \"\\\\\\\\\\\\\\\\Deleted\";\nkeep;"; // TODO / FIXME: This is recommended for the file-based backend: //$out .= "\naddflag \"\\\\Deleted\";\nkeep;"; $terse .= '
' . _("Keep Deleted"); } /* Notify extension */ if (array_key_exists("notify", $rule) && is_array($rule['notify']) && ($rule['notify']['method'] != '')) { global $notifystrings, $prioritystrings; include_once(SM_PATH . 'plugins/avelsieve/include/avelsieve_action_notify.class.php'); $temp_action = new avelsieve_action_notify($sieve, $rule); // To retrieve $notifystrings property $text .= _(" Also notify using the method") . " " . htmlspecialchars($temp_action->notifystrings[$rule['notify']['method']]) . ", ". _("with") . " " . htmlspecialchars($prioritystrings[$rule['notify']['priority']]) . " " . _("priority and the message") . " "" . htmlspecialchars($rule['notify']['message']) . ""."; $out .= "\nnotify :method \"".$rule['notify']['method']."\" "; $out .= ":options \"".$rule['notify']['options']."\" "; if(isset($rule['notify']['id'])) { $out .= ":id \"".$rule['notify']['id']."\" "; } if(isset($rule['notify']['priority']) && array_key_exists($rule['notify']['priority'], $prioritystrings)) { $out .= ":".$rule['notify']['priority'] . " "; } $out .= ':message "'.$rule['notify']['message']."\";\n"; /* FIXME - perhaps allow text: multiline form in notification string? */ $terse .= '
' . sprintf( _("Notify %s"), $rule['notify']['options']); } /* imap4flags extension: This part is actually for the :setflag, :addflag and :removeflag * tests. The :flags tagged argument to fileinto or keep has already been dealt with. */ if (isset($rule['imapflags'])) { $aFlagActions = array('setflag', 'addflag', 'removeflag'); foreach($aFlagActions as $flagAction) { if (isset($rule['imapflags']) && !empty($rule['imapflags'][$flagAction])) { $tmpAction = new avelsieve_action_imapflags($sieve, $rule); list($flags_out, $flags_text, $flags_terse) = $tmpAction->generate_sieve_action($flagAction); $out .= $flags_out; $text .= $flags_text; $terse .= $flags_terse; } } } /* Stop processing other rules */ if (isset($rule['stop'])) { $text .= ' ' . _("Then STOP processing rules."); $out .= "\nstop;"; $terse .= '
' . _("Stop"); } $out .= "\n}\n"; $terse .= ""; if (isset($rule['disabled']) && $rule['disabled']==1) { $text .= ''; } switch($mode) { case 'terse': return $terse; case 'text': case 'verbose': return $text; case 'source': return '

'. (isset($rule['disabled']) ? ' /* (DISABLED)
' : '' ). str_replace("\n", '
', $out). (isset($rule['disabled']) ? '
*/' : '' ); '

'; default: return $out; } } /** * Make a complete set of rules, that is, a SIEVE script. * * @param $rulearray An array of associative arrays, each one describing a * rule. * @return $string */ function makesieverule ($rulearray) { global $implemented_capabilities, $cap_dependencies, $sieve_capabilities, $avelsieve_version, $creation_date, $scriptinfo, $avelsieve_custom_sieve_implementation; if ( (sizeof($rulearray) == 0) || $rulearray[0] == "0" ) { return false; } /* Encoded avelsieve version information */ $versionencoded = base64_encode(serialize($avelsieve_version)); if($avelsieve_custom_sieve_implementation == 'exim') { $out = "# Sieve filter\n"; } elseif($avelsieve_custom_sieve_implementation == 'mfl') { $out = "sieve {\n"; } else { $out = ''; } $out .= "# This script has been automatically generated by avelsieve\n". "# (Sieve Mail Filters Plugin for Squirrelmail)\n". "# Warning: If you edit this manually, then the changes will not \n". "# be reflected in the users' front-end!\n"; $out .= "#AVELSIEVE_VERSION" . $versionencoded . "\n"; $modification_date = time(); if(isset($scriptinfo['created'])) { $out .= "#AVELSIEVE_CREATED" . $scriptinfo['created'] . "\n"; } else { /* New script */ $creation_date = $modification_date; $out .= "#AVELSIEVE_CREATED" . $creation_date . "\n"; } $out .= "#AVELSIEVE_MODIFIED" . $modification_date . "\n"; // $out .= "#AVELSIEVE_COMMENT" . $script_comment . "\n" /* Require all capablities that avelsieve supports AND the server supports. */ $torequire = array(); foreach($implemented_capabilities as $no=>$cap) { if(array_key_exists($cap, $sieve_capabilities)) { $torequire[] = $cap; if(array_key_exists($cap, $cap_dependencies)) { foreach($cap_dependencies[$cap] as $no2=>$dep) { $torequire[] = $dep; } } } } if(!empty($torequire)) { $out .= 'require ["'. implode('","', $torequire) . "\"];\n"; } /* The actual rules */ for ($i=0; $i= 10) { switch ($i) { case 0: $out .= "if\n"; break; default: $out .= "\nif\n"; break; } } else { $out .= "\n"; } */ $out .= makesinglerule($rulearray[$i],'rule'); } /* It seems that if there are some rules and all of them are disabled, or * if there are no rules, then it fails to upload the script (i.e. * timsieved reports a parse error at the last line). By entering the * ...implicit keep explicitly, it seems to work: */ $practically_no_rules = true; if(sizeof($rulearray) > 0) { for($i=0;$i