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
|
#-*- 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 File::Sequence;
use strict;
use vars qw(@ISA @EXPORT @EXPORT_OK);
use Carp;
use File::Errors qw(error_reason error error_reset);
=head1 NAME
File::Sequence - maintain the sequence number
=head1 SYNOPSIS
use File::Sequence;
my $sfh = new File::Sequence { sequence_file => $seq_file };
my $id = $sfh->increment_id;
if ($sfh->error) { use Carp; carp( $sfh->error ); }
If you divide the $id by some modulus, use
my $sfh = new File::Sequence {
sequence_file => $seq_file,
modulus => $modules,
};
my $id = $sfh->increment_id;
For example, if you do new() with modulus 3,
my $sfh = new File::Sequence {
sequence_file => $seq_file,
modulus => 3,
};
$id becomes 0, 1, 2, 0, 1, 2...
=head1 DESCRIPTION
=head2 C<new($args)>
$args->{ sequence_file } is the file holding the current sequence number.
=head2 C<increment_id([$file])>
increment the sequence number.
=cut
require Exporter;
@ISA = qw(Exporter);
sub new
{
my ($self, $args) = @_;
my ($type) = ref($self) || $self;
my $me = {};
$me->{ _sequence_file } = $args->{ sequence_file };
$me->{ _modulus } = $args->{ modulus };
return bless $me, $type;
}
sub increment_id
{
my ($self, $file) = @_;
my $id = 0;
my $seq_file = $file || $self->{ _sequence_file };
unless ($seq_file) {
$self->error_reason("the sequence file is not specified");
return 0;
};
# touch the sequence file if it does not exist.
unless (-f $seq_file) {
use File::Utils qw(touch);
touch($seq_file);
};
use IO::File::Atomic;
my ($rh, $wh) = IO::File::Atomic->rw_open($seq_file);
# read the current sequence number
if (defined $rh) {
$id = $rh->getline;
$rh->close;
}
else {
$self->error_reason("cannot open the sequence file");
return 0;
}
# compute the modulus
if (defined $self->{ _modulus }) {
my $modulus = $self->{ _modulus };
$id++;
$id = $id % $modulus;
}
# increment $id. The incremented number is the current article ID.
else {
$id++;
}
# save $id
print $wh $id, "\n";
$wh->close;
$id;
}
=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
File::Sequence appeared in fml5 mailing list driver package.
See C<http://www.fml.org/> for more details.
=cut
1;
|
