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
|
#-*- perl -*-
#
# Copyright (C) 2002 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: DataCheck.pm,v 1.8 2002/12/24 10:19:43 fukachan Exp $
#
package FML::Command::DataCheck;
use strict;
use vars qw(@ISA @EXPORT @EXPORT_OK $AUTOLOAD);
use Carp;
use FML::Log qw(Log LogWarn LogError);
=head1 NAME
FML::Command::DataCheck - parse, clean up et.al. for command buffer
=head1 SYNOPSIS
=head1 DESCRIPTION
=head1 METHODS
=head2 new($args)
=cut
# Descriptions: ordinary constructor
# Arguments: OBJ($self) HASH_REF($args)
# Side Effects: none
# Return Value: OBJ
sub new
{
my ($self, $args) = @_;
my ($type) = ref($self) || $self;
my $me = {};
return bless $me, $type;
}
# Descriptions: return command name ( ^\S+ in $command ) and the sub name.
# remove the prepending strings such as \s, #, ...
# Arguments: OBJ($self) STR($command)
# Side Effects: none
# Return Value: ARRAY(STR, STR)
sub parse_command_buffer
{
my ($self, $command) = @_;
$command = $self->clean_up($command);
my ($comname, $comsubname) = split(/\s+/, $command);
return ($comname, $comsubname);
}
# Descriptions: return arguments after command name $comname in $command.
# Arguments: OBJ($self) STR($command) STR($comname)
# Side Effects: none
# Return Value: ARRAY_REF
sub parse_command_arguments
{
my ($self, $command, $comname) = @_;
my $found = 0;
my (@options) = ();
# XXX-TODO: $comname matches exactly.
# XXX-TODO: so, you need lower/uppercase before this routine.
# pick up arguments into @options after $comname.
# Example:
# $comname = "subscribe";
# $command = "subscribe rudo von schmit";
# @options = [ 'rudo', 'von', 'shmit' ];
for my $buf (split(/\s+/, $command)) {
push(@options, $buf) if $found;
$found = 1 if $buf eq $comname;
}
return \@options;
}
# Descriptions: check the message of the current process to find
# whether it contais some special keyword e.g. "confirm".
# Arguments: OBJ($self) OBJ($curproc) ARRAY_REF($ra_data)
# Side Effects: none
# Return Value: HASH_REF
sub find_special_keyword
{
my ($self, $curproc, $ra_data) = @_;
my $config = $curproc->{ config };
my $confirm_prefix = $config->{ confirm_command_prefix };
my $admin_prefix = $config->{ privileged_command_prefix };
my $confirm_found = '';
my $admin_found = '';
# clean up
$confirm_prefix = $self->clean_up($confirm_prefix);
$admin_prefix = $self->clean_up($admin_prefix);
# XXX $ra_data is not whole body but already parsed and prepared buffer.
# XXX See below and FML::Process::Command module, for example.
# XXX not use /^$regexp/ due to the case such as "> confirm ...".
for my $buf (@$ra_data) {
if ($buf =~ /$confirm_prefix\s+\w+\s+([\w\d]+)/) {
$confirm_found = $1;
}
if ($buf =~ /$admin_prefix\s+\w+\s+([\w\d]+)/) {
$admin_found = $1;
}
}
return {
confirm_keyword => $confirm_found,
admin_keyword => $admin_found,
};
}
# Descriptions: check the message of the current process to find
# whether it contais special keyword e.g. "confirm".
# Arguments: OBJ($self) OBJ($curproc)
# Side Effects: none
# Return Value: NUM( 1 or )
sub find_commands_for_stranger
{
my ($self, $curproc) = @_;
my $config = $curproc->{ config };
my $commands = $config->get_as_array_ref('commands_for_stranger');
my $body = $curproc->incoming_message_body();
my $msg = $body->find_first_plaintext_message();
my (@body) = split(/\n/, $msg->message_text );
my $comname = '';
LINE:
for my $buf (@body) {
($comname) = $self->parse_command_buffer( $buf );
next LINE unless defined($comname) && $comname;
# $comname matches one of $commands_for_stranger ?
# XXX-TODO: we need to care for lowercase/uppercase mismtach ?
# XXX-TODO: need to define macro EQUAL_CASE_INSENSITIVE(a,b) ?
COMMAND:
for my $proc (@$commands) {
next COMMAND unless defined($proc) && $proc;
return 1 if $comname eq $proc;
}
};
my $data = $self->find_special_keyword($curproc, \@body);
return 1 if $data->{ confirm_keyword };
return 0;
}
# Descriptions: clean up the given string and return a cleaned one.
# For example, "# ls uja " -> "ls uja"
# Arguments: OBJ($self) STR($s)
# Side Effects: none
# Return Value: STR
sub clean_up
{
my ($self, $s) = @_;
$s =~ s/^[\#\s]*//;
$s =~ s/\s*$//;
return $s;
}
=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) 2002 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::DataCheck first appeared in fml8 mailing list driver package.
See C<http://www.fml.org/> for more details.
=cut
1;
|
