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
|
#-*- perl -*-
#
# Copyright (C) 2001,2002,2003 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: Command.pm,v 1.38 2003/03/18 10:42:40 fukachan Exp $
#
# XXX
# XXX FML::Command should be simple since all program uses this wrapper.
# XXX So, complicated checks are moved to FML::Process::* and each module.
# XXX
package FML::Command;
use strict;
use vars qw(@ISA @EXPORT @EXPORT_OK $AUTOLOAD);
use Carp;
use FML::Log qw(Log LogWarn LogError);
my $debug = 0;
=head1 NAME
FML::Command - fml command dispatcher
=head1 SYNOPSIS
use FML::Command;
my $obj = new FML::Command;
$obj->rewrite_prompt($curproc, $command_args, \$orig_command);
=head1 DESCRIPTION
C<FML::Command> is a wrapper and dispathcer for fml commands.
AUTOLOAD() picks up the command request and dispatches
C<FML::Command::User::something> suitable for the request.
Also, it kicks off C<FML::Command::Admin::something> for the admin
command request and makefml commands.
=head1 METHODS
=head2 C<new()>
constructor.
=cut
# Descriptions: 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: destructor (dummy).
# Arguments: none
# Side Effects: none
# Return Value: none
sub DESTROY { ;}
=head2 C<rewrite_prompt($curproc, $command_args, $rbuf)>
rewrite the specified buffer $rbuf (STR_REF).
$rbuf is rewritten as a result.
For example, this function is used to hide the password in the $rbuf
buffer.
Each module such as C<FML::Command::$MODE::$SOMETING> specifies
how to rewrite by rewrite_prompt() method in it.
=cut
# Descriptions: rewrite prompt buffer
# Arguments: OBJ($self)
# OBJ($curproc) HASH_REF($command_args) STR_REF($rbuf)
# Side Effects: none
# Return Value: none
sub rewrite_prompt
{
my ($self, $curproc, $command_args, $rbuf) = @_;
my $command = undef;
my $comname = $command_args->{ comname };
my $mode =
$command_args->{'command_mode'} =~ /admin/i ? 'Admin' : 'User';
my $pkg = "FML::Command::${mode}::${comname}";
eval qq{ use $pkg; \$command = new $pkg;};
unless ($@) {
if ($command->can('rewrite_prompt')) {
$command->rewrite_prompt($curproc, $command_args, $rbuf);
}
else {
LogError("call $pkg but rewrite_prompt() not supported") if $debug;
}
}
else {
if ($debug) {
LogError($@);
LogError("cannot load $pkg");
}
}
}
=head2 C<notice_cc_recipient($curproc, $command_args, $rbuf)>
return addresses to inform for the command reply.
Each module such as C<FML::Command::$MODE::$SOMETING> specifies
recipients by notice_cc_recipient() method in it.
=cut
# Descriptions: return addresses to inform
# Arguments: OBJ($self) OBJ($curproc) HASH_REF($command_args)
# Side Effects: none
# Return Value: ARRAY_REF
sub notice_cc_recipient
{
my ($self, $curproc, $command_args) = @_;
my $command = undef;
my $comname = $command_args->{ comname };
my $mode =
$command_args->{'command_mode'} =~ /admin/i ? 'Admin' : 'User';
my $pkg = "FML::Command::${mode}::${comname}";
eval qq{ use $pkg; \$command = new $pkg;};
unless ($@) {
if ($command->can('notice_cc_recipient')) {
$command->notice_cc_recipient($curproc, $command_args);
}
}
}
=head2 C<AUTOLOAD()>
the command dispatcher.
It hooks up the C<$command> request and loads the module in
C<FML::Command::$MODE::$command>.
=cut
# Descriptions: run FML::Command::XXX:YYY()
# Arguments: OBJ($self) OBJ($curproc) HASH_REF($command_args)
# Side Effects: load appropriate module
# Return Value: none
sub AUTOLOAD
{
my ($self, $curproc, $command_args) = @_;
my $myname = $curproc->myname();
# we need to ignore DESTROY()
return if $AUTOLOAD =~ /DESTROY/;
# user mode by default
# XXX IMPORTANT: user mode if the given mode is invalid.
my $mode = 'User';
if (defined $command_args->{ command_mode }) {
$mode =
$command_args->{ command_mode } =~ /admin/i ? 'Admin' : 'User';
}
my $comname = $AUTOLOAD;
$comname =~ s/.*:://;
my $pkg = "FML::Command::${mode}::${comname}";
Log("load $pkg") if $myname eq 'loader'; # debug
my $command = undef;
eval qq{ use $pkg; \$command = new $pkg;};
unless ($@) {
my $need_lock = 0; # no lock by default.
my $lock_channel = 'command_serialize';
# we need to authenticate this ?
if ($command->can('auth')) {
$command->auth($curproc, $command_args);
}
if ($command->can('check_limit')) {
my $n = $command->check_limit($curproc, $command_args);
if ($n) { croak("exceed limit");}
}
# this command needs lock (currently giant lock) ?
if ($command->can('need_lock')) {
$need_lock = $command->need_lock($mode);
# override lock()
if (defined $command_args->{ override_need_no_lock }) {
$need_lock = 0 if $command_args->{ override_need_no_lock };
}
}
else {
LogError("${pkg} has no need_lock method");
$curproc->reply_message("Error: invalid command definition\n");
$curproc->reply_message(" need_lock() is undefined\n");
$curproc->reply_message(" Please contact the maintainer\n");
}
if ($command->can('lock_channel')) {
$lock_channel = $command->lock_channel() || 'command_serialize';
}
# run the actual process
if ($command->can('process')) {
$curproc->lock($lock_channel) if $need_lock;
$command->process($curproc, $command_args);
$curproc->unlock($lock_channel) if $need_lock;
}
else {
LogError("${pkg} has no process method");
}
}
else {
LogError($@) if $@;
LogError("$pkg module is not found");
croak("$pkg module is not found"); # upcall to FML::Process::Command
}
}
=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 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 first appeared in fml8 mailing list driver package.
See C<http://www.fml.org/> for more details.
=cut
1;
|
