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
|
#-*- perl -*-
#
# Copyright (C) 2001,2002,2003,2004 Ken'ichi Fukamachi
# All rights reserved. This program is free software; you can
# redistribute it and/or modify it under the same terms as Perl itself.
#
# $FML: confirm.pm,v 1.29 2004/02/15 04:38:30 fukachan Exp $
#
package FML::Command::User::confirm;
use strict;
use vars qw(@ISA @EXPORT @EXPORT_OK $AUTOLOAD);
use Carp;
use FML::Log qw(Log LogWarn LogError);
=head1 NAME
FML::Command::User::confirm - allow action after confirmation
=head1 SYNOPSIS
See C<FML::Command> for more details.
=head1 DESCRIPTION
execute the actual corresponding process if the confirmation succeeds.
=head1 METHODS
=head2 process($curproc, $command_args)
=cut
# Descriptions: standard constructor
# Arguments: OBJ($self)
# Side Effects: none
# Return Value: OBJ
sub new
{
my ($self) = @_;
my ($type) = ref($self) || $self;
my $me = {};
return bless $me, $type;
}
# Descriptions: need lock or not
# Arguments: none
# Side Effects: none
# Return Value: NUM( 1 or 0)
sub need_lock { 1;}
# Descriptions: lock channel
# Arguments: none
# Side Effects: none
# Return Value: STR
sub lock_channel { return 'command_serialize';}
# Descriptions: addresses to inform a message copy to
# Arguments: OBJ($self) OBJ($curproc) HASH_REF($command_args)
# Side Effects: none
# Return Value: ARREY_REF
sub notice_cc_recipient
{
my ($self, $curproc, $command_args) = @_;
my $config = $curproc->config();
my $maintainer = $config->{ maintainer };
return [ $maintainer ];
}
# Descriptions: execute the actual process if this confirmation succeeds.
# run _switch_command() for real process.
# Arguments: OBJ($self) OBJ($curproc) HASH_REF($command_args)
# Side Effects: none
# Return Value: none
sub process
{
my ($self, $curproc, $command_args) = @_;
my $config = $curproc->config();
my ($class, $id);
# XXX We should always add/rewrite only $primary_*_map maps via
# XXX command mail, CUI and GUI.
# XXX Rewriting of maps not $primary_*_map is
# XXX 1) may be not writable.
# XXX 2) ambigous and dangerous
# XXX since the map is under controlled by other module.
# XXX for example, one of member_maps is under admin_member_maps.
my $member_map = $config->{ primary_member_map };
my $recipient_map = $config->{ primary_recipient_map };
my $cache_dir = $config->{ db_dir };
my $keyword = $config->{ confirm_command_prefix };
my $expire_limit = $config->{ confirm_expire_limit } || 14*24*3600;
my $command = $command_args->{ command };
# XXX-TODO: sanity
# get class and id from buffer, for example,
# "confirm subscribe 813f42fa2aa84bbba500ed3d2781dea6"
# XXX $keyword not starts at the begining of this line.
# XXX for example, "confirm", "> confirm" and "xxx> confirm ..."
# XXX-TODO: we should move this check to FML::Command::__SOME_WHERE__ ?
if ($command =~ /$keyword\s+(\w+)\s+([\w\d]+)/) {
($class, $id) = ($1, $2);
}
# XXX-TODO: ($class, $id) sanity check ?
# XXX-TODO: if ($class && $id) { ... }
use FML::Confirm;
my $confirm = new FML::Confirm $curproc, {
keyword => $keyword,
cache_dir => $cache_dir,
class => $class,
buffer => $command,
};
my $found = '';
if ($found = $confirm->find($id)) { # if request is found
unless ($confirm->is_expired($id, $expire_limit)) {
my $address = $confirm->get_address($id);
$self->_switch_command($class, $address, $curproc, $command_args);
}
else { # if requset is expired
$curproc->reply_message_nl('error.expired', "request expired");
$curproc->logerror("request expired");
croak("request is expired");
}
}
# request corresponding to thie confirmation reply is not found
else {
$curproc->reply_message_nl('error.no_such_confirmation',
"no such confirmatoin request id=$id",
{ _arg_id => $id });
$curproc->logerror("no such confirmation request id=$id");
croak("no such confirmation request id=$id");
}
}
# Descriptions: load module for the actual process and
# switch this process to it.
# We support only {subscribe,unsubscribe,chaddr} now.
# Arguments: OBJ($self) STR($class) STR($address)
# OBJ($curproc) HASH_REF($command_args)
# Side Effects: module loaded
# Return Value: none
sub _switch_command
{
my ($self, $class, $address, $curproc, $command_args) = @_;
# lower case
$class =~ tr/A-Z/a-z/;
use FML::Command;
my $obj = new FML::Command;
# XXX-TODO: command names which need confirmation are hard-coded.
# XXX-TODO: define available command list in $config.
if ($class eq 'subscribe' ||
$class eq 'unsubscribe' ||
$class eq 'chaddr' ||
$class eq 'on' ||
$class eq 'off') {
$command_args->{ command_data } = $address;
$command_args->{ command_mode } = 'Admin';
$command_args->{ override_need_no_lock } = 1; # already locked
$obj->$class($curproc, $command_args);
}
else {
$curproc->logerror("no such confirmation rule for '$class' command");
$curproc->reply_message_nl('error.no_such_confirmation_for_command',
"no such confirmation for command $class",
{ _arg_command => $class });
croak("no such rule");
}
# XXX-TODO: send back welcome file.
# XXX-TODO: temporary solution, please clean up in near future!
if ($class eq 'subscribe') {
use File::Spec;
use FML::Command::SendFile;
push(@ISA, qw(FML::Command::SendFile));
my $config = $curproc->config();
my $ml_home_dir = $config->{ ml_home_dir };
my $file = File::Spec->catfile($ml_home_dir, "welcome");
$config->set( 'welcome_file', $file );
if (-f $file) {
$self->send_user_xxx_message($curproc, $command_args, "welcome");
}
}
}
=head1 CODING STYLE
See C<http://www.fml.org/software/FNF/> on fml coding style guide.
=head1 AUTHOR
Ken'ichi Fukamachi
=head1 COPYRIGHT
Copyright (C) 2001,2002,2003,2004 Ken'ichi Fukamachi
All rights reserved. This program is free software; you can
redistribute it and/or modify it under the same terms as Perl itself.
=head1 HISTORY
FML::Command::User::confirm first appeared in fml8 mailing list driver package.
See C<http://www.fml.org/> for more details.
=cut
1;
|
