/usr/share/horde/ingo/lib/Script/Procmail.php is in php-horde-ingo 3.2.13-1.
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 315 316 317 318 | <?php
/**
* Copyright 2003-2016 Horde LLC (http://www.horde.org/)
*
* See the enclosed file LICENSE for license information (ASL). If you
* did not receive this file, see http://www.horde.org/licenses/apache.
*
* @author Brent J. Nordquist <bjn@horde.org>
* @author Ben Chavet <ben@horde.org>
* @author Jan Schneider <jan@horde.org>
* @category Horde
* @license http://www.horde.org/licenses/apache ASL
* @package Ingo
*/
/**
* The Ingo_Script_Procmail class represents a Procmail script generator.
*
* @author Brent J. Nordquist <bjn@horde.org>
* @author Ben Chavet <ben@horde.org>
* @author Jan Schneider <jan@horde.org>
* @category Horde
* @license http://www.horde.org/licenses/apache ASL
* @package Ingo
*/
class Ingo_Script_Procmail extends Ingo_Script_Base
{
/**
* 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
);
/**
* The types of tests allowed (implemented) for this driver.
*
* @var array
*/
protected $_types = array(
Ingo_Storage::TYPE_HEADER,
Ingo_Storage::TYPE_BODY
);
/**
* A list of any special types that this driver supports.
*
* @var array
*/
protected $_special_types = array(
'Destination',
);
/**
* The list of tests allowed (implemented) for this driver.
*
* @var array
*/
protected $_tests = array(
'contains',
'not contain',
'begins with',
'not begins with',
'ends with',
'not ends with',
'regex'
);
/**
* Constructor.
*
* @param array $params A hash containing parameters needed.
*/
public function __construct($params = array())
{
parent::__construct($params);
// Bug #10113: Need to explicitly define these variables instead of
// relying on system defaults.
if ($this->_params['path_style'] == 'maildir') {
if (!isset($this->_params['variables']['DEFAULT'])) {
$this->_params['variables']['DEFAULT'] = '$HOME/Maildir/';
}
if (!isset($this->_params['variables']['MAILDIR'])) {
$this->_params['variables']['MAILDIR'] = '$HOME/Maildir';
}
}
}
/**
* Generates the procmail scripts 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_Procmail_Comment(_("procmail script generated by Ingo") . ' (' . date('F j, Y, g:i a') . ')'));
if (isset($this->_params['forward_file']) &&
isset($this->_params['forward_string'])) {
$this->_addItem(
Ingo::RULE_ALL,
new Ingo_Script_String($this->_params['forward_string']),
$this->_params['forward_file']
);
}
/* 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_Procmail_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_VACATION:
$this->generateVacation(!empty($filter['disable']));
break;
case Ingo_Storage::ACTION_FORWARD:
$this->generateForward(!empty($filter['disable']));
break;
default:
if (in_array($filter['action'], $this->_actions)) {
/* Create filter if using AND. */
if ($filter['combine'] == Ingo_Storage::COMBINE_ALL) {
$recipe = new Ingo_Script_Procmail_Recipe($filter, $this->_params);
foreach ($filter['conditions'] as $condition) {
$recipe->addCondition($condition);
}
$this->_addItem(Ingo::RULE_FILTER, new Ingo_Script_Procmail_Comment($filter['name'], !empty($filter['disable']), true));
$this->_addItem(Ingo::RULE_FILTER, $recipe);
} else {
/* Create filter if using OR */
$this->_addItem(Ingo::RULE_FILTER, new Ingo_Script_Procmail_Comment($filter['name'], !empty($filter['disable']), true));
$loop = 0;
foreach ($filter['conditions'] as $condition) {
$recipe = new Ingo_Script_Procmail_Recipe($filter, $this->_params);
if ($loop++) {
$recipe->addFlag('E');
}
$recipe->addCondition($condition);
$this->_addItem(Ingo::RULE_FILTER, $recipe);
}
}
}
}
}
// If an external delivery program is used, add final rule
// to deliver to $DEFAULT
if (isset($this->_params['delivery_agent'])) {
$this->_addItem(Ingo::RULE_FILTER, new Ingo_Script_Procmail_Default($this->_params));
}
}
/**
* Generates the procmail 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_Procmail_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_Procmail_Recipe($params, $this->_params);
$recipe->addCondition(array('field' => 'From', 'value' => $address, 'match' => 'address'));
$this->_addItem(Ingo::RULE_BLACKLIST, $recipe);
}
}
}
}
/**
* Generates the procmail 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_Procmail_Comment(_("Whitelisted Addresses"), $disable, true));
foreach ($wl_addr as $address) {
if (!empty($address)) {
$recipe = new Ingo_Script_Procmail_Recipe(array('action' => Ingo_Storage::ACTION_KEEP, 'disable' => $disable), $this->_params);
$recipe->addCondition(array('field' => 'From', 'value' => $address, 'match' => 'address'));
$this->_addItem(Ingo::RULE_WHITELIST, $recipe);
}
}
}
}
/**
* Generates the procmail script to handle vacation.
*
* @param boolean $disable Disable vacation?
*/
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(),
'reason' => $vacation->getVacationReason(),
'ignorelist' => $vacation->getVacationIgnorelist(),
'excludes' => $vacation->getVacationExcludes(),
'start' => $vacation->getVacationStart(),
'end' => $vacation->getVacationEnd(),
);
if (!empty($addresses)) {
$this->_addItem(Ingo::RULE_VACATION, new Ingo_Script_Procmail_Comment(_("Vacation"), $disable, true));
$params = array('action' => Ingo_Storage::ACTION_VACATION,
'action-value' => $actionval,
'disable' => $disable);
$recipe = new Ingo_Script_Procmail_Recipe($params, $this->_params);
$this->_addItem(Ingo::RULE_VACATION, $recipe);
}
}
/**
* Generates the procmail 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_Procmail_Comment(_("Forwards"), $disable, true));
$params = array('action' => Ingo_Storage::ACTION_FORWARD,
'action-value' => $addresses,
'disable' => $disable);
$recipe = new Ingo_Script_Procmail_Recipe($params, $this->_params);
if ($forward->getForwardKeep()) {
$recipe->addFlag('c');
}
$this->_addItem(Ingo::RULE_FORWARD, $recipe);
}
}
}
|