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
|
#-*- perl -*-
#
# Copyright (C) 2001,2002,2003,2004 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.70 2004/10/28 03:33:48 fukachan Exp $
#
package FML::Article;
use strict;
use vars qw(@ISA @EXPORT @EXPORT_OK);
use Carp;
use FML::Article::Sequence;
@ISA = qw(FML::Article::Sequence);
=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> objects 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 head object of message object chains.
C<new()> method 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 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 = { _curproc => $curproc };
my $msg = $curproc->incoming_message();
if (defined $msg) {
unless (defined $curproc->{ article }->{ message }) {
_setup_article_template($curproc, $msg);
}
}
return bless $me, $type;
}
# Descriptions: return lock channel name.
# Arguments: OBJ($self)
# Side Effects: none
# Return Value: STR
sub get_lock_channel_name
{
my ($self) = @_;
# XXX LOCK_CHANNEL: article_spool
return 'article_spool';
}
# Descriptions: build an article template to distribute.
# Arguments: OBJ($curproc) OBJ($msg_in)
# Side Effects: build $curproc->{ article } HASH_REF.
# Return Value: none
sub _setup_article_template
{
my ($curproc, $msg_in) = @_;
# already defined.
return if defined $curproc->{ article }->{ message };
# create an article template by duplicating the incoming message
my $duphdr = $msg_in->dup_header;
if (defined $duphdr) {
# here, we handle raw $curproc to build $curproc->{ article } ...
$curproc->{ article }->{ message } = $duphdr; # head of a chain.
$curproc->{ article }->{ header } = $duphdr->whole_message_header;
$curproc->{ article }->{ body } = $duphdr->whole_message_body;
}
else {
croak("cannot duplicate message");
}
}
=head2 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 specified by $id.
# 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 };
my $use_subdir = $config->{ spool_type } eq 'subdir' ? 1 : 0;
my $channel = $self->get_lock_channel_name();
# XXX-TODO: use_spool -> use_article_spool ?
if ($config->yes( 'use_spool' )) {
$curproc->lock($channel);
unless (-d $spool_dir) {
$curproc->mkdir($spool_dir, "mode=private");
}
# translate id to the article path e.g. spool/1900, spool/2/1900.
my $file = $self->filepath($id);
# verify and create subdir if not found before spooling in.
if ($use_subdir) {
my $dir = $self->subdirpath($id);
unless (-d $dir) {
$curproc->mkdir($dir, "mode=private");
}
}
unless (-f $file) {
my $error = 0;
# XXX-TODO: IO::Adapter::AtomicFile
use FileHandle;
my $fh = new FileHandle;
if (defined $fh) {
$fh->autoflush(1);
$fh->open($file, "w");
my $header = $curproc->article_message_header();
my $body = $curproc->article_message_body();
$fh->clearerr();
$header->print($fh);
$error++ if $fh->error();
print $fh "\n";
$fh->clearerr();
$body->print($fh);
$error++ if $fh->error();
if ($error) {
$fh->close;
$curproc->logerror("failed to create article");
$self->_try_failover($curproc, $id, $file);
}
else {
$fh->close;
$curproc->log("article $id");
# update article message id cache.
my $_header = $curproc->incoming_message_header();
$_header->update_article_message_id_cache($config);
}
}
}
else {
$curproc->logerror("$id article already exists");
}
$curproc->unlock($channel);
}
else {
$curproc->log("article: spooling disabled");
}
}
# Descriptions: When we fail to create article file,
# we try to save the original message at least.
# So, we try to save article content from incoming queue.
# Arguments: OBJ($self) OBJ($curproc) NUM($id) STR($article_file)
# Side Effects: link(2) or rename(2).
# Return Value: none
sub _try_failover
{
my ($self, $curproc, $id, $article_file) = @_;
my $queue = $curproc->mail_queue_get_incoming_queue();
my $queue_id = $queue->id();
my $queue_file = $queue->incoming_file_path($queue_id);
# 0. nuke (must be) broken article file.
if (-f $article_file) { unlink $article_file;}
# 1. try link(2).
if (link($queue_file, $article_file)) {
$curproc->logwarn("article: linked queue to article file");
$curproc->log("article $id (faked)");
}
# 2. try rename(2).
elsif (rename($queue_file, $article_file)) {
$curproc->logwarn("article: renamed queue to article file");
$curproc->log("article $id (faked)");
}
else {
$curproc->logerror("article: give up failover.");
}
}
=head2 filepath($id)
return article file path.
=head2 subdirpath($id)
return subdir 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 and dir path.
# Arguments: OBJ($self) NUM($id)
# Side Effects: none
# Return Value: ARRAY( STR(file path), STR(dir path) )
sub _filepath
{
my ($self, $id) = @_;
my $curproc = $self->{ _curproc };
my $config = $curproc->config();
my $spool_dir = $config->{ spool_dir };
my $use_subdir = $config->{ spool_type } eq 'subdir' ? 1 : 0;
my $unit = $config->{ spool_subdir_unit };
use Mail::Message::Spool;
my $spool = new Mail::Message::Spool;
my $mms_args = {
base_dir => $spool_dir,
id => $id,
use_subdir => $use_subdir,
subdir_unit => $unit,
} ;
my $file = $spool->filepath($mms_args);
my $dir = $spool->dirpath($mms_args); # spool/ or spool/$subdir/
return ($file, $dir);
}
=head1 SEE ALSO
L<FML::Header>,
L<Mail::Message>
=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,2004 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 first appeared in fml8 mailing list driver package.
See C<http://www.fml.org/> for more details.
=cut
1;
|
