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
|
package Fripost::Schema::Mailbox;
=head1 NAME
Mailbox.pm -
=head1 DESCRIPTION
Mailbox.pm abstracts the LDAP schema definition and provides methods to
add, list or delete virtual mailboxes.
=cut
use 5.010_000;
use strict;
use warnings;
use utf8;
use parent 'Fripost::Schema';
use Fripost::Schema::Misc qw/concat explode must_attrs email_valid/;
use Net::IDN::Encode qw/domain_to_ascii
email_to_ascii email_to_unicode/;
=head1 METHODS
=over 4
=item B<search> (I<domain>, I<OPTIONS>)
List every known (and visible) mailbox under the given domain. The
output is a array of hash references, sorted by mailbox.
=cut
sub search {
my $self = shift;
my $d = domain_to_ascii(shift);
my %options = @_;
my $concat = $options{'-concat'};
my $mailboxes = $self->ldap->search(
base => "fvd=$d,".$self->suffix,
scope => 'one',
deref => 'never',
filter => 'objectClass=FripostVirtualMailbox',
attrs => [ qw/fvu description fripostIsStatusActive
fripostOptionalMaildrop
fripostMailboxQuota/ ]
);
if ($mailboxes->code) {
die $options{'-die'}."\n" if defined $options{'-die'};
die $mailboxes->error."\n";
}
return map { { user => email_to_unicode($_->get_value('fvu'))
, isactive => $_->get_value('fripostIsStatusActive') eq 'TRUE'
, description => concat($concat, $_->get_value('description'))
, forwards => concat($concat, map { email_to_unicode($_) }
$_->get_value('fripostOptionalMaildrop'))
, quota => $_->get_value('fripostMailboxQuota') // undef
}
}
$mailboxes->sorted('fvu')
}
=item B<replace> (I<mailbox>, I<OPTIONS>)
Replace an existing account with the given one.
=cut
sub replace {
my $self = shift;
my $m = shift;
my %options = @_;
foreach (qw/description forwards/) {
$m->{$_} = explode ($options{'-concat'}, $m->{$_})
if defined $m->{$_};
}
eval {
my ($l,$d) = split /\@/, email_to_ascii($m->{user}), 2;
&_is_valid($m);
my $mesg = $self->ldap->modify(
"fvu=$l,fvd=$d,".$self->suffix,
replace => { fripostIsStatusActive => $m->{isactive} ?
'TRUE' : 'FALSE'
, description => $m->{description}
, fripostOptionalMaildrop => $m->{forwards}
} );
die $mesg->error."\n" if $mesg->code;
};
return $@;
}
=item B<passwd> (I<username>, I<password>, I<OPTIONS>)
Change the password of the given user. I<password> is used raw, so you
may want to hash it before hand.
=cut
sub passwd {
my $self = shift;
my ($l,$d) = split /\@/, email_to_ascii(shift), 2;
my $pw = shift;
my %options = @_;
my $mesg = $self->ldap->modify(
"fvu=$l,fvd=$d,".$self->suffix,
replace => { userPassword => $pw } );
return "Cannot change password" if $mesg->code;
}
=item B<add> (I<mailbox>, I<OPTIONS>)
Add the given account.
=cut
sub add {
my $self = shift;
my $m = shift;
my %options = @_;
foreach (qw/description forwards/) {
$m->{$_} = explode ($options{'-concat'}, $m->{$_})
if defined $m->{$_};
}
eval {
die "Missing user name\n" unless $m->{user} =~ /^.+\@.+$/;
my ($l,$d) = split /\@/, email_to_ascii($m->{user}), 2;
&_is_valid($m);
die "‘".$m->{user}."’ already exists\n"
if $self->local->exists($m->{user},%options);
my %attrs = ( objectClass => 'FripostVirtualMailbox'
, fripostIsStatusActive => $m->{isactive} ? 'TRUE' : 'FALSE'
, userPassword => $m->{password}
);
$attrs{description} = $m->{description}
if defined $m->{description} and @{$m->{description}};
$attrs{fripostMailboxQuota} = $m->{quota} if defined $m->{quota};
$attrs{fripostOptionalMaildrop} = $m->{forwards}
if defined $m->{forwards} and @{$m->{forwards}};
my $mesg = $self->ldap->add( "fvu=$l,fvd=$d,".$self->suffix,
attrs => [ %attrs ] );
if ($mesg->code) {
die $options{'-die'}."\n" if defined $options{'-die'};
die $mesg->error."\n";
}
};
return $@;
}
=item B<delete> (I<mailbox>, I<OPTIONS>)
Delete the given mailbox. Note: this will NOT wipe the mailbox off the
disk, but merely delete its entry in the LDAP directory.
=cut
sub delete {
my $self = shift;
my ($l,$d) = split /\@/, email_to_ascii(shift), 2;
my %options = @_;
my $mesg = $self->ldap->delete( "fvu=$l,fvd=$d,".$self->suffix );
if ($mesg->code) {
if (defined $options{'-die'}) {
return $mesg->error unless $options{'-die'};
die $options{'-die'}."\n";
}
die $mesg->error."\n";
}
}
=back
=head1 GLOBAL OPTIONS
If the B<-concat> option is present, it will intersperse multi-valued
attributes. Otherwise, an array reference containing every values will
be returned for these attributes.
The B<-die> option, if present, overides LDAP croaks and errors.
=cut
# Ensure that the given mailbox is valid.
sub _is_valid {
my $m = shift;
must_attrs( $m, qw/user isactive/ );
$m->{user} = email_valid( $m->{user}, -exact => 1);
$m->{forwards} = [ map { email_valid($_) } @{$m->{forwards}} ];
# TODO: match 'quota' against the Dovecot specifications
}
=head1 AUTHOR
Guilhem Moulin C<< <guilhem at fripost.org> >>
=head1 COPYRIGHT
Copyright 2012 Guilhem Moulin.
=head1 LICENSE
This program is free software; you can redistribute it and/or modify it
under the same terms as perl itself.
=cut
1;
__END__
|
