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
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
|
<?php
/**
* The Ingo_Script_procmail:: class represents a Procmail script generator.
*
* $Horde: ingo/lib/Script/procmail.php,v 1.46.10.35 2010/03/17 17:04:26 jan Exp $
*
* Copyright 2003-2009 The Horde Project (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/asl.php.
*
* @author Brent J. Nordquist <bjn@horde.org>
* @author Ben Chavet <ben@horde.org>
* @package Ingo
*/
class Ingo_Script_procmail extends Ingo_Script {
/**
* The list of actions allowed (implemented) for this driver.
*
* @var array
*/
var $_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
*/
var $_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
*/
var $_types = array(
INGO_STORAGE_TYPE_HEADER,
INGO_STORAGE_TYPE_BODY
);
/**
* A list of any special types that this driver supports.
*
* @var array
*/
var $_special_types = array(
'Destination',
);
/**
* The list of tests allowed (implemented) for this driver.
*
* @var array
*/
var $_tests = array(
'contains',
'not contain',
'begins with',
'not begins with',
'ends with',
'not ends with',
'regex'
);
/**
* Can tests be case sensitive?
*
* @var boolean
*/
var $_casesensitive = true;
/**
* Does the driver support the stop-script option?
*
* @var boolean
*/
var $_supportStopScript = true;
/**
* Does the driver require a script file to be generated?
*
* @var boolean
*/
var $_scriptfile = true;
/**
* The recipes that make up the code.
*
* @var array
*/
var $_recipes = array();
/**
* Returns a script previously generated with generate().
*
* @return string The procmail script.
*/
function toCode()
{
$code = '';
foreach ($this->_recipes as $item) {
$code .= $item->generate() . "\n";
}
// If an external delivery program is used, add final rule
// to deliver to $DEFAULT
if (isset($this->_params['delivery_agent'])) {
$code .= ":0 w\n";
$code .= isset($this->_params['delivery_mailbox_prefix']) ?
'| ' . $this->_params['delivery_agent'] . ' ' . $this->_params['delivery_mailbox_prefix'] . '$DEFAULT' :
'| ' . $this->_params['delivery_agent'] . ' $DEFAULT';
}
return rtrim($code) . "\n";
}
/**
* Generates the procmail script to do the filtering specified in the
* rules.
*
* @return string The procmail script.
*/
function generate()
{
$filters = &$GLOBALS['ingo_storage']->retrieve(INGO_STORAGE_ACTION_FILTERS);
$this->addItem(new Procmail_Comment(_("procmail script generated by Ingo") . ' (' . date('F j, Y, g:i a') . ')'));
/* Add variable information, if present. */
if (!empty($this->_params['variables']) &&
is_array($this->_params['variables'])) {
foreach ($this->_params['variables'] as $key => $val) {
$this->addItem(new Procmail_Variable(array('name' => $key, 'value' => $val)));
}
}
foreach ($filters->getFilterlist() 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 Procmail_Recipe($filter, $this->_params);
if (!$filter['stop']) {
$recipe->addFlag('c');
}
foreach ($filter['conditions'] as $condition) {
$recipe->addCondition($condition);
}
$this->addItem(new Procmail_Comment($filter['name'], !empty($filter['disable']), true));
$this->addItem($recipe);
} else {
/* Create filter if using OR */
$this->addItem(new Procmail_Comment($filter['name'], !empty($filter['disable']), true));
$loop = 0;
foreach ($filter['conditions'] as $condition) {
$recipe = &new Procmail_Recipe($filter, $this->_params);
if ($loop++) {
$recipe->addFlag('E');
}
if (!$filter['stop']) {
$recipe->addFlag('c');
}
$recipe->addCondition($condition);
$this->addItem($recipe);
}
}
}
}
}
return $this->toCode();
}
/**
* Generates the procmail script to handle the blacklist specified in
* the rules.
*
* @param boolean $disable Disable the blacklist?
*/
function generateBlacklist($disable = false)
{
$blacklist = &$GLOBALS['ingo_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(new 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 Procmail_Recipe($params, $this->_params);
$recipe->addCondition(array('field' => 'From', 'value' => $address, 'match' => 'address'));
$this->addItem($recipe);
}
}
}
}
/**
* Generates the procmail script to handle the whitelist specified in
* the rules.
*
* @param boolean $disable Disable the whitelist?
*/
function generateWhitelist($disable = false)
{
$whitelist = &$GLOBALS['ingo_storage']->retrieve(INGO_STORAGE_ACTION_WHITELIST);
$wl_addr = $whitelist->getWhitelist();
if (!empty($wl_addr)) {
$this->addItem(new Procmail_Comment(_("Whitelisted Addresses"), $disable, true));
foreach ($wl_addr as $address) {
if (!empty($address)) {
$recipe = new Procmail_Recipe(array('action' => INGO_STORAGE_ACTION_KEEP, 'disable' => $disable), $this->_params);
$recipe->addCondition(array('field' => 'From', 'value' => $address, 'match' => 'address'));
$this->addItem($recipe);
}
}
}
}
/**
* Generates the procmail script to handle vacation.
*
* @param boolean $disable Disable vacation?
*/
function generateVacation($disable = false)
{
$vacation = &$GLOBALS['ingo_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(new Procmail_Comment(_("Vacation"), $disable, true));
$params = array('action' => INGO_STORAGE_ACTION_VACATION,
'action-value' => $actionval,
'disable' => $disable);
$recipe = new Procmail_Recipe($params, $this->_params);
$this->addItem($recipe);
}
}
/**
* Generates the procmail script to handle mail forwards.
*
* @param boolean $disable Disable forwarding?
*/
function generateForward($disable = false)
{
$forward = &$GLOBALS['ingo_storage']->retrieve(INGO_STORAGE_ACTION_FORWARD);
$addresses = $forward->getForwardAddresses();
if (!empty($addresses)) {
$this->addItem(new Procmail_Comment(_("Forwards"), $disable, true));
$params = array('action' => INGO_STORAGE_ACTION_FORWARD,
'action-value' => $addresses,
'disable' => $disable);
$recipe = new Procmail_Recipe($params, $this->_params);
if ($forward->getForwardKeep()) {
$recipe->addFlag('c');
}
$this->addItem($recipe);
}
}
/**
* Adds an item to the recipe list.
*
* @param object $item The item to add to the recipe list.
* The object should have a generate() function.
*/
function addItem($item)
{
$this->_recipes[] = $item;
}
}
/**
* The Procmail_Comment:: class represents a Procmail comment. This is
* a pretty simple class, but it makes the code in Ingo_Script_procmail::
* cleaner as it provides a generate() function and can be added to the
* recipe list the same way as a recipe can be.
*
* @author Ben Chavet <ben@chavet.net>
* @since Ingo 1.0
* @package Ingo
*/
class Procmail_Comment {
/**
* The comment text.
*
* @var string
*/
var $_comment = '';
/**
* Constructs a new procmail comment.
*
* @param string $comment Comment to be generated.
* @param boolean $disable Output 'DISABLED' comment?
* @param boolean $header Output a 'header' comment?
*/
function Procmail_Comment($comment, $disable = false, $header = false)
{
if ($disable) {
$comment = _("DISABLED: ") . $comment;
}
if ($header) {
$this->_comment .= "##### $comment #####";
} else {
$this->_comment .= "# $comment";
}
}
/**
* Returns the comment stored by this object.
*
* @return string The comment stored by this object.
*/
function generate()
{
return $this->_comment;
}
}
/**
* The Procmail_Recipe:: class represents a Procmail recipe.
*
* @author Ben Chavet <ben@chavet.net>
* @since Ingo 1.0
* @package Ingo
*/
class Procmail_Recipe {
var $_action = array();
var $_conditions = array();
var $_disable = '';
var $_flags = '';
var $_params = array(
'date' => 'date',
'echo' => 'echo',
'ls' => 'ls'
);
var $_valid = true;
/**
* Constructs a new procmail recipe.
*
* @param array $params Array of parameters.
* REQUIRED FIELDS:
* 'action'
* OPTIONAL FIELDS:
* 'action-value' (only used if the
* 'action' requires it)
* @param array $scriptparams Array of parameters passed to
* Ingo_Script_procmail::.
*/
function Procmail_Recipe($params = array(), $scriptparams = array())
{
$this->_disable = !empty($params['disable']);
$this->_params = array_merge($this->_params, $scriptparams);
switch ($params['action']) {
case INGO_STORAGE_ACTION_KEEP:
// Note: you may have to set the DEFAULT variable in your
// backend configuration.
if (isset($this->_params['delivery_agent']) && isset($this->_params['delivery_mailbox_prefix'])) {
$this->_action[] = '| ' . $this->_params['delivery_agent'] . ' ' . $this->_params['delivery_mailbox_prefix'] . '$DEFAULT';
} elseif (isset($this->_params['delivery_agent'])) {
$this->_action[] = '| ' . $this->_params['delivery_agent'] . ' $DEFAULT';
} else {
$this->_action[] = '$DEFAULT';
}
break;
case INGO_STORAGE_ACTION_MOVE:
if (isset($this->_params['delivery_agent']) && isset($this->_params['delivery_mailbox_prefix'])) {
$this->_action[] = '| ' . $this->_params['delivery_agent'] . ' ' . $this->_params['delivery_mailbox_prefix'] . $this->procmailPath($params['action-value']);
} elseif (isset($this->_params['delivery_agent'])) {
$this->_action[] = '| ' . $this->_params['delivery_agent'] . ' ' . $this->procmailPath($params['action-value']);
} else {
$this->_action[] = $this->procmailPath($params['action-value']);
}
break;
case INGO_STORAGE_ACTION_DISCARD:
$this->_action[] = '/dev/null';
break;
case INGO_STORAGE_ACTION_REDIRECT:
$this->_action[] = '! ' . $params['action-value'];
break;
case INGO_STORAGE_ACTION_REDIRECTKEEP:
$this->_action[] = '{';
$this->_action[] = ' :0 c';
$this->_action[] = ' ! ' . $params['action-value'];
$this->_action[] = '';
$this->_action[] = ' :0' . (isset($this->_params['delivery_agent']) ? ' w' : '');
if (isset($this->_params['delivery_agent']) && isset($this->_params['delivery_mailbox_prefix'])) {
$this->_action[] = ' | ' . $this->_params['delivery_agent'] . ' ' . $this->_params['delivery_mailbox_prefix'] . '$DEFAULT';
} elseif (isset($this->_params['delivery_agent'])) {
$this->_action[] = ' | ' . $this->_params['delivery_agent'] . ' $DEFAULT';
} else {
$this->_action[] = ' $DEFAULT';
}
$this->_action[] = '}';
break;
case INGO_STORAGE_ACTION_REJECT:
$this->_action[] = '{';
$this->_action[] = ' EXITCODE=' . $params['action-value'];
$this->_action[] = ' HOST="no.address.here"';
$this->_action[] = '}';
break;
case INGO_STORAGE_ACTION_VACATION:
require_once 'Horde/MIME.php';
$days = $params['action-value']['days'];
$timed = !empty($params['action-value']['start']) &&
!empty($params['action-value']['end']);
$this->_action[] = '{';
foreach ($params['action-value']['addresses'] as $address) {
if (!empty($address)) {
$this->_action[] = ' :0';
$this->_action[] = ' * ^TO_' . $address;
$this->_action[] = ' {';
$this->_action[] = ' FILEDATE=`test -f ${VACATION_DIR:-.}/\'.vacation.' . $address . '\' && '
. $this->_params['ls'] . ' -lcn --time-style=+%s ${VACATION_DIR:-.}/\'.vacation.' . $address . '\' | '
. 'awk \'{ print $6 + (' . $days * 86400 . ') }\'`';
$this->_action[] = ' DATE=`' . $this->_params['date'] . ' +%s`';
$this->_action[] = ' DUMMY=`test -f ${VACATION_DIR:-.}/\'.vacation.' . $address . '\' && '
. 'test $FILEDATE -le $DATE && '
. 'rm ${VACATION_DIR:-.}/\'.vacation.' . $address . '\'`';
if ($timed) {
$this->_action[] = ' START=' . $params['action-value']['start'];
$this->_action[] = ' END=' . $params['action-value']['end'];
}
$this->_action[] = '';
$this->_action[] = ' :0 h';
$this->_action[] = ' SUBJECT=| formail -xSubject:';
$this->_action[] = '';
$this->_action[] = ' :0 Whc: ${VACATION_DIR:-.}/vacation.lock';
if ($timed) {
$this->_action[] = ' * ? test $DATE -gt $START && test $END -gt $DATE';
$this->_action[] = ' {';
$this->_action[] = ' :0 Wh';
}
$this->_action[] = ' * ^TO_' . $address;
$this->_action[] = ' * !^X-Loop: ' . $address;
$this->_action[] = ' * !^X-Spam-Flag: YES';
if (count($params['action-value']['excludes']) > 0) {
foreach ($params['action-value']['excludes'] as $exclude) {
if (!empty($exclude)) {
$this->_action[] = ' * !^From.*' . $exclude;
}
}
}
if ($params['action-value']['ignorelist']) {
$this->_action[] = ' * !^FROM_DAEMON';
}
$this->_action[] = ' | formail -rD 8192 ${VACATION_DIR:-.}/.vacation.' . $address;
$this->_action[] = ' :0 eh';
$this->_action[] = ' | (formail -rI"Precedence: junk" \\';
$this->_action[] = ' -a"From: <' . $address . '>" \\';
$this->_action[] = ' -A"X-Loop: ' . $address . '" \\';
if (MIME::is8bit($params['action-value']['reason'])) {
$this->_action[] = ' -i"Subject: ' . MIME::encode($params['action-value']['subject'] . ' (Re: $SUBJECT)', NLS::getCharset()) . '" \\';
$this->_action[] = ' -i"Content-Transfer-Encoding: quoted-printable" \\';
$this->_action[] = ' -i"Content-Type: text/plain; charset=' . NLS::getCharset() . '" ; \\';
$reason = MIME::quotedPrintableEncode($params['action-value']['reason'], "\n");
} else {
$this->_action[] = ' -i"Subject: ' . MIME::encode($params['action-value']['subject'] . ' (Re: $SUBJECT)', NLS::getCharset()) . '" ; \\';
$reason = $params['action-value']['reason'];
}
$reason = addcslashes($reason, "\\\n\r\t\"`");
$this->_action[] = ' ' . $this->_params['echo'] . ' -e "' . $reason . '" \\';
$this->_action[] = ' ) | $SENDMAIL -f' . $address . ' -oi -t';
if ($timed) {
$this->_action[] = ' }';
}
$this->_action[] = ' }';
}
}
$this->_action[] = '}';
break;
case INGO_STORAGE_ACTION_FORWARD:
/* Make sure that we prevent mail loops using 3 methods.
*
* First, we call sendmail -f to set the envelope sender to be the
* same as the original sender, so bounces will go to the original
* sender rather than to us. This unfortunately triggers lots of
* Authentication-Warning: messages in sendmail's logs.
*
* Second, add an X-Loop header, to handle the case where the
* address we forward to forwards back to us.
*
* Third, don't forward mailer daemon messages (i.e., bounces).
* Method 1 above should make this redundant, unless we're sending
* mail from this account and have a bad forward-to account.
*
* Get the from address, saving a call to formail if possible.
* The procmail code for doing this is borrowed from the
* Procmail Library Project, http://pm-lib.sourceforge.net/.
* The Ingo project has the permission to use Procmail Library code
* under Apache licence v 1.x or any later version.
* Permission obtained 2006-04-04 from Author Jari Aalto. */
$this->_action[] = '{';
$this->_action[] = ' :0 ';
$this->_action[] = ' *$ ! ^From *\/[^ ]+';
$this->_action[] = ' *$ ! ^Sender: *\/[^ ]+';
$this->_action[] = ' *$ ! ^From: *\/[^ ]+';
$this->_action[] = ' *$ ! ^Reply-to: *\/[^ ]+';
$this->_action[] = ' {';
$this->_action[] = ' OUTPUT = `formail -zxFrom:`';
$this->_action[] = ' }';
$this->_action[] = ' :0 E';
$this->_action[] = ' {';
$this->_action[] = ' OUTPUT = $MATCH';
$this->_action[] = ' }';
$this->_action[] = '';
/* Forward to each address on our list. */
foreach ($params['action-value'] as $address) {
if (!empty($address)) {
$this->_action[] = ' :0 c';
$this->_action[] = ' * !^FROM_MAILER';
$this->_action[] = ' * !^X-Loop: to-' . $address;
$this->_action[] = ' | formail -A"X-Loop: to-' . $address . '" | $SENDMAIL -oi -f $OUTPUT ' . $address;
}
}
/* In case of mail loop or bounce, store a copy locally. Note
* that if we forward to more than one address, only a mail loop
* on the last address will cause a local copy to be saved. TODO:
* The next two lines are redundant (and create an extra copy of
* the message) if "Keep a copy of messages in this account" is
* checked. */
$this->_action[] = ' :0 E' . (isset($this->_params['delivery_agent']) ? 'w' : '');
if (isset($this->_params['delivery_agent'])) {
$this->_action[] = isset($this->_params['delivery_mailbox_prefix']) ?
' | ' . $this->_params['delivery_agent'] . ' ' . $this->_params['delivery_mailbox_prefix'] . '$DEFAULT' :
' | ' . $this->_params['delivery_agent'] . ' $DEFAULT';
} else {
$this->_action[] = ' $DEFAULT';
}
$this->_action[] = ' :0 ';
$this->_action[] = ' /dev/null';
$this->_action[] = '}';
break;
default:
$this->_valid = false;
break;
}
}
/**
* Adds a flag to the recipe.
*
* @param string $flag String of flags to append to the current flags.
*/
function addFlag($flag)
{
$this->_flags .= $flag;
}
/**
* Adds a condition to the recipe.
*
* @param array $condition Array of parameters. Required keys are 'field'
* and 'value'. 'case' is an optional key.
*/
function addCondition($condition = array())
{
$flag = !empty($condition['case']) ? 'D' : '';
$match = isset($condition['match']) ? $condition['match'] : null;
$string = '';
$prefix = '';
switch ($condition['field']) {
case 'Destination':
$string = '^TO_';
break;
case 'Body':
$flag .= 'B';
break;
default:
// convert 'field' to PCRE pattern matching
if (!strpos($condition['field'], ',')) {
$string = '^' . $condition['field'] . ':';
} else {
$string .= '^(' . str_replace(',', '|', $condition['field']) . '):';
}
$prefix = ' ';
}
$reverseCondition = false;
switch ($match) {
case 'regex':
$string .= $prefix . $condition['value'];
break;
case 'address':
$string .= '(.*\<)?' . preg_quote($condition['value']);
break;
case 'not begins with':
$reverseCondition = true;
// fall through
case 'begins with':
$string .= $prefix . preg_quote($condition['value']);
break;
case 'not ends with':
$reverseCondition = true;
// fall through
case 'ends with':
$string .= '.*' . preg_quote($condition['value']) . '$';
break;
case 'not contain':
$reverseCondition = true;
// fall through
case 'contains':
default:
$string .= '.*' . preg_quote($condition['value']);
break;
}
$this->_conditions[] = array('condition' => ($reverseCondition ? '* !' : '* ') . $string,
'flags' => $flag);
}
/**
* Generates procmail code to represent the recipe.
*
* @return string Procmail code to represent the recipe.
*/
function generate()
{
$nest = 0;
$prefix = '';
$text = array();
if (!$this->_valid) {
return '';
}
// Set the global flags for the whole rule, each condition
// will add its own (such as Body or Case Sensitive)
$global = $this->_flags;
if (isset($this->_conditions[0])) {
$global .= $this->_conditions[0]['flags'];
}
$text[] = ':0 ' . $global . (isset($this->_params['delivery_agent']) ? 'w' : '');
foreach ($this->_conditions as $condition) {
if ($nest > 0) {
$text[] = str_repeat(' ', $nest - 1) . '{';
$text[] = str_repeat(' ', $nest) . ':0 ' . $condition['flags'];
$text[] = str_repeat(' ', $nest) . $condition['condition'];
} else {
$text[] = $condition['condition'];
}
$nest++;
}
if (--$nest > 0) {
$prefix = str_repeat(' ', $nest);
}
foreach ($this->_action as $val) {
$text[] = $prefix . $val;
}
for ($i = $nest; $i > 0; $i--) {
$text[] = str_repeat(' ', $i - 1) . '}';
}
if ($this->_disable) {
$code = '';
foreach ($text as $val) {
$comment = new Procmail_Comment($val);
$code .= $comment->generate() . "\n";
}
return $code . "\n";
} else {
return implode("\n", $text) . "\n";
}
}
/**
* Returns a procmail-ready mailbox path, converting IMAP folder
* pathname conventions as necessary.
*
* @param string $folder The IMAP folder name.
*
* @return string The procmail mailbox path.
*/
function procmailPath($folder)
{
/* NOTE: '$DEFAULT' here is a literal, not a PHP variable. */
if (isset($this->_params) &&
($this->_params['path_style'] == 'maildir')) {
if (empty($folder) || ($folder == 'INBOX')) {
return '$DEFAULT';
}
if (substr($folder, 0, 6) == 'INBOX.') {
$folder = substr($folder, 6);
}
return '"$DEFAULT/.' . escapeshellcmd($folder) . '/"';
} else {
if (empty($folder) || ($folder == 'INBOX')) {
return '$DEFAULT';
}
return str_replace(' ', '\ ', escapeshellcmd($folder));
}
}
}
/**
* The Procmail_Variable:: class represents a Procmail variable.
*
* @author Michael Slusarz <slusarz@horde.org>
* @since Ingo 1.0
* @package Ingo
*/
class Procmail_Variable {
var $_name;
var $_value;
/**
* Constructs a new procmail variable.
*
* @param array $params Array of parameters. Expected fields are 'name'
* and 'value'.
*/
function Procmail_Variable($params = array())
{
$this->_name = $params['name'];
$this->_value = $params['value'];
}
/**
* Generates procmail code to represent the variable.
*
* @return string Procmail code to represent the variable.
*/
function generate()
{
return $this->_name . '=' . $this->_value . "\n";
}
}
|
