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
|
#-*- perl -*-
#
# Copyright (C) 2001,2002 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: Kernel.pm,v 1.13 2002/01/30 15:20:30 fukachan Exp $
#
package FML::Process::CGI::Kernel;
use strict;
use vars qw(@ISA @EXPORT @EXPORT_OK $AUTOLOAD);
use Carp;
use File::Spec;
use FML::Process::Kernel;
use FML::Log qw(Log LogWarn LogError);
@ISA = qw(FML::Process::Kernel);
# load standard CGI routines
use CGI qw/:standard/;
=head1 NAME
FML::Process::CGI::Kernel - CGI basic functions
=head1 SYNOPSIS
use FML::Process::CGI::Kernel;
my $obj = new FML::Process::CGI::Kernel;
$obj->prepare($args);
... snip ...
This new() creates CGI object which wraps C<FML::Process::Kernel>.
=head1 DESCRIPTION
the base class of CGI programs.
It provides basic functions and flow.
=head1 METHODS
=head2 C<new()>
ordinary constructor which is used widely in FML::Process classes.
=cut
# Descriptions: constructor.
# now we re-evaluate $ml_home_dir and @cf again.
# but we need the mechanism to re-evaluate $args passed from
# libexec/loader.
# Arguments: OBJ($self) HASH_REF($args)
# Side Effects: none
# Return Value: OBJ
sub new
{
my ($self, $args) = @_;
my $type = ref($self) || $self;
my $is_need_ml_name = $args->{ 'need_ml_name' };
# we should get $ml_name from HTTP.
if ($is_need_ml_name) {
my $ml_home_prefix = $args->{ ml_home_prefix };
my $ml_name = safe_param_ml_name($self) || do {
croak("not get ml_name from HTTP") if $args->{ need_ml_name };
};
use File::Spec;
my $ml_home_dir = File::Spec->catfile($ml_home_prefix, $ml_name);
my $config_cf = File::Spec->catfile($ml_home_dir, 'config.cf');
# fix $args { cf_list, ml_home_dir };
my $cflist = $args->{ cf_list };
push(@$cflist, $config_cf);
$args->{ ml_home_dir } = $ml_home_dir;
}
# o.k. load configurations
my $curproc = new FML::Process::Kernel $args;
return bless $curproc, $type;
}
=head2 C<prepare()>
print HTTP header.
The charset is C<euc-jp> by default.
=cut
# Descriptions: html header.
# FML::Process::Kernel::prepare() parses incoming_message
# CGI do not parse incoming_message;
# Arguments: OBJ($curproc)
# Side Effects: none
# Return Value: none
sub prepare
{
my ($curproc) = @_;
my $config = $curproc->{ config };
my $charset = $config->{ cgi_charset } || 'euc-jp';
print header(-type => "text/html; charset=$charset",
-charset => $charset,
-target => "_top");
}
=head2 C<verify_request()>
dummy method now.
=head2 C<finish()>
dummy method now.
=cut
sub verify_request { 1;}
sub finish { 1;}
=head2 C<run()>
dispatch *.cgi programs.
FML::CGI::XXX module should implement these routines:
star_html(), run_cgi() and end_html().
run() executes
$curproc->start_html($args);
$curproc->run_cgi($args);
$curproc->end_html($args);
=cut
# Descriptions: run FML::CGI::* methods
# html_start()
# run_cgi()
# html_end()
# Arguments: OBJ($curproc) HASH_REF($args)
# Side Effects: none
# Return Value: none
sub run
{
my ($curproc, $args) = @_;
$curproc->html_start($args);
$curproc->run_cgi($args);
$curproc->html_end($args);
}
=head2 get_ml_list($args)
get HASH ARRAY of valid mailing lists.
=cut
# Descriptions: list up ML
# Arguments: OBJ($curproc) HASH_REF($args)
# Side Effects: none
# Return Value: HASH_ARRAY
sub get_ml_list
{
my ($curproc, $args) = @_;
my $config = $curproc->{ config };
use File::Spec;
my $cf = '';
use DirHandle;
my $dh = new DirHandle $config->{ ml_home_prefix };
my @dirlist;
my $prefix = $config->{ ml_home_prefix };
while ($_ = $dh->read()) {
next if /^\./;
next if /^\@/;
$cf = File::Spec->catfile($prefix, $_, "config.cf");
push(@dirlist, $_) if -f $cf;
}
$dh->close;
return \@dirlist;
}
=head2 safe_param_xxx()
get and filter param('xxx') via AUTOLOAD().
=cut
# Descriptions: trap safe_param_XXX()
# Arguments: OBJ($curproc)
# Side Effects: callback to safe_param*().
# Return Value: depend on safe_param*() return value
sub AUTOLOAD
{
my ($curproc) = @_;
return if $AUTOLOAD =~ /DESTROY/;
my $comname = $AUTOLOAD;
$comname =~ s/.*:://;
if ($comname =~ /^(safe_paramlist)(\d+)_(\S+)/) {
my ($method, $numregexp, $varname) = ($1, $2, $3);
return $curproc->$method($numregexp, $varname);
}
elsif ($comname =~ /^(safe_param)_(\S+)/) {
my ($method, $varname) = ($1, $2);
return $curproc->$method($varname);
}
else {
croak("unknown method $comname");
}
}
=head1 AUTHOR
Ken'ichi Fukamachi
=head1 COPYRIGHT
Copyright (C) 2001,2002 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::Process::CGI::Kernel appeared in fml5 mailing list driver package.
See C<http://www.fml.org/> for more details.
=cut
1;
|
