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
|
#-*- perl -*-
#
# Copyright (C) 2001,2002,2003 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: get.pm,v 1.16 2003/03/18 10:42:44 fukachan Exp $
#
package FML::Command::User::get;
use strict;
use vars qw(@ISA @EXPORT @EXPORT_OK $AUTOLOAD);
use Carp;
use FML::Command::SendFile;
use FML::Log qw(Log LogWarn LogError);
@ISA = qw(FML::Command::SendFile);
=head1 NAME
FML::Command::User::get - send back articles
=head1 SYNOPSIS
See C<FML::Command> for more details.
=head1 DESCRIPTION
send back articles.
=head1 METHODS
=cut
# Descriptions: standard constructor
# Arguments: OBJ($self)
# Side Effects: none
# Return Value: OBJ
sub new
{
my ($self) = @_;
my ($type) = ref($self) || $self;
my $me = {};
return bless $me, $type;
}
# Descriptions: need lock or not
# Arguments: none
# Side Effects: none
# Return Value: NUM( 1 or 0)
sub need_lock { 1;}
# Descriptions: lock channel
# Arguments: none
# Side Effects: none
# Return Value: STR
sub lock_channel { return 'article_spool_modify';}
=head2 check_limit($curproc, $command_args)
=cut
# Descriptions: check the limit specific to this command.
# Arguments: OBJ($self) OBJ($curproc) HASH_REF($command_args)
# Side Effects: none
# Return Value: NUM(1 or 0)
sub check_limit
{
my ($self, $curproc, $command_args) = @_;
my $config = $curproc->config();
my $pcb = $curproc->pcb();
my $total = $pcb->get('command', 'get_command_total_num_request') || 0;
# 1. check the number of article in one command.
my $limit = $config->{ get_command_request_limit } || 10;
my $nreq = $self->num_files_in_send_article_args($curproc, $command_args);
my $name = $command_args->{ comname };
my $_args = { _arg_command => $name, };
# 1.1 total number of requested articles.
my $total_num_req = $total + $nreq;
$pcb->set('command', 'get_command_total_num_request', $total_num_req);
if ($total_num_req > $limit) {
$curproc->reply_message_nl('command.exceed_total_request_limit',
'total requests exceed limit',
$_args);
LogError("get command limit: total=$total_num_req > $limit");
return $nreq;
}
elsif ($nreq > $limit) {
$curproc->reply_message_nl('command.exceed_request_limit',
'requests exceed limit',
$_args);
LogError("get command limit: $nreq > $limit");
return $nreq;
}
else {
return 0;
}
}
=head2 process()
=cut
# Descriptions: send articles (filename =~ /^\d+/$) by FML::Command::SendFile.
# This module is called after
# FML::Process::Command::_can_accpet_command() already checks the
# command syntax. $options is raw command as ARRAY_REF such as
# $options = [ 'get:3', 1, 100 ];
# send_article() called below can parse MH style argument.
# Arguments: OBJ($self) OBJ($curproc) HASH_REF($command_args)
# Side Effects: none
# Return Value: none
sub process
{
my ($self, $curproc, $command_args) = @_;
# call send_article() without checking here but
# Mail::Message::MH checks and expands the specified targets
# to HASH_ARRAY of numbers: [ \d+, \d+, ... ].
$self->send_article($curproc, $command_args);
}
=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 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::Command::User::get first appeared in fml8 mailing list driver package.
See C<http://www.fml.org/> for more details.
=cut
1;
|
