/usr/share/horde/ingo/lib/Script/Maildrop.php is in php-horde-ingo 3.2.8-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 | <?php
/**
* Copyright 2005-2007 Matt Weyland <mathias@weyland.ch>
*
* See the enclosed file LICENSE for license information (ASL). If you
* did not receive this file, see http://www.horde.org/licenses/apache.
*
* @author Matt Weyland <mathias@weyland.ch>
* @author Jan Schneider <jan@horde.org>
* @category Horde
* @license http://www.horde.org/licenses/apache ASL
* @package Ingo
*/
/**
* The Ingo_Script_Maildrop class represents a maildrop script generator.
*
* @author Matt Weyland <mathias@weyland.ch>
* @author Jan Schneider <jan@horde.org>
* @category Horde
* @license http://www.horde.org/licenses/apache ASL
* @package Ingo
*/
class Ingo_Script_Maildrop extends Ingo_Script_Base
{
/**
* Additional storage action since maildrop does not support the "c-flag"
* as in procmail.
*/
const MAILDROP_STORAGE_ACTION_STOREANDFORWARD = 100;
/**
* A list of driver features.
*
* @var array
*/
protected $_features = array(
/* Can tests be case sensitive? */
'case_sensitive' => true,
/* Does the driver support setting IMAP flags? */
'imap_flags' => false,
/* Does the driver support the stop-script option? */
'stop_script' => false,
/* Can this driver perform on demand filtering? */
'on_demand' => false,
/* Does the driver require a script file to be generated? */
'script_file' => true,
);
/**
* The list of actions allowed (implemented) for this driver.
*
* @var array
*/
protected $_actions = array(
Ingo_Storage::ACTION_KEEP,
Ingo_Storage::ACTION_MOVE,
Ingo_Storage::ACTION_DISCARD,
Ingo_Storage::ACTION_REDIRECT,
Ingo_Storage::ACTION_REDIRECTKEEP,
Ingo_Storage::ACTION_REJECT,
);
/**
* The categories of filtering allowed.
*
* @var array
*/
protected $_categories = array(
Ingo_Storage::ACTION_BLACKLIST,
Ingo_Storage::ACTION_WHITELIST,
Ingo_Storage::ACTION_VACATION,
Ingo_Storage::ACTION_FORWARD,
Ingo_Storage::ACTION_SPAM,
);
/**
* The types of tests allowed (implemented) for this driver.
*
* @var array
*/
protected $_types = array(
Ingo_Storage::TYPE_HEADER,
);
/**
* The list of tests allowed (implemented) for this driver.
*
* @var array
*/
protected $_tests = array(
'contains', 'not contain',
'is', 'not is',
'begins with','not begins with',
'ends with', 'not ends with',
'regex', 'not regex',
'matches', 'not matches',
'exists', 'not exist',
'less than', 'less than or equal to',
'equal', 'not equal',
'greater than', 'greater than or equal to',
);
/**
* Generates the script to do the filtering specified in the rules.
*/
protected function _generate()
{
$filters = $this->_params['storage']
->retrieve(Ingo_Storage::ACTION_FILTERS);
$this->_addItem(Ingo::RULE_ALL, new Ingo_Script_Maildrop_Comment(_("maildrop script generated by Ingo") . ' (' . date('F j, Y, g:i a') . ')'));
/* Add variable information, if present. */
if (!empty($this->_params['variables']) &&
is_array($this->_params['variables'])) {
foreach ($this->_params['variables'] as $key => $val) {
$this->_addItem(Ingo::RULE_ALL, new Ingo_Script_Maildrop_Variable(array('name' => $key, 'value' => $val)));
}
}
foreach ($filters->getFilterList($this->_params['skip']) as $filter) {
switch ($filter['action']) {
case Ingo_Storage::ACTION_BLACKLIST:
$this->generateBlacklist(!empty($filter['disable']));
break;
case Ingo_Storage::ACTION_WHITELIST:
$this->generateWhitelist(!empty($filter['disable']));
break;
case Ingo_Storage::ACTION_FORWARD:
$this->generateForward(!empty($filter['disable']));
break;
case Ingo_Storage::ACTION_VACATION:
$this->generateVacation(!empty($filter['disable']));
break;
case Ingo_Storage::ACTION_SPAM:
$this->generateSpamfilter(!empty($filter['disable']));
break;
default:
if (in_array($filter['action'], $this->_actions)) {
/* Create filter if using AND. */
$recipe = new Ingo_Script_Maildrop_Recipe($filter, $this->_params);
foreach ($filter['conditions'] as $condition) {
$recipe->addCondition($condition);
}
$this->_addItem(Ingo::RULE_FILTER, new Ingo_Script_Maildrop_Comment($filter['name'], !empty($filter['disable']), true));
$this->_addItem(Ingo::RULE_FILTER, $recipe);
}
}
}
}
/**
* Generates the maildrop script to handle the blacklist specified in
* the rules.
*
* @param boolean $disable Disable the blacklist?
*/
public function generateBlacklist($disable = false)
{
$blacklist = $this->_params['storage']
->retrieve(Ingo_Storage::ACTION_BLACKLIST);
$bl_addr = $blacklist->getBlacklist();
$bl_folder = $blacklist->getBlacklistFolder();
$bl_type = empty($bl_folder)
? Ingo_Storage::ACTION_DISCARD
: Ingo_Storage::ACTION_MOVE;
if (!empty($bl_addr)) {
$this->_addItem(Ingo::RULE_BLACKLIST, new Ingo_Script_Maildrop_Comment(_("Blacklisted Addresses"), $disable, true));
$params = array('action-value' => $bl_folder,
'action' => $bl_type,
'disable' => $disable);
foreach ($bl_addr as $address) {
if (!empty($address)) {
$recipe = new Ingo_Script_Maildrop_Recipe($params, $this->_params);
$recipe->addCondition(array('field' => 'From', 'value' => $address));
$this->_addItem(Ingo::RULE_BLACKLIST, $recipe);
}
}
}
}
/**
* Generates the maildrop script to handle the whitelist specified in
* the rules.
*
* @param boolean $disable Disable the whitelist?
*/
public function generateWhitelist($disable = false)
{
$whitelist = $this->_params['storage']
->retrieve(Ingo_Storage::ACTION_WHITELIST);
$wl_addr = $whitelist->getWhitelist();
if (!empty($wl_addr)) {
$this->_addItem(Ingo::RULE_WHITELIST, new Ingo_Script_Maildrop_Comment(_("Whitelisted Addresses"), $disable, true));
foreach ($wl_addr as $address) {
if (!empty($address)) {
$recipe = new Ingo_Script_Maildrop_Recipe(array('action' => Ingo_Storage::ACTION_KEEP, 'disable' => $disable), $this->_params);
$recipe->addCondition(array('field' => 'From', 'value' => $address));
$this->_addItem(Ingo::RULE_WHITELIST, $recipe);
}
}
}
}
/**
* Generates the maildrop script to handle mail forwards.
*
* @param boolean $disable Disable forwarding?
*/
public function generateForward($disable = false)
{
$forward = $this->_params['storage']
->retrieve(Ingo_Storage::ACTION_FORWARD);
$addresses = $forward->getForwardAddresses();
if (!empty($addresses)) {
$this->_addItem(Ingo::RULE_FORWARD, new Ingo_Script_Maildrop_Comment(_("Forwards"), $disable, true));
$params = array('action' => Ingo_Storage::ACTION_FORWARD,
'action-value' => $addresses,
'disable' => $disable);
if ($forward->getForwardKeep()) {
$params['action'] = self::MAILDROP_STORAGE_ACTION_STOREANDFORWARD;
}
$recipe = new Ingo_Script_Maildrop_Recipe($params, $this->_params);
$recipe->addCondition(array('field' => 'From', 'value' => ''));
$this->_addItem(Ingo::RULE_FORWARD, $recipe);
}
}
/**
* Generates the maildrop script to handle vacation messages.
*
* @param boolean $disable Disable forwarding?
*/
public function generateVacation($disable = false)
{
$vacation = $this->_params['storage']
->retrieve(Ingo_Storage::ACTION_VACATION);
$addresses = $vacation->getVacationAddresses();
$actionval = array('addresses' => $addresses,
'subject' => $vacation->getVacationSubject(),
'days' => $vacation->getVacationDays(),
'ignorelist' => $vacation->getVacationIgnorelist(),
'excludes' => $vacation->getVacationExcludes(),
'start' => $vacation->getVacationStart(),
'end' => $vacation->getVacationEnd());
if (!empty($addresses)) {
$this->_addItem(Ingo::RULE_VACATION, new Ingo_Script_Maildrop_Comment(_("Vacation"), $disable, true));
$params = array('action' => Ingo_Storage::ACTION_VACATION,
'action-value' => $actionval,
'disable' => $disable);
$recipe = new Ingo_Script_Maildrop_Recipe($params, $this->_params);
$this->_addItem(Ingo::RULE_VACATION, $recipe);
$this->_addItem(
Ingo::RULE_VACATION,
new Ingo_Script_String(
Ingo_Script_Util::vacationReason(
$vacation->getVacationReason(),
$vacation->getVacationStart(),
$vacation->getVacationEnd()
)
),
'vacation.msg'
);
}
}
/**
* Generates the maildrop script to handle spam as identified by
* SpamAssassin.
*
* @param boolean $disable Disable the spam-filter?
*/
public function generateSpamfilter($disable = false)
{
$spam = $this->_params['storage']
->retrieve(Ingo_Storage::ACTION_SPAM);
if ($spam == false) {
return;
}
$spam_folder = $spam->getSpamFolder();
$spam_action = (empty($spam_folder)) ? Ingo_Storage::ACTION_DISCARD : Ingo_Storage::ACTION_MOVE;
$this->_addItem(Ingo::RULE_SPAM, new Ingo_Script_Maildrop_Comment(_("Spam Filter"), $disable, true));
$params = array('action-value' => $spam_folder,
'action' => $spam_action,
'disable' => $disable);
$recipe = new Ingo_Script_Maildrop_Recipe($params, $this->_params);
if ($this->_params['spam_compare'] == 'numeric') {
$recipe->addCondition(array('match' => 'greater than or equal to',
'field' => $this->_params['spam_header'],
'value' => $spam->getSpamLevel()));
} elseif ($this->_params['spam_compare'] == 'string') {
$recipe->addCondition(array('match' => 'contains',
'field' => $this->_params['spam_header'],
'value' => str_repeat($this->_params['spam_char'], $spam->getSpamLevel())));
}
$this->_addItem(Ingo::RULE_SPAM, $recipe);
}
}
|