update comments

13 files changed, 102 insertions, 41 deletions

diff --git a/fml/lib/FML/CGI/Calendar.pm b/fml/lib/FML/CGI/Calendar.pm
index 23dcac7d..963dab56 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.4 2003/08/29 15:33:55 fukachan Exp $
+# $FML: Calendar.pm,v 1.5 2003/10/15 08:16:23 fukachan Exp $
 #
 
 package FML::CGI::Calendar;
@@ -43,10 +43,18 @@ Almost all methods inherit C<FML::Process::CGI> base class.
 
 =head1 METHODS
 
+=head2 html_start()
+
+print out HTML header + body former part and navigator.
+
+=head2 html_end()
+
+print out the navigator and closing of html.
+
 =cut
 
 
-# Descriptions: print out HTML header + body former part
+# Descriptions: print out HTML header + body former part and navigator.
 #    Arguments: OBJ($curproc) HASH_REF($args)
 # Side Effects: none
 # Return Value: none
@@ -72,7 +80,7 @@ sub html_start
 }
 
 
-# Descriptions: print out body latter part
+# Descriptions: print out the navigator and closing of html.
 #    Arguments: OBJ($curproc) HASH_REF($args)
 # Side Effects: none
 # Return Value: none
@@ -104,7 +112,22 @@ sub _show_guide
 }
 
 
-# Descriptions: main routine for calendar as HTML TABLE format
+=head2 run_cgi_main()
+
+main routine to print calendar as HTML TABLE format.
+
+=head2 run_cgi_navigator()
+
+dummy.
+
+=head2 run_cgi_options()
+
+dummy.
+
+=cut
+
+
+# Descriptions: main routine to print calendar as HTML TABLE format.
 #    Arguments: OBJ($curproc) HASH_REF($args)
 # Side Effects: none
 # Return Value: none
diff --git a/fml/lib/FML/Command/Admin/chaddr.pm b/fml/lib/FML/Command/Admin/chaddr.pm
index a1af9a5f..9f5b3fb3 100644
--- a/fml/lib/FML/Command/Admin/chaddr.pm
+++ b/fml/lib/FML/Command/Admin/chaddr.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: chaddr.pm,v 1.19 2003/08/29 15:33:58 fukachan Exp $
+# $FML: chaddr.pm,v 1.20 2003/11/23 03:54:45 fukachan Exp $
 #
 
 package FML::Command::Admin::chaddr;
@@ -62,20 +62,28 @@ sub need_lock { 1;}
 sub lock_channel { return 'command_serialize';}
 
 
-# Descriptions: change address from old one to new one
+# Descriptions: change address from old one to new one.
 #    Arguments: OBJ($self) OBJ($curproc) HASH_REF($command_args)
 # Side Effects: update $member_map $recipient_map
 # Return Value: none
 sub process
 {
     my ($self, $curproc, $command_args) = @_;
-    my $config        = $curproc->config();
+    my $config  = $curproc->config();
+    my $options = $command_args->{ options };
+
+    # XXX We should always add/rewrite only $primary_*_map maps via 
+    # XXX command mail, CUI and GUI.
+    # XXX Rewriting of maps not $primary_*_map is
+    # XXX 1) may be not writable.
+    # XXX 2) ambigous and dangerous 
+    # XXX    since the map is under controlled by other module.
+    # XXX    for example, one of member_maps is under admin_member_maps. 
     my $member_map    = $config->{ 'primary_member_map'    };
     my $recipient_map = $config->{ 'primary_recipient_map' };
-    my $options       = $command_args->{ options };
-    my $old_address   = '';
-    my $new_address   = '';
 
+    my $old_address = '';
+    my $new_address = '';
     if (defined $command_args->{ command_data }) {
 	my $x = $command_args->{ command_data };
 	($old_address, $new_address) = split(/\s+/, $x);
@@ -87,6 +95,7 @@ sub process
 
     $curproc->log("chaddr: $old_address -> $new_address");
 
+    # XXX-TODO: validate $old_address and $new_address syntax.
     # sanity check
     unless ($old_address && $new_address) {
 	croak("chaddr: invalid arguments");
diff --git a/fml/lib/FML/Command/Admin/changepassword.pm b/fml/lib/FML/Command/Admin/changepassword.pm
index bc778b9a..0d26bbb9 100644
--- a/fml/lib/FML/Command/Admin/changepassword.pm
+++ b/fml/lib/FML/Command/Admin/changepassword.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: changepassword.pm,v 1.6 2003/08/23 04:35:30 fukachan Exp $
+# $FML: changepassword.pm,v 1.7 2003/08/23 07:24:43 fukachan Exp $
 #
 
 package FML::Command::Admin::changepassword;
@@ -16,7 +16,7 @@ use FML::Log qw(Log LogWarn LogError);
 
 =head1 NAME
 
-FML::Command::Admin::changepassword - change admin password
+FML::Command::Admin::changepassword - change remote administrator password
 
 =head1 SYNOPSIS
 
@@ -30,6 +30,8 @@ password a new address.
 
 =head2 process($curproc, $command_args)
 
+change remote administrator password.
+
 =cut
 
 
@@ -102,6 +104,7 @@ sub process
 	    croak("wrong arguments");
 	}
 
+	# XXX-TODO: validate $address syntax.
 	$self->_change_password($curproc, $command_args, $address, $password);
     }
     else {
@@ -110,7 +113,7 @@ sub process
 }
 
 
-# Descriptions: change the admin password.
+# Descriptions: change the remote admin password.
 #    Arguments: OBJ($self) OBJ($curproc) HASH_REF($command_args)
 #               STR($address) STR($password)
 # Side Effects: update *admin_member_password_maps
@@ -118,7 +121,15 @@ sub process
 sub _change_password
 {
     my ($self, $curproc, $command_args, $address, $password) = @_;
-    my $config  = $curproc->config();
+    my $config = $curproc->config();
+
+    # XXX We should always add/rewrite only $primary_*_map maps via 
+    # XXX command mail, CUI and GUI.
+    # XXX Rewriting of maps not $primary_*_map is
+    # XXX 1) may be not writable.
+    # XXX 2) ambigous and dangerous 
+    # XXX    since the map is under controlled by other module.
+    # XXX    for example, one of member_maps is under admin_member_maps. 
     my $pri_map = $config->{ primary_admin_member_password_map };
     my $up_args = {
 	map      => $pri_map,
diff --git a/fml/lib/FML/Command/Admin/chpass.pm b/fml/lib/FML/Command/Admin/chpass.pm
index 903c4555..af893062 100644
--- a/fml/lib/FML/Command/Admin/chpass.pm
+++ b/fml/lib/FML/Command/Admin/chpass.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$
+# $FML: chpass.pm,v 1.1 2003/02/02 10:59:19 fukachan Exp $
 #
 
 package FML::Command::Admin::chpass;
@@ -17,7 +17,7 @@ use FML::Command::Admin::changepassword;
 @ISA = qw(FML::Command::Admin::changepassword);
 
 
-# Descriptions: change admin password
+# Descriptions: change remote administrator password.
 #    Arguments: OBJ($self) OBJ($curproc) HASH_REF($command_args)
 # Side Effects: forward request to password module
 # Return Value: none
@@ -30,7 +30,7 @@ sub process
 
 =head1 NAME
 
-FML::Command::Admin::chpass - change admin password
+FML::Command::Admin::chpass - change remote administrator password
 
 =head1 SYNOPSIS
 
@@ -38,6 +38,7 @@ See C<FML::Command> for more details.
 
 =head1 DESCRIPTION
 
+change remote administrator password.
 an alias of C<FML::Command::Admin::changepassword>.
 
 =head1 CODING STYLE
diff --git a/fml/lib/FML/Command/Admin/digest.pm b/fml/lib/FML/Command/Admin/digest.pm
index 7696e322..0e89ccf3 100644
--- a/fml/lib/FML/Command/Admin/digest.pm
+++ b/fml/lib/FML/Command/Admin/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.12 2003/09/27 03:00:16 fukachan Exp $
+# $FML: digest.pm,v 1.13 2003/11/23 03:54:45 fukachan Exp $
 #
 
 package FML::Command::Admin::digest;
@@ -73,16 +73,24 @@ sub process
     my ($self, $curproc, $command_args) = @_;
     my $config  = $curproc->config();
     my $options = $command_args->{ options } || [];
-    my $address = $command_args->{ command_data } || $options->[ 0 ] || undef;
-    my $mode    = $options->[ 1 ] || '';
 
-    # maps
+    # XXX We should always add/rewrite only $primary_*_map maps via 
+    # XXX command mail, CUI and GUI.
+    # XXX Rewriting of maps not $primary_*_map is
+    # XXX 1) may be not writable.
+    # XXX 2) ambigous and dangerous 
+    # XXX    since the map is under controlled by other module.
+    # XXX    for example, one of member_maps is under admin_member_maps. 
     my $recipient_map         = $config->{ primary_recipient_map };
     my $recipient_maps        = $config->get_as_array_ref('recipient_maps');
     my $digest_recipient_map  = $config->{ primary_digest_recipient_map };
     my $digest_recipient_maps =
 	$config->get_as_array_ref('digest_recipient_maps');
 
+    # XXX-TODO: validate $address ?
+    my $address = $command_args->{ command_data } || $options->[ 0 ] || undef;
+    my $mode    = $options->[ 1 ] || '';
+
     # fundamental check
     croak("address not defined")     unless defined $address;
     croak("address not specified")   unless $address;
diff --git a/fml/lib/FML/Command/Admin/digestoff.pm b/fml/lib/FML/Command/Admin/digestoff.pm
index 89f5ffd2..80626718 100644
--- a/fml/lib/FML/Command/Admin/digestoff.pm
+++ b/fml/lib/FML/Command/Admin/digestoff.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: digestoff.pm,v 1.5 2003/08/23 04:35:30 fukachan Exp $
+# $FML: digestoff.pm,v 1.6 2003/09/27 03:00:17 fukachan Exp $
 #
 
 package FML::Command::Admin::digestoff;
@@ -23,7 +23,8 @@ See C<FML::Command> for more details.
 
 =head1 DESCRIPTION
 
-disable digest mode for the specified address.
+disable digest mode for the specified address. 
+It means delivery to this address from digest to real delivery mode.
 
 =head1 METHODS
 
@@ -60,6 +61,7 @@ sub lock_channel { return 'command_serialize';}
 
 
 # Descriptions: disable digest mode for the specified user.
+#               changed from digest to real delivery mode.
 #    Arguments: OBJ($self) OBJ($curproc) HASH_REF($command_args)
 # Side Effects: update $recipient_map,$digest_recipient_maps
 # Return Value: none
diff --git a/fml/lib/FML/Command/Admin/digeston.pm b/fml/lib/FML/Command/Admin/digeston.pm
index a5b7d448..44c48418 100644
--- a/fml/lib/FML/Command/Admin/digeston.pm
+++ b/fml/lib/FML/Command/Admin/digeston.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: digeston.pm,v 1.5 2003/08/23 04:35:30 fukachan Exp $
+# $FML: digeston.pm,v 1.6 2003/09/27 03:00:17 fukachan Exp $
 #
 
 package FML::Command::Admin::digeston;
@@ -24,6 +24,7 @@ See C<FML::Command> for more details.
 =head1 DESCRIPTION
 
 enable digest mode for the specified address.
+change delivery mode to this address from real to digest one.
 
 =head1 METHODS
 
@@ -60,6 +61,7 @@ sub lock_channel { return 'command_serialize';}
 
 
 # Descriptions: digest mode off/on for the specified user.
+#               change delivery mode to this address from real to digest one. 
 #    Arguments: OBJ($self) OBJ($curproc) HASH_REF($command_args)
 # Side Effects: update $recipient_map,$digest_recipient_maps
 # Return Value: none
diff --git a/fml/lib/FML/Command/Admin/error.pm b/fml/lib/FML/Command/Admin/error.pm
index d6d575eb..22ead126 100644
--- a/fml/lib/FML/Command/Admin/error.pm
+++ b/fml/lib/FML/Command/Admin/error.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: error.pm,v 1.7 2003/05/28 14:35:16 fukachan Exp $
+# $FML: error.pm,v 1.8 2003/08/23 04:35:31 fukachan Exp $
 #
 
 package FML::Command::Admin::error;
@@ -23,12 +23,14 @@ See C<FML::Command> for more details.
 
 =head1 DESCRIPTION
 
-change delivery mode from real time to digest.
+show error status.
 
 =head1 METHODS
 
 =head2 process($curproc, $command_args)
 
+call error status list generator.
+
 =cut
 
 
@@ -59,7 +61,7 @@ sub need_lock { 1;}
 sub lock_channel { return undef;}
 
 
-# Descriptions: change delivery mode from real time to digest.
+# Descriptions: list up status of error messages
 #    Arguments: OBJ($self) OBJ($curproc) HASH_REF($command_args)
 # Side Effects: update $recipient_map
 # Return Value: none
diff --git a/fml/lib/FML/Command/Admin/file.pm b/fml/lib/FML/Command/Admin/file.pm
index 82812d83..8b818cd6 100644
--- a/fml/lib/FML/Command/Admin/file.pm
+++ b/fml/lib/FML/Command/Admin/file.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: file.pm,v 1.13 2003/08/23 04:35:31 fukachan Exp $
+# $FML: file.pm,v 1.14 2003/08/29 15:33:58 fukachan Exp $
 #
 
 package FML::Command::Admin::file;
@@ -23,12 +23,12 @@ See C<FML::Command> for more details.
 
 =head1 DESCRIPTION
 
-file a new address.
-
 =head1 METHODS
 
 =head2 process($curproc, $command_args)
 
+dispatch functions for file operations.
+
 =cut
 
 
@@ -114,6 +114,7 @@ sub cgi_menu
 {
     my ($self, $curproc, $args, $command_args) = @_;
 
+    # XXX-TODO: dummy.?
     ;
 }
 
diff --git a/fml/lib/FML/Command/Admin/initpass.pm b/fml/lib/FML/Command/Admin/initpass.pm
index 5e5ab25c..7f651687 100644
--- a/fml/lib/FML/Command/Admin/initpass.pm
+++ b/fml/lib/FML/Command/Admin/initpass.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$
+# $FML: initpass.pm,v 1.1 2003/02/02 10:59:19 fukachan Exp $
 #
 
 package FML::Command::Admin::initpass;
@@ -17,7 +17,7 @@ use FML::Command::Admin::changepassword;
 @ISA = qw(FML::Command::Admin::changepassword);
 
 
-# Descriptions: initialize admin password of a new user.
+# Descriptions: initialize remote admin password of a new user.
 #    Arguments: OBJ($self) OBJ($curproc) HASH_REF($command_args)
 # Side Effects: forward request to password module
 # Return Value: none
diff --git a/fml/lib/FML/Command/Admin/ls.pm b/fml/lib/FML/Command/Admin/ls.pm
index b21d28fa..e8e5fa72 100644
--- a/fml/lib/FML/Command/Admin/ls.pm
+++ b/fml/lib/FML/Command/Admin/ls.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: ls.pm,v 1.3 2002/09/11 23:18:07 fukachan Exp $
+# $FML: ls.pm,v 1.4 2002/09/22 14:56:45 fukachan Exp $
 #
 
 package FML::Command::Admin::ls;
@@ -17,7 +17,7 @@ use FML::Command::Admin::dir;
 @ISA = qw(FML::Command::Admin::dir);
 
 
-# Descriptions: dir
+# Descriptions: file/directory listings.
 #    Arguments: OBJ($self) OBJ($curproc) HASH_REF($command_args)
 # Side Effects: forward request to dir module
 # Return Value: none
@@ -29,7 +29,7 @@ sub process
 
 =head1 NAME
 
-FML::Command::Admin::ls - file operations
+FML::Command::Admin::ls - file/directory listings.
 
 =head1 SYNOPSIS
 
@@ -37,6 +37,7 @@ See C<FML::Command> for more details.
 
 =head1 DESCRIPTION
 
+file/directory listings.
 an alias of C<FML::Command::Admin::dir>.
 
 =head1 CODING STYLE
diff --git a/fml/lib/FML/Command/Admin/passwd.pm b/fml/lib/FML/Command/Admin/passwd.pm
index 42692015..51033629 100644
--- a/fml/lib/FML/Command/Admin/passwd.pm
+++ b/fml/lib/FML/Command/Admin/passwd.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$
+# $FML: passwd.pm,v 1.1 2003/02/02 10:59:19 fukachan Exp $
 #
 
 package FML::Command::Admin::passwd;
@@ -17,7 +17,7 @@ use FML::Command::Admin::changepassword;
 @ISA = qw(FML::Command::Admin::changepassword);
 
 
-# Descriptions: change admin password
+# Descriptions: change remote admin password.
 #    Arguments: OBJ($self) OBJ($curproc) HASH_REF($command_args)
 # Side Effects: forward request to password module
 # Return Value: none
@@ -32,7 +32,7 @@ sub process
 
 =head1 NAME
 
-FML::Command::Admin::passwd - change admin password (fml4 compatible)
+FML::Command::Admin::passwd - change remote admin password (fml4 compatible)
 
 =head1 SYNOPSIS
 
@@ -40,6 +40,7 @@ See C<FML::Command> for more details.
 
 =head1 DESCRIPTION
 
+change remote admin password.
 an alias of C<FML::Command::Admin::changepassword>.
 
 =head1 CODING STYLE
diff --git a/fml/lib/FML/Command/Admin/password.pm b/fml/lib/FML/Command/Admin/password.pm
index 2866f492..89eb8d91 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.10 2003/08/23 04:35:31 fukachan Exp $
+# $FML: password.pm,v 1.11 2003/12/31 03:49:17 fukachan Exp $
 #
 
 package FML::Command::Admin::password;
@@ -23,12 +23,12 @@ See C<FML::Command> for more details.
 
 =head1 DESCRIPTION
 
-password a new address.
-
 =head1 METHODS
 
 =head2 process($curproc, $command_args)
 
+authenticate the remote admin password.
+
 =cut