-
Notifications
You must be signed in to change notification settings - Fork 1
/
email.php
1800 lines (1604 loc) · 52.8 KB
/
email.php
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
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
declare(strict_types=1);
/**
* +------------------------------------------------------------+
* | apnscp |
* +------------------------------------------------------------+
* | Copyright (c) Apis Networks |
* +------------------------------------------------------------+
* | Licensed under Artistic License 2.0 |
* +------------------------------------------------------------+
* | Author: Matt Saladna (msaladna@apisnetworks.com) |
* +------------------------------------------------------------+
*/
/**
* E-mail functions (aliases, virtual mailboxes)
*
* @package core
*/
class Email_Module extends Module_Skeleton implements \Opcenter\Contracts\Hookable, \Module\Skeleton\Contracts\Proxied
{
const DEPENDENCY_MAP = [
'siteinfo',
'ipinfo',
'ipinfo6',
'users',
'aliases',
'dns'
];
const MAILDIR_HOME = \Opcenter\Mail\Storage::MAILDIR_HOME;
const MAILBOX_SPECIAL = 's';
const MAILBOX_FORWARD = 'a';
const MAILBOX_USER = 'v';
const MAILBOX_DISABLED = 'd';
const MAILBOX_ENABLED = 'e';
const MAILBOX_SINGLE = '1';
const MAILBOX_DESTINATION = 'destination';
const VACATION_PREFKEY = 'mail.vacapref';
// webmail installations
const POSTFIX_CMD = '/usr/sbin/postfix';
const DOVECOT_SSL_CONFIG_DIR = '/etc/dovecot/conf.d/ssl';
private $_webmail = array(
'sqmail' => array(
'subdomain' => 'mail',
'path' => '/var/www/html/mail'
),
'horde' => array(
'subdomain' => 'horde',
'path' => '/var/www/html/horde'
),
'roundcube' => array(
'subdomain' => 'roundcube',
'path' => '/var/www/html/roundcube'
)
);
/**
* {{{ void __construct(void)
*
* @ignore
*/
public function __construct()
{
parent::__construct();
$this->exportedFunctions = array(
'address_exists' => PRIVILEGE_SITE | PRIVILEGE_USER,
'create_maildir_backend' => PRIVILEGE_SITE | PRIVILEGE_SERVER_EXEC,
'get_spool_size_backend' => PRIVILEGE_SITE | PRIVILEGE_SERVER_EXEC,
/** Vacation methods */
'add_vacation' => PRIVILEGE_SITE | PRIVILEGE_USER,
'add_vacation_backend' => PRIVILEGE_SITE | PRIVILEGE_USER,
'set_vacation' => PRIVILEGE_SITE | PRIVILEGE_USER,
'set_vacation_options' => PRIVILEGE_SITE | PRIVILEGE_USER,
'get_vacation_options' => PRIVILEGE_SITE | PRIVILEGE_USER,
'vacation_exists' => PRIVILEGE_SITE | PRIVILEGE_USER,
'enable_vacation' => PRIVILEGE_SITE | PRIVILEGE_USER,
'remove_vacation' => PRIVILEGE_SITE | PRIVILEGE_USER,
'get_vacation_message' => PRIVILEGE_SITE | PRIVILEGE_USER,
'change_vacation_message' => PRIVILEGE_SITE | PRIVILEGE_USER,
'get_webmail_location' => PRIVILEGE_SITE | PRIVILEGE_USER,
'webmail_apps' => PRIVILEGE_SITE | PRIVILEGE_USER,
'create_maildir' => PRIVILEGE_SITE | PRIVILEGE_USER,
'remove_maildir' => PRIVILEGE_SITE | PRIVILEGE_USER,
'user_enabled' => PRIVILEGE_SITE | PRIVILEGE_USER,
'get_mail_ip' => PRIVILEGE_SITE | PRIVILEGE_USER,
'get_records' => PRIVILEGE_SITE,
'*' => PRIVILEGE_SITE,
'get_provider' => PRIVILEGE_ALL
);
}
public function _proxy(): \Module_Skeleton
{
$provider = $this->get_provider();
if ($provider === 'builtin') {
return $this;
}
return \Module\Provider::get('mail', $provider, $this->getAuthContext());
}
/**
* Get DNS provider
*
* @return string
*/
public function get_provider(): string
{
return $this->getServiceValue('mail', 'provider', MAIL_PROVIDER_DEFAULT ?? 'builtin');
}
public function list_aliases()
{
return $this->list_mailboxes('forward');
}
/**
* Retrieve mailbox delivery maps from system
*
* @param $filter string optional filter, possible values: forward, local, special, single, enabled, disabled, destination
* @param $address string supplementary argument to 'single', restrict address to %expr%. Mandatory for destination filter type
* @param $domain string optionally restrict to all addresses matching domain
*
* @return array
*
*/
public function list_mailboxes($filter = null, $address = null, $domain = null)
{
$filter_clause = '1=1';
if ($filter == 'forward') {
$filter = self::MAILBOX_FORWARD;
} else if ($filter == 'local') {
$filter = self::MAILBOX_USER;
} else if ($filter == 'special') {
$filter = self::MAILBOX_SPECIAL;
} else if ($filter == 'disabled') {
$filter = self::MAILBOX_DISABLED;
} else if ($filter == 'enabled') {
$filter = self::MAILBOX_ENABLED;
}
if ($filter && !in_array($filter, array(
self::MAILBOX_FORWARD,
self::MAILBOX_USER,
self::MAILBOX_SPECIAL,
self::MAILBOX_DISABLED,
self::MAILBOX_ENABLED,
self::MAILBOX_SINGLE,
self::MAILBOX_DESTINATION
))
) {
return error("invalid filter specification `%s'", $filter);
}
if ($filter == self::MAILBOX_FORWARD) {
$filter_clause = 'type = \'' . self::MAILBOX_FORWARD . '\'';
} else if ($filter == self::MAILBOX_USER) {
$filter_clause = 'type = \'' . self::MAILBOX_USER . '\'';
} else if ($filter == self::MAILBOX_SPECIAL) {
} else if ($filter == self::MAILBOX_SINGLE) {
$filter_clause = 'email_lookup."user" ' . (false !== strpos($address,
'%') ? 'LIKE' : '=') . ' \'' . pg_escape_string($address) . '\'';
} else if ($filter == self::MAILBOX_ENABLED) {
$filter_clause = 'enabled = 1::bit';
} else if ($filter == self::MAILBOX_DISABLED) {
$filter_clause = 'enabled = 0::bit';
} else if ($filter == self::MAILBOX_DESTINATION) {
$filter_clause = 'COALESCE(uids."user",alias_destination) = ' . pg_escape_literal($address);
}
if (null !== $address && $filter !== self::MAILBOX_DESTINATION) {
// @TODO nasty
$filter_clause .= ' AND email_lookup.user = \'' . pg_escape_string(strtolower($address)) . '\'';
}
if ($domain) {
$filter_clause .= ' AND email_lookup.domain = \'' . pg_escape_string(strtolower($domain)) . '\'';
}
$mailboxes = array();
$query = "
SELECT
email_lookup.\"user\",
email_lookup.domain as domain,
type,
enabled,
fs_destination AS target,
uid,
COALESCE(uids.\"user\",alias_destination) as destination
FROM
email_lookup
JOIN
domain_lookup
ON
(email_lookup.domain = domain_lookup.domain)
LEFT JOIN
uids
USING(uid)
WHERE
(domain_lookup.site_id = " . $this->site_id . ") AND " . $filter_clause . " ORDER BY \"user\", domain;";
$pgdb = \PostgreSQL::initialize();
$pgdb->query($query);
while (null !== ($row = $pgdb->fetch_object())) {
$mailboxes[] = array(
'user' => trim($row->user),
'domain' => trim($row->domain),
'type' => $row->type,
'enabled' => (int)$row->enabled,
'mailbox' => $row->destination,
'uid' => (int)$row->uid,
'custom' => ($filter === 'local' ? $row->target : null),
'destination' => $row->destination
);
}
return $mailboxes;
}
public function enable_address($account, $domain = null)
{
$where = 'AND email_lookup.domain = domain_lookup.domain AND domain_lookup.site_id = ' . $this->site_id;
if ($domain) {
$where .= 'AND domain_lookup.domain = \'' . pg_escape_string($domain) . '\'';
}
$pgdb = \PostgreSQL::initialize();
$pgdb->query('UPDATE email_lookup SET enabled = 1::bit FROM domain_lookup WHERE "user" = \'' . pg_escape_string($account) . '\' ' . $where . ';');
return $pgdb->affected_rows() > 0;
}
/**
* @deprecated @link modify_mailbox
*/
public function rename_mailbox($olduser, $olddomain, $newuser, $newdomain, $newmailbox, $newtype = null)
{
return $this->modify_mailbox($olduser, $olddomain, $newuser, $newdomain, $newmailbox, $newtype);
}
/**
* Rename a mailbox
*
* IMPORTANT: a mailbox may not be remapped into a catchall here
*
* @param string $olduser
* @param string $olddomain
* @param string $newuser
* @param string $newdomain
* @param string $newdestination
* @param string|null $newtype
* @return bool
*/
public function modify_mailbox(
string $olduser,
string $olddomain,
string $newuser = '',
string $newdomain = '',
string $newdestination = '',
string $newtype = null
): bool {
$args = array(
'olduser',
'olddomain',
'newuser',
'newdomain',
'newtype'
);
foreach ($args as $var) {
${$var} = strtolower(${$var});
}
if (!$newuser && !$newdomain) {
$newuser = $olduser;
$newdomain = $olddomain;
}
if ($olduser === "majordomo" && $this->majordomo_list_mailing_lists()) {
return error("cannot remove majordomo email address while mailing lists exist");
}
if (($olduser . '@' . $olddomain != $newuser . '@' . $newdomain) && $this->address_exists($newuser,
$newdomain)
) {
return error("Email address %s@%s already exists. Can't rename!",
$newuser, $newdomain);
}
if (!$newtype) {
$newtype = $this->mailbox_type($olduser, $olddomain);
}
$pgdb = \PostgreSQL::initialize();
if ($newtype == self::MAILBOX_USER) {
if (false != ($uid = intval($newdestination))) {
$uid = intval($newdestination);
$local_user = $this->user_get_username_from_uid($uid);
$newdestination = '/home/' . $local_user . '/' . self::MAILDIR_HOME;
if (!$local_user) {
return error("Invalid mailbox destination, invalid uid `%d'", $uid);
}
} else if ($newdestination) {
if (preg_match('!^/home/([^/]+)/' . self::MAILDIR_HOME . '([/.]*)$!', $newdestination,
$match)) {
$local_user = $match[1];
$newdestination = ltrim(str_replace(array('/', '..'), '.', $match[2]), '.');
} else {
$local_user = $newdestination;
$newdestination = null;
}
} else {
// user rename
$local_user = $newuser;
}
$local_user = strtolower($local_user);
$users = $this->user_get_users();
if (!isset($users[$local_user])) {
return error("User account `%s' does not exist", $local_user);
}
$uid = intval($users[$local_user]['uid']);
if ($newdestination == '') {
$newdestination = null;
} else {
$this->query('email_create_maildir_backend', $local_user, $newdestination);
}
$pgdb->query("UPDATE email_lookup SET \"user\" = '" . $newuser . "', domain = '" . $newdomain . "', " .
"fs_destination = " . (($newdestination != null) ? "'" . pg_escape_string(rtrim($newdestination,
' /') . '/') . "'" : "NULL") . ", " .
"alias_destination = NULL, uid = " . $uid . ", type = '" . self::MAILBOX_USER . "' WHERE \"user\" = '" . pg_escape_string($olduser) . "' " .
"AND domain = '" . pg_escape_string($olddomain) . "';");
} else {
if (!$newuser) {
return error("cannot forward catch-alls to external e-mail accounts");
}
$newdestination = preg_replace('/\s+/m', ",", trim($newdestination, ' ,'));
if (!$newdestination) {
return error("no forwarding destination set for `%s@%s`", $newuser, $newdomain);
}
$pgdb->query("UPDATE email_lookup SET \"user\" = '" . pg_escape_string($newuser) . "', domain = '" . pg_escape_string($newdomain) . "', " .
"alias_destination = '" . pg_escape_string($newdestination) . "', uid = NULL, type = '" .
self::MAILBOX_FORWARD . "', fs_destination = NULL WHERE \"user\" = '" .
pg_escape_string($olduser) . "' AND domain = '" . pg_escape_string($olddomain) . "';");
}
$rows = $pgdb->affected_rows();
$this->_shutdown_save_mailboxes();
return $rows > 0;
}
public function address_exists($user, $domain)
{
$user = strtolower($user);
$domain = strtolower($domain);
if (!preg_match('/^[a-z0-9\._@\+-]+$/', $user . '@' . $domain)) {
return error("invalid address `" . $user . '@' . $domain . "'");
}
$pgdb = \PostgreSQL::initialize();
$pgdb->query("SELECT 1 FROM email_lookup WHERE \"user\" = '" . pg_escape_string($user) . "' AND domain = '" . pg_escape_string($domain) . "'");
return $pgdb->num_rows() > 0;
}
/**
* Get mailbox type
*
* @param $user
* @param $domain
* @return bool|null|string
* @throws PostgreSQLError
*/
public function mailbox_type($user, $domain)
{
$user = strtolower($user);
$domain = strtolower($domain);
if (!preg_match(Regex::EMAIL, $user . '@' . $domain)) {
return error("invalid address `" . $user . '@' . $domain . "'");
}
$pgdb = \PostgreSQL::initialize();
$pgdb->query("SELECT type FROM email_lookup WHERE \"user\" = '" . $user . "' AND domain = '" . $domain . "'");
if ($pgdb->num_rows() < 1) {
return null;
}
return $pgdb->fetch_object()->type;
}
private function _shutdown_save_mailboxes()
{
if (!IS_ISAPI) {
$this->save_mailboxes();
}
static $called;
if (isset($called)) {
return;
}
$called = 1;
return register_shutdown_function(array($this, 'save_mailboxes'));
}
/**
* Save all mailboxes to a serialized file
*
* @see restore_mailboxes()
*
* @return boolean
*/
public function save_mailboxes()
{
if (!IS_CLI) {
return $this->query('email_save_mailboxes');
}
$path = $this->domain_info_path();
if (!is_dir($path)) {
// site deleted, ignore save
return true;
}
$path .= '/email_addr';
$email = $this->dump_mailboxes();
return (bool)file_put_contents($path, serialize($email), LOCK_EX);
}
/**
* List all mailboxes for backup/restore purposes
*
* @return array
* @throws PostgreSQLError
*/
public function dump_mailboxes(): array {
$q = 'SELECT * FROM email_lookup WHERE domain IN
(select domain FROM domain_lookup WHERE site_id = ' . $this->site_id . ')';
$db = \PostgreSQL::pdo();
$email = array();
$rs = $db->query($q);
while ($row = $rs->fetch(PDO::FETCH_ASSOC)) {
$email[] = array_map('trim', $row);
}
return $email;
}
/**
* Remove an e-mail alias
*
* @param string $user
* @param string $domain
*/
public function remove_alias($user, $domain)
{
return $this->delete_mailbox($user, $domain, self::MAILBOX_FORWARD);
}
public function delete_mailbox($user, $domain, $type = '')
{
$type = strtolower($type);
if ($type == 'l' || $type == self::MAILBOX_USER) {
$type = self::MAILBOX_USER;
} else if ($type == 'f' || $type == self::MAILBOX_FORWARD) {
$type = self::MAILBOX_FORWARD;
} else if ($type != '') {
return error("unknown address type `%s'", $type);
}
/**
* otherwise we can clog up an mqueue pretty fast
*/
if ($user === "majordomo" && $this->majordomo_list_mailing_lists()) {
return error("cannot remove majordomo email address while mailing lists exist");
}
$clause = '';
if ($type) {
$clause = "AND type = '$type' ";
}
$pgdb = \PostgreSQL::initialize();
$pgdb->query('DELETE FROM
email_lookup
WHERE
"user" = \'' . pg_escape_string($user) . "'
AND
domain = '" . pg_escape_string($domain) . "'
$clause
AND '" . pg_escape_string($domain) . "' IN
(SELECT domain from domain_lookup WHERE site_id = " . $this->site_id . ");");
$rows = $pgdb->affected_rows();
$this->_shutdown_save_mailboxes();
return $rows > 0;
}
public function get_mailbox($user, $domain)
{
$address = $this->list_mailboxes(self::MAILBOX_SINGLE, $user, $domain);
return $address ? array_pop($address) : array();
}
public function remove_maildir($mailbox)
{
// assume remove_maildir() is only called by the owner
if (!IS_CLI) {
return $this->query('email_remove_maildir', $mailbox);
}
$mailbox = trim($mailbox);
if ($mailbox[0] != ".") {
$mailbox = '.' . $mailbox;
}
if (!preg_match(Regex::EMAIL_MAILDIR_FOLDER, $mailbox)) {
return error("invalid maildir folder name `%s'", $mailbox);
}
$home = $this->user_get_user_home();
$path = join(DIRECTORY_SEPARATOR, array($home, self::MAILDIR_HOME, $mailbox));
if (!$this->file_delete($path, true)) {
return error("failed to remove maildir `%s'", $mailbox);
}
$subscriptions = join(DIRECTORY_SEPARATOR,
array(
$this->domain_fs_path(),
$home,
self::MAILDIR_HOME,
'subscriptions'
)
);
$sname = trim($mailbox, '.');
if (!file_exists($subscriptions)) {
$contents = array();
} else {
$contents = file($subscriptions, FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES);
}
if (false === ($key = array_search($sname, $contents))) {
return true;
}
unset($contents[$key]);
file_put_contents($subscriptions, join("\n", $contents) . "\n");
return \Opcenter\Filesystem::chogp($subscriptions, $this->user_id, $this->group_id, 0600);
}
/**
* Restore a saved copy of mailboxes
*
* @return boolean
*/
public function restore_mailboxes($file = 'email_addr')
{
if (!IS_CLI) {
return $this->query('email_restore_mailboxes', $file);
}
if (!strspn($file[0], "abcdefghijklmnopqrstuvwxyz")) {
return error("invalid mailbox backup `%s'", $file);
}
$file = $this->domain_info_path() . '/' . $file;
if (!file_exists($file)) {
warn("mailbox backup `%s' not found", basename($file));
return -1;
}
$db = \PostgreSQL::initialize();
$recs = unserialize(file_get_contents($file));
$escapef = function ($rec) {
return '"' . $rec . '"';
};
$escapev = function ($rec) {
// empty values inserted as NULL
if ($rec === "") {
return "NULL";
} else {
if (ctype_digit($rec)) {
if ($rec == 0 || $rec == 1) {
/*
* assume this is the "enabled" column,
* which mandates a bit
*/
$rec .= '::bit';
}
return $rec;
}
}
return "'" . pg_escape_string($rec) . "'";
};
$db = \PostgreSQL::initialize()->getHandler();
foreach ($recs as $r) {
$fields = array_map($escapef, array_keys($r));
$values = array_map($escapev, array_values($r));
$q = "INSERT INTO email_lookup (" . join($fields, ",") .
") VALUES(" . join($values, ",") . ")";
pg_send_query($db, $q);
while (pg_connection_busy($db)) {
usleep(50);
}
$res = pg_get_result($db);
if (false !== ($err = pg_result_error($res))) {
$errid = pg_result_error_field($res, PGSQL_DIAG_SQLSTATE);
/**
* 23505 (unique_violation) Query violates unique key
*
* @link http://www.postgresql.org/docs/8.2/static/errcodes-appendix.html
*/
if ($errid == 23505) {
warn("skipped duplicate entry `%s@%s'",
$r['user'], $r['domain']);
} else {
if ($errid == 23514) {
warn("skipped entry `%s@%s': domain for `%s' not " .
"assigned to handle mail", $r['user'],
$r['domain'], $r['domain']);
} else {
error("skipped `%s@%s': unknown query error",
$r['user'], $r['domain']);
}
}
}
}
return true;
}
public function remove_mailbox($user, $domain)
{
return $this->delete_mailbox($user, $domain);
}
/**
* Domain is designated to receive e-mail on hosting server
*
* @param string $domain
* @return bool
*/
public function transport_exists($domain)
{
$q = \PostgreSQL::initialize()->query("SELECT site_id FROM domain_lookup WHERE domain = '" . pg_escape_string($domain) . "'");
return $q->num_rows() > 0 && $q->fetch_object()->site_id == $this->site_id;
}
/***
* int get_spool_size (string)
*
* @privilege PRIVILEGE_SITE
* @return int size of the spool in bytes
* @param $username username of the spool; note well this differs from
* {@link File_Module::report_quota} in that the username is used instead of the uid.
* This may change in the future. There is a limitation in this process
* in that it solely scans the main spool file for a user and excludes
* all other inboxes created from IMAP applications (such as SquirrelMail).
*/
public function get_spool_size($username)
{
if (!array_key_exists($username, $this->user_get_users())) {
return error("Invalid user `%s'", $username);
}
return $this->query(
'email_get_spool_size_backend',
$this->domain_fs_path() . '/home/' . $username . '/' . self::MAILDIR_HOME
);
}
/**
* Get mail folder size
*
* @param string $path
* @return bool|int
*/
public function get_spool_size_backend($path)
{
if (!file_exists($path)) {
return 0;
}
$proc = Util_Process_Safe::exec('du -s %s', $path);
if (!$proc['success']) {
return false;
}
return intval($proc['output']) * 1024;
}
/**
* Get vacation options
*
* @return array
*/
public function get_vacation_options(): array
{
$prefs = array_get(\Preferences::factory($this->getAuthContext()), self::VACATION_PREFKEY, []);
$mb = \Opcenter\Mail\Vacation::get($this->getAuthContext());
$defaults = $mb->getDefaults();
return array_merge($defaults, array_intersect_key($prefs, $defaults));
}
public function get_vacation_message($user = null)
{
if (!IS_CLI) {
return $this->query('email_get_vacation_message', $user);
}
if (null !== $user && !($this->permission_level & PRIVILEGE_SITE)) {
return error("unprivileged user may not setup vacation responder for other users");
}
if (null === $user) {
$user = $this->username;
} else if (!$this->user_exists($user)) {
return error("unknown user `%s'", $user);
}
$svc = \Opcenter\Mail\Vacation::getActiveService();
$class = 'Vacation\\Providers\\' . $svc . '\\Options\\Message';
$fqns = \Opcenter\Mail\Vacation::appendNamespace($class);
return (new $fqns)->getFromUser($user);
}
/**
* Wrapper to set_vacation
*
* @deprecated
* @param $response
* @param null $user
* @param array|null $flags
* @return bool|mixed|void
*/
public function add_vacation($response, $user = null, array $flags = null)
{
deprecated_func('use set_vacation()');
return $this->enable_vacation($response, $user, $flags);
}
/**
* Enable vacation auto-responder
*
* @param null|string $user
* @param array|null $flags optional flags
* @return bool|mixed|void
*/
public function enable_vacation($user = null, array $flags = null)
{
if (!IS_CLI) {
return $this->query('email_enable_vacation', $user, $flags);
}
if (null !== $user && !($this->permission_level & PRIVILEGE_SITE)) {
return error("Non-privileged user may not setup vacation responder for other users");
}
if (null === $user) {
$user = $this->getAuthContext();
} else if (!$this->user_exists($user)) {
return error("user `%s' does not exist", $user);
} else if ($user && $flags) {
return error("changing flags of secondary users not implemented");
} else {
$user = \Auth::context($user, $this->site);
}
$driver = \Opcenter\Mail\Vacation::get($user);
if ($flags) {
$this->set_vacation_options($flags);
}
return $driver->enable();
}
/**
* Set vacation options
*
* @param array $options
* @return bool
*/
public function set_vacation_options(array $options): bool
{
$driver = \Opcenter\Mail\Vacation::get($this->getAuthContext());
foreach ($driver->getDefaults() as $k => $v) {
if (isset($options[$k]) && !$driver->setOption($k, $options[$k])) {
unset($options[$k]);
}
}
$pref = \Preferences::factory($this->getAuthContext());
$pref->unlock(\apnscpFunctionInterceptor::factory($this->getAuthContext()));
array_set($pref, self::VACATION_PREFKEY, $options);
if (!$this->inContext()) {
\Preferences::reload();
}
return true;
}
public function vacation_exists($user = null)
{
if (!IS_CLI) {
return $this->query('email_vacation_exists', $user);
}
if (null !== $user && (($this->permission_level & PRIVILEGE_SITE) !== PRIVILEGE_SITE)) {
return error("Unable to check vacation for non-admin account");
} else if (null === $user) {
$user = $this->getAuthContext();
} else {
if (!$this->user_exists($user)) {
return false;
}
$user = \Auth::context($user, $this->site);
}
if (!$this->user_exists($user->username)) {
return error("Invalid user `%s'", $user->username);
}
return \Opcenter\Mail\Vacation::get($user)->enabled();
}
/**
* Change existing vacation message
*
* @param string $response
* @param string|null $user
* @param array|null $flags
* @return bool
*/
public function change_vacation_message($response, $user = null, array $flags = [])
{
deprecated_func('use set_vacation');
return $this->enable_vacation($response, $user, $flags);
}
/**
* Disable vacation status
*
* @param string|null user
* @return bool
*/
public function remove_vacation(string $user = null)
{
if (!IS_CLI) {
return $this->query('email_remove_vacation', $user);
}
if ($user && ($this->permission_level & PRIVILEGE_SITE) !== PRIVILEGE_SITE) {
return error("Unable to check vacation for non-admin account");
}
if (!$user) {
$user = $this->getAuthContext();
} else {
$user = \Auth::context($user, $this->site);
}
if (!$this->user_exists($user->username)) {
return error($user . ": invalid user");
}
$driver = \Opcenter\Mail\Vacation::get($user);
return $driver->disable();
}
public function clone_domain_mailboxes($source, $destination)
{
$this->remove_virtual_transport($destination);
if (!$this->add_virtual_transport($destination)) {
return false;
}
foreach ($this->list_mailboxes(null, null, $source) as $mailbox) {
if ($mailbox['type'] == self::MAILBOX_USER) {
if (preg_match('!^/home/([^/]+)/' . self::MAILDIR_HOME . '/?(.*)$!', $mailbox['destination'],
$mailbox_dest)) {
$username = $mailbox_dest[1];
$subfolder = $mailbox_dest[2];
} else {
$subfolder = '';
$username = $mailbox['destination'];
}
$this->add_mailbox($mailbox['user'],
$destination,
$this->user_get_uid_from_username($username),
$subfolder);
} else if ($mailbox['type'] == self::MAILBOX_FORWARD) {
$this->add_alias($mailbox['user'],
$destination,
str_replace($source,
$destination,
$mailbox['destination']));
}
if (!$mailbox['enabled']) {
$this->disable_address($mailbox['user'], $mailbox['domain']);
}
}
return true;
}
/**
* Deauthorize server from handling mail for domain
*
* @param string $domain domain name to deauthorize
* @param bool $keepdns purge DNS MX settings, null auto-detect to purge
* @return bool
*/
public function remove_virtual_transport($domain, $keepdns = null)
{
$pgdb = \PostgreSQL::initialize();
$q = $pgdb->query("SELECT site_id FROM domain_lookup WHERE domain = '" . pg_escape_string($domain) . "'");
if ($q->num_rows() < 1) {
return false;
}
$site_id = $pgdb->fetch_object()->site_id;
if ($site_id && $site_id != $this->site_id) {
return error("Table entry " . $domain . " owned by another site (" . $site_id . ")");
} else {
if ($pgdb->num_rows() < 1) {
return error("Domain " . $domain . " not found in table");
}
}
foreach ($this->majordomo_list_mailing_lists() as $list) {
$tmp = $this->majordomo_get_domain_from_list_name($list);
if ($tmp == $domain) {
warn("Mailing list `%s' sends from `%s'. Delete via Mail > Mailing Lists", $list, $domain);
}
}
$pgdb->query("DELETE FROM domain_lookup WHERE domain = '" . pg_escape_string($domain) . "' AND site_id = " . (int)$this->site_id . ";");
$ok = $pgdb->affected_rows() > 0;
if (!$this->dns_configured()) {
return warn("DNS is not configured for `%s' - unable to remove MX records automatically", $domain);
}
if (!$this->dns_zone_exists($domain)) {
// zone removed
return true;
}
if (null === $keepdns) {
// do an intelligent lookup to see if MX is default
$split = $this->web_split_host($domain);
$myip = $this->get_mail_ip();
if ($this->dns_record_exists($split['domain'], $split['subdomain'], 'MX')) {
// record exists, confirm MX value
$hostname = ltrim($split['subdomain'] . "." . $split['domain'], ".");
$rec = $this->dns_get_records_by_rr('MX', $hostname);
if (!is_array($rec)) {
warn("error retrieving mx records for `%s'", $hostname);
Error_Reporter::report("unable to remove record for `%s'", $hostname);
return $ok;
}
if (!count($rec)) {
// MX record exists remotely but not on the server
info("no MX records found for hostname `%s'", $hostname);
return $ok;
}
// check just first record
$rec = array_pop($rec);
list($priority, $hostname) = preg_split("/\s+/", $rec['parameter']);
// a fqdn is supplied, terminated by a period, strip it
$hostname = trim($hostname, ".");
$ip = $this->dns_gethostbyname_t($hostname, 5000);
if ($ip && $ip != $myip) {
warn("MX record for `%s' points to third-party server and thus will not be removed from local DNS",
$domain);
return -1;
}
// purge MX record from DNS
$keepdns = false;
}
}
if (!$keepdns) {
$split = $this->web_split_host($domain);
$mailsub = rtrim('mail.' . $split['subdomain'], '.');
$records = $this->get_records($domain);
foreach ($records as $r) {
if ($this->dns_record_exists($split['domain'], $r['name'], $r['rr'], $r['parameter'])) {
$this->dns_remove_record($split['domain'], $r['name'], $r['rr'], $r['parameter']);
}
}
}
return $ok;
}
/**
* Get DNS records
*