summaryrefslogtreecommitdiff
path: root/fml/lib/FML/Header/MessageID.pm
blob: c4bd4bb87f9aee9a30229e592134b7852aa33328 (plain)
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
#-*- 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.
#
# $FML: MessageID.pm,v 1.3 2001/12/22 09:21:07 fukachan Exp $
#

package FML::Header::MessageID;
use strict;
use vars qw(@ISA @EXPORT @EXPORT_OK $AUTOLOAD $Counter);
use Carp;

=head1 NAME

FML::Header::MessageID - manupulate message-id

=head1 SYNOPSIS

    use FML::Header::MessageID;
    my $mid = new FML::Header::MessageID;
    my $obj = $mid->open_cache( {
        directory => $directory,
    });

    if (defined $obj) {
           my $fh = $obj->open;

           # we can tind the $message_id in the past message-id cache ?
           my $dup = $obj->find($message_id);
           print STDERR "error: message-id duplicated\nq" if $dup;

           # save the current id
           print $fh $message_id, "\t", $message_id, "\n";

           $fh->close;
       }
   }

=head1 DESCRIPTION

manipulate Message-Id database.

=head1 METHODS

=head2 C<new($args)>

standard constructor.

=cut


use File::CacheDir;
@ISA = qw(File::CacheDir);


# Descriptions: standard 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;
}


=head2 C<open_cache($args)>

open cache and return C<File::CacheDir> object.

=cut


# Descriptions: open message-id database
#    Arguments: OBJ($self) HASH_REF($args)
# Side Effects: none
# Return Value: OBJ
sub open_cache
{
    my ($self, $args) = @_;
    my $dir  = $args->{ 'directory' };
    my $mode = 'temporal';
    my $days = 14;

    if ($dir) {
	my $obj = new File::CacheDir {
	    directory  => $dir,
	    cache_type => $mode,
	    expires_in => $days,
	};

	$self->{ _obj } = $obj;
	return $obj;
    }

    undef;
}


=head2 C<get($key)>

get value for the key $key in message-id database.

=head2 C<set($key, $value)>

set value for the key $key in message-id database.

=cut


# Descriptions: get value for $key
#    Arguments: OBJ($self) STR($key)
# Side Effects: none
# Return Value: STR
sub get
{
    my ($self, $key) = @_;
    my $obj = $self->{ _obj };

    if (defined $obj) {
	return $obj->find($key);
    }

    undef;
}


# Descriptions: set value for $key
#    Arguments: OBJ($self) STR($key) STR($value)
# Side Effects: none
# Return Value: STR
sub set
{
    my ($self, $key, $value) = @_;
    my $obj = $self->{ _obj };

    if (defined $obj) {
	$obj->set($key, $value);
    }

    undef;
}


=head2 C<gen_id($curproc, $args)>

generate and return a new message-id.

=cut


# Descriptions: generate new message-id used in reply message
#    Arguments: OBJ($self) OBJ($curproc) HASH_REF($args)
# Side Effects: counter increment
# Return Value: STR
sub gen_id
{
    my ($self, $curproc, $args) = @_;
    my $config = $curproc->{ config };

    $Counter++;
    time.".$$.$Counter\@" . $config->{ address_for_post };
}


=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::Header::MessageID appeared in fml5 mailing list driver package.
See C<http://www.fml.org/> for more details.

=cut


1;