rule.php

<?php
/*
 * $Id$
 *
 * Copyright (C) 2002-2007 Stephen Grier <stephengrier@users.sourceforge.net>
 *
 * See the inclosed NOTICE file for conditions of use and distribution.
 */


require './lib/base.php';

// Rule modes.
define("SMARTSIEVE_RULE_MODE_GENERAL", 'general');
define("SMARTSIEVE_RULE_MODE_FORWARD", 'forward');
define("SMARTSIEVE_RULE_MODE_SPAM", 'spam');
define("SMARTSIEVE_RULE_MODE_CUSTOM", 'custom');
define("SMARTSIEVE_RULE_MODE_WHITELIST", 'whitelist');
define("SMARTSIEVE_RULE_MODE_VACATION", 'vacation');

// Form actions.
define("FORM_ACTION_ENABLE", 'enable');
define("FORM_ACTION_DISABLE", 'disable');
define("FORM_ACTION_DELETE", 'delete');
define("FORM_ACTION_SAVE", 'save');

SmartSieve::checkAuthentication();

$smartsieve = &$_SESSION['smartsieve'];
$script = &$_SESSION['scripts'][$_SESSION['smartsieve']['workingScript']];

// If not in GUI mode, redirect.
if ($script->mode == 'advanced' || $script->so == false) {
	header('Location: ' . SmartSieve::setUrl('main.php'));
	exit;
}

// What kind of rule are we creating?
$mode = SMARTSIEVE_RULE_MODE_GENERAL;
if (($m = SmartSieve::getFormValue('mode')) !== null &&
	($m == SMARTSIEVE_RULE_MODE_SPAM ||
	 $m == SMARTSIEVE_RULE_MODE_FORWARD ||
	 $m == SMARTSIEVE_RULE_MODE_CUSTOM ||
	 $m == SMARTSIEVE_RULE_MODE_WHITELIST ||
	 $m == SMARTSIEVE_RULE_MODE_VACATION)) {
	$mode = $m;
}

// Get values for this rule.
$ruleID = null;
$rule = array('status' => 'ENABLED',
			  'control' => CONTROL_ELSEIF,
			  'matchAny' => 0,
			  'conditions' => array(),
			  'actions' => array(),
			  );
// Get form values from POST data.
if (SmartSieve::getPOST('ruleID') !== null) {
	$ruleID = SmartSieve::getPOST('ruleID');
	$rule = getPOSTValues();
}
// Use values from an existing rule.
elseif (SmartSieve::getGET('ruleID') !== null) {
	$ruleID = SmartSieve::getGET('ruleID');
	$rule = $script->getRule($ruleID);
}
// If using spam mode, look for an existing spam rule.
elseif ($mode == SMARTSIEVE_RULE_MODE_SPAM) {
	$ruleID = $script->getSpecialRuleId(RULE_TAG_SPAM);
	if ($ruleID !== null) {
		$rule = $script->getRule($ruleID);
	} elseif (($spam = SmartSieve::getConf('spam_filter')) !== null &&
			   isset($spam['header']) &&
			   isset($spam['matchStr']) &&
			   isset($spam['matchType'])) {
		$rule['conditions'][] = array('type'=>TEST_HEADER,
									  'header'=>$spam['header'],
									  'matchStr'=>$spam['matchStr'],
									  'matchType'=>$spam['matchType'],
									  'not'=>(!empty($spam['not'])) ? true : false);
	} else {
		$mode = SMARTSIEVE_RULE_MODE_GENERAL;
	}
}
// If using forward mode, look for an existing forward rule.
elseif ($mode == SMARTSIEVE_RULE_MODE_FORWARD) {
	$ruleID = $script->getSpecialRuleId(RULE_TAG_FORWARD);
	if ($ruleID !== null) {
		$rule = $script->getRule($ruleID);
	} elseif (SmartSieve::getConf('use_forward_mail_interface', true) == true) {
		$rule['actions'][] = array('type'=>ACTION_REDIRECT, 'address'=>'');
	} else {
		$mode = SMARTSIEVE_RULE_MODE_GENERAL;
	}
} elseif ($mode == SMARTSIEVE_RULE_MODE_VACATION) {
	$ruleID = $script->getSpecialRuleId(RULE_TAG_VACATION);
	if ($ruleID !== null) {
		$rule = $script->getRule($ruleID);
	} elseif (SmartSieve::getConf('use_vacation_interface', true) == true) {
		$rule['actions'][] = array('type'=>ACTION_VACATION,
								   'message'=>'',
								   'days'=>SmartSieve::getConf('vacation_days', 7),
								   'addresses'=>array());
	} else {
		$mode = SMARTSIEVE_RULE_MODE_GENERAL;
	}
} elseif ($mode == SMARTSIEVE_RULE_MODE_WHITELIST) {
	$ruleID = $script->getSpecialRuleId(RULE_TAG_WHITELIST);
	if ($ruleID !== null) {
		$rule = $script->getRule($ruleID);
	} elseif (SmartSieve::getConf('use_whitelist', true) == true) {
		$rule['conditions'][] = array('type'=>TEST_ADDRESS,
									'header'=>'from',
									'matchStr'=>'',
									'matchType'=>MATCH_IS);
		$rule['actions'][] = array('type'=>ACTION_STOP);
	} else {
		$mode = SMARTSIEVE_RULE_MODE_GENERAL;
	}
}
// Check if this is a custom rule.
foreach ($rule['actions'] as $action) {
	if ($action['type'] == ACTION_CUSTOM) {
		$mode = SMARTSIEVE_RULE_MODE_CUSTOM;
	}
}
// If this is a new custom rule, display custom rule interface only if permitted to do so.
if ($mode == SMARTSIEVE_RULE_MODE_CUSTOM && !isset($ruleID)) {
	if (SmartSieve::getConf('allow_custom', true) !== false) {
		$rule['actions'][] = array('type'=>ACTION_CUSTOM, 'sieve'=>'');
	} else {
		$mode = SMARTSIEVE_RULE_MODE_GENERAL;
	}
}

// If rule has a fileinto action, get the list of mailboxes for this user.
// Don't do this if user has authzed as another user (Bug #1775235).
$mailboxes = array();
foreach ($rule['actions'] as $action) {
	if ($action['type'] == ACTION_FILEINTO &&
		$_SESSION['smartsieve']['auth'] == $_SESSION['smartsieve']['authz']) {
		$mailboxes = SmartSieve::getMailboxList();
	}
}

// Perform actions.

$action = SmartSieve::getFormValue('thisAction');

switch ($action) {

	case (FORM_ACTION_ENABLE):
		$rule['status'] = 'ENABLED';
		if (isSane($rule)) {
			$oldrule = $script->getRule($ruleID);
			if (isset($script->rules[$ruleID])) {
				$ruleID = $script->saveRule($rule, $ruleID);
			} else {
				$ruleID = $script->addRule($rule, (int)SmartSieve::getPOST('position'));
			}
			if (!$script->updateScript()) {
				SmartSieve::setError(SmartSieve::text('ERROR: ') . $script->errstr);
				SmartSieve::log(sprintf('failed writing script "%s" for %s: %s',
					$script->name, $_SESSION['smartsieve']['authz'], $script->errstr), LOG_ERR);
				if ($oldrule) {
					$ruleID = $script->saveRule($oldrule, $ruleID);
				} else {
					$script->deleteRule($ruleID);
				}
			} else {
				SmartSieve::setNotice(SmartSieve::text('Rule successfully enabled'));
				if (SmartSieve::getConf('return_after_update') === true) {
					header('Location: ' . SmartSieve::setUrl('main.php'),true);
					exit;
				}
			}
		}
		break;

	case (FORM_ACTION_DISABLE):
		$rule['status'] = 'DISABLED';
		if (isSane($rule)) {
			$oldrule = $script->getRule($ruleID);
			if (isset($script->rules[$ruleID])) {
				$ruleID = $script->saveRule($rule, $ruleID);
			} else {
				$ruleID = $script->addRule($rule, (int)SmartSieve::getPOST('position'));
			}
			if (!$script->updateScript()) {
				SmartSieve::setError(SmartSieve::text('ERROR: ') . $script->errstr);
				SmartSieve::log(sprintf('failed writing script "%s" for %s: %s',
					$script->name, $_SESSION['smartsieve']['authz'], $script->errstr), LOG_ERR);
				if ($oldrule) {
					$ruleID = $script->saveRule($oldrule, $ruleID);
				} else {
					$script->deleteRule($ruleID);
				}
			} else {
				SmartSieve::setNotice(SmartSieve::text('Rule successfully disabled'));
				if (SmartSieve::getConf('return_after_update') === true) {
					header('Location: ' . SmartSieve::setUrl('main.php'),true);
					exit;
				}
			}
		}
		break;

	case (FORM_ACTION_DELETE):
		$oldrule = $script->getRule($ruleID);
		if ($script->deleteRule($ruleID)) {
			if (!$script->updateScript()) {
				SmartSieve::setError(SmartSieve::text('ERROR: ') . $script->errstr);
				SmartSieve::log(sprintf('failed writing script "%s" for %s: %s',
					$script->name, $_SESSION['smartsieve']['authz'], $script->errstr), LOG_ERR);
				if ($oldrule) {
					$ruleID = $script->saveRule($oldrule, $ruleID);
				}
			} else {
				SmartSieve::setNotice(SmartSieve::text('Rule successfully deleted'));
				header('Location: ' . SmartSieve::setUrl('main.php'),true);
				exit;
			}
		} else {
			SmartSieve::setError(SmartSieve::text('ERROR: rule does not exist.'));
		}
		break;

	case (FORM_ACTION_SAVE):
		if (isSane($rule)) {
			$oldrule = $script->getRule($ruleID);
			if (isset($script->rules[$ruleID])) {
				$ruleID = $script->saveRule($rule, $ruleID);
			} else {
				$ruleID = $script->addRule($rule, (int)SmartSieve::getPOST('position'));
			}
			if (!$script->updateScript()) {
				SmartSieve::setError(SmartSieve::text('ERROR: ') . $script->errstr);
				SmartSieve::log(sprintf('failed writing script "%s" for %s: %s',
					$script->name, $_SESSION['smartsieve']['authz'], $script->errstr), LOG_ERR);
				if ($oldrule) {
					$ruleID = $script->saveRule($oldrule, $ruleID);
				} else {
					$script->deleteRule($ruleID);
				}
			} else {
				SmartSieve::setNotice(SmartSieve::text('Your changes have been successfully saved'));
				if (SmartSieve::getConf('return_after_update') === true) {
					header('Location: ' . SmartSieve::setUrl('main.php'),true);
					exit;
				}
			}
		}
		break;
}


$jsfile = 'rule.js';
$jsonload = '';
$wrap_width = (SmartSieve::getConf('wrap_width')) ? SmartSieve::getConf('wrap_width') : 80;
// Define a list of imap flags to make available to the addflag action.
$imapFlags = SmartSieve::getConf('imap_flags', array('\\\\Seen', '\\\\Deleted', '\\\\Answered', '\\\\Flagged', 'Junk', 'NotJunk', '$Label1', '$Label2', '$Label3', '$Label4', '$Label5'));
$notifyMethods = SmartSieve::getConf('notify_methods', array());

// Add dummy condition and action for "Add action" widgits.
$rule['conditions'][] = array('type' => 'new');
$rule['actions'][] = array('type' => 'new');

switch ($mode) {
	case (SMARTSIEVE_RULE_MODE_SPAM):
		$help_url = SmartSieve::getConf('spam_help_url', '');
		$template = '/spam.inc';
		break;
	case (SMARTSIEVE_RULE_MODE_FORWARD):
		$help_url = SmartSieve::getConf('forward_help_url', '');
		$template = '/forward.inc';
		break;
	case (SMARTSIEVE_RULE_MODE_CUSTOM):
		$help_url = SmartSieve::getConf('custom_help_url', '');
		$template = '/custom.inc';
		break;
	case (SMARTSIEVE_RULE_MODE_VACATION):
		$help_url = SmartSieve::getConf('vacation_help_url', '');
		$template = '/vacation.inc';
		break;
	case (SMARTSIEVE_RULE_MODE_WHITELIST):
		$help_url = SmartSieve::getConf('whitelist_help_url', '');
		$template = '/whitelist.inc';
		break;
	default:
		$help_url = SmartSieve::getConf('rule_help_url', '');
		$template = '/rule.inc';
		break;
}

include SmartSieve::getConf('include_dir', 'include') . '/common-head.inc';
include SmartSieve::getConf('include_dir', 'include') . '/menu.inc';
include SmartSieve::getConf('include_dir', 'include') . '/common_status.inc';
include SmartSieve::getConf('include_dir', 'include') . $template;
include SmartSieve::getConf('include_dir', 'include') . '/common-footer.inc';

SmartSieve::close();


/**
 * Get values from the rule edit form.
 *
 * @return array Rule values
 */
function getPOSTValues()
{
	$rule = array();
	$rule['status'] = SmartSieve::getPOST('status', 'ENABLED');
	$rule['control'] = SmartSieve::getPOST('control');
	$rule['matchAny'] = SmartSieve::getPOST('anyof');
	$rule['conditions'] = array();
	$special = SmartSieve::getPOST('special');
	if (!empty($special)) {
		$rule['special'] = $special;
	}
	$i = 0;
	while (($type = SmartSieve::getPOST('condition' . $i)) !== null) {
		$condition = array();
		switch ($type) {
			case ('new'):
				break;
			case ('from'):
				$condition['type'] = TEST_ADDRESS;
				$condition['header'] = 'from';
				$condition['matchStr'] = SmartSieve::utf8Encode(SmartSieve::getPOST('matchStr'.$i));
				break;
			case ('to'):
				$condition['type'] = TEST_ADDRESS;
				$condition['header'] = 'to';
				$condition['matchStr'] = SmartSieve::utf8Encode(SmartSieve::getPOST('matchStr'.$i));
				break;
			case ('tocc'):
				$condition['type'] = TEST_ADDRESS;
				$condition['header'] = array('to', 'cc');
				$condition['matchStr'] = SmartSieve::utf8Encode(SmartSieve::getPOST('matchStr'.$i));
				break;
			case ('subject'):
				$condition['type'] = TEST_HEADER;
				$condition['header'] = 'subject';
				$condition['matchStr'] = SmartSieve::utf8Encode(SmartSieve::getPOST('matchStr'.$i));
				break;
			case ('size'):
				$condition['type'] = TEST_SIZE;
				$condition['gthan'] = SmartSieve::getPOST('gthan'.$i);
				$condition['kbytes'] = SmartSieve::getPOST('size'.$i);
				break;
			case ('header'):
				$condition['type'] = TEST_HEADER;
				$condition['header'] = SmartSieve::utf8Encode(SmartSieve::getPOST('header'.$i));
				$condition['matchStr'] = SmartSieve::utf8Encode(SmartSieve::getPOST('headerMatchStr'.$i));
				break;
			case ('body'):
				$condition['type'] = TEST_BODY;
				$condition['matchStr'] = SmartSieve::utf8Encode(SmartSieve::getPOST('bodyMatchStr'.$i));
				break;
		}
		if ($type != 'new' && ($condition['type'] == TEST_ADDRESS || $condition['type'] == TEST_HEADER || $condition['type'] == TEST_BODY)) {
			$matchType = SmartSieve::getPOST('matchType'.$i);
			switch ($matchType) {
				case ('is'):
					$condition['matchType'] = MATCH_IS;
					break;
				case ('notis'):
					$condition['matchType'] = MATCH_IS;
					$condition['not'] = true;
					break;
				case ('matches'):
					$condition['matchType'] = MATCH_MATCHES;
					break;
				case ('notmatches'):
					$condition['matchType'] = MATCH_MATCHES;
					$condition['not'] = true;
					break;
				case ('regex'):
					$condition['matchType'] = MATCH_REGEX;
					break;
				case ('notregex'):
					$condition['matchType'] = MATCH_REGEX;
					$condition['not'] = true;
					break;
				case ('notcontains'):
					$condition['matchType'] = MATCH_CONTAINS;
					$condition['not'] = true;
					break;
				case ('contains'):
				default:
					$condition['matchType'] = MATCH_CONTAINS;
					break;
			}
		}
		// If delete value set, ignore this condition.
		if (SmartSieve::getPOST('delete' . $i++) == '1' || $type == 'new') {
			continue;
		}
		$rule['conditions'][] = $condition;
	}
	$rule['actions'] = array();
	$i = 0;
	while (($type = SmartSieve::getPOST('action' . $i)) !== null) {
		$action = array();
		switch ($type) {
			case ('new'):
				break;
			case (ACTION_FILEINTO):
				$action['type'] = ACTION_FILEINTO;
				$action['folder'] = SmartSieve::getPOST(ACTION_FILEINTO . $i);
				break;
			case (ACTION_REDIRECT):
				$action['type'] = ACTION_REDIRECT;
				$action['address'] = SmartSieve::utf8Encode(SmartSieve::getPOST(ACTION_REDIRECT . $i));
				break;
			case (ACTION_REJECT):
				$action['type'] = ACTION_REJECT;
				$action['message'] = SmartSieve::utf8Encode(SmartSieve::getPOST(ACTION_REJECT . $i));
				break;
			case (ACTION_DISCARD):
				$action['type'] = ACTION_DISCARD;
				break;
			case (ACTION_KEEP):
				$action['type'] = ACTION_KEEP;
				break;
			case (ACTION_STOP):
				$action['type'] = ACTION_STOP;
				break;
			case (ACTION_CUSTOM):
				$action['type'] = ACTION_CUSTOM;
				$action['sieve'] = SmartSieve::utf8Encode(SmartSieve::getPOST('sieve'));
				break;
			case (ACTION_VACATION):
				$action['type'] = ACTION_VACATION;
				$action['message'] = SmartSieve::utf8Encode(SmartSieve::getPOST('message'.$i));
				$action['days'] = SmartSieve::getPOST('days'.$i);
				$addrs = SmartSieve::getFormValue('address'.$i);
				$addresses = array();
				if (is_array($addrs)) {
					foreach ($addrs as $addr) {
						$addresses[] = SmartSieve::utf8Encode($addr);
					}
				}
				$newAddrs = SmartSieve::utf8Encode(SmartSieve::getFormValue('newaddresses'.$i));
				$newAddrs = preg_replace("/\"|\\\/", "", $newAddrs);
				$addrs = preg_split("/\s*,\s*|\s+/", $newAddrs);
				foreach ($addrs as $addr) {
					if (!empty($addr)) {
						$addresses[] = $addr;
					}
				}
				$action['addresses'] = array_unique($addresses);
				break;
			case (ACTION_ADDFLAG):
				$action['type'] = ACTION_ADDFLAG;
				$action['flag'] = SmartSieve::getPOST(ACTION_ADDFLAG.$i);
				break;
			case (ACTION_NOTIFY):
				$action['type'] = ACTION_NOTIFY;
				$action['method'] = SmartSieve::getPOST('notify_method'.$i);
				$action['options'] = SmartSieve::utf8Encode(SmartSieve::getPOST('notify_options'.$i));
				$action['message'] = SmartSieve::utf8Encode(SmartSieve::getPOST('message'.$i));
				break;
		}
		// If delete value set, ignore this condition.
		if (SmartSieve::getPOST('deleteAction' . $i++) == '1' || $type == 'new') {
			continue;
		}
		$rule['actions'][] = $action;
	}
	return $rule;
}


/**
 * Is this rule sane.
 *
 * Performs basic sanity/integrity checks.
 *
 * @param array $rule Rule values
 * @return boolean true if sane, false if not
 */
function isSane($rule)
{
	$max_field_chars = SmartSieve::getConf('max_field_chars', 500);
	$max_textbox_chars = SmartSieve::getConf('max_textbox_chars', 50000);

	// Condition checks.

	foreach ($rule['conditions'] as $condition) {
		// Check values do not exceed acceptable sizes.
		if ($condition['type'] == TEST_ADDRESS || $condition['type'] == TEST_HEADER) {
			if (($condition['type'] == TEST_HEADER && strlen($condition['header']) > $max_field_chars) ||
				strlen($condition['matchStr']) > $max_field_chars) {
				SmartSieve::setError(SmartSieve::text('The condition value you supplied is too long. It should not exceed %d characters.', array($max_field_chars)));
				return false;
			}
		}
		if ($condition['type'] == TEST_SIZE) {
			// Message size must not contain non-digits.
			if (preg_match("/\D/", $condition['kbytes'])) {
				SmartSieve::setError(SmartSieve::text('Message size value must be a positive integer'));
				return false;
			}
		}
		if ($condition['type'] == TEST_HEADER) {
			if (empty($condition['header'])) {
				SmartSieve::setError(SmartSieve::text('Please supply a message header to match on'));
				return false;
			}
			if (empty($condition['matchStr'])) {
				SmartSieve::setError(SmartSieve::text('You must supply a value for the header "%s"',
					array($condition['header'])));
				return false;
			}
		}
		if ($condition['type'] == TEST_BODY) {
			if (empty($condition['matchStr'])) {
				SmartSieve::setError(SmartSieve::text('You must supply a value to match in the message body'));
				return false;
			}
		}
	}

	// Action checks.

	// Rule must have an action.
	if (empty($rule['actions'])) {
		SmartSieve::setError(SmartSieve::text('Please supply an action'));
		return false;
	}
	foreach ($rule['actions'] as $action) {
		// Actions that require a value.
		if (($action['type'] == ACTION_FILEINTO && empty($action['folder'])) ||
			($action['type'] == ACTION_REDIRECT && empty($action['address'])) ||
			($action['type'] == ACTION_REJECT && empty($action['message'])) ||
			($action['type'] == ACTION_VACATION && empty($action['message'])) ||
			($action['type'] == ACTION_ADDFLAG && empty($action['flag'])) ||
			($action['type'] == ACTION_NOTIFY && empty($action['message'])) ||
			($action['type'] == ACTION_CUSTOM && empty($action['sieve']))) {
			SmartSieve::setError(SmartSieve::text('You must supply an argument for this action'));
			return false;
		}
		if ($action['type'] == ACTION_FILEINTO) {
			if (!empty($GLOBALS['mailboxes']) && !in_array($action['folder'], $GLOBALS['mailboxes'])) {
				SmartSieve::setError(SmartSieve::text('The folder "%s" does not exist', array($action['folder'])));
				return false;
			}
		}
		if ($action['type'] == ACTION_REDIRECT) {
			if (strlen($action['address']) > $max_field_chars) {
				SmartSieve::setError(SmartSieve::text('The email address you supplied is too long. It should not exceed %d characters', array($max_field_chars)));
				return false;
			}
			if (!preg_match("/^[\x21-\x7E]+@([0-9a-zA-Z-]+\.)+[0-9a-zA-Z]{2,}$/i", $action['address'])) {
			SmartSieve::setError(SmartSieve::text('"%s" is not a valid email address',
				array(htmlspecialchars($action['address']))));
				return false;
			}
		}
		if ($action['type'] == ACTION_REJECT) {
			if (strlen($action['message']) > $max_textbox_chars) {
				SmartSieve::setError(SmartSieve::text('Your reject message is too long. It should not exceed %d characters', array($max_textbox_chars)));
				return false;
			}
		}
		if ($action['type'] == ACTION_VACATION) {
			if (strlen($action['message']) > $max_textbox_chars) {
				SmartSieve::setError(SmartSieve::text('Your vacation message must not exceed %d characters',
					array($max_textbox_chars)));
				return false;
			}
			foreach ($action['addresses'] as $addr) {
				if (!preg_match("/^[\x21-\x7E]+@([0-9a-zA-Z-]+\.)+[0-9a-zA-Z]{2,}$/i", $addr)) {
					SmartSieve::setError(SmartSieve::text('"%s" is not a valid email address',
						array(htmlspecialchars($addr))));
					return false;
				}
			}
			if (!is_numeric($action['days'])) {
				SmartSieve::setError(SmartSieve::text('Vacation days must be a positive integer'));
				return false;
			}
		}
		if ($action['type'] == ACTION_ADDFLAG) {
			$allowed = SmartSieve::getConf('imap_flags', array('\\\\Seen', '\\\\Deleted', '\\\\Answered', '\\\\Flagged', 'Junk', 'NotJunk', '$Label1', '$Label2', '$Label3', '$Label4', '$Label5'));
			if (!in_array($action['flag'], $allowed)) {
				SmartSieve::setError(SmartSieve::text('This flag is not permitted'));
				return false;
			}
		}
		if ($action['type'] == ACTION_NOTIFY) {
			$allowed = SmartSieve::getConf('notify_methods', array());
			if (!in_array($action['method'], $allowed)) {
				SmartSieve::setError(SmartSieve::text('This notify method is not permitted'));
				return false;
			}
		}
	}

	// Call is_sane_hook callback function, if defined.
	if (($func = SmartSieve::getConf('is_sane_hook')) !== null &&
			function_exists($func)) {
			return call_user_func($func, $rule);
	}

	// All values sane.
	return true;
}

/**
 * Format an array of vacation addresses for the vacation widget.
 *
 * The full list of addresses will include any set in an existing vacation
 * action, plus those returned by get_email_addresses_hook, if set.
 *
 * @param array $addresses List of addresses set in existing vacation object
 * @return array Formatted array of all addresses
 */
function getAllAddresses($addresses)
{
	$all = array();
	if (is_array($addresses)) {
		foreach ($addresses as $address) {
			$all[SmartSieve::utf8Decode($address)] = true;
		}
	}
	static $extra_addresses;
	if (!isset($extra_addresses)) {
		$extra_addresses = array();
		if (($func = SmartSieve::getConf('get_email_addresses_hook')) !== null &&
			function_exists($func)) {
			$extra_addresses = call_user_func($func);
		}
	}
	foreach ($extra_addresses as $addr) {
		if (!in_array($addr, $addresses)) {
			$all[SmartSieve::utf8Decode($addr)] = false;
		}
	}
	// Try some other options if have no addresses.
	if (empty($all)) {
		// If username is fully qualified, suggest that.
		if (strpos($_SESSION['smartsieve']['authz'],'@') !== false) {
			$all[$_SESSION['smartsieve']['authz']] = false;
		}
		if (!empty($_SESSION['smartsieve']['server']['maildomain'])) {
			$all[$_SESSION['smartsieve']['authz'] . '@' . $_SESSION['smartsieve']['server']['maildomain']] = false;
		}
	}
	return $all;
}