diff options
| author | fukachan <fukachan> | 2004-07-23 13:16:30 +0000 |
|---|---|---|
| committer | fukachan <fukachan> | 2004-07-23 13:16:30 +0000 |
| commit | 017265cfc701f6abcd99f52a0fa6eb9516fd510f (patch) | |
| tree | 971613cdfec2b93173ad88a8dfa579dc29ba5ac3 | |
| parent | 1359417a1475d1530200003dd4005954bff51c50 (diff) | |
| download | fml8-017265cfc701f6abcd99f52a0fa6eb9516fd510f.tar.gz fml8-017265cfc701f6abcd99f52a0fa6eb9516fd510f.tar.bz2 fml8-017265cfc701f6abcd99f52a0fa6eb9516fd510f.zip | |
fix comments (FNF)
64 files changed, 330 insertions, 269 deletions
diff --git a/fml/lib/ErrorStatus.pm b/fml/lib/ErrorStatus.pm index b6115c31..c751dcdd 100644 --- a/fml/lib/ErrorStatus.pm +++ b/fml/lib/ErrorStatus.pm @@ -1,10 +1,10 @@ #-*- perl -*- # -# Copyright (C) 2001,2002,2003 Ken'ichi Fukamachi +# Copyright (C) 2001,2002,2003,2004 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: ErrorStatus.pm,v 1.8 2003/08/23 04:35:25 fukachan Exp $ +# $FML: ErrorStatus.pm,v 1.9 2004/07/11 14:20:09 fukachan Exp $ # package ErrorStatus; @@ -129,7 +129,7 @@ Ken'ichi Fukamachi =head1 COPYRIGHT -Copyright (C) 2001,2002,2003 Ken'ichi Fukamachi +Copyright (C) 2001,2002,2003,2004 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. diff --git a/fml/lib/FML/Article.pm b/fml/lib/FML/Article.pm index eec23a9b..90b0681a 100644 --- a/fml/lib/FML/Article.pm +++ b/fml/lib/FML/Article.pm @@ -4,7 +4,7 @@ # All rights reserved. This program is free software; you can # redistribute it and/or modify it under the same terms as Perl itself. # -# $FML: Article.pm,v 1.65 2004/05/25 04:04:43 fukachan Exp $ +# $FML: Article.pm,v 1.66 2004/05/28 03:53:50 fukachan Exp $ # package FML::Article; @@ -19,7 +19,7 @@ use FML::Article::Sequence; =head1 NAME -FML::Article - manipulate an ML article and related information +FML::Article - manipulate an ML article and related information. =head1 SYNOPSIS @@ -129,7 +129,7 @@ If the variable C<$use_spool> is 'yes', this routine works. =cut -# Descriptions: spool in the article +# Descriptions: spool in the article specified by $id. # Arguments: OBJ($self) NUM($id) # Side Effects: create article in ML spool # Return Value: none @@ -150,10 +150,10 @@ sub spool_in $curproc->mkdir($spool_dir, "mode=private"); } - # translate the article path e.g. spool/1900, spool/2/1900 + # translate id to the article path e.g. spool/1900, spool/2/1900. my $file = $self->filepath($id); - # verify and create subdir if not found before spool in. + # verify and create subdir if not found before spooling in. if ($use_subdir) { my $dir = $self->subdirpath($id); unless (-d $dir) { diff --git a/fml/lib/FML/Article/Thread.pm b/fml/lib/FML/Article/Thread.pm index 6b7526dc..2f925b4a 100644 --- a/fml/lib/FML/Article/Thread.pm +++ b/fml/lib/FML/Article/Thread.pm @@ -3,7 +3,7 @@ # Copyright (C) 2003,2004 Ken'ichi Fukamachi # All rights reserved. # -# $FML: Thread.pm,v 1.8 2004/03/31 12:38:08 fukachan Exp $ +# $FML: Thread.pm,v 1.9 2004/04/23 04:10:26 fukachan Exp $ # package FML::Article::Thread; @@ -395,6 +395,7 @@ sub check_if_article_is_reply_message # 2) it looks subject has a reply tag ? use FML::Header::Subject; my $subj = new FML::Header::Subject; + # XXX need $subject is already decoded. if ($subj->is_reply($subject)) { $thread->set_article_status($id, $state_followed); } diff --git a/fml/lib/FML/CGI/Admin/Menu.pm b/fml/lib/FML/CGI/Admin/Menu.pm index aa15bff5..a74f0fd2 100644 --- a/fml/lib/FML/CGI/Admin/Menu.pm +++ b/fml/lib/FML/CGI/Admin/Menu.pm @@ -4,7 +4,7 @@ # All rights reserved. This program is free software; you can # redistribute it and/or modify it under the same terms as Perl itself. # -# $FML: Menu.pm,v 1.28 2004/01/18 13:56:06 fukachan Exp $ +# $FML: Menu.pm,v 1.29 2004/01/21 03:45:04 fukachan Exp $ # package FML::CGI::Admin::Menu; @@ -19,7 +19,7 @@ use FML::CGI::Menu; =head1 NAME -FML::CGI::Admin::Menu - provides CGI control function for the specific domain +FML::CGI::Admin::Menu - provides CGI control function for the specific domain. =head1 SYNOPSIS diff --git a/fml/lib/FML/CGI/Calendar.pm b/fml/lib/FML/CGI/Calendar.pm index 2feb0b17..4c4f23bf 100644 --- a/fml/lib/FML/CGI/Calendar.pm +++ b/fml/lib/FML/CGI/Calendar.pm @@ -4,7 +4,7 @@ # All rights reserved. This program is free software; you can # redistribute it and/or modify it under the same terms as Perl itself. # -# $FML: Calendar.pm,v 1.7 2004/01/01 08:48:38 fukachan Exp $ +# $FML: Calendar.pm,v 1.8 2004/01/01 23:52:09 fukachan Exp $ # package FML::CGI::Calendar; @@ -19,7 +19,7 @@ use FML::Process::CGI; =head1 NAME -FML::CGI::Calendar - CGI module to show calendar as HTML TABLE (DEMO) +FML::CGI::Calendar - CGI module to show calendar as HTML TABLE (DEMO). =head1 SYNOPSIS @@ -61,12 +61,12 @@ print out the navigator and closing of html. sub html_start { my ($curproc) = @_; - my $config = $curproc->config(); - my $user = $curproc->safe_param_user; - my $myname = $curproc->myname(); - my $title = "$user schedule"; - my $color = '#E6E6FA'; - my $charset = $curproc->get_charset("cgi"); + my $config = $curproc->config(); + my $user = $curproc->safe_param_user; + my $myname = $curproc->myname(); + my $title = "$user schedule"; + my $color = '#E6E6FA'; + my $charset = $curproc->get_charset("cgi"); # o.k start html print start_html(-title => $title, @@ -145,7 +145,7 @@ sub run_cgi_main } -# Descriptions: show menu (table based menu) +# Descriptions: show menu (table based menu) (dummy). # Arguments: OBJ($curproc) # Side Effects: none # Return Value: none @@ -156,7 +156,7 @@ sub run_cgi_navigator } -# Descriptions: show menu (table based menu) +# Descriptions: show menu (table based menu) (dummy). # Arguments: OBJ($curproc) # Side Effects: none # Return Value: none diff --git a/fml/lib/FML/CGI/List.pm b/fml/lib/FML/CGI/List.pm index c6051a35..43bdab74 100644 --- a/fml/lib/FML/CGI/List.pm +++ b/fml/lib/FML/CGI/List.pm @@ -4,7 +4,7 @@ # 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.11 2004/02/15 04:38:26 fukachan Exp $ +# $FML: List.pm,v 1.12 2004/04/18 05:59:42 fukachan Exp $ # package FML::CGI::List; @@ -14,7 +14,7 @@ use vars qw(@ISA @EXPORT @EXPORT_OK $AUTOLOAD); use CGI qw/:standard/; # load standard CGI routines -# Descriptions: standard constructor +# Descriptions: constructor. # Arguments: OBJ($self) # Side Effects: none # Return Value: OBJ @@ -27,7 +27,7 @@ sub new } -# Descriptions: show address list +# Descriptions: show address list. # Arguments: OBJ($self) OBJ($curproc) HASH_REF($command_args) # Side Effects: none # Return Value: none diff --git a/fml/lib/FML/CGI/MLAdmin/Menu.pm b/fml/lib/FML/CGI/MLAdmin/Menu.pm index 785ab896..b6baeddf 100644 --- a/fml/lib/FML/CGI/MLAdmin/Menu.pm +++ b/fml/lib/FML/CGI/MLAdmin/Menu.pm @@ -4,7 +4,7 @@ # All rights reserved. This program is free software; you can # redistribute it and/or modify it under the same terms as Perl itself. # -# $FML: Menu.pm,v 1.1 2003/09/25 11:40:57 fukachan Exp $ +# $FML: Menu.pm,v 1.2 2004/01/21 03:45:07 fukachan Exp $ # package FML::CGI::MLAdmin::Menu; @@ -19,7 +19,7 @@ use FML::CGI::Menu; =head1 NAME -FML::CGI::MLAdmin::Menu - provides CGI controll for the specific domain +FML::CGI::MLAdmin::Menu - provides CGI controll for the specific ML. =head1 SYNOPSIS diff --git a/fml/lib/FML/CGI/Menu.pm b/fml/lib/FML/CGI/Menu.pm index 359719ab..b9f3b8a5 100644 --- a/fml/lib/FML/CGI/Menu.pm +++ b/fml/lib/FML/CGI/Menu.pm @@ -4,7 +4,7 @@ # All rights reserved. This program is free software; you can # redistribute it and/or modify it under the same terms as Perl itself. # -# $FML: Menu.pm,v 1.10 2004/03/31 05:28:17 fukachan Exp $ +# $FML: Menu.pm,v 1.11 2004/03/31 12:34:26 fukachan Exp $ # package FML::CGI::Menu; @@ -21,7 +21,7 @@ my $debug = 0; =head1 NAME -FML::CGI::Menu - provides CGI control function for the specific domain +FML::CGI::Menu - provides CGI control function for the specific domain. =head1 SYNOPSIS @@ -65,7 +65,7 @@ This module has routines needed for the admin CGI. =cut -# Descriptions: print out HTML header + body former part +# Descriptions: print out HTML header + body former part. # Arguments: OBJ($curproc) # Side Effects: none # Return Value: none @@ -89,7 +89,7 @@ sub html_start } -# Descriptions: print out body latter part +# Descriptions: print out body latter part. # Arguments: OBJ($curproc) # Side Effects: none # Return Value: none @@ -204,7 +204,7 @@ sub run_cgi_main } -# Descriptions: show menu (table based menu) +# Descriptions: show menu (table based menu). # Arguments: OBJ($curproc) # Side Effects: none # Return Value: none @@ -265,7 +265,7 @@ execute cgi_menu() given as FML::Command::* =cut -# Descriptions: execute FML::Command +# Descriptions: show meu. # Arguments: OBJ($curproc) # Side Effects: load module # Return Value: none @@ -279,12 +279,12 @@ sub run_cgi_menu =head2 run_cgi_help() -help. +show help. =cut -# Descriptions: show help +# Descriptions: show help. # Arguments: OBJ($curproc) # Side Effects: none # Return Value: none @@ -321,12 +321,12 @@ sub run_cgi_help =head2 run_cgi_command_help() -command_help. +show command dependent help. =cut -# Descriptions: show command_dependent help +# Descriptions: show command dependent help. # Arguments: OBJ($curproc) # Side Effects: none # Return Value: none @@ -381,7 +381,7 @@ sub _gen_msg_args L<CGI>, L<FML::Process::CGI> and -L<FML::Process::Flow> +L<FML::Process::Flow>. =head1 CODING STYLE diff --git a/fml/lib/FML/CGI/User.pm b/fml/lib/FML/CGI/User.pm index 27e7e45d..6896f550 100644 --- a/fml/lib/FML/CGI/User.pm +++ b/fml/lib/FML/CGI/User.pm @@ -4,7 +4,7 @@ # All rights reserved. This program is free software; you can # redistribute it and/or modify it under the same terms as Perl itself. # -# $FML: User.pm,v 1.8 2004/01/02 14:50:29 fukachan Exp $ +# $FML: User.pm,v 1.9 2004/01/18 13:56:05 fukachan Exp $ # package FML::CGI::User; @@ -14,7 +14,7 @@ use vars qw(@ISA @EXPORT @EXPORT_OK $AUTOLOAD); use CGI qw/:standard/; # load standard CGI routines -# Descriptions: standard constructor +# Descriptions: constructor. # Arguments: OBJ($self) # Side Effects: none # Return Value: OBJ @@ -44,11 +44,15 @@ sub cgi_menu my $address_list = []; my $selected_key = ''; - # XXX-TODO: who verified $ml_name and $comname ? + # + # XXX $comman_args are checked already. + # $command_args are passed in the following way: + # FML::CGI::Menu::run_cgi_main et.al. builds/checks $command_args. + # FML::CGI::Menu -(via PCB)-> cgi_execute_cgi_menu() -> cgi_menu(). + # - # XXX-TODO: we should enable configurable by config files. - - # which address list to show at the scrolling list + # XXX-TODO: commnd list shoul be configurable by config files. + # which address list to show at the scrolling list. if ($comname eq 'subscribe' || $comname eq 'adduser' || $comname eq 'useradd' || diff --git a/fml/lib/FML/Command/Admin/newdomain.pm b/fml/lib/FML/Command/Admin/newdomain.pm index 7195ad1c..0bae0e1c 100644 --- a/fml/lib/FML/Command/Admin/newdomain.pm +++ b/fml/lib/FML/Command/Admin/newdomain.pm @@ -4,7 +4,7 @@ # All rights reserved. This program is free software; you can # redistribute it and/or modify it under the same terms as Perl itself. # -# $FML: newdomain.pm,v 1.6 2004/01/02 14:49:25 fukachan Exp $ +# $FML: newdomain.pm,v 1.7 2004/01/02 16:08:38 fukachan Exp $ # package FML::Command::Admin::newdomain; @@ -15,7 +15,7 @@ use Carp; =head1 NAME -FML::Command::Admin::newdomain - declare a new domain we use +FML::Command::Admin::newdomain - declare a new domain we use. =head1 SYNOPSIS @@ -28,7 +28,7 @@ declare a new domain we use. =cut -# Descriptions: standard constructor +# Descriptions: constructor. # Arguments: OBJ($self) # Side Effects: none # Return Value: OBJ @@ -41,14 +41,14 @@ sub new } -# Descriptions: not need lock in the first time +# Descriptions: not need lock in the first time. # Arguments: none # Side Effects: none # Return Value: NUM( 1 or 0) sub need_lock { 0;} -# Descriptions: declare a new domain we use +# Descriptions: declare a new domain we use. # Arguments: OBJ($self) OBJ($curproc) HASH_REF($command_args) # Side Effects: forward request to dir module # Return Value: none diff --git a/fml/lib/FML/Command/Admin/newml.pm b/fml/lib/FML/Command/Admin/newml.pm index 637197f1..a1a71f51 100644 --- a/fml/lib/FML/Command/Admin/newml.pm +++ b/fml/lib/FML/Command/Admin/newml.pm @@ -4,7 +4,7 @@ # All rights reserved. This program is free software; you can # redistribute it and/or modify it under the same terms as Perl itself. # -# $FML: newml.pm,v 1.78 2004/02/15 04:38:29 fukachan Exp $ +# $FML: newml.pm,v 1.79 2004/03/16 12:53:40 fukachan Exp $ # package FML::Command::Admin::newml; @@ -15,7 +15,7 @@ use Carp; =head1 NAME -FML::Command::Admin::newml - set up a new mailing list +FML::Command::Admin::newml - set up a new mailing list. =head1 SYNOPSIS @@ -38,7 +38,7 @@ install config.cf, include, include-ctl et. al. =cut -# Descriptions: standard constructor +# Descriptions: constructor. # Arguments: OBJ($self) # Side Effects: none # Return Value: OBJ @@ -51,14 +51,14 @@ sub new } -# Descriptions: not need lock in the first time +# Descriptions: not need lock in the first time. # Arguments: none # Side Effects: none # Return Value: NUM( 1 or 0) sub need_lock { 0;} -# Descriptions: set up a new mailing list +# Descriptions: set up a new mailing list. # Arguments: OBJ($self) OBJ($curproc) HASH_REF($command_args) # Side Effects: create mailing list directory, # install config.cf, include, include-ctl et. al. @@ -162,6 +162,7 @@ sub cgi_menu my ($self, $curproc, $command_args) = @_; my $r = ''; + # XXX-TODO: $command_args checked ? eval q{ use FML::CGI::ML; my $obj = new FML::CGI::ML; diff --git a/fml/lib/FML/Command/Admin/password.pm b/fml/lib/FML/Command/Admin/password.pm index 1649a660..0779daa3 100644 --- a/fml/lib/FML/Command/Admin/password.pm +++ b/fml/lib/FML/Command/Admin/password.pm @@ -4,7 +4,7 @@ # All rights reserved. This program is free software; you can # redistribute it and/or modify it under the same terms as Perl itself. # -# $FML: password.pm,v 1.13.2.1 2004/03/04 04:00:20 fukachan Exp $ +# $FML: password.pm,v 1.14 2004/03/04 04:30:13 fukachan Exp $ # package FML::Command::Admin::password; @@ -15,7 +15,7 @@ use Carp; =head1 NAME -FML::Command::Admin::password - authenticate the remote admin password +FML::Command::Admin::password - authenticate the remote admin password. =head1 SYNOPSIS @@ -45,21 +45,21 @@ sub new } -# Descriptions: need lock or not +# Descriptions: need lock or not. # Arguments: none # Side Effects: none # Return Value: NUM( 1 or 0) sub need_lock { 1;} -# Descriptions: lock channel +# Descriptions: lock channel. # Arguments: none # Side Effects: none # Return Value: STR sub lock_channel { return 'command_serialize';} -# Descriptions: rewrite buffer to hide the password phrase in $rbuf +# Descriptions: rewrite buffer to hide the password phrase in $rbuf. # Arguments: OBJ($self) OBJ($curproc) HASH_REF($command_args) STR_REF($rbuf) # Side Effects: none # Return Value: none diff --git a/fml/lib/FML/Command/Admin/rmdomain.pm b/fml/lib/FML/Command/Admin/rmdomain.pm index f6a6ef35..01609c23 100644 --- a/fml/lib/FML/Command/Admin/rmdomain.pm +++ b/fml/lib/FML/Command/Admin/rmdomain.pm @@ -4,7 +4,7 @@ # All rights reserved. This program is free software; you can # redistribute it and/or modify it under the same terms as Perl itself. # -# $FML: rmdomain.pm,v 1.4 2003/11/16 23:49:12 fukachan Exp $ +# $FML: rmdomain.pm,v 1.5 2003/12/28 13:23:16 fukachan Exp $ # package FML::Command::Admin::rmdomain; @@ -28,7 +28,7 @@ an alias of C<FML::Command::Admin::dir>. =cut -# Descriptions: standard constructor +# Descriptions: constructor. # Arguments: OBJ($self) # Side Effects: none # Return Value: OBJ @@ -41,7 +41,7 @@ sub new } -# Descriptions: not need lock in the first time +# Descriptions: not need lock in the first time. # Arguments: none # Side Effects: none # Return Value: NUM( 1 or 0) diff --git a/fml/lib/FML/Command/Admin/rmml.pm b/fml/lib/FML/Command/Admin/rmml.pm index c8228098..83f998fe 100644 --- a/fml/lib/FML/Command/Admin/rmml.pm +++ b/fml/lib/FML/Command/Admin/rmml.pm @@ -4,7 +4,7 @@ # All rights reserved. This program is free software; you can # redistribute it and/or modify it under the same terms as Perl itself. # -# $FML: rmml.pm,v 1.24 2004/01/01 23:52:13 fukachan Exp $ +# $FML: rmml.pm,v 1.25 2004/01/02 14:45:05 fukachan Exp $ # package FML::Command::Admin::rmml; @@ -15,7 +15,7 @@ use Carp; =head1 NAME -FML::Command::Admin::rmml - remove the specified mailing list +FML::Command::Admin::rmml - remove the specified mailing list. =head1 SYNOPSIS @@ -38,7 +38,7 @@ and the corresponding alias entries. =cut -# Descriptions: standard constructor +# Descriptions: constructor. # Arguments: OBJ($self) # Side Effects: none # Return Value: OBJ @@ -51,7 +51,7 @@ sub new } -# Descriptions: not need lock in the first time +# Descriptions: not need lock in the first time. # Arguments: none # Side Effects: none # Return Value: NUM( 1 or 0) @@ -114,6 +114,7 @@ sub cgi_menu my ($self, $curproc, $command_args) = @_; my $r = ''; + # XXX-TODO: $commnad_args checked ? eval q{ use FML::CGI::ML; my $obj = new FML::CGI::ML; diff --git a/fml/lib/FML/Command/FileUtils.pm b/fml/lib/FML/Command/FileUtils.pm index aedaaada..ffae0c51 100644 --- a/fml/lib/FML/Command/FileUtils.pm +++ b/fml/lib/FML/Command/FileUtils.pm @@ -4,7 +4,7 @@ # All rights reserved. This program is free software; you can # redistribute it and/or modify it under the same terms as Perl itself. # -# $FML: FileUtils.pm,v 1.16 2004/02/15 04:38:27 fukachan Exp $ +# $FML: FileUtils.pm,v 1.17 2004/04/23 04:10:30 fukachan Exp $ # package FML::Command::FileUtils; @@ -15,7 +15,7 @@ use Carp; =head1 NAME -FML::Command::FileUtils - utilities to handle files +FML::Command::FileUtils - utilities to handle files. =head1 SYNOPSIS @@ -25,12 +25,12 @@ FML::Command::FileUtils - utilities to handle files =head2 new() -standard constructor. +constructor. =cut -# Descriptions: standard constructor +# Descriptions: constructor # Arguments: OBJ($self) # Side Effects: none # Return Value: OBJ @@ -60,7 +60,7 @@ in FML::Restriction class. =cut -# Descriptions: remove files +# Descriptions: remove files. # Arguments: OBJ($self) VARARGS(@p) # Side Effects: remove files # Return Value: same as remove() @@ -71,7 +71,7 @@ sub delete } -# Descriptions: remove files +# Descriptions: remove files. # Arguments: OBJ($self) # OBJ($curproc) HASH_REF($command_args) HASH_REF($du_args) # Side Effects: none diff --git a/fml/lib/FML/Command/SendFile.pm b/fml/lib/FML/Command/SendFile.pm index 4a35c472..5075d77a 100644 --- a/fml/lib/FML/Command/SendFile.pm +++ b/fml/lib/FML/Command/SendFile.pm @@ -4,7 +4,7 @@ # All rights reserved. This program is free software; you can # redistribute it and/or modify it under the same terms as Perl itself. # -# $FML: SendFile.pm,v 1.39 2004/03/23 06:34:15 fukachan Exp $ +# $FML: SendFile.pm,v 1.40 2004/04/23 04:10:31 fukachan Exp $ # package FML::Command::SendFile; @@ -18,7 +18,7 @@ my $debug = 0; =head1 NAME -FML::Command::SendFile - utility functions to send back file(s) +FML::Command::SendFile - utility functions to send back file(s). =head1 SYNOPSIS @@ -50,7 +50,7 @@ C<FML::Command::Admin> modules. # Descriptions: return the number of files specified in $command_args. # Arguments: OBJ($self) OBJ($curproc) HASH_REF($command_args) # Side Effects: none -# Return Value: none +# Return Value: NUM sub num_files_in_send_article_args { my ($self, $curproc, $command_args) = @_; @@ -137,7 +137,7 @@ sub send_article } -# Descriptions: check the argument and expand it if needed +# Descriptions: check the argument and expand it if needed. # Arguments: OBJ($self) OBJ($curproc) STR($fn) # Side Effects: none # Return Value: ARRAY_REF as [ $fist .. $last ] @@ -181,12 +181,12 @@ sub send_file my $config = $curproc->config(); # XXX get_charset() take Accpet-Language: header field into account. - my $charset = $curproc->get_charset("reply_message"); + my $charset = $curproc->get_charset("reply_message"); # XXX-TODO: who validate $filename and $filepath ? $curproc->log("send_file: $filepath"); - # template substitution: kanji code, $varname expansion et. al. + # template substitution: kanji code, $varname expansion et.al. # we prepare file to send back which has proper kanji code et.al. my $params = { src => $filepath, diff --git a/fml/lib/FML/Config.pm b/fml/lib/FML/Config.pm index 40df5486..68a546e5 100644 --- a/fml/lib/FML/Config.pm +++ b/fml/lib/FML/Config.pm @@ -4,7 +4,7 @@ # All rights reserved. This program is free software; you can # redistribute it and/or modify it under the same terms as Perl itself. # -# $FML: Config.pm,v 1.94 2004/04/17 11:37:56 fukachan Exp $ +# $FML: Config.pm,v 1.95 2004/05/24 15:41:28 fukachan Exp $ # package FML::Config; @@ -30,7 +30,7 @@ $current_context = '__default__'; =head1 NAME -FML::Config -- manipulate fml8 configuration file +FML::Config -- manipulate fml8 configuration name space. =head1 SYNOPSIS @@ -224,7 +224,7 @@ them to %_fml_config. =cut -# Descriptions: load file +# Descriptions: load file. # Arguments: OBJ($self) STR($file) # Side Effects: none # Return Value: none @@ -235,7 +235,7 @@ sub overload } -# Descriptions: load file +# Descriptions: load file. # Arguments: OBJ($self) STR($file) # Side Effects: none # Return Value: none @@ -330,6 +330,7 @@ sub _read_file if ($mode eq 'raw') { # save comment buffer if ($buf =~ /^\s*\#/o) { $comment_buffer .= $buf;} + # XXX-TODO: next LINE ? } else { # by default, nuke trailing "\n" chomp $buf; @@ -411,7 +412,7 @@ sub __update_config } -# Descriptions: append $value into $config +# Descriptions: append $value into $config object. # Arguments: HASH_REF($config) # STR($key) STR($value) STR($name_space) STR($mode) # Side Effects: update $config @@ -506,7 +507,7 @@ appearing order. my $config_hold_space = {}; -# Descriptions: read $file and push the content into $config +# Descriptions: read $file and push the content into $config object. # Arguments: OBJ($self) STR($file) # Side Effects: open file # Return Value: none @@ -548,7 +549,7 @@ sub read } -# Descriptions: save $config into $file +# Descriptions: save $config into $file file. # Arguments: OBJ($self) STR($file) # Side Effects: rewrite $file # Return Value: none @@ -665,7 +666,7 @@ sub __hash_copy } -# Descriptions: update config in the next level name space e.g. [mysql:xxx] +# Descriptions: update config in the next level name space e.g. [mysql:xxx]. # Arguments: OBJ($config) # Side Effects: update config # Return Value: none @@ -684,7 +685,7 @@ sub _expand_nextlevel } -# Descriptions: variable expansion +# Descriptions: variable expansion. # Arguments: OBJ($config) HASH_REF($hints) # Side Effects: variable expansion in $config # Return Value: none @@ -838,7 +839,7 @@ return 0 if not. =cut -# Descriptions: return 1 if the value of the key is "yes" +# Descriptions: return 1 if the value of the key is "yes". # Arguments: OBJ($self) STR($key) # Side Effects: none # Return Value: 1 or 0 @@ -863,7 +864,7 @@ sub yes } -# Descriptions: return 1 if the value of the key is "no" +# Descriptions: return 1 if the value of the key is "no". # Arguments: OBJ($self) STR($key) # Side Effects: none # Return Value: 1 or 0 @@ -1083,7 +1084,7 @@ tie() IO. =cut -# Descriptions: begin op for tie() with %_fml_config +# Descriptions: begin op for tie() with %_fml_config. # Arguments: OBJ($self) # Side Effects: none # Return Value: OBJ @@ -1097,7 +1098,7 @@ sub TIEHASH -# Descriptions: FETCH op for tie() with %_fml_config +# Descriptions: FETCH op for tie() with %_fml_config. # Arguments: OBJ($self) STR($key) # Side Effects: none # Return Value: STR @@ -1132,7 +1133,7 @@ sub FETCH } -# Descriptions: STORE op for tie() with %_fml_config +# Descriptions: STORE op for tie() with %_fml_config. # Arguments: OBJ($self) STR($key) STR($value) # Side Effects: update %_fml_config # Return Value: STR or UNDEF @@ -1154,7 +1155,7 @@ sub STORE } -# Descriptions: DELETE op for tie() with %_fml_config +# Descriptions: DELETE op for tie() with %_fml_config. # Arguments: OBJ($self) STR($key) # Side Effects: update %_fml_config # Return Value: none @@ -1168,7 +1169,7 @@ sub DELETE } -# Descriptions: CLEAR op for tie() with %_fml_config +# Descriptions: CLEAR op for tie() with %_fml_config. # Arguments: OBJ($self) # Side Effects: update %_fml_config # Return Value: none @@ -1181,7 +1182,7 @@ sub CLEAR } -# Descriptions: FIRSTKEY op for tie() with %_fml_config +# Descriptions: FIRSTKEY op for tie() with %_fml_config. # Arguments: OBJ($self) # Side Effects: none # Return Value: STR @@ -1199,7 +1200,7 @@ sub FIRSTKEY } -# Descriptions: NEXTKEY op for tie() with %_fml_config +# Descriptions: NEXTKEY op for tie() with %_fml_config. # Arguments: OBJ($self) # Side Effects: none # Return Value: STR diff --git a/fml/lib/FML/Config/Convert.pm b/fml/lib/FML/Config/Convert.pm index bc7e7790..90c429e6 100644 --- a/fml/lib/FML/Config/Convert.pm +++ b/fml/lib/FML/Config/Convert.pm @@ -4,7 +4,7 @@ # All rights reserved. This program is free software; you can # redistribute it and/or modify it under the same terms as Perl itself. # -# $FML: Convert.pm,v 1.17 2004/01/18 14:05:59 fukachan Exp $ +# $FML: Convert.pm,v 1.18 2004/01/21 03:51:17 fukachan Exp $ # @@ -16,7 +16,7 @@ use Carp; =head1 NAME -FML::Config::Convert -- tiny non object-style variable expansion tool +FML::Config::Convert -- tiny non object-style variable expansion tool. =head1 SYNOPSIS @@ -56,7 +56,8 @@ convert() wrapper for files. =cut -# Descriptions: conversion filter for file handles. +# Descriptions: conversion filter for file handles +# with configuration replacement. # Arguments: HANDLE($in) HANDLE($out) HASH_REF($config) # Side Effects: print out to handle $out # Return Value: none @@ -111,7 +112,7 @@ sub convert_file } -# Descriptions: replace __variable__ with real value in $config +# Descriptions: replace __variable__ with real value in $config. # Arguments: STR($buf) HASH_REF($config) # Side Effects: buffer replacement # Return Value: STR($buf) HASH_REF($config) diff --git a/fml/lib/FML/Credential.pm b/fml/lib/FML/Credential.pm index 7380c640..467355e5 100644 --- a/fml/lib/FML/Credential.pm +++ b/fml/lib/FML/Credential.pm @@ -4,7 +4,7 @@ # All rights reserved. This program is free software; you can # redistribute it and/or modify it under the same terms as Perl itself. # -# $FML: Credential.pm,v 1.59 2004/04/27 13:28:06 fukachan Exp $ +# $FML: Credential.pm,v 1.60 2004/07/11 15:43:36 fukachan Exp $ # package FML::Credential; @@ -46,8 +46,14 @@ So this hash is accessible in public. =head2 new() -bind $self to the module internal C<\%Credential> hash and return the -hash reference as an object. +constructor. It bind $self to the module internal C<\%Credential> hash +and return the hash reference as an object. + +ASSMPUTION: + +We assume one process has one credential since the mail sender must be +unique. It must be one credential even if context switching of +processing mailing list occurs. =cut @@ -115,7 +121,7 @@ sub _reconfigure } -# Descriptions: dummy +# Descriptions: dummy. # Arguments: OBJ($self) HASH_REF($args) # Side Effects: none # Return Value: none @@ -135,7 +141,7 @@ compare user part case insensitively. =cut -# Descriptions: compare user part case sensitively (default) +# Descriptions: compare user part case sensitively. # Arguments: OBJ($self) # Side Effects: none # Return Value: none @@ -192,7 +198,7 @@ For example, consider these two addresses: rudo@nuinui.net rudo@sapporo.nuinui.net -These addresses differs. But +These addresses differ. But rudo@fml.nuinui.net rudo@sapporo.fml.nuinui.net @@ -471,7 +477,7 @@ sub matched_address } -# Descriptions: save the last matched address +# Descriptions: save the last matched address. # Arguments: OBJ($self) STR($address) # Side Effects: update $self->{ _last_matched_address }; # Return Value: STR @@ -482,7 +488,7 @@ sub _save_address } -# Descriptions: return the last matched address +# Descriptions: return the last matched address. # Arguments: OBJ($self) STR($address) # Side Effects: none # Return Value: STR @@ -546,7 +552,7 @@ process. =cut -# Descriptions: return the mail sender +# Descriptions: return the mail sender. # Arguments: OBJ($self) # Side Effects: none # Return Value: STR(mail address) @@ -599,7 +605,7 @@ return the number of C<level>. =cut -# Descriptions: set address comparison level +# Descriptions: set address comparison level. # Arguments: OBJ($self) NUM($level) # Side Effects: change private variables in object # Return Value: NUM @@ -616,7 +622,7 @@ sub set_compare_level } -# Descriptions: return address comparison level +# Descriptions: return address comparison level. # Arguments: OBJ($self) # Side Effects: none # Return Value: NUM @@ -642,7 +648,7 @@ sub get_compare_level # XXX-TODO: remove get() and set(), which are not used ? -# Descriptions: get value for the specified key +# Descriptions: get value for the specified key. # Arguments: OBJ($self) STR($key) # Side Effects: change object # Return Value: STR @@ -660,7 +666,7 @@ sub get } -# Descriptions: set value for $key to be $value +# Descriptions: set value for $key to be $value. # Arguments: OBJ($self) STR($key) STR($value) # Side Effects: none # Return Value: STR diff --git a/fml/lib/FML/Digest.pm b/fml/lib/FML/Digest.pm index 9222e810..7c0ac4a3 100644 --- a/fml/lib/FML/Digest.pm +++ b/fml/lib/FML/Digest.pm @@ -4,7 +4,7 @@ # All rights reserved. This program is free software; you can # redistribute it and/or modify it under the same terms as Perl itself. # -# $FML: Digest.pm,v 1.18 2004/04/11 13:02:15 fukachan Exp $ +# $FML: Digest.pm,v 1.19 2004/04/23 04:10:27 fukachan Exp $ # package FML::Digest; @@ -115,7 +115,7 @@ sub get_article_id } -# Descriptions: return the last article id sent back as digest +# Descriptions: return the last sequence id sent back as digest. # Arguments: OBJ($self) STR($seq_file) # Side Effects: none # Return Value: NUM @@ -143,7 +143,7 @@ sub _get_id } -# Descriptions: return the last article id sent back as digest. +# Descriptions: set digest id. # Arguments: OBJ($self) NUM($id) # Side Effects: none # Return Value: NUM diff --git a/fml/lib/FML/Error/Analyze.pm b/fml/lib/FML/Error/Analyze.pm index 756a8bf8..0ca9f0d1 100644 --- a/fml/lib/FML/Error/Analyze.pm +++ b/fml/lib/FML/Error/Analyze.pm @@ -4,7 +4,7 @@ # All rights reserved. This program is free software; you can # redistribute it and/or modify it under the same terms as Perl itself. # -# $FML: Analyze.pm,v 1.27 2004/02/15 04:38:31 fukachan Exp $ +# $FML: Analyze.pm,v 1.28 2004/04/23 04:10:33 fukachan Exp $ # package FML::Error::Analyze; @@ -41,10 +41,12 @@ FML::Error::Analyze - provide model specific analyzer routines. =head2 new() +constructor. + =cut -# Descriptions: standard constructor +# Descriptions: constructor. # Arguments: OBJ($self) HASH_REF($curproc) # Side Effects: none # Return Value: OBJ @@ -75,7 +77,7 @@ return addresses to be removed. =cut -# Descriptions: return summary +# Descriptions: return summary as HASH_REF. # Arguments: OBJ($self) # Side Effects: none # Return Value: HASH_REF @@ -93,7 +95,7 @@ sub summary } -# Descriptions: return removal address candidates +# Descriptions: return removal address candidates as HASH_REF. # Arguments: OBJ($self) # Side Effects: none # Return Value: ARRAY_REF @@ -128,14 +130,12 @@ sub print =head2 AUTOLOAD() -the command dispatcher. -It hooks up the C<$command> request and loads the module in -C<FML::Command::$MODE::$command>. +the command dispatcher kicking up FML::Error::Analyze::COMMAND class. =cut -# Descriptions: run FML::Error::Analyze::XXX() +# Descriptions: run FML::Error::Analyze::XXX(). # Arguments: OBJ($self) OBJ($curproc) HASH_REF($anal_data) # Side Effects: load appropriate module # Return Value: none diff --git a/fml/lib/FML/Error/Analyze/histgram.pm b/fml/lib/FML/Error/Analyze/histgram.pm index b7ccaedf..f102aed5 100644 --- a/fml/lib/FML/Error/Analyze/histgram.pm +++ b/fml/lib/FML/Error/Analyze/histgram.pm @@ -4,7 +4,7 @@ # All rights reserved. This program is free software; you can # redistribute it and/or modify it under the same terms as Perl itself. # -# $FML: histgram.pm,v 1.9 2004/04/23 04:10:33 fukachan Exp $ +# $FML: histgram.pm,v 1.10 2004/05/22 06:19:52 fukachan Exp $ # package FML::Error::Analyze::histgram; @@ -17,7 +17,7 @@ my $debug = 1; =head1 NAME -FML::Error::Analyze::histgram - cost evaluator +FML::Error::Analyze::histgram - cost evaluator. =head1 SYNOPSIS @@ -72,7 +72,7 @@ but sum up count as the delta. =cut -# Descriptions: error continuity based cost counting +# Descriptions: error continuity based cost counting. # Arguments: OBJ($self) OBJ($curproc) HASH_REF($data) # Side Effects: none # Return Value: ARRAY_REF @@ -171,7 +171,7 @@ sub _histgram } -# Descriptions: return array list with 0 padding (debug) +# Descriptions: return array list with 0 padding (debug). # Arguments: ARRAY_REF($ra) # Side Effects: none # Return Value: STR @@ -204,7 +204,7 @@ sub summary # Descriptions: return addresses to be removed. # Arguments: OBJ($self) # Side Effects: none -# Return Value: HASH_REF +# Return Value: ARRAY_REF sub removal_address { my ($self) = @_; diff --git a/fml/lib/FML/Error/Analyze/simple_count.pm b/fml/lib/FML/Error/Analyze/simple_count.pm index c88f005d..02187072 100644 --- a/fml/lib/FML/Error/Analyze/simple_count.pm +++ b/fml/lib/FML/Error/Analyze/simple_count.pm @@ -4,7 +4,7 @@ # All rights reserved. This program is free software; you can # redistribute it and/or modify it under the same terms as Perl itself. # -# $FML: simple_count.pm,v 1.8 2004/04/23 04:10:33 fukachan Exp $ +# $FML: simple_count.pm,v 1.9 2004/05/22 06:19:52 fukachan Exp $ # package FML::Error::Analyze::simple_count; @@ -17,7 +17,7 @@ my $debug = 1; =head1 NAME -FML::Error::Analyze::simple_count - simple cost evaluator +FML::Error::Analyze::simple_count - simple cost evaluator. =head1 SYNOPSIS @@ -53,7 +53,7 @@ The cost to sum up varies according to the status code. =cut -# Descriptions: main dispatcher +# Descriptions: main dispatcher. # Arguments: OBJ($self) OBJ($curproc) HASH_REF($data) # Side Effects: none # Return Value: none @@ -142,7 +142,7 @@ sub summary # Descriptions: return addresses to be removed. # Arguments: OBJ($self) # Side Effects: none -# Return Value: HASH_REF +# Return Value: ARRAY_REF sub removal_address { my ($self) = @_; @@ -151,7 +151,7 @@ sub removal_address } -# Descriptions: print address and the summary +# Descriptions: print address and the summary. # Arguments: OBJ($self) STR($addr) # Side Effects: none # Return Value: none diff --git a/fml/lib/FML/Error/Cache.pm b/fml/lib/FML/Error/Cache.pm index 0100dc5f..b94c03d0 100644 --- a/fml/lib/FML/Error/Cache.pm +++ b/fml/lib/FML/Error/Cache.pm @@ -4,7 +4,7 @@ # All rights reserved. This program is free software; you can # redistribute it and/or modify it under the same terms as Perl itself. # -# $FML: Cache.pm,v 1.21 2004/04/23 04:10:33 fukachan Exp $ +# $FML: Cache.pm,v 1.22 2004/05/22 06:19:52 fukachan Exp $ # package FML::Error::Cache; @@ -39,12 +39,12 @@ where C<$bounce_info) follows: =head2 new() -standard constructor. +constructor. =cut -# Descriptions: standard constructor +# Descriptions: constructor. # Arguments: OBJ($self) HASH_REF($curproc) # Side Effects: none # Return Value: OBJ @@ -83,19 +83,19 @@ dummy. =cut -# Descriptions: none +# Descriptions: dummy. # Arguments: none # Side Effects: none # Return Value: none sub open { 1;} -# Descriptions: none +# Descriptions: dummy. # Arguments: none # Side Effects: none # Return Value: none sub close { 1;} -# Descriptions: none +# Descriptions: dummy. # Arguments: none # Side Effects: none # Return Value: none @@ -232,7 +232,7 @@ sub _open_cache my $config = $curproc->config(); my $dir = $config->{ error_mail_analyzer_cache_dir }; - # parameters: but not used now. + # parameters. my %db = (); my $type = $config->{ error_mail_analyzer_cache_type }; my $mode = $config->{ error_mail_analyzer_cache_mode } || 'temporal'; diff --git a/fml/lib/FML/Filter/External.pm b/fml/lib/FML/Filter/External.pm index 1ae7b815..ea4287be 100644 --- a/fml/lib/FML/Filter/External.pm +++ b/fml/lib/FML/Filter/External.pm @@ -4,7 +4,7 @@ # All rights reserved. This program is free software; you can # redistribute it and/or modify it under the same terms as Perl itself. # -# $FML: External.pm,v 1.1 2004/05/25 03:39:50 fukachan Exp $ +# $FML: External.pm,v 1.2 2004/05/25 16:11:32 fukachan Exp $ # package FML::Filter::External; @@ -63,6 +63,7 @@ sub spawn \$ext_filter->process(\$curproc, \$msg); }; + # XXX-TODO: exit(75) if timeout. my $r; if ($r = $@) { $curproc->logerror($@); diff --git a/fml/lib/FML/Filter/External/bogofilter.pm b/fml/lib/FML/Filter/External/bogofilter.pm index b8606d89..e70fa3d5 100644 --- a/fml/lib/FML/Filter/External/bogofilter.pm +++ b/fml/lib/FML/Filter/External/bogofilter.pm @@ -4,7 +4,7 @@ # All rights reserved. This program is free software; you can # redistribute it and/or modify it under the same terms as Perl itself. # -# $FML: bogofilter.pm,v 1.1 2004/05/25 03:39:50 fukachan Exp $ +# $FML: bogofilter.pm,v 1.2 2004/06/24 10:40:24 fukachan Exp $ # package FML::Filter::External::bogofilter; @@ -14,7 +14,7 @@ use Carp; =head1 NAME -FML::Filter::External::bogofilter - Bogo Filter interface. +FML::Filter::External::bogofilter - bogofilter interface. =head1 SYNOPSIS @@ -22,7 +22,9 @@ FML::Filter::External::bogofilter - Bogo Filter interface. =head1 METHODS -=head2 C<new()> +=head2 new() + +constructor. =cut diff --git a/fml/lib/FML/Filter/External/clamscan.pm b/fml/lib/FML/Filter/External/clamscan.pm index d376fa27..3ee4a078 100644 --- a/fml/lib/FML/Filter/External/clamscan.pm +++ b/fml/lib/FML/Filter/External/clamscan.pm @@ -4,7 +4,7 @@ # All rights reserved. This program is free software; you can # redistribute it and/or modify it under the same terms as Perl itself. # -# $FML: clamscan.pm,v 1.1 2004/06/24 11:01:33 fukachan Exp $ +# $FML: clamscan.pm,v 1.2 2004/06/26 11:43:08 fukachan Exp $ # package FML::Filter::External::clamscan; @@ -14,7 +14,7 @@ use Carp; =head1 NAME -FML::Filter::External::clamscan - SpamAssassin interface. +FML::Filter::External::clamscan - clamav interface. =head1 SYNOPSIS @@ -22,7 +22,9 @@ FML::Filter::External::clamscan - SpamAssassin interface. =head1 METHODS -=head2 C<new()> +=head2 new() + +constructor. =cut @@ -40,7 +42,7 @@ sub new } -# Descriptions: check if the current message looks a spam. +# Descriptions: check if the current message looks a virus. # Arguments: OBJ($self) OBJ($curproc) # Side Effects: none # Return Value: NUM(1 or 0) (1 if spam) @@ -73,6 +75,8 @@ sub process sub _check { my ($self, $curproc, $program) = @_; + + # XXX-TODO: configurable. my $opts = "--quiet --mbox"; use FileHandle; @@ -84,6 +88,7 @@ sub _check $msg->print($wh); $wh->close(); + # XXX-TODO: correct ? unless (-f $tmp_file) { return 0; } diff --git a/fml/lib/FML/Filter/External/spamc.pm b/fml/lib/FML/Filter/External/spamc.pm index 807ce3b3..2d4544b8 100644 --- a/fml/lib/FML/Filter/External/spamc.pm +++ b/fml/lib/FML/Filter/External/spamc.pm @@ -4,7 +4,7 @@ # All rights reserved. This program is free software; you can # redistribute it and/or modify it under the same terms as Perl itself. # -# $FML: spamc.pm,v 1.1 2004/05/25 03:39:50 fukachan Exp $ +# $FML: spamc.pm,v 1.2 2004/06/24 10:40:24 fukachan Exp $ # package FML::Filter::External::spamc; @@ -22,7 +22,9 @@ FML::Filter::External::spamc - SpamAssassin interface. =head1 METHODS -=head2 C<new()> +=head2 new() + +constructor. =cut @@ -74,6 +76,8 @@ sub process sub _check { my ($self, $curproc, $msg, $program) = @_; + + # XXX-TODO: configurable. my $opts = "-c"; use FileHandle; diff --git a/fml/lib/FML/Filter/Header.pm b/fml/lib/FML/Filter/Header.pm index 5bc78061..557d7d9a 100644 --- a/fml/lib/FML/Filter/Header.pm +++ b/fml/lib/FML/Filter/Header.pm @@ -4,7 +4,7 @@ # All rights reserved. This program is free software; you can # redistribute it and/or modify it under the same terms as Perl itself. # -# $FML: Header.pm,v 1.8 2004/01/21 03:52:00 fukachan Exp $ +# $FML: Header.pm,v 1.9 2004/02/01 14:52:50 fukachan Exp $ # package FML::Filter::Header; @@ -16,7 +16,7 @@ use ErrorStatus qw(error_set error error_clear); =head1 NAME -FML::Filter::Header - filter based on mail header content +FML::Filter::Header - filter based on mail header content. =head1 SYNOPSIS @@ -150,7 +150,7 @@ sub check_message_id } # Descriptions: validate the date in the given message $msg. -# This routine checks missing date field +# This routine checks missing date field. # Arguments: OBJ($self) OBJ($msg) # Side Effects: croak() # Return Value: none diff --git a/fml/lib/FML/Log.pm b/fml/lib/FML/Log.pm index f2a5a587..87ac377c 100644 --- a/fml/lib/FML/Log.pm +++ b/fml/lib/FML/Log.pm @@ -2,7 +2,7 @@ # # Copyright (C) 2000,2001,2002,2003,2004 Ken'ichi Fukamachi # -# $FML: Log.pm,v 1.27 2003/09/13 09:04:51 fukachan Exp $ +# $FML: Log.pm,v 1.28 2004/01/02 14:42:45 fukachan Exp $ # package FML::Log; @@ -18,7 +18,7 @@ use FML::Credential; =head1 NAME -FML::Log - logging functions +FML::Log - logging functions. =head1 SYNOPSIS @@ -78,7 +78,7 @@ same as Log("error: $message", $args); =cut -# Descriptions: write message $msg to logfile +# Descriptions: write message $msg to logfile. # Arguments: STR($mesg) HASH_REF($args) # Side Effects: update logfile # Return Value: none diff --git a/fml/lib/FML/Log/Print/Simple.pm b/fml/lib/FML/Log/Print/Simple.pm index 5123fc68..68b06bac 100644 --- a/fml/lib/FML/Log/Print/Simple.pm +++ b/fml/lib/FML/Log/Print/Simple.pm @@ -4,7 +4,7 @@ # All rights reserved. This program is free software; you can # redistribute it and/or modify it under the same terms as Perl itself. # -# $FML: Simple.pm,v 1.3 2004/01/22 12:34:23 fukachan Exp $ +# $FML: Simple.pm,v 1.4 2004/01/23 09:17:38 fukachan Exp $ # package FML::Log::Print::Simple; @@ -14,7 +14,7 @@ use Carp; =head1 NAME -FML::Log::Print::Simple - simplest print out engine +FML::Log::Print::Simple - simplest print out engine. =head1 SYNOPSIS @@ -44,7 +44,7 @@ sub new } -# Descriptions: add message to message queue. +# Descriptions: add message to module internal message queue. # Arguments: OBJ($self) OBJ($msg) # Side Effects: update queue. # Return Value: none diff --git a/fml/lib/FML/ML/Control.pm b/fml/lib/FML/ML/Control.pm index 4b59d98c..b4e1013e 100644 --- a/fml/lib/FML/ML/Control.pm +++ b/fml/lib/FML/ML/Control.pm @@ -4,7 +4,7 @@ # All rights reserved. This program is free software; you can # redistribute it and/or modify it under the same terms as Perl itself. # -# $FML: Control.pm,v 1.4 2004/01/23 09:17:36 fukachan Exp $ +# $FML: Control.pm,v 1.5 2004/02/15 04:38:32 fukachan Exp $ # package FML::ML::Control; @@ -23,10 +23,14 @@ FML::ML::Control - create, rename and delete ml_home_dir. =head1 METHODS +=head2 new() + +constructor. + =cut -# Descriptions: standard constructor. +# Descriptions: constructor. # Arguments: OBJ($self) OBJ($curproc) # Side Effects: none # Return Value: OBJ @@ -485,7 +489,7 @@ sub remove_ml_home_dir } -# Descriptions: remove aliases entry +# Descriptions: remove aliases entry. # Arguments: OBJ($self) # OBJ($curproc) # HASH_REF($command_args) @@ -503,6 +507,7 @@ sub remove_aliases use FML::MTA::Control; for my $mta (@$list) { + # XXX-TODO: $optargs = { mta_type => $mta } valid ? my $optargs = { mta_type => $mta }; my $obj = new FML::MTA::Control; $obj->remove_alias($curproc, $params, $optargs); diff --git a/fml/lib/FML/ML/HomePrefix.pm b/fml/lib/FML/ML/HomePrefix.pm index f85e5cd1..478c9913 100644 --- a/fml/lib/FML/ML/HomePrefix.pm +++ b/fml/lib/FML/ML/HomePrefix.pm @@ -4,7 +4,7 @@ # All rights reserved. This program is free software; you can # redistribute it and/or modify it under the same terms as Perl itself. # -# $FML: HomePrefix.pm,v 1.4 2004/04/23 04:10:34 fukachan Exp $ +# $FML: HomePrefix.pm,v 1.5 2004/04/27 13:23:25 fukachan Exp $ # package FML::ML::HomePrefix; @@ -33,7 +33,7 @@ FML::ML::HomePrefix - create, rename and delete ml_home_prefix dir. =cut -# Descriptions: standard constructor. +# Descriptions: constructor. # Arguments: OBJ($self) OBJ($curproc) # Side Effects: none # Return Value: OBJ diff --git a/fml/lib/FML/MTA/Control.pm b/fml/lib/FML/MTA/Control.pm index 9d52742b..2a0ab2fa 100644 --- a/fml/lib/FML/MTA/Control.pm +++ b/fml/lib/FML/MTA/Control.pm @@ -4,7 +4,7 @@ # All rights reserved. This program is free software; you can # redistribute it and/or modify it under the same terms as Perl itself. # -# $FML: Control.pm,v 1.4 2004/01/22 15:01:01 fukachan Exp $ +# $FML: Control.pm,v 1.5 2004/02/15 04:38:33 fukachan Exp $ # package FML::MTA::Control; @@ -29,7 +29,7 @@ my $debug = 0; =head1 NAME -FML::MTA::Control - utilities to handle MTA specific configurations +FML::MTA::Control - utilities to handle MTA specific configurations. =head1 SYNOPSIS @@ -55,7 +55,7 @@ and my $default_mta = 'postfix'; -# Descriptions: ordinary constructor. +# Descriptions: constructor. # Arguments: OBJ($self) HASH_REF($ctl_args) # Side Effects: none # Return Value: OBJ @@ -72,7 +72,7 @@ sub new } -# Descriptions: $mta_type is valid or not. +# Descriptions: check if $mta_type is valid or not. # Arguments: OBJ($self) STR($mta_type) # Side Effects: none # Return Value: NUM(1 or 0) @@ -112,7 +112,7 @@ sub setup } -# Descriptions: update alias.db from alias file +# Descriptions: update alias.db from alias file. # Arguments: OBJ($self) OBJ($curproc) HASH_REF($params) HASH_REF($optargs) # Side Effects: update aliases # Return Value: none @@ -131,7 +131,7 @@ sub update_alias } -# Descriptions: find key in alias maps +# Descriptions: find key in alias maps. # Arguments: OBJ($self) OBJ($curproc) HASH_REF($params) HASH_REF($optargs) # Side Effects: none # Return Value: none @@ -151,7 +151,7 @@ sub find_key_in_alias_maps } -# Descriptions: return aliases as HASH_REF +# Descriptions: return aliases as HASH_REF. # Arguments: OBJ($self) OBJ($curproc) HASH_REF($params) HASH_REF($optargs) # Side Effects: none # Return Value: HASH_REF diff --git a/fml/lib/FML/MTA/Control/Postfix.pm b/fml/lib/FML/MTA/Control/Postfix.pm index ddc0affc..2459711a 100644 --- a/fml/lib/FML/MTA/Control/Postfix.pm +++ b/fml/lib/FML/MTA/Control/Postfix.pm @@ -4,7 +4,7 @@ # All rights reserved. This program is free software; you can # redistribute it and/or modify it under the same terms as Perl itself. # -# $FML: Postfix.pm,v 1.3 2004/01/23 09:17:37 fukachan Exp $ +# $FML: Postfix.pm,v 1.4 2004/04/10 12:41:29 fukachan Exp $ # package FML::MTA::Control::Postfix; @@ -17,7 +17,7 @@ my $debug = 0; =head1 NAME -FML::MTA::Control::Postfix - handle postfix specific configurations +FML::MTA::Control::Postfix - handle postfix specific configurations. =head1 SYNOPSIS @@ -142,7 +142,7 @@ sub postfix_update_alias } -# Descriptions: find key in aliases +# Descriptions: find key in aliases. # Arguments: OBJ($self) # OBJ($curproc) HASH_REF($params) HASH_REF($optargs) # Side Effects: none @@ -229,7 +229,7 @@ sub _find_key_in_file -# Descriptions: get { key => value } in aliases. +# Descriptions: get aliases info as HASH_REF. # Arguments: OBJ($self) # OBJ($curproc) HASH_REF($params) HASH_REF($optargs) # Side Effects: none @@ -416,6 +416,9 @@ sub postfix_remove_virtual_map key => $key, map => $map, }; + + # XXX-TODO: _remove_postfix_style_virtual (private method) + # XXX-TODO: NOT CROSS AMONG modules. $self->_remove_postfix_style_virtual($curproc, $params, $optargs, $p); } diff --git a/fml/lib/FML/MTA/Control/Procmail.pm b/fml/lib/FML/MTA/Control/Procmail.pm index c1af1886..bfdcd91b 100644 --- a/fml/lib/FML/MTA/Control/Procmail.pm +++ b/fml/lib/FML/MTA/Control/Procmail.pm @@ -4,7 +4,7 @@ # All rights reserved. This program is free software; you can # redistribute it and/or modify it under the same terms as Perl itself. # -# $FML: Procmail.pm,v 1.3 2004/01/23 09:17:37 fukachan Exp $ +# $FML: Procmail.pm,v 1.4 2004/04/10 12:41:29 fukachan Exp $ # package FML::MTA::Control::Procmail; @@ -17,7 +17,7 @@ my $debug = 0; =head1 NAME -FML::MTA::Control::Procmail - handle procmail specific configurations +FML::MTA::Control::Procmail - handle procmail specific configurations. =head1 SYNOPSIS @@ -157,7 +157,7 @@ sub procmail_find_key_in_alias_maps } -# Descriptions: get { key => value } in aliases +# Descriptions: get alias info as HASH_REF. # Arguments: OBJ($self) # OBJ($curproc) HASH_REF($params) HASH_REF($optargs) # Side Effects: none diff --git a/fml/lib/FML/MTA/Control/Qmail.pm b/fml/lib/FML/MTA/Control/Qmail.pm index 8454a585..b4e915d4 100644 --- a/fml/lib/FML/MTA/Control/Qmail.pm +++ b/fml/lib/FML/MTA/Control/Qmail.pm @@ -4,7 +4,7 @@ # All rights reserved. This program is free software; you can # redistribute it and/or modify it under the same terms as Perl itself. # -# $FML: Qmail.pm,v 1.2 2004/01/02 14:42:45 fukachan Exp $ +# $FML: Qmail.pm,v 1.3 2004/01/22 15:01:02 fukachan Exp $ # package FML::MTA::Control::Qmail; @@ -17,7 +17,7 @@ my $debug = 0; =head1 NAME -FML::MTA::Control::Qmail - handle qmail specific configurations +FML::MTA::Control::Qmail - handle qmail specific configurations. =head1 SYNOPSIS diff --git a/fml/lib/FML/MTA/Control/Sendmail.pm b/fml/lib/FML/MTA/Control/Sendmail.pm index 869c37e5..89677c21 100644 --- a/fml/lib/FML/MTA/Control/Sendmail.pm +++ b/fml/lib/FML/MTA/Control/Sendmail.pm @@ -4,7 +4,7 @@ # All rights reserved. This program is free software; you can # redistribute it and/or modify it under the same terms as Perl itself. # -# $FML: Sendmail.pm,v 1.3 2004/01/23 09:17:37 fukachan Exp $ +# $FML: Sendmail.pm,v 1.4 2004/04/10 12:41:29 fukachan Exp $ # package FML::MTA::Control::Sendmail; @@ -17,7 +17,7 @@ my $debug = 0; =head1 NAME -FML::MTA::Control::Sendmail - handle sendmail specific configurations +FML::MTA::Control::Sendmail - handle sendmail specific configurations. =head1 SYNOPSIS diff --git a/fml/lib/FML/MTA/Control/Utils.pm b/fml/lib/FML/MTA/Control/Utils.pm index 9beb582c..aaaf1ed8 100644 --- a/fml/lib/FML/MTA/Control/Utils.pm +++ b/fml/lib/FML/MTA/Control/Utils.pm @@ -4,7 +4,7 @@ # All rights reserved. This program is free software; you can # redistribute it and/or modify it under the same terms as Perl itself. # -# $FML: Utils.pm,v 1.2 2004/01/22 15:01:02 fukachan Exp $ +# $FML: Utils.pm,v 1.3 2004/01/23 09:17:37 fukachan Exp $ # package FML::MTA::Control::Utils; @@ -17,7 +17,7 @@ my $debug = 0; =head1 NAME -FML::MTA::Control::Utils - utility functions +FML::MTA::Control::Utils - utility functions. =head1 SYNOPSIS diff --git a/fml/lib/FML/Merge.pm b/fml/lib/FML/Merge.pm index 6f5ec814..1d83e246 100644 --- a/fml/lib/FML/Merge.pm +++ b/fml/lib/FML/Merge.pm @@ -4,7 +4,7 @@ # All rights reserved. This program is free software; you can # redistribute it and/or modify it under the same terms as Perl itself. # -# $FML: Merge.pm,v 1.8 2004/03/18 13:25:54 fukachan Exp $ +# $FML: Merge.pm,v 1.9 2004/03/20 02:43:02 fukachan Exp $ # package FML::Merge; @@ -23,6 +23,8 @@ FML::Merge - merge other system configurations to fml8 ones. =head2 new($curproc, $params) +constructor. + =cut @@ -286,6 +288,7 @@ sub merge_into_config_cf my ($self) = @_; my $m_config = $self->{ _m_config }; + # XXX-TODO: "/tmp/default_config.ph" ??? # files to compare. my $old_config_ph = $m_config->old_file_path("config.ph"); my $default_config_ph = "/tmp/default_config.ph"; diff --git a/fml/lib/FML/Merge/Config.pm b/fml/lib/FML/Merge/Config.pm index b3cd35c4..fac56eb6 100644 --- a/fml/lib/FML/Merge/Config.pm +++ b/fml/lib/FML/Merge/Config.pm @@ -4,7 +4,7 @@ # All rights reserved. This program is free software; you can # redistribute it and/or modify it under the same terms as Perl itself. # -# $FML: @template.pm,v 1.8 2004/01/01 07:29:27 fukachan Exp $ +# $FML: Config.pm,v 1.1 2004/03/20 02:43:03 fukachan Exp $ # package FML::Merge::Config; @@ -16,7 +16,7 @@ use File::Spec; =head1 NAME -FML::Merge::Config - handle configurations +FML::Merge::Config - handle configurations. =head1 SYNOPSIS @@ -24,7 +24,9 @@ FML::Merge::Config - handle configurations =head1 METHODS -=head2 C<new()> +=head2 new() + +constructor. =cut diff --git a/fml/lib/FML/Merge/FML4/Config.pm b/fml/lib/FML/Merge/FML4/Config.pm index cceb5373..51a12995 100644 --- a/fml/lib/FML/Merge/FML4/Config.pm +++ b/fml/lib/FML/Merge/FML4/Config.pm @@ -4,7 +4,7 @@ # All rights reserved. This program is free software; you can # redistribute it and/or modify it under the same terms as Perl itself. # -# $FML: Config.pm,v 1.3 2004/03/17 13:30:42 fukachan Exp $ +# $FML: Config.pm,v 1.4 2004/03/18 13:25:56 fukachan Exp $ # package FML::Merge::FML4::Config; @@ -15,7 +15,7 @@ use Carp; =head1 NAME -FML::Merge::FML4::Config - what files we need to merge +FML::Merge::FML4::Config - what files we need to merge. =head1 SYNOPSIS @@ -23,7 +23,9 @@ FML::Merge::FML4::Config - what files we need to merge =head1 METHODS -=head2 C<new()> +=head2 new() + +constructor. =cut @@ -192,7 +194,7 @@ my $ml_home_dir_backup_target_files = { }; -# Descriptions: return files to back up. +# Descriptions: return list of files to back up. # Arguments: OBJ($self) # Side Effects: none # Return Value: ARRAY_REF @@ -265,7 +267,7 @@ sub get_continuous_use_files } -# Descriptions: return backup mode. +# Descriptions: check if we should backup this $file. # Arguments: OBJ($self) STR($file) # Side Effects: none # Return Value: STR diff --git a/fml/lib/FML/Merge/FML4/List.pm b/fml/lib/FML/Merge/FML4/List.pm index 8e159ffc..b0c2d7f5 100644 --- a/fml/lib/FML/Merge/FML4/List.pm +++ b/fml/lib/FML/Merge/FML4/List.pm @@ -4,7 +4,7 @@ # 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.4 2004/03/18 13:25:56 fukachan Exp $ +# $FML: List.pm,v 1.5 2004/03/20 02:43:04 fukachan Exp $ # package FML::Merge::FML4::List; @@ -22,7 +22,9 @@ FML::Merge::FML4::List - convert member list files. =head1 METHODS -=head2 C<new()> +=head2 new() + +constructor. =cut @@ -72,7 +74,7 @@ sub convert } -# Descriptions: convert fml4 actives to fml8 recipients. +# Descriptions: convert fml4 actives to fml8 recipients file. # Arguments: OBJ($self) OBJ($m_config) # Side Effects: create fml8 file. # Return Value: none @@ -86,7 +88,7 @@ sub _convert_actives } -# Descriptions: convert fml4 members to fml8 members. +# Descriptions: convert fml4 members to fml8 members file. # Arguments: OBJ($self) OBJ($m_config) # Side Effects: create fml8 file. # Return Value: none @@ -100,7 +102,8 @@ sub _convert_members } -# Descriptions: convert fml4 members-admin to fml8 {recipients,members}-admin. +# Descriptions: convert fml4 members-admin to +# fml8 {recipients,members}-admin file. # Arguments: OBJ($self) OBJ($m_config) # Side Effects: create fml8 file. # Return Value: none @@ -117,7 +120,8 @@ sub _convert_members_admin } -# Descriptions: convert fml4 moderators to fml8 {recipients,members}-moderator. +# Descriptions: convert fml4 moderators to +# fml8 {recipients,members}-moderator file. # Arguments: OBJ($self) OBJ($m_config) # Side Effects: create fml8 file. # Return Value: none diff --git a/fml/lib/FML/Merge/FML4/config_ph.pm b/fml/lib/FML/Merge/FML4/config_ph.pm index 73041f2e..ef407e88 100644 --- a/fml/lib/FML/Merge/FML4/config_ph.pm +++ b/fml/lib/FML/Merge/FML4/config_ph.pm @@ -4,7 +4,7 @@ # All rights reserved. This program is free software; you can # redistribute it and/or modify it under the same terms as Perl itself. # -# $FML: config_ph.pm,v 1.4 2004/03/17 12:53:16 fukachan Exp $ +# $FML: config_ph.pm,v 1.5 2004/03/18 13:25:57 fukachan Exp $ # package FML::Merge::FML4::config_ph; @@ -24,7 +24,9 @@ FML::Merge::FML4::config_ph - handle fml4's config.ph file. =head1 METHODS -=head2 C<new()> +=head2 new() + +constructor. =cut diff --git a/fml/lib/FML/Process/CGI.pm b/fml/lib/FML/Process/CGI.pm index 96e33a6f..2cf8e408 100644 --- a/fml/lib/FML/Process/CGI.pm +++ b/fml/lib/FML/Process/CGI.pm @@ -4,7 +4,7 @@ # All rights reserved. This program is free software; you can # redistribute it and/or modify it under the same terms as Perl itself. # -# $FML: CGI.pm,v 1.23 2002/12/22 03:46:20 fukachan Exp $ +# $FML: CGI.pm,v 1.24 2004/01/02 14:42:43 fukachan Exp $ # package FML::Process::CGI; @@ -18,7 +18,7 @@ use FML::Process::CGI::Param; =head1 NAME -FML::Process::CGI - CGI basic functions +FML::Process::CGI - CGI basic functions. =head1 SYNOPSIS diff --git a/fml/lib/FML/Process/CGI/Utils.pm b/fml/lib/FML/Process/CGI/Utils.pm index 12a8f1aa..86a986ab 100644 --- a/fml/lib/FML/Process/CGI/Utils.pm +++ b/fml/lib/FML/Process/CGI/Utils.pm @@ -4,7 +4,7 @@ # All rights reserved. This program is free software; you can # redistribute it and/or modify it under the same terms as Perl itself. # -# $FML: Utils.pm,v 1.12 2004/03/12 11:45:54 fukachan Exp $ +# $FML: Utils.pm,v 1.13 2004/04/18 05:59:44 fukachan Exp $ # package FML::Process::CGI::Utils; @@ -14,7 +14,7 @@ use Carp; =head1 NAME -FML::Process::CGI::Utils - utility for FML::Process::CGI::Kernel +FML::Process::CGI::Utils - utility for FML::Process::CGI::Kernel. =head1 SYNOPSIS @@ -44,7 +44,7 @@ sub cgi_var_ml_name } -# Descriptions: return $ml_domain defined in *.cgi programd . +# Descriptions: return $ml_domain defined in *.cgi programd. # ml_domain is hard-coded, not dependent on cgi_var_cgi_mode. # Arguments: OBJ($curproc) # Side Effects: none @@ -91,7 +91,7 @@ sub cgi_var_ml_name_list } -# Descriptions: return address map +# Descriptions: return address map. # Arguments: OBJ($curproc) # Side Effects: none # Return Value: STR @@ -105,7 +105,7 @@ sub cgi_var_address_map } -# Descriptions: return list of address map +# Descriptions: return list of address map. # Arguments: OBJ($curproc) # Side Effects: none # Return Value: ARRAY_REF @@ -129,7 +129,7 @@ sub cgi_var_myname } -# Descriptions: return command list +# Descriptions: return available command list in cgi mode. # Arguments: OBJ($curproc) # Side Effects: none # Return Value: ARRAY_REF @@ -143,6 +143,7 @@ sub cgi_var_available_command_list return $config->get_as_array_ref('admin_cgi_allowed_commands'); } else { + # XXX-TODO: commands_for_ml_admin_cgi -> ml_admin_cgi_allowed_commands return $config->get_as_array_ref('commands_for_ml_admin_cgi'); } } @@ -159,7 +160,7 @@ sub cgi_var_action } -# Descriptions: return action name. +# Descriptions: return frame target name. # Arguments: OBJ($curproc) # Side Effects: none # Return Value: STR diff --git a/fml/lib/FML/Process/Digest.pm b/fml/lib/FML/Process/Digest.pm index 6e4d33c0..c0480507 100644 --- a/fml/lib/FML/Process/Digest.pm +++ b/fml/lib/FML/Process/Digest.pm @@ -3,7 +3,7 @@ # Copyright (C) 2002,2003,2004 Ken'ichi Fukamachi # All rights reserved. # -# $FML: Digest.pm,v 1.19 2004/04/23 04:10:36 fukachan Exp $ +# $FML: Digest.pm,v 1.20 2004/05/22 11:42:54 fukachan Exp $ # package FML::Process::Digest; @@ -168,6 +168,8 @@ sub run =head2 help() +show help. + =cut diff --git a/fml/lib/FML/Process/Switch.pm b/fml/lib/FML/Process/Switch.pm index 638655de..d9541e24 100644 --- a/fml/lib/FML/Process/Switch.pm +++ b/fml/lib/FML/Process/Switch.pm @@ -4,7 +4,7 @@ # All rights reserved. This program is free software; you can # redistribute it and/or modify it under the same terms as Perl itself. # -# $FML: Switch.pm,v 1.105 2004/03/31 12:53:52 fukachan Exp $ +# $FML: Switch.pm,v 1.106 2004/05/19 09:03:07 fukachan Exp $ # package FML::Process::Switch; @@ -17,7 +17,7 @@ use File::Spec; =head1 NAME -FML::Process::Switch - dispatch a module suitable with the program name +FML::Process::Switch - dispatch a module suitable with the program name. =head1 SYNOPSIS @@ -79,7 +79,7 @@ We pass it to C<load_module()> later. =cut -# Descriptions: the second phase of bootstrap +# Descriptions: the second phase of bootstrap. # Arguments: STR($main_cf_file) HASH_REF($main_cf) # Side Effects: none # Return Value: same as FML::Process::Flow::ProcessStart() @@ -216,7 +216,7 @@ sub main::Bootstrap2 } -# Descriptions: try to save the error message +# Descriptions: try to save the error message. # Arguments: HASH_REF($main_cf) STR($s) # Side Effects: save message to a log file if could # Return Value: none @@ -276,7 +276,7 @@ C<$args> is like this: =cut -# Descriptions: top level process switch +# Descriptions: top level process switch. # emulates "use $package" but $package is dynamically # determined by e.g. $0. # Arguments: STR($myname) HASH_REF($args) @@ -311,7 +311,7 @@ sub load_module # Return Value: HASH_REF sub _overload_main_cf { - my ($main_cf) = @_; + my ($main_cf) = @_; my $new_main_cf = {}; my $config_dir = $main_cf->{ default_config_dir }; @@ -338,7 +338,7 @@ sub _overload_main_cf } -# Descriptions: return the suitable getopt options +# Descriptions: return the suitable getopt options. # Arguments: HASH_REF($main_cf) STR($name) # Side Effects: none # Return Value: ARRAY_REF (getopt parameters) diff --git a/fml/lib/FML/Restriction/CGI.pm b/fml/lib/FML/Restriction/CGI.pm index ee5e11c7..744c0df0 100644 --- a/fml/lib/FML/Restriction/CGI.pm +++ b/fml/lib/FML/Restriction/CGI.pm @@ -3,7 +3,7 @@ # Copyright (C) 2001,2002,2004 Ken'ichi Fukamachi # All rights reserved. # -# $FML: CGI.pm,v 1.10 2004/01/02 14:42:44 fukachan Exp $ +# $FML: CGI.pm,v 1.11 2004/01/21 03:40:43 fukachan Exp $ # package FML::Restriction::CGI; @@ -17,7 +17,7 @@ use FML::Restriction::Base; =head1 NAME -FML::Restriction::CGI -- define safe data regexp for CGI modules +FML::Restriction::CGI -- define safe data regexp for CGI modules. =head1 SYNOPSIS @@ -53,7 +53,7 @@ my %cgi_methond = -# Descriptions: return basic variable safe expression +# Descriptions: return set of basic variable safe expressions as HASH_REF. # Arguments: OBJ($self) # Side Effects: none # Return Value: HASH_REF @@ -64,7 +64,7 @@ sub param_regexp } -# Descriptions: return method safe expression +# Descriptions: return set of method safe expressions as HASH_REF. # Arguments: OBJ($self) # Side Effects: none # Return Value: HASH_REF diff --git a/fml/lib/FML/Restriction/Command.pm b/fml/lib/FML/Restriction/Command.pm index c6a3e6b8..3b6aedf3 100644 --- a/fml/lib/FML/Restriction/Command.pm +++ b/fml/lib/FML/Restriction/Command.pm @@ -4,7 +4,7 @@ # All rights reserved. This program is free software; you can # redistribute it and/or modify it under the same terms as Perl itself. # -# $FML: Command.pm,v 1.13 2004/03/14 08:51:15 fukachan Exp $ +# $FML: Command.pm,v 1.14 2004/03/18 13:29:39 fukachan Exp $ # package FML::Restriction::Command; @@ -18,7 +18,7 @@ push(@ISA, qw(FML::Restriction::Post)); =head1 NAME -FML::Restriction::Command - safe regexp allowed as a command +FML::Restriction::Command - command mail restrictions. =head1 SYNOPSIS @@ -60,6 +60,7 @@ sub permit_user_command my ($match, $reason) = $self->SUPER::permit_member_maps($rule, $sender); # 2) command match anonymous one ? + # XXX-TODO: deny reason is first match ? last match ? if ($match) { if ($reason eq 'reject') { my $_rule = "permit_member_maps"; @@ -105,6 +106,7 @@ sub permit_anonymous_command $curproc->log("debug: match: rule=$rule comname=$comname"); return("matched", "permit"); } + # XXX-TODO: not need deny reason logging ? return(0, undef); } @@ -134,6 +136,7 @@ sub permit_admin_member_maps $curproc->log("found in admin_member_maps"); return("matched", "permit"); } + # XXX-TODO: not need deny reason logging ? return(0, undef); } @@ -158,6 +161,7 @@ sub check_admin_member_password return("matched", "permit"); } else { + # XXX-TODO: not need deny reason logging ? $curproc->log("admin password: auth fail"); return(0, undef); } diff --git a/fml/lib/FML/Restriction/Post.pm b/fml/lib/FML/Restriction/Post.pm index 030378a7..b5d9edc7 100644 --- a/fml/lib/FML/Restriction/Post.pm +++ b/fml/lib/FML/Restriction/Post.pm @@ -4,7 +4,7 @@ # All rights reserved. This program is free software; you can # redistribute it and/or modify it under the same terms as Perl itself. # -# $FML: Post.pm,v 1.11 2004/03/14 06:49:26 fukachan Exp $ +# $FML: Post.pm,v 1.12 2004/04/23 04:10:38 fukachan Exp $ # package FML::Restriction::Post; @@ -114,6 +114,7 @@ sub permit_member_maps # $curproc->reply_message( " your address: $sender" ); # save reason for later use. + # XXX the deny reason is first match. unless ($curproc->restriction_state_get_deny_reason()) { $curproc->restriction_state_set_deny_reason($rule); } @@ -136,6 +137,7 @@ sub reject my ($self, $rule, $sender) = @_; my $curproc = $self->{ _curproc }; + # XXX the deny reason is first match. unless ($curproc->restriction_state_get_deny_reason()) { $curproc->restriction_state_set_deny_reason($rule); } diff --git a/fml/lib/FML/Sys/Alias.pm b/fml/lib/FML/Sys/Alias.pm index 961327dc..ec95b6c6 100644 --- a/fml/lib/FML/Sys/Alias.pm +++ b/fml/lib/FML/Sys/Alias.pm @@ -1,10 +1,10 @@ #-*- perl -*- # -# Copyright (C) 2003 Ken'ichi Fukamachi +# Copyright (C) 2003,2004 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: Alias.pm,v 1.2 2003/08/23 04:35:41 fukachan Exp $ +# $FML: Alias.pm,v 1.3 2004/07/11 15:43:40 fukachan Exp $ # package FML::Sys::Alias; @@ -182,7 +182,7 @@ Ken'ichi Fukamachi =head1 COPYRIGHT -Copyright (C) 2003 Ken'ichi Fukamachi +Copyright (C) 2003,2004 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. diff --git a/fml/lib/FML/Sys/User.pm b/fml/lib/FML/Sys/User.pm index 7f5a58f2..c0ec7046 100644 --- a/fml/lib/FML/Sys/User.pm +++ b/fml/lib/FML/Sys/User.pm @@ -1,10 +1,10 @@ #-*- perl -*- # -# Copyright (C) 2003 Ken'ichi Fukamachi +# Copyright (C) 2003,2004 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: User.pm,v 1.2 2003/08/23 04:35:42 fukachan Exp $ +# $FML: User.pm,v 1.3 2004/07/11 15:43:40 fukachan Exp $ # package FML::Sys::User; @@ -95,7 +95,7 @@ Ken'ichi Fukamachi =head1 COPYRIGHT -Copyright (C) 2003 Ken'ichi Fukamachi +Copyright (C) 2003,2004 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. diff --git a/fml/lib/Mail/Message/Address.pm b/fml/lib/Mail/Message/Address.pm index eedda186..ab58c27c 100644 --- a/fml/lib/Mail/Message/Address.pm +++ b/fml/lib/Mail/Message/Address.pm @@ -4,7 +4,7 @@ # All rights reserved. This program is free software; you can # redistribute it and/or modify it under the same terms as Perl itself. # -# $FML: Address.pm,v 1.4 2004/06/29 10:03:48 fukachan Exp $ +# $FML: Address.pm,v 1.5 2004/07/06 23:55:58 fukachan Exp $ # package Mail::Message::Address; @@ -26,7 +26,7 @@ This class is an adapter for Mail::Address for convenience. =head1 METHODS -=head2 C<new()> +=head2 new() constructor. diff --git a/fml/lib/Mail/Message/Charset.pm b/fml/lib/Mail/Message/Charset.pm index f8f89d89..0f130ad8 100644 --- a/fml/lib/Mail/Message/Charset.pm +++ b/fml/lib/Mail/Message/Charset.pm @@ -2,7 +2,7 @@ # # Copyright (C) 2003,2004 Ken'ichi Fukamachi # -# $FML: Charset.pm,v 1.3 2004/02/06 13:29:47 fukachan Exp $ +# $FML: Charset.pm,v 1.4 2004/02/26 12:59:07 fukachan Exp $ # package Mail::Message::Charset; @@ -10,7 +10,7 @@ use strict; =head1 NAME -Mail::Message::Charset - charset map +Mail::Message::Charset - charset map. =head1 SYNOPSIS @@ -209,7 +209,7 @@ sub new } -# Descriptions: return default charset. +# Descriptions: return default charset for internal usage. # Arguments: OBJ($self) # Side Effects: none # Return Value: OBJ @@ -220,7 +220,7 @@ sub internal_default_charset } -# Descriptions: return default charset. +# Descriptions: return default charset for message handling. # Arguments: OBJ($self) # Side Effects: none # Return Value: OBJ @@ -231,7 +231,7 @@ sub message_default_charset } -# Descriptions: get charset info: e.g. japanese => euc-jp. +# Descriptions: convert charset info: e.g. japanese => euc-jp. # Arguments: OBJ($self) STR($language) # Side Effects: none # Return Value: STR @@ -243,7 +243,7 @@ sub language_to_internal_charset } -# Descriptions: get charset info: e.g. ja or japanese => iso-2022-jp. +# Descriptions: convert charset info: e.g. ja or japanese => iso-2022-jp. # Arguments: OBJ($self) STR($language) # Side Effects: none # Return Value: STR diff --git a/fml/lib/Mail/Message/Checksum.pm b/fml/lib/Mail/Message/Checksum.pm index 57e230ba..0ca64a8b 100644 --- a/fml/lib/Mail/Message/Checksum.pm +++ b/fml/lib/Mail/Message/Checksum.pm @@ -4,7 +4,7 @@ # All rights reserved. This program is free software; you can # redistribute it and/or modify it under the same terms as Perl itself. # -# $FML: Checksum.pm,v 1.10 2003/08/23 05:15:14 fukachan Exp $ +# $FML: Checksum.pm,v 1.11 2004/01/24 09:03:59 fukachan Exp $ # package Mail::Message::Checksum; @@ -14,7 +14,7 @@ use Carp; =head1 NAME -Mail::Message::Checksum - utilities for checksum +Mail::Message::Checksum - utilities for checksum. =head1 SYNOPSIS @@ -26,14 +26,14 @@ Mail::Message::Checksum - utilities for checksum =head2 new() -the constructor. +constructor. It checks we can use MD5 perl module or we need to use external programs such as C<md5>, C<cksum>, et.al. =cut -# Descriptions: ordinary constructor. +# Descriptions: constructor. # Arguments: OBJ($self) HASH_REF($args) # Side Effects: none # Return Value: OBJ @@ -193,7 +193,7 @@ See POSIX 1003.2 for more details. =cut -# Descriptions: return the traditional checksum of the given $file +# Descriptions: return the traditional checksum of the given $file. # Arguments: OBJ($self) STR($file) # Side Effects: none # Return Value: ARRAY(STR, STR) @@ -202,6 +202,7 @@ sub cksum2 my ($self, $file) = @_; my ($crc, $total, $nr, $buf, $r); + # XXX-TODO: style $crc = $total = 0; if (open($file, $file)) { while (($nr = sysread($file, $buf, 1024)) > 0) { diff --git a/fml/lib/Mail/Message/Language.pm b/fml/lib/Mail/Message/Language.pm index 32d5d795..7a94537e 100644 --- a/fml/lib/Mail/Message/Language.pm +++ b/fml/lib/Mail/Message/Language.pm @@ -2,7 +2,7 @@ # # Copyright (C) 2003,2004 Ken'ichi Fukamachi # -# $FML: Language.pm,v 1.3 2004/02/29 15:57:26 fukachan Exp $ +# $FML: Language.pm,v 1.4 2004/02/29 15:59:41 fukachan Exp $ # package Mail::Message::Language; @@ -10,7 +10,7 @@ use strict; =head1 NAME -Mail::Message::Language - handle *-Language: +Mail::Message::Language - handle *-Language: field. =head1 SYNOPSIS diff --git a/fml/lib/Mail/Message/Language/Japanese/Subject.pm b/fml/lib/Mail/Message/Language/Japanese/Subject.pm index 926db889..96904077 100644 --- a/fml/lib/Mail/Message/Language/Japanese/Subject.pm +++ b/fml/lib/Mail/Message/Language/Japanese/Subject.pm @@ -1,10 +1,10 @@ #-*- perl -*- # -# Copyright (C) 2001,2002,2003 Ken'ichi Fukamachi +# Copyright (C) 2001,2002,2003,2004 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: Subject.pm,v 1.15 2003/07/21 13:26:05 fukachan Exp $ +# $FML: Subject.pm,v 1.16 2003/08/23 04:35:48 fukachan Exp $ # @@ -21,7 +21,7 @@ use Jcode; =head1 NAME -Mail::Message::Language::Japanese::Subject - functions for Japanese subject +Mail::Message::Language::Japanese::Subject - functions for Japanese subject. =head1 SYNOPSIS @@ -120,7 +120,7 @@ within C<Subject:>. # ¥ì¥ì¥ìÂкö -# Descriptions: remove Re: +# Descriptions: remove Re: strings. # Arguments: OBJ($self) STR($subject) # Side Effects: none # Return Value: STR @@ -157,11 +157,11 @@ See C<http://www.fml.org/software/FNF/> on fml coding style guide. =head1 AUTHOR - Ken'ichi Fukamachi +Ken'ichi Fukamachi =head1 COPYRIGHT -Copyright (C) 2001,2002,2003 Ken'ichi Fukamachi +Copyright (C) 2001,2002,2003,2004 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. diff --git a/fml/lib/Mail/Message/MH.pm b/fml/lib/Mail/Message/MH.pm index 6bca29ae..56c23a6e 100644 --- a/fml/lib/Mail/Message/MH.pm +++ b/fml/lib/Mail/Message/MH.pm @@ -2,7 +2,7 @@ # # Copyright (C) 2001,2002,2003,2004 Ken'ichi Fukamachi # -# $FML: MH.pm,v 1.17 2004/01/24 09:04:00 fukachan Exp $ +# $FML: MH.pm,v 1.18 2004/03/27 09:25:45 fukachan Exp $ # package Mail::Message::MH; @@ -10,7 +10,7 @@ use strict; =head1 NAME -Mail::Message::MH - utilities to handle MH style format +Mail::Message::MH - utilities to handle MH style format. =head1 SYNOPSIS diff --git a/fml/lib/Mail/Message/Parse.pm b/fml/lib/Mail/Message/Parse.pm index 778ed4a5..714ae0c8 100644 --- a/fml/lib/Mail/Message/Parse.pm +++ b/fml/lib/Mail/Message/Parse.pm @@ -4,7 +4,7 @@ # All rights reserved. This program is free software; you can # redistribute it and/or modify it under the same terms as Perl itself. # -# $FML: Parse.pm,v 1.8 2002/09/22 14:57:04 fukachan Exp $ +# $FML: Parse.pm,v 1.9 2004/01/02 14:42:48 fukachan Exp $ # @@ -32,7 +32,7 @@ sub new =head1 NAME -Mail::Message::Parse - parse a mail message +Mail::Message::Parse - parse a mail message. =head1 SYNOPSIS diff --git a/fml/lib/Mail/Message/Spool.pm b/fml/lib/Mail/Message/Spool.pm index 95442ccb..e8d524d4 100644 --- a/fml/lib/Mail/Message/Spool.pm +++ b/fml/lib/Mail/Message/Spool.pm @@ -2,7 +2,7 @@ # # Copyright (C) 2002,2003,2004 Ken'ichi Fukamachi # -# $FML: Spool.pm,v 1.11 2003/03/03 15:53:50 fukachan Exp $ +# $FML: Spool.pm,v 1.12 2004/01/24 09:04:00 fukachan Exp $ # package Mail::Message::Spool; @@ -12,7 +12,7 @@ use Carp; =head1 NAME -Mail::Message::Spool - utilities to handle directory such as article spool +Mail::Message::Spool - utilities to handle directory such as article spool. =head1 SYNOPSIS @@ -29,7 +29,7 @@ directory such as article spool. =head2 new() -standard constructor. +constructor. =cut diff --git a/fml/lib/Mail/Message/String.pm b/fml/lib/Mail/Message/String.pm index 8d5f0b1e..29bbaf85 100644 --- a/fml/lib/Mail/Message/String.pm +++ b/fml/lib/Mail/Message/String.pm @@ -4,7 +4,7 @@ # All rights reserved. This program is free software; you can # redistribute it and/or modify it under the same terms as Perl itself. # -# $FML: String.pm,v 1.6 2004/03/27 09:25:13 fukachan Exp $ +# $FML: String.pm,v 1.7 2004/03/31 02:48:22 fukachan Exp $ # package Mail::Message::String; @@ -35,7 +35,9 @@ Mail::Message::String - base class of string used in message (header). =head1 METHODS -=head2 C<new()> +=head2 new() + +constructor. =cut @@ -75,7 +77,7 @@ get (converted) data in this object as string (same as as_str()). =cut -# Descriptions: initialize data in this object. +# Descriptions: set string data in this object. # Arguments: OBJ($self) STR($str) # Side Effects: none # Return Value: OBJ @@ -86,7 +88,7 @@ sub set } -# Descriptions: get data in this object as string (same as as_str()). +# Descriptions: get string data in this object as string (same as as_str()). # Arguments: OBJ($self) # Side Effects: none # Return Value: OBJ @@ -99,12 +101,12 @@ sub get =head2 as_str() -return data (converted data) by string. +return data (converted data) as string. =cut -# Descriptions: return data (converted data) by string. +# Descriptions: return data (converted data) as string. # Arguments: OBJ($self) # Side Effects: none # Return Value: STR diff --git a/fml/lib/Mail/Message/Subject.pm b/fml/lib/Mail/Message/Subject.pm index 2b2800b3..886ffd9e 100644 --- a/fml/lib/Mail/Message/Subject.pm +++ b/fml/lib/Mail/Message/Subject.pm @@ -2,7 +2,7 @@ # # Copyright (C) 2004 Ken'ichi Fukamachi # -# $FML: Subject.pm,v 1.3 2004/03/28 11:11:55 fukachan Exp $ +# $FML: Subject.pm,v 1.4 2004/06/23 00:05:38 fukachan Exp $ # package Mail::Message::Subject; @@ -66,7 +66,7 @@ sub delete_dup_reply_tag # XXX-TODO: care for not Japanese string! # XXX-TODO: call this module if $subject is Japanese or English. - # XXX-TODO: but what should we do when the code is not the two ? + # XXX-TODO: but what should we do when the code is not the two above ? if (1) { use Mail::Message::Language::Japanese::Subject; my $sbj = new Mail::Message::Language::Japanese::Subject; @@ -116,6 +116,7 @@ sub delete_tag my ($self, $tag) = @_; my $subject = $self->as_str(); + # XXX $subject SHOULD BE MIME DECODED ALREADY. # for example, ml_name = elena # if $tag has special regexp such as \U$ml_name\E or \L$ml_name\E if (defined $tag) { diff --git a/fml/lib/Mail/Message/Utils.pm b/fml/lib/Mail/Message/Utils.pm index 29270458..202e539c 100644 --- a/fml/lib/Mail/Message/Utils.pm +++ b/fml/lib/Mail/Message/Utils.pm @@ -4,7 +4,7 @@ # All rights reserved. This program is free software; you can # redistribute it and/or modify it under the same terms as Perl itself. # -# $FML: Utils.pm,v 1.9 2003/08/23 04:35:48 fukachan Exp $ +# $FML: Utils.pm,v 1.10 2004/01/24 09:04:00 fukachan Exp $ # package Mail::Message::Utils; @@ -14,7 +14,7 @@ use Carp; =head1 NAME -Mail::Message::Utils - utility functions for Mail::Message +Mail::Message::Utils - utility functions for Mail::Message. =head1 SYNOPSIS |