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
|
#-*- perl -*-
#
# Copyright (C) 2002,2003,2004,2005,2006 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: list.pm,v 1.27 2006/03/04 13:48:28 fukachan Exp $
#
package FML::Command::Admin::list;
use strict;
use vars qw(@ISA @EXPORT @EXPORT_OK $AUTOLOAD);
use Carp;
=head1 NAME
FML::Command::Admin::list - show the content of specified map(s).
=head1 SYNOPSIS
See C<FML::Command> for more details.
=head1 METHODS
=head2 new()
constructor.
=head2 need_lock()
need lock or not.
=head2 lock_channel()
return lock channel name.
=head2 verify_syntax($curproc, $command_context)
provide command specific syntax checker.
=head2 process($curproc, $command_context)
main command specific routine.
show user list(s).
=cut
# Descriptions: 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 { 0;}
# Descriptions: show the specified map(s).
# Arguments: OBJ($self) OBJ($curproc) OBJ($command_context)
# Side Effects: forward request to dir module
# Return Value: none
sub process
{
my ($self, $curproc, $command_context) = @_;
my $options = [];
my $x_options = $command_context->get_options() || [];
# import makefml options
if (defined $x_options && ref($x_options) eq 'ARRAY') {
if (@$x_options) { $options = $x_options;}
}
$self->_show_list($curproc, $command_context, $options);
}
# Descriptions: show content of the specified map(s).
# Arguments: OBJ($self) OBJ($curproc) OBJ($command_context)
# HASH_ARRAY($options)
# Side Effects: none
# Return Value: none
sub _show_list
{
my ($self, $curproc, $command_context, $options) = @_;
my $config = $curproc->config();
my $maplist = $config->get_as_array_ref('list_command_default_maps');
# XXX first match is ok ?
ARGV:
for my $option (@$options) {
my $list = $self->_get_map_candidates_as_array_ref($option);
KEY:
for my $key (@$list) {
if (defined $config->{ $key } && $config->{ $key }) {
$maplist = $config->get_as_array_ref( $key );
last ARGV;
}
}
}
# cheap sanity
unless (defined $maplist) { croak("list: map undefined");}
unless (@$maplist) { croak("list: map unspecified");}
# $uc_args = FML::User::Control specific parameters
my $uc_args = {
maplist => $maplist,
wh => \*STDOUT,
};
my $r = '';
eval q{
use FML::User::Control;
my $obj = new FML::User::Control;
$obj->print_userlist($curproc, $command_context, $uc_args);
};
if ($r = $@) {
croak($r);
}
}
# Descriptions: generate map name list with $key word.
# Arguments: OBJ($self) STR($key)
# Side Effects: none
# Return Value: ARRAY_REF
sub _get_map_candidates_as_array_ref
{
my ($self, $key) = @_;
my (@list) = (sprintf("%s_maps", $key),
sprintf("primary_%s_map", $key),
sprintf("fml_%s_maps", $key));
if ($key =~ /maps$/ || $key =~ /^primary_\S+_map$/) {
unshift(@list, $key);
}
return \@list;
}
# Descriptions: show cgi menu for list command.
# Arguments: OBJ($self) OBJ($curproc) OBJ($command_context)
# Side Effects: update $member_map $recipient_map
# Return Value: none
sub cgi_menu
{
my ($self, $curproc, $command_context) = @_;
my $r = '';
# navigation bar
eval q{
use FML::CGI::List;
my $obj = new FML::CGI::List;
$obj->cgi_menu($curproc, $command_context);
};
if ($r = $@) {
print $r;
croak($r);
}
print "<hr>\n";
# the default map is defined in _show_list().
# so, we set null string by default.
my $map_default = $curproc->safe_param_map() || '';
my $options = [ $map_default ];
eval q{
$self->_show_list($curproc, $command_context, $options);
};
if ($r = $@) {
print $r;
croak($r);
}
}
=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) 2002,2003,2004,2005,2006 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::Admin::list first appeared in fml8 mailing list driver package.
See C<http://www.fml.org/> for more detailist.
=cut
1;
|
