egroupware/mail/inc/class.mail_sieve.inc.php

1133 lines
29 KiB
PHP

<?php
/**
* EGroupware - Mail - interface class
*
* @link http://www.egroupware.org
* @package mail
* @author Hadi Nategh [hn@stylite.de]
* @copyright (c) 2013 by Hadi Nategh <hn-AT-stylite.de>
* @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License
* @version $Id$
*/
include_once(EGW_INCLUDE_ROOT.'/etemplate/inc/class.etemplate.inc.php');
class mail_sieve
{
var $public_functions = array
(
'editVacation' => True,
'index' => True,
'edit' => True,
'editEmailNotification'=> True, // Added email notifications
);
/**
* Flag if we can do a timed vaction message, requires Cyrus Admin User/Pw to enable/disable via async service
*
* @var boolean
*/
var $timed_vacation;
//var $scriptName = 'felamimail';
/**
* @var emailadmin_sieve
*/
var $bosieve;
var $errorStack;
var $tmpl;
var $etmpl;
var $vtmpl;
var $eNotitmpl;
var $mailbo;
var $extraAddr;
var $currentIdentity;
/**
* Constructor
*
*
*/
function __construct()
{
$this->displayCharset = translation::charset();
$profileID = 0;
if (isset($GLOBALS['egw_info']['user']['preferences']['mail']['ActiveProfileID']))
{
$profileID = (int) $GLOBALS['egw_info']['user']['preferences']['mail']['ActiveProfileID'];
}
$this->mailbo = mail_bo::getInstance(false, $profileID, false,false);
$this->mailPreferences =& $this->mailbo->mailPreferences;
$this->mailConfig = config::read('mail');
$allIdentities = mail_bo::getAllIdentities();
$defaultIdentity = $this->mailbo->getDefaultIdentity();
$this->currentIdentity = $allIdentities[$defaultIdentity];
$this->currentIdentity['identity_string'] = mail_bo::generateIdentityString($allIdentities[$defaultIdentity],true);
$this->restoreSessionData();
$this->bosieve = $this->mailbo->icServer;
$this->timed_vacation = $this->bosieve->enableSieve && $this->bosieve->acc_imap_administration;
}
/**
* Sieve rules list
*
* @param {array} $content=null
* @param {string} $msg=null
*/
function index(array $content=null,$msg=null)
{
//Instantiate an etemplate_new object
$tmpl = new etemplate_new('mail.sieve.index');
if ($msg)
{
$content['msg'] = $msg;
}
if ($this->mailbo->icServer->enableSieve)
{
//Initializes the Grid contents
$content['rg']= $this->get_rows();
// Set content-menu actions
$tmpl->set_cell_attribute('rg', 'actions',$this->get_actions());
$sel_options = array(
'status' => array(
'ENABLED' => lang('Enabled'),
'DISABLED' => lang('Disabled'),
)
);
}
else
{
$content['msg'] = lang('error').':'.lang('Serverside Filterrules (Sieve) are not activated').'. '.lang('Please contact your Administrator to validate if your Server supports Serverside Filterrules, and how to enable them in EGroupware for your active Account (%1) with ID:%2.',$this->currentIdentity['identity_string'],$this->mailbo->profileID);
$content['hideIfSieveDisabled']='mail_DisplayNone';
}
$tmpl->exec('mail.mail_sieve.index',$content,$sel_options,array());
}
/**
* Email Notification Edit
*
*
* @param {array} $content
* @param {string} $msg
*/
function editEmailNotification($content=null, $msg='')
{
//Instantiate an etemplate_new object, representing sieve.emailNotification
$eNotitmpl = new etemplate_new('mail.sieve.emailNotification');
if ($this->mailbo->icServer->enableSieve)
{
$eNotification = $this->getEmailNotification();
if (!is_array($content))
{
$content = $eNotification;
if (!empty($eNotification['externalEmail']))
{
$content['externalEmail'] = explode(",",$eNotification['externalEmail']);
}
}
else
{
$this->restoreSessionData();
list($button) = @each($content['button']);
unset ($content['button']);
switch($button)
{
case 'save':
case 'apply':
if (isset($content['status']))
{
$newEmailNotification = $content;
if (empty($this->mailPreferences['prefpreventforwarding']) ||
$this->mailPreferences['prefpreventforwarding'] == 0 )
{
if (is_array($content['externalEmail']) && !empty($content['externalEmail']))
{
$newEmailNotification['externalEmail'] = implode(",",$content['externalEmail']);
}
}
}
if (isset($content['externalEmail']) && !empty($content['externalEmail']))
{
if (!$this->bosieve->setEmailNotification($this->scriptName, $newEmailNotification))
{
$msg = lang("email notification update failed")."<br />";
break;
}
else
{
$msg .= lang("email notification successfully updated!");
}
}
else
{
$msg .= lang('email notification update failed! You need to set an email address!');
break;
}
egw_framework::refresh_opener($msg, 'mail');
if ($button === 'apply')
{
break;
}
case 'cancel':
egw_framework::window_close();
common::egw_exit();
}
$this->saveSessionData();
}
$sel_options = array(
'status' => array(
'on' => lang('Active'),
'off' => lang('Deactive'),
),
'displaySubject' => array(
0 => lang('No'),
1 => lang('Yes'),
),
);
$content['msg'] = $msg;
}
else
{
$content['msg'] = lang('error').':'.lang('Serverside Filterrules (Sieve) are not activated').'. '.lang('Please contact your Administrator to validate if your Server supports Serverside Filterrules, and how to enable them in EGroupware for your active Account (%1) with ID:%2.',$this->currentIdentity['identity_string'],$this->mailbo->profileID);
$content['hideIfSieveDisabled']='mail_DisplayNone';
}
$eNotitmpl->exec('mail.mail_sieve.editEmailNotification', $content,$sel_options);
}
/**
* Sieve rules edit
*
*
* @param {array} $content=null
*/
function edit ($content=null)
{
//Instantiate an etemplate_new object, representing sieve.edit template
$etmpl = new etemplate_new('mail.sieve.edit');
if (!is_array($content))
{
if ( $this->getRules($_GET['ruleID']) && isset($_GET['ruleID']))
{
$rules = $this->rulesByID;
$content= $rules;
switch ($rules['action'])
{
case 'folder':
$content['action_folder_text'][] = translation::convert($rules['action_arg'],'utf-8','utf7-imap');
break;
case 'address':
$content['action_address_text'][] = $rules['action_arg'];
break;
case 'reject':
$content['action_reject_text'] = $rules['action_arg'];
}
}
else // Adding new rule
{
$this->getRules(null);
$newRulePriority = count($this->rules)*2+1;
$newRules ['priority'] = $newRulePriority;
$newRules ['status'] = 'ENABLED';
$readonlys = array(
'button[delete]' => 'true',
);
$this->rulesByID = $newRules;
$content = $this->rulesByID;
}
$this->saveSessionData();
}
else
{
$this->restoreSessionData();
list($button) = @each($content['button']);
//$ruleID is calculated by priority from the selected rule and is an unique ID
$ruleID = ($this->rulesByID['priority'] -1) / 2;
$error = 0;
switch ($button)
{
case 'save':
case 'apply':
if($content)
{
unset($content['button']);
$newRule = $content;
$newRule['priority'] = $this->rulesByID['priority'];
$newRule['status'] = $this->rulesByID['status'];
switch ($content['action'])
{
case 'folder':
$newRule['action_arg'] = translation::convert(implode($content['action_folder_text']), 'utf7-imap', 'utf-8');
break;
case 'address':
$newRule['action_arg'] = implode($content['action_address_text']);
//error_log(__METHOD__. '() newRules_address '. array2string($newRule['action_arg']));
break;
case 'reject':
$newRule['action_arg'] = $content['action_reject_text'];
}
unset($newRule['action_folder_text']);
unset($newRule['action_address_text']);
unset($newRule['action_reject_text']);
$newRule['flg'] = 0 ;
if( $newRule['continue'] ) { $newRule['flg'] += 1; }
if( $newRule['gthan'] ) { $newRule['flg'] += 2; }
if( $newRule['anyof'] ) { $newRule['flg'] += 4; }
if( $newRule['keep'] ) { $newRule['flg'] += 8; }
if( $newRule['regexp'] ) { $newRule['flg'] += 128; }
if($newRule['action'] && $this->rulesByID['priority'])
{
$this->rules[$ruleID] = $newRule;
$ret = $this->bosieve->setRules($this->scriptName, $this->rules);
if (!$ret && !empty($this->bosieve->error))
{
$msg .= lang("Saving the rule failed:")."<br />".$this->bosieve->error."<br />";
}
else
{
$msg .= lang("The rule with priority %1 successfully saved!",$ruleID);
}
$this->saveSessionData();
}
else
{
$msg .= "\n".lang("Error: Could not save rule").' '.lang("No action defined!");
$error++;
}
}
else
{
$msg .= "\n".lang("Error: Could not save rule").' '.lang("No action defined!");
$error++;
}
egw_framework::refresh_opener($msg, 'mail');
if ($button == "apply")
{
break;
}
//fall through
case 'delete':
if ($button == "delete")
{
$msg = $this->ajax_action(false,$button, $ruleID, $msg);
}
egw_framework::refresh_opener($msg, 'mail');
case 'cancel':
egw_framework::window_close();
common::egw_exit();
}
}
$sel_options = array(//array_merge($sel_options,array(
'anyof' => array(
0 => lang('all of'),
1 => lang('any of'),
),
'gthan' => array(
0 => lang('less than'),
1 => lang('greater than'),
),
'bodytransform' => array(
0 => 'raw',
1 => 'text',
),
'ctype' => emailadmin_script::$btransform_ctype_array,
);
//Set the preselect_options for mail/folders as we are not allow free entry for folder taglist
$mailCompose = new mail_compose();
$sel_options['action_folder_text'] = $mailCompose->ajax_searchFolder(0,true);
return $etmpl->exec('mail.mail_sieve.edit',$content,$sel_options,$readonlys,array(),2);
}
/**
* Read email notification script from the sieve script from server
*
*
* @return type, returns array of email notification data, and in case of failure returns false
*/
function getEmailNotification()
{
if(!(empty($this->mailPreferences['prefpreventnotificationformailviaemail']) || $this->mailPreferences['prefpreventnotificationformailviaemail'] == 0))
{
throw new egw_exception_no_permission();
}
if($this->bosieve->getScript($this->scriptName))
{
if(PEAR::isError($error = $this->bosieve->retrieveRules($this->scriptName)) )
{
$rules = array();
$emailNotification = array();
}
else
{
$rules = $this->bosieve->getRules($this->scriptName);
$emailNotification = $this->bosieve->getEmailNotification($this->scriptName);
}
}
else
{
// something went wrong
error_log(__METHOD__.__LINE__.' failed');
return false;
}
return $emailNotification;
}
/**
* Fetch Vacation rules and predefined Addresses from mailserver
*
* @param {array} $vacation
* @param {string} $msg
*
* @return {array} return multi-dimentional array of vacation and aliases
*/
function getVacation(&$vacation,&$msg)
{
//$response->call('app.mail.sieve_vac_response_addresses');
if(!(empty($this->mailPreferences['prefpreventabsentnotice']) || $this->mailPreferences['prefpreventabsentnotice'] == 0))
{
throw new egw_exception_no_permission();
}
if($this->bosieve->getScript($this->scriptName))
{
if(PEAR::isError($error = $this->bosieve->retrieveRules($this->scriptName)) )
{
$vacation = array();
}
else
{
$vacation = $this->bosieve->getVacation($this->scriptName);
}
}
else
{
// something went wrong
$msg = lang('Unable to fetch vacation!');
}
$allIdentities = mail_bo::getAllIdentities();
foreach($allIdentities as &$singleIdentity)
{
$predefinedAddresses[$singleIdentity['ident_email']] = $singleIdentity['ident_email'];
}
asort($predefinedAddresses);
return array(
'vacation' =>$vacation,
'aliases' => array_values($predefinedAddresses),
'defaultProfile' => $allIdentities[$this->mailbo->getDefaultIdentity()]
);
}
/**
* Vacation edit
*
* @param {array} $content
* @param {string} $msg
*/
function editVacation($content=null, $msg='')
{
//Instantiate an etemplate_new object, representing the sieve.vacation template
$vtmpl = new etemplate_new('mail.sieve.vacation');
$vacation = array();
if ($this->mailbo->icServer->enableSieve)
{
$vacRules = $this->getVacation($vacation,$msg);
//$this->timed_vacation=true;//this could force the timed vacation thingy even if not supported ;-)
if ($this->timed_vacation)
{
$ByDate = array('by_date' => lang('By date'));
}
if (!is_array($content))
{
$content = $vacation = $vacRules['vacation'];
if (empty($vacation['addresses']))
{
$content['addresses']='';
}
if (!empty($vacation['forwards']))
{
$content['forwards'] = explode(",",$vacation['forwards']);
}
else
{
$content['forwards'] = '';
}
//Set default value for days new entry
if (empty($content['days']))
{
$content['days'] = '3';
}
}
else
{
$this->restoreSessionData();
list($button) = @each($content['button']);
unset ($content['button']);
switch($button)
{
case 'save':
case 'apply':
if ($GLOBALS['egw_info']['user']['apps']['admin'])
{
// store text as default
if ($content['set_as_default'] == 1)
{
config::save_value('default_vacation_text', $content['text'], 'mail');
}
}
if (isset($content['status']))
{
//error_log(__METHOD__. 'content:' . array2string($content));
$newVacation = $content;
if (empty($this->mailPreferences['prefpreventforwarding']) ||
$this->mailPreferences['prefpreventforwarding'] == 0 )
{
if (is_array($content['forwards']) && !empty($content['forwards']))
{
$newVacation['forwards'] = implode(",",$content['forwards']);
}
else
{
$newVacation ['forwards'] = '';
}
}
else
{
unset($newVacation ['forwards']);
}
if (!in_array($newVacation['status'],array('on','off','by_date')))
{
$newVacation['status'] = 'off';
}
$checkAddresses = (isset($content['check_mail_sent_to']) && ($content['check_mail_sent_to']) != 0) ? true: false;
if ($content['addresses'])
{
$newVacation ['addresses'] = $content['addresses'];
}
else
{
}
if($this->checkRule($newVacation,$checkAddresses))
{
if (!$this->bosieve->setVacation($this->scriptName, $newVacation))
{
$msg = lang('vacation update failed') . "\n" . lang('Vacation notice update failed') . ":" . $this->bosieve->error;
break;
}
else
{
if (!isset($newVacation['scriptName']) || empty($newVacation['scriptName']))
{
$newVacation['scriptName'] = $this->scriptName;
}
$this->bosieve->setAsyncJob($newVacation);
$msg = lang('Vacation notice sucessfully updated.');
}
}
else
{
$msg .= implode("\n",$this->errorStack);
}
// refresh vacationNotice on index
$response = egw_json_response::get();
$response->call('app.mail.mail_callRefreshVacationNotice',$this->mailbo->profileID);
egw_framework::refresh_opener($msg, 'mail','edit');
if ($button === 'apply' || $this->bosieve->error !=="")
{
break;
}
}
case 'cancel':
egw_framework::window_close();
}
}
$sel_options = array(
'status' => array(
'on' => lang('Active'),
'off' => lang('Deactive'),
),
'addresses' => array_combine($vacRules['aliases'],$vacRules['aliases']),
);
if (!empty($ByDate))
{
$sel_options['status'] += $ByDate;
}
$content['msg'] = $msg;
}
else
{
$content['msg'] = lang('error').':'.lang('Serverside Filterrules (Sieve) are not activated').'. '.lang('Please contact your Administrator to validate if your Server supports Serverside Filterrules, and how to enable them in EGroupware for your active Account (%1) with ID:%2.',$this->currentIdentity['identity_string'],$this->mailbo->profileID);
$content['hideIfSieveDisabled']='mail_DisplayNone';
}
$vtmpl->exec('mail.mail_sieve.editVacation',$content,$sel_options,array(),array(),2);
}
/**
* Checking vaction validation
*
* @param {array} $_vacation
* @param {boolean} $_checkAddresses
*
* @return boolean
*/
function checkRule($_vacation,$_checkAddresses=true)
{
$this->errorStack = array();
if (!$_vacation['text'])
{
$this->errorStack['text'] = lang('Please supply the message to send with auto-responses').'! ';
}
if (!$_vacation['days'])
{
$this->errorStack['days'] = lang('Please select the number of days to wait between responses').'!';
}
if(is_array($_vacation['addresses']) && !empty($_vacation['addresses']))
{
$regexp="/^[a-z0-9]+([_\\.-][a-z0-9]+)*@([a-z0-9]+([\.-][a-z0-9]+)*)+\\.[a-z]{2,}$/i";
foreach ($_vacation['addresses'] as $addr)
{
if (!preg_match($regexp,$addr) && $_checkAddresses)
{
$this->errorStack['addresses'] = lang('One address is not valid').'!';
}
}
}
else
{
$this->errorStack['addresses'] = lang('Please select a address').'!';
}
if ($_vacation['status'] == 'by_date')
{
if (!$_vacation['start_date'] || !$_vacation['end_date'])
{
$this->errorStack['status'] = lang('Activating by date requires a start- AND end-date!');
}
elseif($_vacation['start_date'] > $_vacation['end_date'])
{
$this->errorStack['status'] = lang('Vacation start-date must be BEFORE the end-date!');
}
}
if ($_vacation['forwards'])
{
foreach(preg_split('/, ?/',$_vacation['forwards']) as $addr)
{
if (!preg_match($regexp,$addr) && $_checkAddresses)
{
$this->errorStack['forwards'] = lang('One address is not valid'.'!');
}
}
}
//error_log(__METHOD__. array2string($this->errorStack));
if(count($this->errorStack) == 0)
{
return true;
}
else
{
$this->errorStack['message'] = lang('Vacation notice is not saved yet! (But we filled in some defaults to cover some of the above errors. Please correct and check your settings and save again.)');
return false;
}
}
/**
* Move rule to an other position in list
*
* @param {array} $orders
*/
function ajax_moveRule($orders)
{
foreach ($orders as $keys => $val)
{
$orders[$keys] = $val -1;
}
$this->getRules(null);
$newrules = $this->rules;
foreach($orders as $keys => $ruleID)
{
$newrules[$keys] = $this->rules[$ruleID];
}
$this->rules = $newrules;
$this->updateScript();
$this->saveSessionData();
//Calling to referesh after move action
$response = egw_json_response::get();
$response->call('app.mail.sieve_refresh');
}
/**
* Ajax function to handle the server side content for refreshing the form
*
* @param type $execId,
*
*/
function ajax_sieve_egw_refresh($execId)
{
//Need to read the template to use for refreshing the form
$response = egw_json_response::get();
$response->generic('assign',array(
'etemplate_exec_id' => $execId,
'id' => 'rg',
'key' => 'value',
'value' => array('content' => $this->get_rows())
));
//error_log(__METHOD__. "RESPONSE".array2string($response));
}
/**
* Ajax function to handle actions over sieve rules list on gd
*
* @param {int|boolean} $exec_id template unique Id | false if we only wants to use serverside actions
* @param {string} $actions name of action
* @param {string} $checked the selected rule id
* @param {string} $msg containing the message comming from the client-side
*
*/
function ajax_action($exec_id, $action,$checked,$msg)
{
$this->getRules(null);
switch ($action)
{
case 'delete':
if ($checked === count($this->rules)-1)
{
$msg = lang('rule with priority ') . $checked . lang(' deleted!');
}else
{
$msg = lang('rule with priority ') . $checked . lang(' deleted!') . lang(' And the rule with priority %1, now got the priority %2',$checked+1,$checked);
}
unset($this->rules[$checked]);
$this->rules = array_values($this->rules);
break;
case 'enable':
$msg = lang('rule with priority ') . $checked . lang(' enabled!');
$this->rules[$checked][status] = 'ENABLED';
break;
case 'disable':
$msg = lang('rule with priority ') . $checked . lang(' disabled!');
$this->rules[$checked][status] = 'DISABLED';
break;
case 'move':
break;
}
ob_start();
$result = $this->updateScript();
if($result)
{
egw_json_response::get()->error($result);
return;
}
$this->saveSessionData();
//Refresh the grid
if ($exec_id)
{
$this->ajax_sieve_egw_refresh($exec_id,$msg);
}
else
{
return $msg;
}
}
/**
* Convert an script seive format rule to human readable format
*
* @param {array} $rule Array of rules
* @return {string} return the rule as a string.
*/
function buildRule($rule)
{
$andor = ' '. lang('and') .' ';
$started = 0;
if ($rule['anyof'])
{
$andor = ' '. lang('or') .' ';
}
$complete = lang('IF').' ';
if ($rule['unconditional'])
{
$complete = "[Unconditional] ";
}
if ($rule['from'])
{
$match = $this->setMatchType($rule['from'],$rule['regexp']);
$complete .= "'From:' " . $match . " '" . $rule['from'] . "'";
$started = 1;
}
if ($rule['to'])
{
if ($started)
{
$complete .= $andor;
}
$match = $this->setMatchType($rule['to'],$rule['regexp']);
$complete .= "'To:' " . $match . " '" . $rule['to'] . "'";
$started = 1;
}
if ($rule['subject'])
{
if ($started)
{
$complete .= $andor;
}
$match = $this->setMatchType($rule['subject'],$rule['regexp']);
$complete .= "'Subject:' " . $match . " '" . $rule['subject'] . "'";
$started = 1;
}
if ($rule['field'] && $rule['field_val'])
{
if ($started)
{
$complete .= $andor;
}
$match = $this->setMatchType($rule['field_val'],$rule['regexp']);
$complete .= "'" . $rule['field'] . "' " . $match . " '" . $rule['field_val'] . "'";
$started = 1;
}
if ($rule['size'])
{
$xthan = " less than '";
if ($rule['gthan'])
{
$xthan = " greater than '";
}
if ($started)
{
$complete .= $andor;
}
$complete .= "message " . $xthan . $rule['size'] . "KB'";
$started = 1;
}
if (!empty($rule['field_bodytransform']))
{
if ($started)
{
$newruletext .= ", ";
}
$btransform = " :raw ";
$match = ' :contains';
if ($rule['bodytransform'])
{
$btransform = " :text ";
}
if (preg_match("/\*|\?/", $rule['field_bodytransform']))
{
$match = ':matches';
}
if ($rule['regexp'])
{
$match = ':regex';
}
$complete .= " body " . $btransform . $match . " \"" . $rule['field_bodytransform'] . "\"";
$started = 1;
}
if ($rule['ctype']!= '0' && !empty($rule['ctype']))
{
if ($started)
{
$newruletext .= ", ";
}
$btransform_ctype = emailadmin_script::$btransform_ctype_array[$rule['ctype']];
$ctype_subtype = "";
if ($rule['field_ctype_val'])
{
$ctype_subtype = "/";
}
$complete .= " body :content " . " \"" . $btransform_ctype . $ctype_subtype . $rule['field_ctype_val'] . "\"" . " :contains \"\"";
$started = 1;
//error_log(__CLASS__."::".__METHOD__.array2string(emailadmin_script::$btransform_ctype_array));
}
if (!$rule['unconditional'])
{
$complete .= ' '.lang('THEN').' ';
}
if (preg_match("/folder/i",$rule['action']))
{
$complete .= lang('file into')." '" . $rule['action_arg'] . "';";
}
if (preg_match("/reject/i",$rule['action']))
{
$complete .= lang('reject with')." '" . $rule['action_arg'] . "'.";
}
if (preg_match("/address/i",$rule['action']))
{
$complete .= lang('forward to').' ' . $rule['action_arg'] .'.';
}
if (preg_match("/discard/i",$rule['action']))
{
$complete .= lang('discard').'.';
}
if ($rule['continue'])
{
$complete .= " [Continue]";
}
if ($rule['keep'])
{
$complete .= " [Keep a copy]";
}
return $complete;
}
/**
* Helper function to find the type of content
*
* @param {string} $matchstr string that should be compared
* @param {string} $regex regular expresion as pattern to be matched
* @return {string} return the type
*/
function setMatchType (&$matchstr, $regex = false)
{
$match = lang('contains');
if (preg_match("/^\s*!/", $matchstr))
{
$match = lang('does not contain');
}
if (preg_match("/\*|\?/", $matchstr))
{
$match = lang('matches');
if (preg_match("/^\s*!/", $matchstr))
{
$match = lang('does not match');
}
}
if ($regex)
{
$match = lang('matches regexp');
if (preg_match("/^\s*!/", $matchstr))
{
$match = lang('does not match regexp');
}
}
if ($regex && preg_match("/^\s*\\\\!/", $matchstr))
{
$matchstr = preg_replace("/^\s*\\\\!/","!",$matchstr);
}
else
{
$matchstr = preg_replace("/^\s*!/","",$matchstr);
}
return $match;
}
/**
* Save session data
*
*
*/
function saveSessionData()
{
$sessionData['sieve_rules'] = $this->rules;
$sessionData['sieve_rulesByID'] = $this->rulesByID;
$sessionData['sieve_scriptToEdit'] = $this->scriptToEdit;
$GLOBALS['egw']->session->appsession('sieve_session_data','',$sessionData);
}
/**
* Update the sieve script on mail server
*
*
*/
function updateScript()
{
if (!$this->bosieve->setRules($this->scriptToEdit, $this->rules))
{
return "update failed";
}
}
/**
* getRules()
* Fetched rules save on array()rules.
*
* @param {string} $ruleID Numeric Id of the rule if specify return the specitic rule| otherwise ruleByID would be null
*
* @return {boolean} returns false in case of failure and true in case of success.
*/
function getRules($ruleID = null)
{
if(($script = $this->bosieve->getScript($this->scriptName)))
{
$this->scriptToEdit = $this->scriptName;
if(PEAR::isError($error = $this->bosieve->retrieveRules($this->scriptName)) )
{
error_log(__METHOD__.__LINE__.$error->message);
$this->rules = array();
$this->rulesByID = array();
$this->vacation = array();
}
else
{
$this->rules = $this->bosieve->getRules($this->scriptName);
$this->rulesByID = $this->rules[$ruleID];
$this->vacation = $this->bosieve->getVacation($this->scriptName);
}
return true;
}
else
{
// something went wrong
error_log(__METHOD__.__LINE__.' failed');
return false;
}
//error_log(__METHOD__.array2string( $script));
}
/**
* Restore session data
*
*/
function restoreSessionData()
{
$sessionData = $GLOBALS['egw']->session->appsession('sieve_session_data');
$this->rules = $sessionData['sieve_rules'];
$this->rulesByID = $sessionData['sieve_rulesByID'];
$this->scriptToEdit = $sessionData['sieve_scriptToEdit'];
}
/**
*
* Get the data for iterating the rows on rules list grid
* @param {array} $rows Array of rows
* @param {array} $readonlys Array of readonlys contents
*
* @return {boolean|array} Array of rows | false if failed
*/
function get_rows(&$rows)
{
$rows = array();
$this->getRules(null); /* ADDED BY GHORTH */
//$this->saveSessionData();
if (is_array($this->rules) && !empty($this->rules) )
{
$rows = $this->rules;
foreach ($rows as &$row )
{
$row['rules'] = $this->buildRule($row);
$row['ruleID'] =(string)(($row['priority'] -1) / 2 );
if ($row ['status'] === 'DISABLED')
{
$row['class'] = 'mail_sieve_DISABLED';
}
}
}else
{
//error_log(__METHOD__.'There are no rules or something is went wrong at getRules()!');
return false;
}
// Shift one down, because in grid the first row is reserved for header
array_unshift($rows,array(''=> ''));
return $rows;
}
/**
* Get actions / context menu for index
*
* @return {array} returns defined actions as an array
*/
private function get_actions()
{
$actions =array(
'edit' => array(
'caption' => 'Edit',
'default' => true,
'onExecute' => 'javaScript:app.mail.action',
'disableClass' => 'th'
),
'add' => array(
'caption' => 'Add',
'onExecute' => 'javaScript:app.mail.action'
),
'enable' => array(
'caption' => 'Enable',
'onExecute' => 'javaScript:app.mail.action',
'enableClass' => 'mail_sieve_DISABLED',
'hideOnDisabled' => true
),
'disable' => array(
'caption' => 'Disable',
'onExecute' => 'javaScript:app.mail.action',
'disableClass' => 'mail_sieve_DISABLED',
'hideOnDisabled' => true
),
'delete' => array(
'caption' => 'Delete',
'onExecute' => 'javaScript:app.mail.action'
),
);
return $actions;
}
}