source: devel/pb-modules/lib/ProjectBuilder/Conf.pm @ 1904

Last change on this file since 1904 was 1904, checked in by bruno, 5 years ago
  • Add a pb_conf_write function and its test
File size: 10.3 KB
Line 
1#!/usr/bin/perl -w
2#
3# ProjectBuilder Conf module
4# Conf files subroutines brought by the the Project-Builder project
5# which can be easily used by wahtever perl project
6#
7# Copyright B. Cornec 2007-2012
8# Eric Anderson's changes are (c) Copyright 2012 Hewlett Packard
9# Provided under the GPL v2
10#
11# $Id$
12#
13
14package ProjectBuilder::Conf;
15
16use strict;
17use Carp 'confess';
18use Data::Dumper;
19use ProjectBuilder::Base;
20use ProjectBuilder::Version;
21
22# Inherit from the "Exporter" module which handles exporting functions.
23 
24use vars qw($VERSION $REVISION @ISA @EXPORT);
25use Exporter;
26 
27# Export, by default, all the functions into the namespace of
28# any code which uses this module.
29 
30our @ISA = qw(Exporter);
31our @EXPORT = qw(pb_conf_init pb_conf_add pb_conf_read pb_conf_read_if pb_conf_write pb_conf_get pb_conf_get_if pb_conf_print pb_conf_get_all);
32($VERSION,$REVISION) = pb_version_init();
33
34# Global hash of conf files
35# Key is the conf file name
36# Value is its rank
37my %pbconffiles;
38
39# Global hash of conf file content
40# Key is the config keyword
41# Value is a hash whose key depends on the nature of the config keyword as documented
42# and value is the confguration value
43# We consider that values can not change during the life of pb
44my $h = ();
45
46=pod
47
48=head1 NAME
49
50ProjectBuilder::Conf, part of the project-builder.org - module dealing with configuration files
51
52=head1 DESCRIPTION
53
54This modules provides functions dealing with configuration files.
55
56=head1 SYNOPSIS
57
58  use ProjectBuilder::Conf;
59
60  #
61  # Read hash codes of values from a configuration file and return table of pointers
62  #
63  my ($k1, $k2) = pb_conf_read_if("$ENV{'HOME'}/.pbrc","key1","key2");
64  my ($k) = pb_conf_read("$ENV{'HOME'}/.pbrc","key");
65
66=head1 USAGE
67
68=over 4
69
70=item B<pb_conf_init>
71
72This function setup the environment PBPROJ for project-builder function usage from other projects.
73The first parameter is the project name.
74It sets up environment variables (PBPROJ)
75
76=cut
77
78sub pb_conf_init {
79
80my $proj=shift || undef;
81
82pb_log(1,"Entering pb_conf_init\n");
83#
84# Check project name
85# Could be with env var PBPROJ
86# or option -p
87# if not defined take the first in conf file
88#
89if ((defined $ENV{'PBPROJ'}) &&
90    (not defined $proj)) {
91    pb_log(2,"PBPROJ env var setup ($ENV{'PBPROJ'}) so using it\n");
92    $proj = $ENV{'PBPROJ'};
93}
94
95if (defined $proj) {
96    $ENV{'PBPROJ'} = $proj;
97} else {
98    $ENV{'PBPROJ'} = "default";
99}
100pb_log(1,"PBPROJ = $ENV{'PBPROJ'}\n");
101}
102
103
104=item B<pb_conf_cache>
105
106This function caches the configuration file content passed as first parameter into the a hash passed in second parameter
107It returns the modified hash
108Can be used in correlation with the %h hash to store permanently values or not if temporarily.
109
110=cut
111
112sub pb_conf_cache {
113
114my $cf = shift;
115my $lh = shift;
116
117# Read the content of the config file and cache it in the %h hash further availble for queries
118open(CONF,$cf) || confess "Unable to open $cf";
119while(<CONF>) {
120    if (/^\s*([A-z0-9-_.]+)\s+([[A-z0-9-_.]+)\s*=\s*(.*)$/) {
121        pb_log(3,"DEBUG: 1:$1 2:$2 3:$3\n");
122        $lh->{$1}->{$2}=$3;
123    }
124}
125close(CONF);
126return($lh);
127}
128
129=item B<pb_conf_add>
130
131This function adds the configuration file to the list last, and cache their content in the %h hash
132
133=cut
134
135sub pb_conf_add {
136
137pb_log(2,"DEBUG: pb_conf_add with ".Dumper(@_)."\n");
138my $lh;
139
140foreach my $cf (@_) {
141    if (! -r $cf) {
142        pb_log(0,"WARNING: pb_conf_add can not read $cf\n");
143        next;
144    }
145    # Skip already used conf files
146    return($lh) if (defined $pbconffiles{$cf});
147   
148    # Add the new one at the end
149    my $num = keys %pbconffiles;
150    pb_log(2,"DEBUG: pb_conf_cache of $cf at position $num\n");
151    $pbconffiles{$cf} = $num;
152
153    # Read the content of the config file
154    $lh = pb_conf_cache($cf,$lh);
155    # and cache it in the %h hash for further queries but after the previous
156    # as we load conf files in reverse order (most precise first)
157    pb_conf_add_last_in_hash($lh)
158}
159}
160
161
162=item B<pb_conf_read_if>
163
164This function returns a table of pointers on hashes
165corresponding to the keys in a configuration file passed in parameter.
166If that file doesn't exist, it returns undef.
167
168The format of the configuration file is as follows:
169
170key tag = value1,value2,...
171
172Supposing the file is called "$ENV{'HOME'}/.pbrc", containing the following:
173
174  $ cat $HOME/.pbrc
175  pbver pb = 3
176  pbver default = 1
177  pblist pb = 12,25
178
179calling it like this:
180
181  my ($k1, $k2) = pb_conf_read_if("$ENV{'HOME'}/.pbrc","pbver","pblist");
182
183will allow to get the mapping:
184
185  $k1->{'pb'}  contains 3
186  $k1->{'default'} contains 1
187  $k2->{'pb'} contains 12,25
188
189Valid chars for keys and tags are letters, numbers, '-' and '_'.
190
191The file read is forgotten after its usage. If you want permanent caching of the data, use pb_conf_add then pb_conf_get
192
193=cut
194
195sub pb_conf_read_if {
196
197my $conffile = shift;
198my @param = @_;
199
200open(CONF,$conffile) || return((undef));
201close(CONF);
202return(pb_conf_read($conffile,@param));
203}
204
205=item B<pb_conf_read>
206
207This function is similar to B<pb_conf_read_if> except that it dies when the file in parameter doesn't exist.
208
209=cut
210
211sub pb_conf_read {
212
213my $conffile = shift;
214my @param = @_;
215my @ptr;
216my $lh;
217
218$lh = pb_conf_cache($conffile,$lh);
219
220foreach my $param (@param) {
221    push @ptr,$lh->{$param};
222}
223return(@ptr);
224}
225
226=item B<pb_conf_write>
227
228This function writes in the file passed ias first parameter the hash of values passed as second parameter
229
230=cut
231
232sub pb_conf_write {
233
234my $conffile = shift;
235my $h = $_;
236
237open(CONF,"> $conffile") || confess "Unbale to wirte into $conffile";
238
239foreach my $p (keys %$h) {
240    foreach my $key ($p) {
241        print CONF "$p $key = $p->{$key}\n";
242    }
243}
244close(CONF);
245}
246
247
248
249=item B<pb_conf_get_in_hash_if>
250
251This function returns a table, corresponding to a set of values queried in the hash passed in parameter or undef if it doesn't exist.
252It takes a table of keys as an input parameter.
253
254=cut
255
256sub pb_conf_get_in_hash_if {
257
258my $lh = shift || return(());
259my @params = @_;
260my @ptr = ();
261
262pb_log(2,"DEBUG: pb_conf_get_in_hash_if on params ".join(' ',@params)."\n");
263foreach my $k (@params) {
264    push @ptr,$lh->{$k};
265}
266
267pb_log(2,"DEBUG: pb_conf_get_in_hash_if returns\n".Dumper(@ptr));
268return(@ptr);
269}
270
271
272
273=item B<pb_conf_get_if>
274
275This 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.
276
277The format of the configurations file is as follows:
278
279key tag = value1,value2,...
280
281It will gather the values from all the configurations files passed to pb_conf_add, and return the values for the keys
282
283  $ cat $HOME/.pbrc
284  pbver pb = 1
285  pblist pb = 4
286  $ cat $HOME/.pbrc2
287  pbver pb = 3
288  pblist default = 5
289
290calling it like this:
291
292  pb_conf_add("$HOME/.pbrc","$HOME/.pbrc2");
293  my ($k1, $k2) = pb_conf_get_if("pbver","pblist");
294
295will allow to get the mapping:
296
297  $k1->{'pb'} contains 3
298  $k2->{'pb'} contains 4
299
300Valid chars for keys and tags are letters, numbers, '-' and '_'.
301
302=cut
303
304sub pb_conf_get_if {
305
306return(pb_conf_get_in_hash_if($h,@_));
307}
308
309=item B<pb_conf_add_last_in_hash>
310
311This 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)
312
313It is used internally by pb_conf_add and is not exported.
314
315=cut
316
317sub pb_conf_add_last_in_hash {
318
319my $ptr = shift || undef;
320
321return if (not defined $ptr);
322# TODO: test $ptr is a hash pointer
323
324# When called without correct initialization, try to work anyway with default as project
325pb_conf_init("default") if (not defined $ENV{'PBPROJ'});
326
327my @params = (sort keys %$ptr);
328
329# Everything is returned via @h
330# @h contains the values overloading what @ptr may contain.
331my @h = pb_conf_get_if(@params);
332my @ptr = pb_conf_get_in_hash_if($ptr,@params);
333
334my $p1;
335my $p2;
336
337pb_log(2,"DEBUG: pb_conf_add_last_in_hash params: ".Dumper(@params)."\n");
338pb_log(2,"DEBUG: pb_conf_add_last_in_hash hash: ".Dumper(@h)."\n");
339pb_log(2,"DEBUG: pb_conf_add_last_in_hash input: ".Dumper(@ptr)."\n");
340
341foreach my $i (0..$#params) {
342    $p1 = $h[$i];
343    $p2 = $ptr[$i];
344    # Always try to take the param from h
345    # in order to mask what could be defined already in ptr
346    if (not defined $p2) {
347        # exit if no p1 either
348        next if (not defined $p1);
349        # No ref in p2 so use p1
350        $p1->{$ENV{'PBPROJ'}} = $p1->{'default'} if ((not defined $p1->{$ENV{'PBPROJ'}}) && (defined $p1->{'default'}));
351    } else {
352        # Ref found in p2
353        if (not defined $p1) {
354            # No ref in p1 so use p2's value
355            $p2->{$ENV{'PBPROJ'}} = $p2->{'default'} if ((not defined $p2->{$ENV{'PBPROJ'}}) && (defined $p2->{'default'}));
356            $p1 = $p2;
357        } else {
358            # Both are defined - handling the overloading
359            if (not defined $p1->{'default'}) {
360                if (defined $p2->{'default'}) {
361                    $p1->{'default'} = $p2->{'default'};
362                }
363            }
364
365            if (not defined $p1->{$ENV{'PBPROJ'}}) {
366                if (defined $p2->{$ENV{'PBPROJ'}}) {
367                    $p1->{$ENV{'PBPROJ'}} = $p2->{$ENV{'PBPROJ'}};
368                } else {
369                    $p1->{$ENV{'PBPROJ'}} = $p1->{'default'} if (defined $p1->{'default'});
370                }
371            }
372            # Now copy back into p1 all p2 content which doesn't exist in p1
373            # p1 content always has priority over p2
374            foreach my $k (keys %$p2) {
375                $p1->{$k} = $p2->{$k} if (not defined $p1->{$k});
376            }
377        }
378    }
379    $h->{$params[$i]} = $p1;
380}
381pb_log(2,"DEBUG: pb_conf_add_last_in_hash output: ".Dumper($h)."\n");
382}
383
384=item B<pb_conf_get>
385
386This function is the same B<pb_conf_get_if>, except that it tests each returned value as they need to exist in that case.
387
388=cut
389
390sub pb_conf_get {
391
392my @param = @_;
393my @return = pb_conf_get_if(@param);
394my $proj = undef;
395
396if (not defined $ENV{'PBPROJ'}) {
397    $proj = "unknown";
398} else {
399    $proj = $ENV{'PBPROJ'};
400}
401
402confess "No params found for $proj" if (not @return);
403
404foreach my $i (0..$#param) {
405    confess "No $param[$i] defined for $proj" if (not defined $return[$i]);
406}
407return(@return);
408}
409
410
411=item B<pb_conf_get_all>
412
413This function returns an array wirh all configuration parameters
414
415=cut
416
417sub pb_conf_get_all {
418
419return(sort keys %$h);
420}
421
422=back
423
424=head1 WEB SITES
425
426The main Web site of the project is available at L<http://www.project-builder.org/>. Bug reports should be filled using the trac instance of the project at L<http://trac.project-builder.org/>.
427
428=head1 USER MAILING LIST
429
430None exists for the moment.
431
432=head1 AUTHORS
433
434The Project-Builder.org team L<http://trac.project-builder.org/> lead by Bruno Cornec L<mailto:bruno@project-builder.org>.
435
436=head1 COPYRIGHT
437
438Project-Builder.org is distributed under the GPL v2.0 license
439described in the file C<COPYING> included with the distribution.
440
441=cut
442
443
4441;
Note: See TracBrowser for help on using the repository browser.