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
|
#-*- perl -*-
#
# Copyright (C) 2001,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: SendFile.pm,v 1.12 2002/02/17 03:13:48 fukachan Exp $
#
package FML::Command::SendFile;
use strict;
use vars qw(@ISA @EXPORT @EXPORT_OK $AUTOLOAD);
use Carp;
use File::Spec;
use FML::Log qw(Log LogWarn LogError);
=head1 NAME
FML::Command::SendFile - utility functions to send back file(s)
=head1 SYNOPSIS
For example, See L<FML::Command::User::get> and
L<FML::Command::Admin::get>..
sub process
{
my ($self, $curproc, $command_args) = @_;
$self->send_article($curproc, $command_args);
}
=head1 DESCRIPTION
This module provides several utility functions to send back article
and file in C<$ml_home_dir>.
=head1 METHODS
=head2 C<send_article($curproc, $command_args)>
send back articles. This is used in C<FML::Command::User> and
C<FML::Command::Admin> modules.
=cut
# Descriptions: send back articles
# Arguments: OBJ($self) OBJ($curproc) HASH_REF($command_args)
# Side Effects: none
# Return Value: none
sub send_article
{
my ($self, $curproc, $command_args) = @_;
my $command = $command_args->{ command };
my $config = $curproc->{ config };
my $ml_name = $config->{ ml_name };
my $spool_dir = $config->{ spool_dir };
my $charset = $config->{ template_file_charset };
my $is_error = 0;
# command buffer = get 1
# command buffer = get 1,2,3
# command buffer = get last:3
my (@files) = split(/\s+/, $command);
shift @files; # remove get
for my $fn (@files) {
my $filelist = $self->_is_valid_argument($curproc, $fn);
if (defined $filelist) {
for my $fn (@$filelist) {
my $file = File::Spec->catfile($spool_dir, $fn);
if (-f $file) {
Log("send back article $fn");
$curproc->reply_message( {
type => "message/rfc822; charset=$charset",
path => $file,
filename => $fn,
disposition => "$ml_name ML article $fn",
});
}
else {
Log("no such file: $file");
}
}
}
# invalid argument
else {
Log("send_article: invalid target: $fn");
$is_error = 1;
}
}
if ($is_error) {
$curproc->reply_message_nl('command.get.invalid.args',
"invalid argument");
croak("send_article() fails");
}
}
# Descriptions: check the argument and expand it if needed
# Arguments: OBJ($self) OBJ($curproc) STR($fn)
# Side Effects: none
# Return Value: HASH_ARRAY as [ $fist .. $last ]
sub _is_valid_argument
{
my ($self, $curproc, $fn) = @_;
use File::Sequence;
my $config = $curproc->{ config };
my $file = $config->{ sequence_file };
my $sequence = new File::Sequence { sequence_file => $file };
if ($fn =~ /^\d+$/) {
return [ $fn ];
}
elsif ($fn =~ /^[\d,]+$/) {
my (@fn) = split(/,/, $fn);
return \@fn;
}
elsif ($fn =~ /^(\d+)\-(\d+)$/) {
my ($first, $last) = ($1, $2);
return _expand_range($first, $last);
}
elsif ($fn eq 'first') {
return [ 1 ];
}
elsif ($fn eq 'last' || $fn eq 'cur') {
my $last_id = $sequence->get_id();
return [ $last_id ];
}
elsif ($fn =~ /^first:(\d+)$/) {
my $range = $1;
return _expand_range(1, 1 + $range);
}
elsif ($fn =~ /^last:(\d+)$/) {
my $range = $1;
my $last_id = $sequence->get_id();
return _expand_range($last_id - $range, $last_id);
}
else {
return undef;
}
}
# Descriptions: make an array from $fist to $last number.
# This array is composed of article numbers.
# Arguments: NUM($first_number) NUM($last_number)
# Side Effects: none
# Return Value: HASH_ARRAY as [ $first .. $last ]
sub _expand_range
{
my ($first, $last) = @_;
my (@fn);
for ($first .. $last) { push(@fn, $_);}
return \@fn;
}
=head2 C<send_file($curproc, $command_args)>
send back file specified as C<$command_args->{ _file_to_send }>.
=cut
# Descriptions: send arbitrary file in $ml_home_dir.
# XXX we permit arbitrary file for admin to get.
# Arguments: OBJ($self) OBJ($curproc) HASH_REF($command_args)
# Side Effects: none
# Return Value: none
sub send_file
{
my ($self, $curproc, $command_args) = @_;
my $file_name = $command_args->{ _filename_to_send };
my $what_file = $command_args->{ _file_to_send };
my $config = $curproc->{ config };
my $charset = $config->{ reply_message_charset };
# template substitution: kanji code, $varname expansion et. al.
my $params = {
src => $what_file,
charset_out => $charset,
};
my $xxxx_template = $curproc->prepare_file_to_return( $params );
if (-f $xxxx_template) {
$curproc->reply_message( {
type => "text/plain; charset=$charset",
path => $xxxx_template,
filename => $file_name,
disposition => $file_name,
});
}
else {
croak("$what_file not found\n");
}
}
=head2 C<send_user_xxx_message($curproc, $command_args, $type)>
Send back a help file if "help" is found in $ml_home_dir
(e.g. /var/spool/ml/elena) for backward compatibility.
Sebd back the default help message if not found.
=cut
# Descriptions: send back file file in $ml_home_dir if found.
# return the default message if not found.
# Arguments: OBJ($self) OBJ($curproc) HASH_REF($command_args) STR($type)
# Side Effects: put the message into the mail queue
# Return Value: none
sub send_user_xxx_message
{
my ($self, $curproc, $command_args, $type) = @_;
my $config = $curproc->{ config };
# if "help" is found in $ml_home_dir (e.g. /var/spool/ml/elena),
# send it.
if (-f $config->{ "${type}_file" }) {
$command_args->{ _file_to_send } = $config->{ "${type}_file" };
$self->send_file($curproc, $command_args);
}
# if "help" is not found, use the default help message.
else {
$curproc->reply_message_nl("help.user.${type}",
"${type} unavailable (error).");
}
}
=head1 AUTHOR
Ken'ichi Fukamachi
=head1 COPYRIGHT
Copyright (C) 2001,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::SendFile appeared in fml5 mailing list driver package.
See C<http://www.fml.org/> for more details.
=cut
1;
|
