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
|
<?php
/*
+-----------------------------------------------------------------------+
| rcube_sieve class for managesieve operations (using PEAR::Net_Sieve) |
| |
| Author: Aleksander Machniak <alec@alec.pl> |
| Modifications by: Philip Weir |
| * Make ruleset name configurable |
| * Added import functions |
+-----------------------------------------------------------------------+
*/
define('SIEVE_ERROR_CONNECTION', 1);
define('SIEVE_ERROR_LOGIN', 2);
define('SIEVE_ERROR_NOT_EXISTS', 3); // script not exists
define('SIEVE_ERROR_INSTALL', 4); // script installation
define('SIEVE_ERROR_ACTIVATE', 5); // script activation
define('SIEVE_ERROR_OTHER', 255); // other/unknown error
class rcube_sieve
{
private $sieve;
private $ruleset;
private $importers = array();
private $elsif;
private $cache = false;
public $error = false;
public $list = array();
public $script;
public function __construct($username, $password, $host, $port, $auth_type = NULL, $usetls, $ruleset, $dir, $elsif = true, $auth_cid = NULL, $auth_pw = NULL)
{
$this->sieve = new Net_Sieve();
$data = rcube::get_instance()->plugins->exec_hook('sieverules_connect', array(
'username' => $username, 'password' => $password, 'host' => $host, 'port' => $port,
'auth_type' => $auth_type, 'usetls' => $usetls, 'ruleset' => $ruleset, 'dir' => $dir,
'elsif' => $elsif, 'auth_cid' => $auth_cid, 'auth_pw' => $auth_pw));
$username = $data['username'];
$password = $data['password'];
$host = $data['host'];
$port = $data['port'];
$auth_type = $data['auth_type'];
$usetls = $data['usetls'];
$ruleset = $data['ruleset'];
$dir = $data['dir'];
$elsif = $data['elsif'];
$auth_cid = $data['auth_cid'];
$auth_pw = $data['auth_pw'];
if (PEAR::isError($this->sieve->connect($host, $port, NULL, $usetls)))
return $this->_set_error(SIEVE_ERROR_CONNECTION);
if (!empty($auth_cid)) {
$authz = $username;
$username = $auth_cid;
$password = $auth_pw;
}
if (PEAR::isError($this->sieve->login($username, $password, $auth_type ? strtoupper($auth_type) : NULL, $authz)))
return $this->_set_error(SIEVE_ERROR_LOGIN);
$this->ruleset = $ruleset;
$this->elsif = $elsif;
if ($this->ruleset !== false) {
$this->get_script();
}
else {
$this->ruleset = $this->get_active();
$this->get_script();
}
// init importers
$dir = slashify(realpath(slashify($dir) . 'importFilters/'));
$handle = opendir($dir);
while ($importer = readdir($handle)) {
if (is_file($dir . $importer) && is_readable($dir . $importer)) {
include($dir . $importer);
$importer = substr($importer, 0, -4);
$importer = 'srimport_' . $importer;
if (class_exists($importer, false)) {
$importerClass = new $importer();
$this->importers[$importer] = $importerClass;
}
}
}
closedir($handle);
}
public function __destruct()
{
$this->sieve->disconnect();
}
public function error()
{
return $this->error ? $this->error : false;
}
public function save($script = '')
{
if (!$script)
$script = $this->script->as_text();
if (!$script)
$script = '/* empty script */';
// allow additional actions before ruleset is saved
$data = rcube::get_instance()->plugins->exec_hook('sieverules_save', array(
'ruleset' => $this->ruleset, 'script' => $script));
if ($data['abort'])
return $data['message'] ? $data['message'] : false;
if (PEAR::isError($this->sieve->installScript($this->ruleset, $data['script'])))
return $this->_set_error(SIEVE_ERROR_INSTALL);
if ($this->cache) $_SESSION['sieverules_script_cache_' . $this->ruleset] = serialize($this->script);
return true;
}
public function get_extensions()
{
if ($this->sieve) {
$ext = $this->sieve->getExtensions();
$ext = array_map('strtolower', (array) $ext);
return $ext;
}
}
public function check_import()
{
$result = false;
foreach ($this->list as $ruleset) {
if ($ruleset == $this->ruleset)
continue;
$script = $this->sieve->getScript($ruleset);
foreach ($this->importers as $id => $importer) {
if ($importer->detector($script)) {
$result = array($id, $importer->name, $ruleset);
break;
}
}
}
return $result;
}
public function do_import($type, $ruleset)
{
$script = $this->sieve->getScript($ruleset);
$content = $this->importers[$type]->importer($script);
$this->script->import_filters($content);
if (is_array($content))
return $this->save();
else
return $this->save($content);
}
public function get_script()
{
if (!$this->sieve)
return false;
if ($this->cache && $_SESSION['sieverules_script_cache']) {
$this->list = unserialize($_SESSION['sieverules_scripts_list']);
$this->script = unserialize($_SESSION['sieverules_script_cache_' . $this->ruleset]);
return;
}
$this->list = $this->sieve->listScripts();
if (PEAR::isError($this->list))
return $this->_set_error(SIEVE_ERROR_OTHER);
if (in_array($this->ruleset, $this->list)) {
$script = $this->sieve->getScript($this->ruleset);
if (PEAR::isError($script))
return $this->_set_error(SIEVE_ERROR_OTHER);
}
else {
$this->_set_error(SIEVE_ERROR_NOT_EXISTS);
$script = '';
}
$data = rcube::get_instance()->plugins->exec_hook('sieverules_load', array(
'ruleset' => $this->ruleset, 'script' => $script));
$this->script = new rcube_sieve_script($data['script'], $this->get_extensions(), $this->elsif);
if ($this->cache) {
$_SESSION['sieverules_scripts_list'] = serialize($this->list);
$_SESSION['sieverules_script_cache_' . $this->ruleset] = serialize($this->script);
}
}
public function get_active()
{
return $this->sieve->getActive();
}
public function set_active($ruleset)
{
if (PEAR::isError($this->sieve->setActive($ruleset)))
return $this->_set_error(SIEVE_ERROR_ACTIVATE);
return true;
}
public function del_script($script)
{
return $this->sieve->removeScript($script);
}
public function set_ruleset($ruleset)
{
$this->ruleset = $ruleset;
$this->get_script();
}
public function set_debug($debug)
{
$this->sieve->setDebug($debug, array($this, 'debug_handler'));
}
public function debug_handler(&$sieve, $message)
{
rcube::write_log('sieverules', preg_replace('/\r\n$/', '', $message));
}
private function _set_error($error)
{
$this->error = $error;
return false;
}
}
?>
|
