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
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
|
#-*- 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: Article.pm,v 1.42 2002/07/31 13:00:46 fukachan Exp $
#
package FML::Article;
use strict;
use vars qw(@ISA @EXPORT @EXPORT_OK);
use Carp;
use FML::Log qw(Log LogWarn LogError);
=head1 NAME
FML::Article - manipulate an ML article and related information
=head1 SYNOPSIS
use FML::Article;
$article = new FML::Article $curproc;
# get sequence number
my $id = $article->increment_id;
# spool in the article before delivery
$article->spool_in($id);
my $article_file = $article->filepath($article_id);
=head1 DESCRIPTION
C<$article> object is just a container which holds
C<header> and C<body> object as hash keys.
The C<header> is an C<FML::Header> object,
the C<body> is a C<Mail::Message> object
and
the C<message> is the whole of chains.
new() sets up the $curproc as
my $dupmsg = $curproc->{'incoming_message'}->{ message }->dup_header;
$curproc->{ article }->{ message } = $dupmsg;
$curproc->{ article }->{ header } = $dupmsg->whole_message_header;
$curproc->{ article }->{ body } = $dupmsg->whole_message_body;
This is the basic structure of the article object.
=head1 METHODS
=head2 C<new(curproc)>
prepare an article message, which is duplicated from the incoming
message $curproc->{ incoming_message }.
=cut
# Descriptions: constructor
# Arguments: OBJ($self) OBJ($curproc)
# Side Effects: none
# Return Value: OBJ(FML::Article)
sub new
{
my ($self, $curproc) = @_;
my ($type) = ref($self) || $self;
my $me = {};
if (defined $curproc->{'incoming_message'}->{ message }) {
_setup_article_template($curproc);
}
$me->{ curproc } = $curproc;
return bless $me, $type;
}
# Descriptions: build an article template to distribute
# Arguments: OBJ($curproc)
# Side Effects: build $curproc->{ article }
# Return Value: none
sub _setup_article_template
{
my ($curproc) = @_;
# create an article template by duplicating the incoming message
my $dupmsg = $curproc->{'incoming_message'}->{ message }->dup_header;
if (defined $dupmsg) {
$curproc->{ article }->{ message } = $dupmsg;
$curproc->{ article }->{ header } = $dupmsg->whole_message_header;
$curproc->{ article }->{ body } = $dupmsg->whole_message_body;
}
else {
croak("cannot duplicate message");
}
}
=head2 C<increment_id()>
increment the sequence number of this article C<$self> and
save it to C<$sequence_file>.
This routine uses C<File::Sequence> module.
=cut
# Descriptions: determine article id (sequence number)
# Arguments: OBJ($self)
# Side Effects: save and update the current article sequence number
# Return Value: NUM(sequence identifier)
sub increment_id
{
my ($self) = @_;
my $curproc = $self->{ curproc };
my $config = $curproc->{ config };
my $pcb = $curproc->{ pcb };
my $seq_file = $config->{ sequence_file };
# XXX we should enhance IO::Adapter module to handle
# XXX sequential number.
use File::Sequence;
my $sfh = new File::Sequence { sequence_file => $seq_file };
my $id = $sfh->increment_id;
if ($sfh->error) { LogError( $sfh->error ); }
# save $id in pcb (process control block) and return $id
$pcb->set('article', 'id', $id);
$id;
}
=head2 C<id()>
return the current article sequence number.
=cut
# Descriptions: return the article id (sequence number)
# Arguments: OBJ($self)
# Side Effects: none
# Return Value: NUM(sequence number)
sub id
{
my ($self) = @_;
my $curproc = $self->{ curproc };
my $pcb = $curproc->{ pcb };
return $pcb->get('article', 'id');
}
=head2 C<spool_in(id)>
save the article to the file name C<id> in the article spool.
If the variable C<$use_spool> is 'yes', this routine works.
=cut
# Descriptions: spool in the article
# Arguments: OBJ($self) NUM($id)
# Side Effects: create article in ML spool
# Return Value: none
sub spool_in
{
my ($self, $id) = @_;
my $curproc = $self->{ curproc };
my $config = $curproc->{ config };
my $spool_dir = $config->{ spool_dir };
if ( $config->yes( 'use_spool' ) ) {
unless (-d $spool_dir) {
eval q{
use File::Path;
mkpath( $spool_dir, 0, 0700 );
};
LogError($@) if $@;
}
# translate the article path e.g. spool/1900, spool/2/1900
my $file = $self->filepath($id);
unless (-f $file) {
use FileHandle;
my $fh = new FileHandle;
if (defined $fh) {
$fh->open($file, "w");
$curproc->{ article }->{ header }->print($fh);
print $fh "\n";
$curproc->{ article }->{ body }->print($fh);
$fh->close;
Log("article $id");
}
}
else {
LogError("$id article already exists");
}
}
else {
Log("not spool article");
}
}
=head2 filepath($id)
return article file path.
=cut
# Descriptions: return article file path.
# Arguments: OBJ($self) NUM($id)
# Side Effects: none
# Return Value: STR(file path)
sub filepath
{
my ($self, $id) = @_;
my ($file_path, $dir_path) = $self->_filepath($id);
return $file_path;
}
# Descriptions: return subdir path for this article
# Arguments: OBJ($self) NUM($id)
# Side Effects: none
# Return Value: STR(file path)
sub subdirpath
{
my ($self, $id) = @_;
my ($file_path, $dir_path) = $self->_filepath($id);
return $dir_path;
}
# Descriptions: return article file path.
# Arguments: OBJ($self) NUM($id)
# Side Effects: none
# Return Value: ARRAY( STR(file path), STR(dir path) )
sub _filepath
{
my ($self, $id) = @_;
my $use_subdir = 0;
my $curproc = $self->{ curproc };
my $config = $curproc->{ config };
my $spool_dir = $config->{ spool_dir };
# use subdir ? e.g. spool/0/999 style
if ($config->{ spool_type } eq 'subdir') {
$use_subdir = 1;
}
use Mail::Message::Spool;
my $spool = new Mail::Message::Spool;
my $args = {
base_dir => $spool_dir,
id => $id,
use_subdir => $use_subdir,
subdir_unit => $config->{ spool_subdir_unit },
} ;
my $file = $spool->filepath($args);
my $dir = $spool->dirpath($args);
unless (-d $dir) {
eval q{ use File::Utils qw(mkdirhier);};
mkdirhier($dir, 0700);
}
return ($file, $dir);
}
=head2 speculate_max_id([$spool_dir])
scan the spool_dir and get max number among files in it It must be the
max (latest) article number in its folder.
=cut
# Descriptions: scan the spool_dir and get max number among files in it
# It must be the max (latest) article number in its folder.
# Arguments: OBJ($curproc) STR($spool_dir)
# Side Effects: none
# Return Value: NUM(sequence number) or undef
sub speculate_max_id
{
my ($curproc, $spool_dir) = @_;
my $config = $curproc->{ config };
unless (defined $spool_dir) {
$spool_dir = $config->{ spool_dir };
}
use DirHandle;
my $dh = new DirHandle $spool_dir;
if (defined $dh) {
my $max = 0;
my $fn = ''; # file name
while (defined($fn = $dh->read)) {
next unless $fn =~ /^\d+$/;
$max = $max < $fn ? $fn : $max;
}
$dh->close();
return( $max > 0 ? $max : undef );
}
return undef;
}
=head1 SEE ALSO
L<FML::Header>,
L<Mail::Message>,
L<File::Sequence>
=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::Article appeared in fml5 mailing list driver package.
See C<http://www.fml.org/> for more details.
=cut
1;
|
