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
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
|
#-*- perl -*-
#
# Copyright (C) 2000,2001,2002,2003 Ken'ichi Fukamachi
# All rights reserved.
#
# $FML: ConfViewer.pm,v 1.19 2002/12/18 04:43:52 fukachan Exp $
#
package FML::Process::ConfViewer;
use strict;
use Carp;
use vars qw($debug @ISA @EXPORT @EXPORT_OK);
use FML::Log qw(Log LogWarn LogError);
use FML::Process::Kernel;
@ISA = qw(FML::Process::Kernel);
=head1 NAME
FML::Process::ConfViewer -- show configuration variables
=head1 SYNOPSIS
use FML::Process::ConfViewer;
$curproc = new FML::Process::ConfViewer;
...
$curproc->run();
...
=head1 DESCRIPTION
FML::Process::ConfViewer provides the main function for C<fmlconf>.
=head1 METHODS
=head2 C<new($args)>
ordinary constructor.
It make a C<FML::Process::Kernel> object and return it.
=head2 C<prepare($args)>
fix @INC, adjust ml_* and load configuration files.
=head2 C<verify_request($args)>
show help unless @ARGV.
=cut
# Descriptions: ordinary constructor
# Arguments: OBJ($self) HASH_REF($args)
# Side Effects: none
# Return Value: FML::Process::ConfViewer object
sub new
{
my ($self, $args) = @_;
my $type = ref($self) || $self;
my $curproc = new FML::Process::Kernel $args;
return bless $curproc, $type;
}
# Descriptions: adjust ml_* and load configuration files.
# Arguments: OBJ($curproc) HASH_REF($args)
# Side Effects: none
# Return Value: none
sub prepare
{
my ($curproc, $args) = @_;
my $config = $curproc->{ config };
my $eval = $config->get_hook( 'fmlconf_prepare_start_hook' );
if ($eval) {
eval qq{ $eval; };
print STDERR $@ if $@;
}
$curproc->resolve_ml_specific_variables( $args );
$curproc->load_config_files( $args->{ cf_list } );
$curproc->fix_perl_include_path();
$eval = $config->get_hook( 'fmlconf_prepare_end_hook' );
if ($eval) {
eval qq{ $eval; };
print STDERR $@ if $@;
}
}
# Descriptions: check @ARGV, call help() if needed
# Arguments: OBJ($curproc) HASH_REF($args)
# Side Effects: exit ASAP.
# longjmp() to help() if appropriate
# Return Value: none
sub verify_request
{
my ($curproc, $args) = @_;
my $argv = $curproc->command_line_argv();
my $config = $curproc->{ config };
my $eval = $config->get_hook( 'fmlconf_verify_request_start_hook' );
if ($eval) {
eval qq{ $eval; };
print STDERR $@ if $@;
}
if (length(@$argv) == 0 || (not $argv->[0])) {
$curproc->help();
exit(0);
}
$eval = $config->get_hook( 'fmlconf_verify_request_end_hook' );
if ($eval) {
eval qq{ $eval; };
print STDERR $@ if $@;
}
}
=head2 C<run($args)>
the top level dispatcher for C<fmlconf>.
It kicks off internal function C<_fmlconf($args)> for C<fmlconf>.
NOTE:
C<$args> is passed from parrent libexec/loader.
See <FML::Process::Switch()> on C<$args> for more details.
=cut
# Descriptions: just a switch, call _fmlconf()
# Arguments: OBJ($curproc) HASH_REF($args)
# Side Effects: none
# Return Value: none
sub run
{
my ($curproc, $args) = @_;
my $config = $curproc->{ config };
my $myname = $curproc->myname();
my $argv = $curproc->command_line_argv();
my $eval = $config->get_hook( 'fmlconf_run_start_hook' );
if ($eval) {
eval qq{ $eval; };
print STDERR $@ if $@;
}
$curproc->_fmlconf($args);
$eval = $config->get_hook( 'fmlconf_run_end_hook' );
if ($eval) {
eval qq{ $eval; };
print STDERR $@ if $@;
}
}
=head2 help()
show help.
=cut
# Descriptions: show help
# Arguments: OBJ($curproc) HASH_REF($args)
# Side Effects: none
# Return Value: none
sub help
{
my ($curproc, $args) = @_;
my $name = $curproc->myname();
print <<"_EOF_";
Usage: $name [-n] \$ml_name
show all configuration variables
-n show only difference from default
_EOF_
}
# Descriptions: dummy
# Arguments: OBJ($curproc) HASH_REF($args)
# Side Effects: none
# Return Value: none
sub finish
{
my ($curproc, $args) = @_;
my $config = $curproc->{ config };
my $eval = $config->get_hook( 'fmlconf_finish_start_hook' );
if ($eval) {
eval qq{ $eval; };
print STDERR $@ if $@;
}
$eval = $config->get_hook( 'fmlconf_finish_end_hook' );
if ($eval) {
eval qq{ $eval; };
print STDERR $@ if $@;
}
}
=head2 C<_fmlconf($args)> (INTERNAL USE)
run dump_variables of C<FML::Config>.
=cut
# Descriptions: show configurations variables in the sytle "key = value".
# Arguments: OBJ($curproc) HASH_REF($args)
# Side Effects: none
# Return Value: none
sub _fmlconf
{
my ($curproc, $args) = @_;
my $config = $curproc->{ config };
my $mode = $args->{ options }->{ n } ? 'difference_only' : 'all';
my $argv = $curproc->command_line_argv();
# if variable name is given, show the value.
if (defined $argv->[1]) {
my $k = $argv->[1];
print "$k = ", $config->{ $k }, "\n";
}
else {
$config->dump_variables({ mode => $mode });
}
}
=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) 2000,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::Process::ConfViewer first appeared in fml8 mailing list driver package.
See C<http://www.fml.org/> for more details.
=cut
1;
|
