FNF: cosmetics. fix comments.

5 files changed, 70 insertions, 58 deletions

diff --git a/fml/lib/FML/MTA/Control.pm b/fml/lib/FML/MTA/Control.pm
index b85de115..ffe3de98 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.2 2004/01/02 10:23:56 fukachan Exp $
+# $FML: Control.pm,v 1.3 2004/01/02 14:50:32 fukachan Exp $
 #
 
 package FML::MTA::Control;
@@ -55,7 +55,7 @@ and
 my $default_mta = 'postfix';
 
 
-# Descriptions: ordinary constructor
+# Descriptions: ordinary constructor.
 #    Arguments: OBJ($self) HASH_REF($ctl_args)
 # Side Effects: none
 # Return Value: OBJ
@@ -92,7 +92,7 @@ sub is_valid_mta_type
 }
 
 
-# Descriptions: install configuration template files
+# Descriptions: install configuration template files.
 #    Arguments: OBJ($self)
 #               HASH_REF($curproc) HASH_REF($params) HASH_REF($optargs)
 # Side Effects: update aliases
@@ -170,7 +170,7 @@ sub get_aliases_as_hash_ref
 }
 
 
-# Descriptions: install alias file
+# Descriptions: install alias file.
 #    Arguments: OBJ($self) OBJ($curproc) HASH_REF($params) HASH_REF($optargs)
 # Side Effects: update aliases
 # Return Value: none
@@ -189,7 +189,7 @@ sub install_alias
 }
 
 
-# Descriptions: remove entry in alias maps
+# Descriptions: remove entry in alias maps.
 #    Arguments: OBJ($self) OBJ($curproc) HASH_REF($params) HASH_REF($optargs)
 # Side Effects: update aliases
 # Return Value: none
@@ -208,7 +208,7 @@ sub remove_alias
 }
 
 
-# Descriptions: install/update virtual map file
+# Descriptions: install/update virtual map file.
 #    Arguments: OBJ($self) OBJ($curproc) HASH_REF($params) HASH_REF($optargs)
 # Side Effects: update aliases
 # Return Value: none
@@ -227,7 +227,7 @@ sub install_virtual_map
 }
 
 
-# Descriptions: remove entry in virtual maps
+# Descriptions: remove entry in virtual maps.
 #    Arguments: OBJ($self) OBJ($curproc) HASH_REF($params) HASH_REF($optargs)
 # Side Effects: update aliases
 # Return Value: none
@@ -246,7 +246,7 @@ sub remove_virtual_map
 }
 
 
-# Descriptions: update virtual_map
+# Descriptions: update virtual_map.
 #    Arguments: OBJ($self) OBJ($curproc) HASH_REF($params) HASH_REF($optargs)
 # Side Effects: update virtual_map
 # Return Value: none
@@ -265,7 +265,7 @@ sub update_virtual_map
 }
 
 
-# Descriptions: install file $to dst with variable expansion of $src
+# Descriptions: install file $to dst with variable expansion of $src.
 #    Arguments: OBJ($self) STR($src) STR($dst) HASH_REF($config)
 # Side Effects: create $dst
 # Return Value: none
@@ -273,6 +273,7 @@ sub _install
 {
     my ($self, $src, $dst, $config) = @_;
 
+    # XXX-TODO: method-ify ? 
     eval q{
 	use FML::Config::Convert;
 	&FML::Config::Convert::convert_file($src, $dst, $config);
@@ -281,7 +282,7 @@ sub _install
 }
 
 
-# Descriptions: remove the specified entry in the postfix style map
+# Descriptions: remove the specified entry in the postfix style map.
 #    Arguments: OBJ($self) OBJ($curproc) HASH_REF($params) HASH_REF($optargs)
 #               HASH_REF($p)
 # Side Effects: update virtual_map
@@ -292,6 +293,10 @@ sub _remove_postfix_style_virtual
     my $removed = 0;
     my $key     = $p->{ key };
 
+    #
+    # XXX-TODO: ERROR: this module is private but used over modules. 
+    #
+
     use File::Spec;
     my $virtual     = $p->{ map };
     my $virtual_new = $virtual . 'new'. $$;
diff --git a/fml/lib/FML/MTA/Control/Postfix.pm b/fml/lib/FML/MTA/Control/Postfix.pm
index 12925ecd..be3558d4 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.23 2003/09/13 09:17:00 fukachan Exp $
+# $FML: Postfix.pm,v 1.1 2003/12/28 13:23:19 fukachan Exp $
 #
 
 package FML::MTA::Control::Postfix;
@@ -30,7 +30,7 @@ set up aliases and virtual maps for postfix.
 =cut
 
 
-# Descriptions: install new alias entries
+# Descriptions: install new alias entries.
 #    Arguments: OBJ($self)
 #               OBJ($curproc) HASH_REF($params) HASH_REF($optargs)
 # Side Effects: update aliases
@@ -61,7 +61,7 @@ sub postfix_install_alias
 }
 
 
-# Descriptions: remove alias
+# Descriptions: remove alias.
 #    Arguments: OBJ($self)
 #               OBJ($curproc) HASH_REF($params) HASH_REF($optargs)
 # Side Effects: update aliases
@@ -123,7 +123,7 @@ sub postfix_remove_alias
 }
 
 
-# Descriptions: regenerate aliases.db
+# Descriptions: regenerate aliases.db.
 #    Arguments: OBJ($self)
 #               OBJ($curproc) HASH_REF($params) HASH_REF($optargs)
 # Side Effects: update aliases
@@ -232,7 +232,7 @@ sub _find_key_in_file
 
 
 
-# Descriptions: get { key => value } in aliases
+# Descriptions: get { key => value } in aliases.
 #    Arguments: OBJ($self)
 #               OBJ($curproc) HASH_REF($params) HASH_REF($optargs)
 # Side Effects: none
@@ -256,6 +256,7 @@ sub postfix_get_aliases_as_hash_ref
     for my $map (@$maps) {
 	$curproc->ui_message("scan key = $key, map = $map") if $debug;
 
+	# XXX-TODO: correct? file:/some/where/map ignored too ?
 	if ($map =~ /^\w+:/) {
 	    $curproc->ui_message("* ignored $map");
 	    next MAP;
@@ -268,11 +269,11 @@ sub postfix_get_aliases_as_hash_ref
 
 	  LINE:
 	    while ($buf = <$fh>) {
-		next LINE if $buf =~ /^#/;
-		next LINE if $buf =~ /^\s*$/;
+		next LINE if $buf =~ /^#/o;
+		next LINE if $buf =~ /^\s*$/o;
 
 		chomp $buf;
-		($key, $value)   = split(/:/, $buf, 2);
+		($key, $value) = split(/:/, $buf, 2);
 		$value =~ s/^\s*//;
 		$value =~ s/s*$//;
 		$aliases->{ $key } = $value;
@@ -288,7 +289,7 @@ sub postfix_get_aliases_as_hash_ref
 }
 
 
-# Descriptions: return alias_maps as ARRAY_REF
+# Descriptions: return alias_maps as ARRAY_REF.
 #    Arguments: OBJ($self)
 #               OBJ($curproc) HASH_REF($params) HASH_REF($optargs)
 # Side Effects: none
@@ -318,7 +319,7 @@ sub postfix_alias_maps
 }
 
 
-# Descriptions: install configuration templates
+# Descriptions: install configuration templates.
 #    Arguments: OBJ($self)
 #               OBJ($curproc) HASH_REF($params) HASH_REF($optargs)
 # Side Effects: create include*
@@ -344,7 +345,7 @@ sub postfix_setup
 }
 
 
-# Descriptions: rewrite $params
+# Descriptions: rewrite $params.
 #    Arguments: OBJ($self)
 #               OBJ($curproc) HASH_REF($params) HASH_REF($optargs)
 # Side Effects: update $params
@@ -362,7 +363,7 @@ sub _postfix_rewrite_virtual_params
 }
 
 
-# Descriptions: install postfix virtual_maps
+# Descriptions: install postfix virtual_maps.
 #    Arguments: OBJ($self)
 #               OBJ($curproc) HASH_REF($params) HASH_REF($optargs)
 # Side Effects: install/udpate postfix virtual_maps and the .db
@@ -382,6 +383,7 @@ sub postfix_install_virtual_map
     my $dst     = $virtual . "." . $$;
     $curproc->ui_message("updating $virtual");
 
+    # XXX-TODO: correct for 2nd virtual domain ?
     # at the first time
     unless( -f $virtual) {
 	use FileHandle;
@@ -403,7 +405,7 @@ sub postfix_install_virtual_map
 
 
 
-# Descriptions: remove postfix virtual_maps
+# Descriptions: remove postfix virtual_maps.
 #    Arguments: OBJ($self)
 #               OBJ($curproc) HASH_REF($params) HASH_REF($optargs)
 # Side Effects: remove/udpate postfix virtual_maps and the .db
@@ -411,10 +413,10 @@ sub postfix_install_virtual_map
 sub postfix_remove_virtual_map
 {
     my ($self, $curproc, $params, $optargs) = @_;
-    my $config  = $curproc->config();
-    my $map     = $config->{ postfix_virtual_map_file };
-    my $key     = $params->{ ml_name };
-    my $p       = {
+    my $config = $curproc->config();
+    my $map    = $config->{ postfix_virtual_map_file };
+    my $key    = $params->{ ml_name };
+    my $p      = {
 	key => $key,
 	map => $map,
     };
@@ -422,7 +424,7 @@ sub postfix_remove_virtual_map
 }
 
 
-# Descriptions: regenerate virtual.db
+# Descriptions: regenerate virtual.db.
 #    Arguments: OBJ($self)
 #               OBJ($curproc) HASH_REF($params) HASH_REF($optargs)
 # Side Effects: update aliases
diff --git a/fml/lib/FML/MTA/Control/Qmail.pm b/fml/lib/FML/MTA/Control/Qmail.pm
index 20225356..8454a585 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.1 2003/12/28 13:23:19 fukachan Exp $
+# $FML: Qmail.pm,v 1.2 2004/01/02 14:42:45 fukachan Exp $
 #
 
 package FML::MTA::Control::Qmail;
@@ -106,7 +106,7 @@ sub qmail_find_key_in_alias_maps
 }
 
 
-# Descriptions: get { key => value } in aliases
+# Descriptions: get { key => value } in aliases.
 #    Arguments: OBJ($self) OBJ($curproc) HASH_REF($params) HASH_REF($optargs)
 # Side Effects: none
 # Return Value: HASH_REF
@@ -119,7 +119,7 @@ sub qmail_get_aliases_as_hash_ref
 }
 
 
-# Descriptions: return alias_maps as ARRAY_REF
+# Descriptions: return alias_maps as ARRAY_REF.
 #    Arguments: OBJ($self) OBJ($curproc) HASH_REF($params) HASH_REF($optargs)
 # Side Effects: none
 # Return Value: ARRAY_REF
@@ -132,7 +132,7 @@ sub qmail_alias_maps
 }
 
 
-# Descriptions: create ~/.qmail-* files
+# Descriptions: create ~/.qmail-* files.
 #    Arguments: OBJ($self) OBJ($curproc) HASH_REF($params) HASH_REF($optargs)
 # Side Effects: creates ~/.qmail-XXX
 # Return Value: none
@@ -187,18 +187,21 @@ sub qmail_setup
 sub qmail_install_virtual_map
 {
     my ($self, $curproc, $params) = @_;
-    my $fmlowner     = $curproc->fml_owner();
-    my $config       = $curproc->config();
-    my $ml_domain    = $config->{ ml_domain };
-    my $virtual      = $config->{ qmail_virtual_map_file };
+    my $fmlowner  = $curproc->fml_owner();
+    my $config    = $curproc->config();
+    my $ml_domain = $config->{ ml_domain };
+    my $virtual   = $config->{ qmail_virtual_map_file };
 
     # 1. check the current template file firstly
     my $found = 0;
     my $fh    = new FileHandle $virtual;
     if (defined $fh) {
 	my $buf;
+
+      LINE:
 	while ($buf = <$fh>) {
 	    $found = 1 if $buf =~ /^$ml_domain:/i;
+	    last LINE  if $found;
 	}
 	$fh->close();
     }
@@ -219,7 +222,7 @@ sub qmail_install_virtual_map
 }
 
 
-# Descriptions: dummy
+# Descriptions: dummy.
 #    Arguments: OBJ($self) HASH_REF($args)
 # Side Effects: none
 # Return Value: none
@@ -229,7 +232,7 @@ sub qmail_remove_virtual_map
 }
 
 
-# Descriptions: dummy
+# Descriptions: dummy.
 #    Arguments: OBJ($self) HASH_REF($args)
 # Side Effects: none
 # Return Value: none
diff --git a/fml/lib/FML/MTA/Control/Sendmail.pm b/fml/lib/FML/MTA/Control/Sendmail.pm
index 746fa4ea..531caed2 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.7 2003/09/13 09:17:00 fukachan Exp $
+# $FML: Sendmail.pm,v 1.1 2003/12/28 13:23:19 fukachan Exp $
 #
 
 package FML::MTA::Control::Sendmail;
@@ -33,7 +33,7 @@ set up aliases and virtual maps for sendmail.
 #XXX-TODO: We should check "Tfml" in sendmail.cf in installation.
 
 
-# Descriptions: install new alias entries
+# Descriptions: install new alias entries.
 #    Arguments: OBJ($self)
 #               OBJ($curproc) HASH_REF($params) HASH_REF($optargs)
 # Side Effects: update aliases
@@ -45,7 +45,7 @@ sub sendmail_install_alias
 }
 
 
-# Descriptions: remove alias
+# Descriptions: remove alias.
 #    Arguments: OBJ($self)
 #               OBJ($curproc) HASH_REF($params) HASH_REF($optargs)
 # Side Effects: update aliases
@@ -57,7 +57,7 @@ sub sendmail_remove_alias
 }
 
 
-# Descriptions: regenerate aliases.db
+# Descriptions: regenerate aliases.db.
 #    Arguments: OBJ($self)
 #               OBJ($curproc) HASH_REF($params) HASH_REF($optargs)
 # Side Effects: update aliases
@@ -79,7 +79,7 @@ sub sendmail_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
@@ -91,7 +91,7 @@ sub sendmail_find_key_in_alias_maps
 }
 
 
-# Descriptions: get { key => value } in aliases
+# Descriptions: get { key => value } in aliases.
 #    Arguments: OBJ($self)
 #               OBJ($curproc) HASH_REF($params) HASH_REF($optargs)
 # Side Effects: none
@@ -103,7 +103,7 @@ sub sendmail_get_aliases_as_hash_ref
 }
 
 
-# Descriptions: return alias_maps as ARRAY_REF
+# Descriptions: return alias_maps as ARRAY_REF.
 #    Arguments: OBJ($self)
 #               OBJ($curproc) HASH_REF($params) HASH_REF($optargs)
 # Side Effects: none
@@ -118,7 +118,7 @@ sub sendmail_alias_maps
 }
 
 
-# Descriptions: install configuration templates
+# Descriptions: install configuration templates.
 #    Arguments: OBJ($self)
 #               OBJ($curproc) HASH_REF($params) HASH_REF($optargs)
 # Side Effects: create include*
@@ -130,7 +130,7 @@ sub sendmail_setup
 }
 
 
-# Descriptions: rewrite $params
+# Descriptions: rewrite $params.
 #    Arguments: OBJ($self)
 #               OBJ($curproc) HASH_REF($params) HASH_REF($optargs)
 # Side Effects: update $params
@@ -143,7 +143,7 @@ sub _sendmail_rewrite_virtual_params
 }
 
 
-# Descriptions: install sendmail virtual_maps
+# Descriptions: install sendmail virtual_maps.
 #    Arguments: OBJ($self)
 #               OBJ($curproc) HASH_REF($params) HASH_REF($optargs)
 # Side Effects: install/udpate sendmail virtual_maps and the .db
@@ -184,7 +184,7 @@ sub sendmail_install_virtual_map
 
 
 
-# Descriptions: remove sendmail virtual_maps
+# Descriptions: remove sendmail virtual_maps.
 #    Arguments: OBJ($self)
 #               OBJ($curproc) HASH_REF($params) HASH_REF($optargs)
 # Side Effects: remove/udpate sendmail virtual_maps and the .db
@@ -192,10 +192,10 @@ sub sendmail_install_virtual_map
 sub sendmail_remove_virtual_map
 {
     my ($self, $curproc, $params, $optargs) = @_;
-    my $config  = $curproc->config();
-    my $map     = $config->{ sendmail_virtual_map_file };
-    my $key     = $params->{ ml_name };
-    my $p       = {
+    my $config = $curproc->config();
+    my $map    = $config->{ sendmail_virtual_map_file };
+    my $key    = $params->{ ml_name };
+    my $p      = {
 	key => $key,
 	map => $map,
     };
@@ -203,7 +203,7 @@ sub sendmail_remove_virtual_map
 }
 
 
-# Descriptions: regenerate virtual.db
+# Descriptions: regenerate virtual.db.
 #    Arguments: OBJ($self)
 #               OBJ($curproc) HASH_REF($params) HASH_REF($optargs)
 # Side Effects: update aliases
@@ -218,6 +218,8 @@ sub sendmail_update_virtual_map
     # XXX-TODO: NOT IMPLEMENTED
     if (-f $virtual) {
 	$curproc->ui_message("updating $virtual database");
+
+	# XXX-TODO: oops, hash HARD CODED.
 	if (-x $makemap) {
 	    system "$makemap hash $virtual < $virtual";
 	}
@@ -237,7 +239,7 @@ get map types supported by makemap.
 =cut
 
 
-# Descriptions: get map types supported by makemap
+# Descriptions: get map types supported by makemap.
 #    Arguments: OBJ($self)
 #               OBJ($curproc) HASH_REF($params) HASH_REF($optargs)
 # Side Effects: none
diff --git a/fml/lib/FML/MTA/Control/Utils.pm b/fml/lib/FML/MTA/Control/Utils.pm
index 49fd65bc..31915bf0 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 2003/02/09 12:31:43 fukachan Exp $
+# $FML: Utils.pm,v 1.1 2003/12/28 13:23:19 fukachan Exp $
 #
 
 package FML::MTA::Control::Utils;
@@ -21,10 +21,10 @@ FML::MTA::Control::Utils - utility functions
 
 =head1 SYNOPSIS
 
-set up aliases and virtual maps for Utils.
-
 =head1 DESCRIPTION
 
+utility functions for MTA control library.
+
 =head1 METHODS
 
 =head2 is_user_entry_exist_in_passwd($user)