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
|
#-*- perl -*-
#
# 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.
#
# $Id$
# $FML$
#
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 - article manipulation components
=head1 SYNOPSIS
use FML::Article;
$article = new FML::Article $curproc;
$header = $article->{ header };
$body = $article->{ body };
=head1 DESCRIPTION
$article object is just a container which holds
C<header> and C<body> object as hash keys.
The C<header> is an FML::Header object and
the C<body> is a MailingList::Messages object.
=head1 METHODS
=head2 C<new(curproc)>
prepare a message duplicated from the incoming message holded in
C<$curproc->{ incoming_message }>.
=cut
# Descriptions: constructor
# Arguments: $self $curproc
# Side Effects: none
# Return Value: FML::Article object
sub new
{
my ($self, $curproc) = @_;
my ($type) = ref($self) || $self;
my $me = {};
_setup_article_template($curproc);
$me->{ curproc } = $curproc;
return bless $me, $type;
}
# Descriptions: prepare article template to distribute
# Arguments: $self $curproc
# Side Effects: build $curproc->{ article }
# Return Value: none
sub _setup_article_template
{
my ($curproc) = @_;
# setup article to distribute
my $msg = $curproc->{'incoming_message'};
# create an article template by duplicating the incoming message
$curproc->{ article }->{ header } = $msg->{'header'}->dup();
$curproc->{ article }->{ body } = $msg->{'body'};
}
=head2 C<increment_id()>
increment article sequence number and
save it to C<$sequence_file>.
This routine uses C<File::Sequence> module.
=head2 C<id()>
return the current article sequence number.
=cut
# Descriptions: determine article id (sequence number)
# Arguments: $self
# Side Effects: record the current article sequence number
# Return Value: number (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 };
use File::Sequence;
my $sfh = new File::Sequence { sequence_file => $seq_file };
my $id = $sfh->increment_id;
if ($sfh->error) { Log( $sfh->error ); }
# save $id in pcb (process control block) and return $id
$pcb->set('article', 'id', $id);
$id;
}
# Descriptions: return the article id (sequence number)
# Arguments: $self
# Side Effects: none
# Return Value: number (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: $self $curproc
# Side Effects:
# Return Value: none
sub spool_in
{
my ($self, $id) = @_;
# configurations
my $curproc = $self->{ curproc };
my $config = $curproc->{ config };
my $spool_dir = $config->{ spool_dir };
if ( $config->yes( 'use_spool' ) ) {
unless (-d $spool_dir) {
use File::Path;
mkpath( $spool_dir, 0, 0700 );
}
my $file = $spool_dir . "/" . $id;
use FileHandle;
my $fh = new FileHandle;
$fh->open($file, "w");
if (defined $fh) {
$curproc->{ article }->{ header }->print($fh);
print $fh "\n";
$curproc->{ article }->{ body }->raw_print($fh);
$fh->close;
Log("Article $id");
}
}
else {
Log("not spool article");
}
}
=head1 SEE ALSO
L<FML::Header>,
L<MailingList::Messsages>,
L<File::Sequence>
=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::Article appeared in fml5 mailing list driver package.
See C<http://www.fml.org/> for more details.
=cut
1;
|
