Aliases.pm 6.73 KB
Newer Older
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
# -*- indent-tabs-mode: nil; -*-
# vim:ft=perl:et:sw=4
# $Id$

# Sympa - SYsteme de Multi-Postage Automatique
#
# Copyright 2017 The Sympa Community. See the AUTHORS.md file at the top-level
# directory of this distribution and at
# <https://github.com/sympa-community/sympa.git>.
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

package Sympa::Aliases;

use strict;
use warnings;
use English qw(-no_match_vars);
BEGIN { eval 'use Net::SMTP'; }

use Conf;
use Sympa::Constants;
use Sympa::Log;

my $log = Sympa::Log->instance;

sub new {
    bless {} => shift;
}

# OLd name: Sympa::Admin::list_check_smtp().
sub check {
    $log->syslog('debug2', '(%s, %s, %s)', @_);
    my $self     = shift;
    my $name     = shift;
    my $robot_id = shift;

    my $conf = '';
    my $smtp;

    my $smtp_relay = Conf::get_robot_conf($robot_id, 'list_check_smtp');
    my $smtp_helo  = Conf::get_robot_conf($robot_id, 'list_check_helo')
        || $smtp_relay;
    $smtp_helo =~ s/:[-\w]+$// if $smtp_helo;
    my $suffixes = Conf::get_robot_conf($robot_id, 'list_check_suffixes');
    return 0
        unless $smtp_relay and $suffixes;
    $log->syslog('debug2', '(%s, %s)', $name, $robot_id);
    my @suf = split /\s*,\s*/, $suffixes;
    return 0 unless @suf;    #FIXME

    my @addresses = (
        $name . '@' . $robot_id,
        map { $name . '-' . $_ . '@' . $robot_id } @suf
    );

    unless ($Net::SMTP::VERSION) {
        $log->syslog('err',
            'Unable to use Net library, Net::SMTP required, install it first'
        );
        return undef;
    }
    if ($smtp = Net::SMTP->new(
            $smtp_relay,
            Hello   => $smtp_helo,
            Timeout => 30
        )
        ) {
        $smtp->mail('');
        foreach my $address (@addresses) {
            $conf = $smtp->to($address);
            last if $conf;
        }
        $smtp->quit();
        return $conf;
    }
    return undef;
}

# Old name: Sympa::Admin::install_aliases().
sub add {
    $log->syslog('debug', '(%s, %s)', @_);
    my $self = shift;
    my $list = shift;

    return 1
        if lc Conf::get_robot_conf($list->{'domain'}, 'sendmail_aliases') eq
            'none';

    my $alias_manager = $Conf::Conf{'alias_manager'};
    $log->syslog('debug2', '%s add %s %s', $alias_manager, $list->{'name'},
        $list->{'admin'}{'host'});

    unless (-x $alias_manager) {
        $log->syslog('err', 'Failed to install aliases: %m');
        return undef;
    }

    #FIXME: 'host' parameter is passed to alias_manager: no 'domain'
    # parameter to determine robot.
    my $status =
        system($alias_manager, 'add', $list->{'name'},
        $list->{'admin'}{'host'}) >> 8;

    if ($status == 0) {
        $log->syslog('info', 'Aliases installed successfully');
        return 1;
    }

    if ($status == 1) {
        $log->syslog('err', 'Configuration file %s has errors',
            Conf::get_sympa_conf());
    } elsif ($status == 2) {
        $log->syslog('err',
            'Internal error: Incorrect call to alias_manager');
    } elsif ($status == 3) {
        # Won't occur
        $log->syslog('err',
            'Could not read sympa config file, report to httpd error_log');
    } elsif ($status == 4) {
        # Won't occur
        $log->syslog('err',
            'Could not get default domain, report to httpd error_log');
    } elsif ($status == 5) {
        $log->syslog('err', 'Unable to append to alias file');
    } elsif ($status == 6) {
        $log->syslog('err', 'Unable to run newaliases');
    } elsif ($status == 7) {
        $log->syslog('err',
            'Unable to read alias file, report to httpd error_log');
    } elsif ($status == 8) {
        $log->syslog('err',
            'Could not create temporay file, report to httpd error_log');
    } elsif ($status == 13) {
        $log->syslog('info', 'Some of list aliases already exist');
    } elsif ($status == 14) {
        $log->syslog('err',
            'Can not open lock file, report to httpd error_log');
    } elsif ($status == 15) {
        $log->syslog('err', 'The parser returned empty aliases');
    } else {
        $log->syslog('err', 'Unknown error %s while running alias manager %s',
            $status, $alias_manager);
    }

    return undef;
}

# Old names: Sympa::Admin::remove_aliases() & Sympa::List::remove_aliases().
sub del {
    $log->syslog('info', '(%s, %s)', @_);
    my $self = shift;
    my $list = shift;

    return 1
        if lc Conf::get_robot_conf($list->{'domain'}, 'sendmail_aliases') eq
            'none';

    my $alias_manager = $Conf::Conf{'alias_manager'};

    unless (-x $alias_manager) {
        $log->syslog('err', 'Cannot run alias_manager %s', $alias_manager);
        return undef;
    }

    my $status =
        system($alias_manager, 'del', $list->{'name'},
        $list->{'admin'}{'host'}) >> 8;

    if ($status == 0) {
        $log->syslog('info', 'Aliases for list %s removed successfully',
            $list);
        return 1;
    } else {
        $log->syslog('err', 'Failed to remove aliases; status %d: %m',
            $status);
        return undef;
    }
}

1;
__END__

=encoding utf-8

=head1 NAME 

Sympa::Aliases - Base class for alias management

=head1 DESCRIPTION 

TBD.

=head2 Methods

=over

=item new ( )

I<Constructor>.
Creates new instance of L<Sympa::Aliases>.

=item check ($listname, $robot_id)

I<Instance method>.
Checks if the requested list exists already using SMTP 'rcpt to'.

Parameters:

=over

=item $listname

Name of the list.

=item $robot_id

List's robot.

=back

Returns:

L<Net::SMTP> object or false value.

=item add ($list)

I<Instance method>.
Installs aliases for the list $list.

Parameters:

=over

=item $list

An instance of L<Sympa::List>.

=back

Returns:

C<undef> if not applicable or aliases not installed. or C<1> if OK.

=item del ($list)

I<Instance method>.
Removes aliases for the list $list.

Parameters:

=over

=item $list

An instance of L<Sympa::List>.

=back

Returns:

C<undef> if not applicable. C<1> (if ok) or concated string of alias not
removed.

=back

=head1 HISTORY

F<alias_manager.pl> as a program to automate alias management appeared on
Sympa 3.1b.13.

L<Sympa::Aliases> module as an OO-based class appeared on Sympa 6.2.23b,
and it obsoleted F<alias_manager.pl>.

=cut