/usr/share/horde/ingo/lib/Script/Base.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 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 | <?php
/**
* Copyright 2012-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 Jan Schneider <jan@horde.org>
* @category Horde
* @license http://www.horde.org/licenses/apache ASL
* @package Ingo
*/
/**
* The Ingo_Script_Base class provides a common abstracted interface to the
* script-generation subclasses.
*
* @author Brent J. Nordquist <bjn@horde.org>
* @author Jan Schneider <jan@horde.org>
* @category Horde
* @license http://www.horde.org/licenses/apache ASL
* @package Ingo
*/
abstract class Ingo_Script_Base
{
/**
* The script class' additional parameters.
*
* @var array
*/
protected $_params = array();
/**
* A list of driver features.
*
* @var array
*/
protected $_features = array(
/* Can tests be case sensitive? */
'case_sensitive' => false,
/* 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' => false,
);
/**
* The list of actions allowed (implemented) for this driver.
* This SHOULD be defined in each subclass.
*
* @var array
*/
protected $_actions = array();
/**
* The categories of filtering allowed.
* This SHOULD be defined in each subclass.
*
* @var array
*/
protected $_categories = array();
/**
* Which form fields are supported in each category by this driver?
*
* This is an associative array with the keys taken from $_actions, each
* value is a list of strings with the supported feature names. An absent
* key is interpreted as "all features supported".
*
* @var array
*/
protected $_categoryFeatures = array();
/**
* The list of tests allowed (implemented) for this driver.
* This SHOULD be defined in each subclass.
*
* @var array
*/
protected $_tests = array();
/**
* The types of tests allowed (implemented) for this driver.
* This SHOULD be defined in each subclass.
*
* @var array
*/
protected $_types = array();
/**
* A list of any special types that this driver supports.
*
* @var array
*/
protected $_special_types = array();
/**
* The recipes that make up the code.
*
* @var array
*/
protected $_recipes = array();
/**
* Have the recipes been generated yet?
*
* @var boolean
*/
protected $_generated = false;
/**
* Constructor.
*
* @param array $params A hash containing parameters needed.
*/
public function __construct(array $params = array())
{
global $registry;
$this->setParams($params);
/* Determine if ingo should handle the blacklist. */
if ((($key = array_search(Ingo_Storage::ACTION_BLACKLIST, $this->_categories)) !== false) &&
($registry->hasMethod('mail/blacklistFrom') != 'ingo')) {
unset($this->_categories[$key]);
}
/* Determine if ingo should handle the whitelist. */
if ((($key = array_search(Ingo_Storage::ACTION_WHITELIST, $this->_categories)) !== false) &&
($registry->hasMethod('mail/whitelistFrom') != 'ingo')) {
unset($this->_categories[$key]);
}
}
/**
* Updates the parameters.
*
* @param array $params A hash containing parameters.
*
* @return Ingo_Script This object, for chaining.
*/
public function setParams(array $params = array())
{
$this->_params = array_merge($this->_params, $params);
return $this;
}
/**
* Returns whether the script driver supports a certain feature.
*
* @see $_features
*
* @param string $feature A feature name.
*
* @return boolean True if this feature is supported.
*/
public function hasFeature($feature)
{
return !empty($this->_features[$feature]);
}
/**
* Returns a regular expression that should catch mails coming from most
* daemons, mailing list, newsletters, and other bulk.
*
* This is the expression used for procmail's FROM_DAEMON, including all
* mailinglist headers.
*
* @return string A regular expression.
*/
public function excludeRegexp()
{
return '(^(Mailing-List:|List-(Id|Help|Unsubscribe|Subscribe|Owner|Post|Archive):|Precedence:.*(junk|bulk|list)|To: Multiple recipients of|(((Resent-)?(From|Sender)|X-Envelope-From):|>?From)([^>]*[^(.%@a-z0-9])?(Post(ma?(st(e?r)?|n)|office)|(send)?Mail(er)?|daemon|m(mdf|ajordomo)|n?uucp|LIST(SERV|proc)|NETSERV|o(wner|ps)|r(e(quest|sponse)|oot)|b(ounce|bs\.smtp)|echo|mirror|s(erv(ices?|er)|mtp(error)?|ystem)|A(dmin(istrator)?|MMGR|utoanswer))(([^).!:a-z0-9][-_a-z0-9]*)?[%@>\t ][^<)]*(\(.*\).*)?)?$([^>]|$)))';
}
/**
* Returns the available actions for this driver.
*
* @return array The list of available actions.
*/
public function availableActions()
{
return $this->_actions;
}
/**
* Returns the available categories for this driver.
*
* @return array The list of categories.
*/
public function availableCategories()
{
return $this->_categories;
}
/**
* Returns the supported form fields for this driver.
*
* @return array An array with the supported field names of the requested category.
*/
public function availableCategoryFeatures($category)
{
return isset($this->_categoryFeatures[$category]) ? $this->_categoryFeatures[$category] : array();
}
/**
* Returns the available tests for this driver.
*
* @return array The list of tests actions.
*/
public function availableTests()
{
return $this->_tests;
}
/**
* Returns the available test types for this driver.
*
* @return array The list of test types.
*/
public function availableTypes()
{
return $this->_types;
}
/**
* Returns any test types that are special for this driver.
*
* @return array The list of special types
*/
public function specialTypes()
{
return $this->_special_types;
}
/**
* Generates the scripts to do the filtering specified in the rules.
*
* @return array The scripts.
*/
public function generate()
{
if (!$this->_generated) {
$this->_generate();
$this->_generated = true;
}
$scripts = array();
foreach ($this->_recipes as $item) {
$rule = isset($this->_params['transport'][$item['rule']])
? $item['rule']
: Ingo::RULE_ALL;
$name = '';
if (strlen($item['name'])) {
$name = $item['name'];
} elseif (isset($this->_params['transport'][$rule]['params']['filename'])) {
$name = $this->_params['transport'][$rule]['params']['filename'];
} elseif (isset($this->_params['transport'][$rule]['params']['scriptname'])) {
$name = $this->_params['transport'][$rule]['params']['scriptname'];
}
if (!isset($scripts[$rule . $name])) {
$scripts[$rule . $name] = array(
'transport' => $this->_params['transport'][$rule],
'name' => $name,
'script' => '',
'recipes' => array(),
);
}
$scripts[$rule . $name]['script'] .= $item['object']->generate() . "\n";
$scripts[$rule . $name]['recipes'][] = $item;
}
return array_values($scripts);
}
/**
* Generates the scripts to do the filtering specified in the rules.
*/
protected function _generate()
{
}
/**
* Adds an item to the recipe list.
*
* @param integer $rule One of the Ingo::RULE_* constants.
* @param Ingo_Script_Item $item An item to add to the recipe list.
* @param string $name A script name.
*/
protected function _addItem($rule, Ingo_Script_Item $item, $name = null)
{
$this->_recipes[] = array(
'rule' => $rule,
'object' => $item,
'name' => $name
);
}
/**
* Inserts an item into the recipe list.
*
* @param integer $rule One of the Ingo::RULE_* constants.
* @param Ingo_Script_Item $item An item to add to the recipe list.
* @param string $name A script name.
* @þaram integer $position Where to add the item.
*/
protected function _insertItem($rule, Ingo_Script_Item $item, $name = null,
$position = 0)
{
array_splice(
$this->_recipes,
$position,
0,
array(array(
'rule' => $rule,
'object' => $item,
'name' => $name
))
);
}
/**
* Performs the filtering specified in the rules.
*
* @param integer $change The timestamp of the latest rule change during
* the current session (uses session value if
* null).
*/
public function perform($change = null)
{
global $session;
if (is_null($change)) {
$change = $session->get('ingo', 'change');
}
$this->_perform($change);
}
/**
* @see perform()
*/
protected function _perform($change)
{
}
/**
* Is the perform() function available right now?
*
* This is not a duplication of hasFeature() because drivers might override
* this to do real-time checks if on-demand filtering is not only available
* theoretically but practically in this very moment.
*
* @return boolean True if perform() is available, false if not.
*/
public function canPerform()
{
return $this->hasFeature('on_demand');
}
/**
* Is this a valid rule?
*
* @param integer $type The rule type.
*
* @return boolean Whether the rule is valid or not for this driver.
*/
protected function _validRule($type)
{
return (!empty($type) && in_array($type, array_merge($this->_categories, $this->_actions)));
}
}
|