From: ndparker <>
Date: Sat, 16 Jun 2001 20:38:51 +0000 (+0000)
Subject: version checks added, Conf.pm restructured, comments added
X-Git-Url: https://git.p6c8.net/selfforum.git/commitdiff_plain/7b4499e347dfca2b50bfa1d8a0c6ca1419976fbc?ds=sidebyside

version checks added, Conf.pm restructured, comments added
---

diff --git a/selfforum-cgi/shared/CheckRFC.pm b/selfforum-cgi/shared/CheckRFC.pm
index 6f8fa49..d1731d2 100644
--- a/selfforum-cgi/shared/CheckRFC.pm
+++ b/selfforum-cgi/shared/CheckRFC.pm
@@ -17,6 +17,7 @@ use vars qw(
   @email
   @EXPORT
   @ISA
+  $VERSION
 );
 
 $v56 = eval q[
@@ -26,6 +27,10 @@ $v56 = eval q[
 
 use Carp qw(croak);
 
+# Version check
+#
+$VERSION = do { my @r =(q$Revision$ =~ /\d+/g); sprintf "%d."."%02d" x $#r, @r };
+
 ################################################################################
 #
 # Export
@@ -53,25 +58,27 @@ require Exporter;
 #
 sub is_URL ($@) {
   my ($string, @schemes) = @_;
+  my $scheme;
 
   return unless (defined ($string) and length ($string));
 
   @schemes = qw(http) unless (@schemes);
   @schemes = keys %url if (@schemes == 1 and $schemes[0] eq ':ALL');
 
-  for (@schemes) {
-    croak "unknown url scheme '$_'" unless exists $url{$_};
-    unless (/mailto/) {
-      return 1 if ($string =~ /$url{$_}/);
+  for $scheme (@schemes) {
+    croak "unknown url scheme '$scheme'" unless exists $url{$scheme};
+    unless ($scheme =~ /mailto/) {
+      return 1 if ($string =~ /$url{$scheme}/);
     }
     else {
-      return unless ($string =~ /^mailto:(.+)/);
-
-      if ($_ eq 'mailto') {
-        return 1 if (is_email ($1));
-      }
-      elsif ($_ eq 'strict_mailto') {
-        return 1 if (is_email ($1,1));
+      if ($string =~ /^mailto:(.+)/) {
+
+        if ($scheme eq 'mailto') {
+          return 1 if (is_email ($1));
+        }
+        elsif ($scheme eq 'strict_mailto') {
+          return 1 if (is_email ($1,1));
+        }
       }
     }
   }
diff --git a/selfforum-cgi/shared/Conf.pm b/selfforum-cgi/shared/Conf.pm
index b675995..ca39efd 100644
--- a/selfforum-cgi/shared/Conf.pm
+++ b/selfforum-cgi/shared/Conf.pm
@@ -1,81 +1,68 @@
-# Conf.pm
+package Conf;
 
-# ====================================================
-# Autor: n.d.p. / 2001-01-05
-# lm   : n.d.p. / 2001-02-02
-# ====================================================
-# Funktion:
-#      Einlesen der Scriptkonfiguration
-# ====================================================
+################################################################################
+#                                                                              #
+# File:        shared/Conf.pm                                                  #
+#                                                                              #
+# Authors:     Andre Malo       <nd@o3media.de>, 2001-06-16                    #
+#                                                                              #
+# Description: read and parse configuration files                              #
+#                                                                              #
+################################################################################
 
 use strict;
-
-package Conf;
+use vars qw(
+  @EXPORT
+  $VERSION
+);
 
 use XML::DOM;
 
-# ====================================================
-# Funktionsexport
-# ====================================================
+################################################################################
+# Version check
+#
+$VERSION = do { my @r =(q$Revision$ =~ /\d+/g); sprintf "%d."."%02d" x $#r, @r };
 
+################################################################################
+#
+# Export
+#
 use base qw(Exporter);
-@Conf::EXPORT = qw(read_script_conf);
+@EXPORT = qw(read_script_conf);
 
-################################
-# sub read_script_conf
+### add_limit () ###############################################################
 #
-# Scriptkonf. lesen
-################################
-
-sub read_script_conf ($$$) {
-  my ($Config, $Shared, $Script) = @_;
-
-  $Script =~ s/^(.*)\..*$/$1/;             # Vornamen extrahieren
-  my $common  = "$Shared/common.xml";      # gemeinsame Konf-datei
-  my $group   = "$Config/common.xml";  # gemeinsame (Gruppen-)Konf-datei
-  my $special = "$Config/$Script.xml"; # spezielle Konf-datei
-  my %conf=();                             # conf-Hash
-
-  &parse_script_conf ($common , \%conf, $Script);   # und los...
-  &parse_script_conf ($group,   \%conf, $Script);
-  &parse_script_conf ($special, \%conf, $Script);
-
-  # Rueckgabe
-  \%conf;
-}
-
-# ====================================================
-# Private Funktionen
-# ====================================================
-
-sub parse_script_conf ($$$) {
-  my ($filename, $conf, $Script) = @_;
-
-  if (-f $filename) {
-    # XML parsen
-    my $xml = new XML::DOM::Parser -> parsefile ($filename);
-    my $config = $xml -> getElementsByTagName ('Config',0) -> item (0);
-
-    foreach ($config -> getElementsByTagName ('Constant', 0)) {&add_data ($_, $conf)}
-    foreach ($config -> getElementsByTagName ('Property', 0)) {&add_prop ($_, $conf)}
-    foreach ($config -> getElementsByTagName ('Limit', 0))    {&add_limit ($_, $conf, $Script)}}
-
-  return;
-}
-
-sub add_data ($$) {
-  my ($node, $conf) = @_;
-  my $name = $node -> getAttribute ('name');
+# add limited data
+#
+# Params: $node   - element node
+#         $conf   - hashref of config hash (will be modified)
+#         $Script - scriptname (first name)
+#
+# Return: ~none~
+#
+sub add_limit ($$$) {
+  my ($node, $conf, $Script) = @_;
 
-  die "element '".$node -> getNodeName."' requires attribute 'name' - aborted" unless (length ($name) and defined ($name));
-  die "double defined name '$name' - aborted" if ( exists ( $conf -> {$name} ) );
+  my %apps = map {($_ -> getFirstChild -> getData => 1)}
+                   $node -> getElementsByTagName ('Application',0) -> item (0)
+                   -> getElementsByTagName ('Script',0);
 
-  # Wert eintragen
-  $conf -> {$name} = ($node -> hasChildNodes)?$node -> getFirstChild -> getData:undef;
+  if ($apps {$Script}) {
+    foreach ($node -> getElementsByTagName ('Constant', 0)) {add_data ($_, $conf)}
+    foreach ($node -> getElementsByTagName ('Property', 0)) {add_prop ($_, $conf)}}
 
   return;
 }
 
+### add_prop () ################################################################
+#
+# add a property (recursive if necessary)
+#
+# Params: $node - element node
+#         $conf - hashref of config hash (will be modified)
+#
+# Return: ~none~
+#
 sub add_prop ($$) {
   my ($node, $conf) = @_;
 
@@ -88,6 +75,7 @@ sub add_prop ($$) {
   my @lists  = $node -> getElementsByTagName ('List', 0);
 
   # Properties
+  #
   if (@props) {
     for (@props) {
       my $hash = (defined $conf -> {$name})?$conf -> {$name}:{};
@@ -98,6 +86,7 @@ sub add_prop ($$) {
       $conf -> {$name} = $hash;}}
 
   # Array
+  #
   if (@lists) {
     for (@lists) {
       my $lname = $_ -> getAttribute ('name');
@@ -108,6 +97,7 @@ sub add_prop ($$) {
       $conf -> {$name} -> {$lname} = [map {($_ -> hasChildNodes)?$_ -> getFirstChild -> getData:undef} $_ -> getElementsByTagName ('ListItem', 0)];}}
 
   # Hash
+  #
   if (@vars) {
     for (@vars) {
       my $vname = $_ -> getAttribute ('name');
@@ -120,31 +110,91 @@ sub add_prop ($$) {
   return;
 }
 
-sub add_limit ($$$) {
-  my ($node, $conf, $Script) = @_;
+### add_data () ################################################################
+#
+# add a real value (Constant or Variable)
+#
+# Params: $node - Element node
+#         $conf - hashref of config hash (will be modified)
+#
+# Return: ~none~
+#
+sub add_data ($$) {
+  my ($node, $conf) = @_;
+  my $name = $node -> getAttribute ('name');
 
-  my %apps = map {($_ -> getFirstChild -> getData => 1)}
-                   $node -> getElementsByTagName ('Application',0) -> item (0)
-                   -> getElementsByTagName ('Script',0);
+  die q"element '".$node -> getNodeName.q"' requires attribute 'name' - aborted" unless (length ($name) and defined ($name));
+  die q"double defined name '$name' - aborted" if ( exists ( $conf -> {$name} ) );
 
-  if ($apps {$Script}) {
-    foreach ($node -> getElementsByTagName ('Constant', 0)) {&add_data ($_, $conf)}
-    foreach ($node -> getElementsByTagName ('Property', 0)) {&add_prop ($_, $conf)}}
+  $conf -> {$name} = ($node -> hasChildNodes)?$node -> getFirstChild -> getData:undef;
 
   return;
 }
 
-# ====================================================
-# Modulinitialisierung
-# ====================================================
+### parse_script_conf () #######################################################
+#
+# parse a config file
+#
+# Params: $filename - filename
+#         $conf     - hashref of config hash (hash will be modified)
+#         $Script   - scriptname
+#
+# Return: ~none~
+#
+sub parse_script_conf ($\%$) {
+  my ($filename, $conf, $Script) = @_;
+
+  if (-f $filename) {
+    my $xml = new XML::DOM::Parser -> parsefile ($filename);
+    my $config = $xml -> getElementsByTagName ('Config', 0) -> item (0);
+
+    add_data  $_, $conf          for ($config -> getElementsByTagName ('Constant', 0));
+    add_prop  $_, $conf          for ($config -> getElementsByTagName ('Property', 0));
+    add_limit $_, $conf, $Script for ($config -> getElementsByTagName ('Limit', 0));
+  }
 
-# making require happy
+  return;
+}
+
+### read_script_conf () ########################################################
+#
+# read and parse whole script config.
+#
+# Params: $Config - /path/to/config-dir   # NO trailing slash please
+#         $Shared - /path/to/shared-dir   #        -- " --
+#         $Script - scriptname
+#
+sub read_script_conf ($$$) {
+  my ($Config, $Shared, $Script) = @_;
+
+  $Script =~ s/^(.*)\..*$/$1/;             # extract script's 'first name'
+  my $common  = "$Shared/common.xml";      # shared config file
+  my $group   = "$Config/common.xml";      # group config file
+  my $special = "$Config/$Script.xml";     # special script config file
+  my %conf=();                             # config hash
+
+  parse_script_conf ($common , %conf, $Script);
+  parse_script_conf ($group,   %conf, $Script);
+  parse_script_conf ($special, %conf, $Script);
+
+  # return
+  #
+  \%conf;
+}
+
+# keep 'require' happy
 1;
 
-# ====================================================
-# end of Conf
-# ====================================================
+#
+#
+### end of Conf ################################################################
 
+### show() #####################################################################
+#
+# mini data dumper
+#
+# Usage: Conf::Test::show (hashref)
+#
 package Conf::Test;sub show{print"Content-type: text/plain\n\n";&hash($_[
 0],'')}sub hash{my($ref,$string)=@_;foreach(sort keys%$ref){my$val=$ref->
 {$_};unless(ref($val)){print$string,$_,' = ',$val,"\n";next;}else{if(ref(
@@ -155,6 +205,6 @@ ref($_)eq 'HASH'){&hash($_,"$string\[$i] -> ")}else{if(ref($_)eq'ARRAY'){
 &array($_,"$string\[$i] -> ");}}}$i++;}}# n.d.p./2001-01-05/lm:2001-01-19
 # FUNCTION: printing the configuration, USAGE: &Conf::Test::show ($conf);
 
-# ====================================================
-# 'real' end of Conf .-))
-# ====================================================
\ No newline at end of file
+#
+#
+### *real* end of Conf ;-) #####################################################