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
|
package FS::svc_mailinglist;
use base qw( FS::svc_Domain_Mixin FS::svc_Common );
use strict;
use Scalar::Util qw( blessed );
use FS::Record qw( dbh ); # qsearch qsearchs dbh );
use FS::mailinglist;
=head1 NAME
FS::svc_mailinglist - Object methods for svc_mailinglist records
=head1 SYNOPSIS
use FS::svc_mailinglist;
$record = new FS::svc_mailinglist \%hash;
$record = new FS::svc_mailinglist { 'column' => 'value' };
$error = $record->insert;
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
=head1 DESCRIPTION
An FS::svc_mailinglist object represents a mailing list customer service.
FS::svc_mailinglist inherits from FS::Record. The following fields are
currently supported:
=over 4
=item svcnum
primary key
=item username
username
=item domsvc
domsvc
=item listnum
listnum
=item reply_to_group
reply_to_group
=item remove_author
remove_author
=item reject_auto
reject_auto
=item remove_to_and_cc
remove_to_and_cc
=back
=head1 METHODS
=over 4
=item new HASHREF
Creates a new record. To add the record to the database, see L<"insert">.
Note that this stores the hash reference, not a distinct copy of the hash it
points to. You can ask the object for a copy with the I<hash> method.
=cut
# the new method can be inherited from FS::Record, if a table method is defined
sub table { 'svc_mailinglist'; }
sub table_info {
{
'name' => 'Mailing list',
'display_weight' => 31,
'cancel_weight' => 55,
'fields' => {
'username' => { 'label' => 'List address',
'disable_default' => 1,
'disable_fixed' => 1,
'disable_inventory' => 1,
},
'domsvc' => { 'label' => 'List address domain',
'disable_inventory' => 1,
},
'domain' => 'List address domain',
'listnum' => { 'label' => 'List name',
'disable_inventory' => 1,
},
'listname' => 'List name', #actually mailinglist.listname
'reply_to' => { 'label' => 'Reply-To list',
'type' => 'checkbox',
'disable_inventory' => 1,
'disable_select' => 1,
},
'remove_from' => { 'label' => 'Remove From: from messages',
'type' => 'checkbox',
'disable_inventory' => 1,
'disable_select' => 1,
},
'reject_auto' => { 'label' => 'Reject automatic messages',
'type' => 'checkbox',
'disable_inventory' => 1,
'disable_select' => 1,
},
'remove_to_and_cc' => { 'label' => 'Remove To: and Cc: from messages',
'type' => 'checkbox',
'disable_inventory' => 1,
'disable_select' => 1,
},
},
};
}
=item insert
Adds this record to the database. If there is an error, returns the error,
otherwise returns false.
=cut
sub insert {
my $self = shift;
local $SIG{HUP} = 'IGNORE';
local $SIG{INT} = 'IGNORE';
local $SIG{QUIT} = 'IGNORE';
local $SIG{TERM} = 'IGNORE';
local $SIG{TSTP} = 'IGNORE';
local $SIG{PIPE} = 'IGNORE';
my $oldAutoCommit = $FS::UID::AutoCommit;
local $FS::UID::AutoCommit = 0;
my $dbh = dbh;
my $error;
#attach to existing lists? sound scary
#unless ( $self->listnum ) {
my $mailinglist = new FS::mailinglist {
'listname' => $self->get('listname'),
};
$error = $mailinglist->insert;
if ( $error ) {
$dbh->rollback if $oldAutoCommit;
return $error;
}
$self->listnum($mailinglist->listnum);
#}
$error = $self->SUPER::insert(@_);
if ( $error ) {
$dbh->rollback if $oldAutoCommit;
return $error;
}
$dbh->commit or die $dbh->errstr if $oldAutoCommit;
'';
}
=item delete
Delete this record from the database.
=cut
sub delete {
my $self = shift;
local $SIG{HUP} = 'IGNORE';
local $SIG{INT} = 'IGNORE';
local $SIG{QUIT} = 'IGNORE';
local $SIG{TERM} = 'IGNORE';
local $SIG{TSTP} = 'IGNORE';
local $SIG{PIPE} = 'IGNORE';
my $oldAutoCommit = $FS::UID::AutoCommit;
local $FS::UID::AutoCommit = 0;
my $dbh = dbh;
my $error = $self->mailinglist->delete || $self->SUPER::delete;
if ( $error ) {
$dbh->rollback if $oldAutoCommit;
return $error;
}
$dbh->commit or die $dbh->errstr if $oldAutoCommit;
'';
}
=item replace OLD_RECORD
Replaces the OLD_RECORD with this one in the database. If there is an error,
returns the error, otherwise returns false.
=cut
sub replace {
my $new = shift;
my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
? shift
: $new->replace_old;
return "can't change listnum" if $old->listnum != $new->listnum; #?
my %options = @_;
local $SIG{HUP} = 'IGNORE';
local $SIG{INT} = 'IGNORE';
local $SIG{QUIT} = 'IGNORE';
local $SIG{TERM} = 'IGNORE';
local $SIG{TSTP} = 'IGNORE';
local $SIG{PIPE} = 'IGNORE';
my $oldAutoCommit = $FS::UID::AutoCommit;
local $FS::UID::AutoCommit = 0;
my $dbh = dbh;
if ( $new->get('listname') && $new->get('listname') ne $old->listname ) {
my $mailinglist = $old->mailinglist;
$mailinglist->listname($new->get('listname'));
my $error = $mailinglist->replace;
if ( $error ) {
$dbh->rollback if $oldAutoCommit;
return $error if $error;
}
}
my $error = $new->SUPER::replace($old, %options);
if ( $error ) {
$dbh->rollback if $oldAutoCommit;
return $error if $error;
}
$dbh->commit or die $dbh->errstr if $oldAutoCommit;
''; #no error
}
=item check
Checks all fields to make sure this is a valid record. If there is
an error, returns the error, otherwise returns false. Called by the insert
and replace methods.
=cut
# the check method should currently be supplied - FS::Record contains some
# data checking routines
sub check {
my $self = shift;
my $error =
$self->ut_numbern('svcnum')
|| $self->ut_text('username')
|| $self->ut_foreign_key('domsvc', 'svc_domain', 'svcnum')
#|| $self->ut_foreign_key('listnum', 'mailinglist', 'listnum')
|| $self->ut_foreign_keyn('listnum', 'mailinglist', 'listnum')
|| $self->ut_enum('reply_to_group', [ '', 'Y' ] )
|| $self->ut_enum('remove_author', [ '', 'Y' ] )
|| $self->ut_enum('reject_auto', [ '', 'Y' ] )
|| $self->ut_enum('remove_to_and_cc', [ '', 'Y' ] )
;
return $error if $error;
return "Can't remove listnum" if $self->svcnum && ! $self->listnum;
$self->SUPER::check;
}
=item mailinglist
=item listname
=cut
sub listname {
my $self = shift;
my $mailinglist = $self->mailinglist;
$mailinglist ? $mailinglist->listname : '';
}
=item label
=cut
sub label {
my $self = shift;
$self->listname. ' <'. $self->username. '@'. $self->domain. '>';
}
=back
=head1 BUGS
=head1 SEE ALSO
L<FS::Record>, schema.html from the base documentation.
=cut
1;
|