Changeset 1495 in ProjectBuilder

Timestamp:

May 7, 2012, 4:44:13 AM (12 years ago)

Author:

Bruno Cornec

Message:

r4735@localhost: bruno | 2012-05-07 03:46:39 +0200

• Conf.pm largely rewritten to cache all conf files into a local $h hash in which conf files are added in reverse order.

The new pb_conf_hash stores a configuration file into a hash structure passed in parameter.
pb_conf_add now triggers the computation of the hash structure with pb_conf_cache and adds it to the main $h hash.
pb_conf_read_if now just uses the content in the $h hash to return its table.
pb_conf_get_in_hash_if function added to do the same as pb_conf_read_if on the cached $h hash instead of a configuration file.
pb_conf_get_if now uses pb_conf_get_in_hash_if and the $h hash without re-reading conf files
pb_conf_add_last_in_hash adds the content of a hash behind the content of the $h main hash (was done in pb_conf_get before)
pb_env_init now calls pb_conf_init to have PBPROJ defined when needed.
pb seems to work with this new version (builds itself)

• Add a new getconf option to pb in order to see the state of the current configuration parameters (now in memory)

Location:

devel

Files:

• pb-modules/lib/ProjectBuilder/Conf.pm (modified) (11 diffs)
• pb-modules/lib/ProjectBuilder/Env.pm (modified) (2 diffs)
• pb/bin/pb (modified) (2 diffs)
• pb/lib/ProjectBuilder/CMS.pm (modified) (1 diff)

devel/pb-modules/lib/ProjectBuilder/Conf.pm

@@ -24 +24 @@
  
 our @ISA = qw(Exporter);
-our @EXPORT = qw(pb_conf_init pb_conf_add pb_conf_read pb_conf_read_if pb_conf_get pb_conf_get_if);
+our @EXPORT = qw(pb_conf_init pb_conf_add pb_conf_read pb_conf_read_if pb_conf_get pb_conf_get_if pb_conf_print);
 ($VERSION,$REVISION) = pb_version_init();
 
@@ -32 +32 @@
 my %pbconffiles;
 
-# Global hash of cached values. 
+# Global hash of conf file content
+# Key is the config keyword
+# Value is a hash whose key depends on the nature of the config keyword as documented
+# and value is the confguration value
 # We consider that values can not change during the life of pb
-# my %cachedval;
+my $h = ();
 
 =pod
@@ -72 +75 @@
 my $proj=shift || undef;
 
+pb_log(1,"Entering pb_conf_init\n");
 if (defined $proj) {
     $ENV{'PBPROJ'} = $proj;
@@ -77 +81 @@
     $ENV{'PBPROJ'} = "default";
 }
-}
-
-
+pb_log(1,"PBPROJ = $ENV{'PBPROJ'}\n");
+}
+
+
+=item B<pb_conf_cache>
+
+This function caches the configuration file content passed as first parameter into the a hash passed in second parameter
+It returns the modified hash
+Can be used in correlation with the %h hash to store permanently values or not if temporarily.
+
+=cut
+
+sub pb_conf_cache {
+
+my $cf = shift;
+my $lh = shift;
+
+# Read the content of the config file and cache it in the %h hash further availble for queries
+open(CONF,$cf) || die "Unable to open $cf";
+while(<CONF>) {
+    if (/^\s*([A-z0-9-_.]+)\s+([[A-z0-9-_.]+)\s*=\s*(.+)$/) {
+        pb_log(3,"DEBUG: 1:$1 2:$2 3:$3\n");
+        $lh->{$1}->{$2}=$3;
+    }
+}
+close(CONF);
+return($lh);
+}
 
 =item B<pb_conf_add>
 
-This function adds the configuration file to the list last.
+This function adds the configuration file to the list last, and cache their content in the %h hash
 
 =cut
@@ -90 +119 @@
 
 pb_log(2,"DEBUG: pb_conf_add with ".Dumper(@_)."\n");
+my $lh;
 
 foreach my $cf (@_) {
+    if (! -r $cf) {
+        pb_log(0,"WARNING: pb_conf_add can not read $cf\n");
+        next;
+    }
     # Skip already used conf files
-    next if (defined $pbconffiles{$cf});
+    return($lh) if (defined $pbconffiles{$cf});
+    
     # Add the new one at the end
     my $num = keys %pbconffiles;
-    pb_log(2,"DEBUG: pb_conf_add $cf at position $num\n");
+    pb_log(2,"DEBUG: pb_conf_cache of $cf at position $num\n");
     $pbconffiles{$cf} = $num;
-    pb_log(0,"WARNING: pb_conf_add can not read $cf\n") if (! -r $cf);
-}
-}
+
+    # Read the content of the config file 
+    $lh = pb_conf_cache($cf,$lh);
+    # and cache it in the %h hash for further queries but after the previous
+    # as we load conf files in reverse order (most precise first)
+    pb_conf_add_last_in_hash($lh)
+}
+}
+
 
 =item B<pb_conf_read_if>
@@ -131 +172 @@
 Valid chars for keys and tags are letters, numbers, '-' and '_'.
 
+The file read is forgotten after its usage. If you want permanent caching of the data, use pb_conf_add then pb_conf_get
+
 =cut
 
@@ -153 +196 @@
 my $conffile = shift;
 my @param = @_;
-my $trace;
 my @ptr;
-my %h;
-
-open(CONF,$conffile) || die "Unable to open $conffile";
-while(<CONF>) {
-    if (/^\s*([A-z0-9-_.]+)\s+([[A-z0-9-_.]+)\s*=\s*(.+)$/) {
-        pb_log(3,"DEBUG: 1:$1 2:$2 3:$3\n");
-        $h{$1}{$2}=$3;
-    }
-}
-close(CONF);
-
-for my $param (@param) {
-    push @ptr,$h{$param};
+my $lh;
+
+$lh = pb_conf_cache($conffile,$lh);
+
+foreach my $param (@param) {
+    push @ptr,$lh->{$param};
 }
 return(@ptr);
 }
 
+
+
+=item B<pb_conf_get_in_hash_if>
+
+This function returns a table, corresponding to a set of values queried in the hash passe in parameter or undef if it doen't exist. It takes a table of keys as an input parameter.
+
+=cut
+
+sub pb_conf_get_in_hash_if {
+
+my $lh = shift || return(());
+my @params = @_;
+my @ptr = ();
+
+pb_log(2,"DEBUG: pb_conf_get_in_hash_if on params ".join(' ',@params)."\n");
+foreach my $k (@params) {
+    push @ptr,$lh->{$k};
+}
+
+pb_log(2,"DEBUG: pb_conf_get_in_hash_if returns\n".Dumper(@ptr));
+return(@ptr);
+}
+
+
+
 =item B<pb_conf_get_if>
 
-This function returns a table, corresponding to a set of values queried in the conf files or undef if it doen't exist. It takes a table of keys as an input parameter.
+This function returns a table, corresponding to a set of values queried in the %h hash or undef if it doen't exist. It takes a table of keys as an input parameter.
 
 The format of the configurations file is as follows:
@@ -180 +240 @@
 key tag = value1,value2,...
 
-It will gather the values from all the configurations files passed to pb_conf_add, and return the values for the keys, taking in account the order of conf files, to manage overloading.
+It will gather the values from all the configurations files passed to pb_conf_add, and return the values for the keys
 
   $ cat $HOME/.pbrc
@@ -205 +265 @@
 sub pb_conf_get_if {
 
-my @param = @_;
-
-my $ptr = undef;
-
-# the most important conf file is first, so read them in reverse order
-foreach my $f (reverse sort { $pbconffiles{$a} <=> $pbconffiles{$b} } keys %pbconffiles) {
-    pb_log(2,"DEBUG: pb_conf_get_if in file $f\n");
-    $ptr = pb_conf_get_fromfile_if("$f",$ptr,@param);
-}
-
-return(@$ptr);
-}
-
-=item B<pb_conf_fromfile_if>
-
-This function returns a pointer on a table, corresponding to a merge of values queried in the conf file and the pointer on another table passed as parameter. It takes a table of keys as last input parameter.
-
-  my ($k1) = pb_conf_fromfile_if("$HOME/.pbrc",undef,"pbver","pblist");
-  my ($k2) = pb_conf_fromfile_if("$HOME/.pbrc3",$k1,"pbver","pblist");
-
-It is used internally by pb_conf_get_if and is not exported yet.
-
-=cut
-
-
-sub pb_conf_get_fromfile_if {
-
-my $conffile = shift;
-my $ptr2 = shift || undef;
-my @param = @_;
-
-# Everything is returned via ptr1
-my @ptr1 = ();
-my @ptr2 = ();
-
-# @ptr1 contains the values overloading what @ptr2 may contain.
-@ptr1 = pb_conf_read_if("$conffile", @param) if (defined $conffile);
-@ptr2 = @$ptr2 if (defined $ptr2);
+my @params = @_;
+my @ptr = undef;
+
+return(pb_conf_get_in_hash_if($h,@params));
+}
+
+=item B<pb_conf_add_last_in_hash>
+
+This function merges the values passed in the hash parameter into the %h hash, but only if itdoesn't already contain a value, or if the value is more precise (real value instead of default)
+
+It is used internally by pb_conf_add and is not exported.
+
+=cut
+
+sub pb_conf_add_last_in_hash {
+
+my $ptr = shift || undef;
+
+return if (not defined $ptr);
+# TODO: test $ptr is a hash pointer
+
+my @params = (sort keys %$ptr);
+
+# Everything is returned via @h
+# @h contains the values overloading what @ptr may contain.
+my @h = pb_conf_get_if(@params);
+my @ptr = pb_conf_get_in_hash_if($ptr,@params);
 
 my $p1;
 my $p2;
 
-pb_log(2,"DEBUG: pb_conf_get_from_file $conffile: ".Dumper(@ptr1)."\n");
-pb_log(2,"DEBUG: pb_conf_get_from_file input: ".Dumper(@ptr2)."\n");
-pb_log(2,"DEBUG: pb_conf_get_from_file param: ".Dumper(@param)."\n");
-
-foreach my $i (0..$#param) {
-    $p1 = $ptr1[$i];
-    # Optimisation doesn't seem useful
-    # if ((defined $p1) && (defined $cachedval{$p1})) {
-    # $ptr1[$i] = $cachedval{$p1};
-    # next;
-    # }
-    $p2 = $ptr2[$i];
-    # Always try to take the param from ptr1 
-    # in order to mask what could be defined already in ptr2
+pb_log(2,"DEBUG: pb_conf_add_last_in_hash params: ".Dumper(@params)."\n");
+pb_log(2,"DEBUG: pb_conf_add_last_in_hash hash: ".Dumper(@h)."\n");
+pb_log(2,"DEBUG: pb_conf_add_last_in_hash input: ".Dumper(@ptr)."\n");
+
+foreach my $i (0..$#params) {
+    $p1 = $h[$i];
+    $p2 = $ptr[$i];
+    # Always try to take the param from h 
+    # in order to mask what could be defined already in ptr
     if (not defined $p2) {
         # exit if no p1 either
@@ -294 +338 @@
         }
     }
-    $ptr1[$i] = $p1;
-    # Cache values to avoid redoing all that analyze when asked again on a known value
-    # $cachedval{$p1} = $p1;
-}
-pb_log(2,"DEBUG: pb_conf_get output: ".Dumper(@ptr1)."\n");
-return(\@ptr1);
+    $h->{$params[$i]} = $p1;
+}
+pb_log(2,"DEBUG: pb_conf_add_last_in_hash output: ".Dumper($h)."\n");
 }
 
@@ -328 +369 @@
 }
 
+
+=item B<pb_conf_print>
+
+This function prints every configuration parameter in order to help debug stacking issues with conf files
+
+=cut
+
+sub pb_conf_print {
+
+pb_log(0,"Full pb configuration for project $ENV{'PBPROJ'}\n");
+pb_log(0,"====================================\n");
+foreach my $k (sort keys %$h) {
+    pb_log(0,"$k => ".Dumper($h->{$k})."\n");
+}
+}
+
 =back 
 

devel/pb-modules/lib/ProjectBuilder/Env.pm

@@ -145 +145 @@
 my $tag;
 
+pb_conf_init($proj);
 pb_env_init_pbrc();
 
@@ -151 +152 @@
 # Could be with env var PBPROJ
 # or option -p
-# if not define take the first in conf file
+# if not defined take the first in conf file
 #
 if ((defined $ENV{'PBPROJ'}) &&

devel/pb/bin/pb

@@ -383 +383 @@
 
 Create tar files for the website under your CMS. 
+
+=item B<getconf>
+
+Print the full configuration parameters as found in the various configuration files. help to debug conf issues.
 
 =item B<clean>
@@ -713 +717 @@
 } elsif ($action =~ /^newproj$/) {
     # Nothing to do - already done in pb_env_init
+} elsif ($action =~ /^getconf$/) {
+    my $pbos = pb_distro_get_context();
+    pb_conf_print();
 } elsif ($action =~ /^clean$/) {
     pb_clean();

devel/pb/lib/ProjectBuilder/CMS.pm

@@ -158 +158 @@
 my $ver = basename($dir);
 my $msg = "updated to $ver";
-$msg = "Project $ENV{PBPROJ} creation" if (defined $pbinit);
+$msg = "Project $ENV{'PBPROJ'} creation" if (defined $pbinit);
 
 pb_vcs_checkin($scheme,$dir,$msg);