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
|
#!/usr/local/bin/perl -w
#-*- perl -*-
#
# Copyright (C) 2000,2001 Ken'ichi Fukamachi
# All rights reserved.
#
# $FML: Command.pm,v 1.14 2001/10/10 14:56:01 fukachan Exp $
#
package FML::Process::Command;
use vars qw($debug @ISA @EXPORT @EXPORT_OK);
use strict;
use Carp;
use FML::Process::Kernel;
use FML::Log qw(Log LogWarn LogError);
use FML::Config;
@ISA = qw(FML::Process::Kernel);
=head1 NAME
FML::Process::Command -- fml5 command dispacher.
=head1 SYNOPSIS
use FML::Process::Command;
...
See L<FML::Process::Flow> for details of fml process flow.
=head1 DESCRIPTION
C<FML::Process::Command> is a command wrapper and top level
dispatcher for commands.
It kicks off corresponding
C<FML::Command>->C<$command($curproc,$args)>
for the given C<$command>.
=head1 METHODS
=head2 C<new($args)>
make fml process object.
my $curproc = new FML::Process::Kernel $args;
=head2 C<prepare($args)>
forward the request to SUPER CLASS.
=cut
sub new
{
my ($self, $args) = @_;
my $type = ref($self) || $self;
my $curproc = new FML::Process::Kernel $args;
return bless $curproc, $type;
}
sub prepare
{
my ($self, $args) = @_;
$self->SUPER::prepare($args);
}
=head2 C<verify_request($args)>
verify the sender is a valid member or not.
=cut
sub verify_request
{
my ($curproc, $args) = @_;
$curproc->verify_sender_credential();
}
=head2 C<run($args)>
dispatcher to run correspondig C<FML::Command::command> for
C<command>.
lock
execute FML::Command::command
unlock
=cut
sub run
{
my ($curproc, $args) = @_;
# $curproc->lock();
{
if ($curproc->permit_command($args)) {
$curproc->_evaluate_command($args);
}
else {
Log("deny command submission");
}
}
# $curproc->unlock();
}
=head2 C<finish($args)>
$curproc->inform_reply_messages();
=cut
sub finish
{
my ($curproc, $args) = @_;
$curproc->inform_reply_messages();
$curproc->queue_flush();
}
# dynamic loading of command definition.
# It resolves your customized command easily.
sub _evaluate_command
{
my ($curproc, $args) = @_;
my $config = $curproc->{ config };
my $ml_name = $config->{ ml_name };
my $argv = $config->{ main_cf }->{ ARGV };
my $body = $curproc->{ incoming_message }->{ body }->data_in_body_part;
my @body = split(/\n/, $body);
my $prompt = $config->{ command_prompt } || '>>>';
$curproc->reply_message("result for your command requests follows:");
COMMAND:
for my $command (@body) {
#
# cheap diagnostics
#
# 1. command exists or not
my $comname = (split(/\s+/, $command))[0];
my $is_valid =
$config->has_attribute( "available_commands", $comname )
? 'yes' : 'no';
Log("command = " . $comname . " (valid?=$is_valid)");
# 2. command syntax check
use FML::Filter::Utils;
unless ( FML::Filter::Utils::is_secure_command_string( $command ) ) {
LogError("insecure command: $command");
$curproc->reply_message("\n$prompt $command");
$curproc->reply_message("insecure, so ignored.");
$is_valid = 'no';
}
# stop.
next COMMAND if $is_valid eq 'no';
# arguments to pass off to each method
my @options = ();
my $optargs = {
command_mode => 'user',
command => $command,
ml_name => $ml_name,
options => \@options,
argv => $argv,
args => $args,
};
use FML::Command;
my $obj = new FML::Command;
if (defined $obj) {
$curproc->reply_message("\n$prompt $command");
eval q{
$obj->$comname($curproc, $optargs);
};
unless ($@) {
$curproc->reply_message_nl('general.success', "ok.");
}
else {
$curproc->reply_message_nl('general.fail', "fail.");
LogError("command ${comname} fail");
if ($@ =~ /^(.*)at/) {
my $reason = $1;
my $nlinfo = $obj->error_nl();
if (defined $nlinfo) {
my $class = $nlinfo->{ class };
my $args = $nlinfo->{ args };
$curproc->reply_message_nl($class, $reason, $args);
}
else {
$curproc->reply_message($reason);
}
Log($reason); # pick up reason
}
}
}
#
# next COMMAND;
#
}
}
=head1 AUTHOR
Ken'ichi Fukamachi
=head1 COPYRIGHT
Copyright (C) 2001 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::Process::Command appeared in fml5 mailing list driver package.
See C<http://www.fml.org/> for more details.
=cut
1;
|
