[405] | 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 | #
|
---|
[2488] | 7 | # Copyright B. Cornec 2007-today
|
---|
[1528] | 8 | # Eric Anderson's changes are (c) Copyright 2012 Hewlett Packard
|
---|
| 9 | # Provided under the GPL v2
|
---|
| 10 | #
|
---|
[405] | 11 | # $Id$
|
---|
| 12 | #
|
---|
| 13 |
|
---|
| 14 | package ProjectBuilder::Conf;
|
---|
| 15 |
|
---|
| 16 | use strict;
|
---|
[2362] | 17 | use Carp qw/cluck confess/;
|
---|
[405] | 18 | use Data::Dumper;
|
---|
| 19 | use ProjectBuilder::Base;
|
---|
[1148] | 20 | use ProjectBuilder::Version;
|
---|
[405] | 21 |
|
---|
| 22 | # Inherit from the "Exporter" module which handles exporting functions.
|
---|
| 23 |
|
---|
[2500] | 24 | use vars qw(@ISA @EXPORT);
|
---|
[405] | 25 | use Exporter;
|
---|
| 26 |
|
---|
| 27 | # Export, by default, all the functions into the namespace of
|
---|
| 28 | # any code which uses this module.
|
---|
| 29 |
|
---|
| 30 | our @ISA = qw(Exporter);
|
---|
[2426] | 31 | our @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_get_all pb_conf_get_hash pb_conf_cache pb_conf_update_v0 pb_conf_get_in_hash_if);
|
---|
[405] | 32 |
|
---|
[898] | 33 | # Global hash of conf files
|
---|
| 34 | # Key is the conf file name
|
---|
| 35 | # Value is its rank
|
---|
| 36 | my %pbconffiles;
|
---|
[409] | 37 |
|
---|
[1495] | 38 | # Global hash of conf file content
|
---|
| 39 | # Key is the config keyword
|
---|
| 40 | # Value is a hash whose key depends on the nature of the config keyword as documented
|
---|
| 41 | # and value is the confguration value
|
---|
[898] | 42 | # We consider that values can not change during the life of pb
|
---|
[1495] | 43 | my $h = ();
|
---|
[898] | 44 |
|
---|
[2500] | 45 | my $dpfunc;
|
---|
| 46 | my $ldfunc;
|
---|
| 47 | our ($VERSION,$REVISION,$PBCONFVER) = pb_version_init();
|
---|
| 48 |
|
---|
[405] | 49 | =pod
|
---|
| 50 |
|
---|
| 51 | =head1 NAME
|
---|
| 52 |
|
---|
| 53 | ProjectBuilder::Conf, part of the project-builder.org - module dealing with configuration files
|
---|
| 54 |
|
---|
| 55 | =head1 DESCRIPTION
|
---|
| 56 |
|
---|
| 57 | This modules provides functions dealing with configuration files.
|
---|
| 58 |
|
---|
| 59 | =head1 SYNOPSIS
|
---|
| 60 |
|
---|
| 61 | use ProjectBuilder::Conf;
|
---|
| 62 |
|
---|
| 63 | #
|
---|
| 64 | # Read hash codes of values from a configuration file and return table of pointers
|
---|
| 65 | #
|
---|
[2252] | 66 | my ($k1, $k2) = pb_conf_read_if("$ENV{'HOME'}/.pbrc.yml","key1","key2");
|
---|
| 67 | my ($k) = pb_conf_read("$ENV{'HOME'}/.pbrc.yml","key");
|
---|
[405] | 68 |
|
---|
| 69 | =head1 USAGE
|
---|
| 70 |
|
---|
[2152] | 71 | The configuration files are loaded in a specific order from most generic to the most specific
|
---|
| 72 | to allow for overwrite to work:
|
---|
| 73 |
|
---|
[2250] | 74 | For recent versions of pb (>= 0.15):
|
---|
| 75 | 1. /usr/share/pb/pb.yml - the read-only system conf file provided by install
|
---|
| 76 | 2. /etc/pb/pb.yml - the same global conf file given to the sysadmin in order to make system wide modifications
|
---|
| 77 | 3. /path/to/project.yml - Configuration file for the project we're building for
|
---|
| 78 | 4. /vm|vepath/to/.pbrc.yml - configuration file for VM, VE or RM specific parameters. Cumulative should be orthogonal
|
---|
| 79 | 5. $HOME/.pbrc.yml - user's configuration file
|
---|
| 80 |
|
---|
| 81 | For versions of pb up to 0.14:
|
---|
[2241] | 82 | 1. /usr/share/pb/pb.conf - the read-only system conf file provided by install
|
---|
| 83 | 2. /etc/pb/pb.conf - the same global conf file given to the sysadmin in order to make system wide modifications
|
---|
[2152] | 84 | 3. /path/to/project.pb - Configuration file for the project we're building for
|
---|
| 85 | 4. /(vm|ve|rm)path/to/.pbrc - configuration file for VM, VE or RM specific parameters. Cumulative should be orthogonal
|
---|
| 86 | 5. $HOME/.pbrc - user's configuration file
|
---|
| 87 |
|
---|
[2250] | 88 | The format of the configuration file is as follows:
|
---|
| 89 |
|
---|
| 90 | For recent versions of pb (>= 0.15):
|
---|
| 91 | YAML format is now used - The version of the configuration files is
|
---|
| 92 |
|
---|
| 93 | Supposing the file is called "$ENV{'HOME'}/.pbrc.yml", containing the following:
|
---|
| 94 |
|
---|
| 95 | $ cat $HOME/.pbrc.yml
|
---|
[2257] | 96 | ---
|
---|
[2250] | 97 | pbver:
|
---|
| 98 | - pb: 3
|
---|
| 99 | - default: 1
|
---|
| 100 | pblist:
|
---|
| 101 | - pb: 12,25
|
---|
| 102 |
|
---|
| 103 | calling it like this:
|
---|
| 104 |
|
---|
| 105 | my ($k1, $k2) = pb_conf_read_if("$ENV{'HOME'}/.pbrc.yml","pbver","pblist");
|
---|
| 106 |
|
---|
| 107 | will allow to get the mapping:
|
---|
| 108 |
|
---|
| 109 | $k1->{'pb'} contains 3
|
---|
| 110 | $k1->{'default'} contains 1
|
---|
| 111 | $k2->{'pb'} contains 12,25
|
---|
| 112 |
|
---|
| 113 | For versions of pb up to 0.14:
|
---|
| 114 | An own format was used - The version of the configuration files is 0
|
---|
| 115 |
|
---|
| 116 | key tag = value1,value2,...
|
---|
| 117 |
|
---|
| 118 | Supposing the file is called "$ENV{'HOME'}/.pbrc", containing the following:
|
---|
| 119 |
|
---|
| 120 | $ cat $HOME/.pbrc
|
---|
| 121 | pbver pb = 3
|
---|
| 122 | pbver default = 1
|
---|
| 123 | pblist pb = 12,25
|
---|
| 124 |
|
---|
| 125 | calling it like this:
|
---|
| 126 |
|
---|
| 127 | my ($k1, $k2) = pb_conf_read_if("$ENV{'HOME'}/.pbrc","pbver","pblist");
|
---|
| 128 |
|
---|
| 129 | will allow to get the mapping:
|
---|
| 130 |
|
---|
| 131 | $k1->{'pb'} contains 3
|
---|
| 132 | $k1->{'default'} contains 1
|
---|
| 133 | $k2->{'pb'} contains 12,25
|
---|
| 134 |
|
---|
| 135 | Valid chars for keys and tags are letters, numbers, '-' and '_'.
|
---|
| 136 |
|
---|
[405] | 137 | =over 4
|
---|
| 138 |
|
---|
[505] | 139 | =item B<pb_conf_init>
|
---|
| 140 |
|
---|
[898] | 141 | This function setup the environment PBPROJ for project-builder function usage from other projects.
|
---|
[505] | 142 | The first parameter is the project name.
|
---|
[898] | 143 | It sets up environment variables (PBPROJ)
|
---|
[505] | 144 |
|
---|
| 145 | =cut
|
---|
| 146 |
|
---|
| 147 | sub pb_conf_init {
|
---|
| 148 |
|
---|
[1907] | 149 | my $proj=shift;
|
---|
[505] | 150 |
|
---|
[2500] | 151 | pb_log(2,"Entering pb_conf_init\n");
|
---|
[1584] | 152 | #
|
---|
| 153 | # Check project name
|
---|
| 154 | # Could be with env var PBPROJ
|
---|
| 155 | # or option -p
|
---|
| 156 | # if not defined take the first in conf file
|
---|
| 157 | #
|
---|
| 158 | if ((defined $ENV{'PBPROJ'}) &&
|
---|
| 159 | (not defined $proj)) {
|
---|
| 160 | pb_log(2,"PBPROJ env var setup ($ENV{'PBPROJ'}) so using it\n");
|
---|
| 161 | $proj = $ENV{'PBPROJ'};
|
---|
| 162 | }
|
---|
| 163 |
|
---|
[505] | 164 | if (defined $proj) {
|
---|
| 165 | $ENV{'PBPROJ'} = $proj;
|
---|
| 166 | } else {
|
---|
| 167 | $ENV{'PBPROJ'} = "default";
|
---|
| 168 | }
|
---|
[1495] | 169 | pb_log(1,"PBPROJ = $ENV{'PBPROJ'}\n");
|
---|
[2500] | 170 |
|
---|
| 171 | # Manage YAML modules to use
|
---|
| 172 |
|
---|
| 173 | if ($PBCONFVER >= 1) {
|
---|
| 174 | eval {
|
---|
| 175 | require YAML::XS;
|
---|
| 176 | YAML::XS->import();
|
---|
| 177 | };
|
---|
[2598] | 178 | if ($@) {
|
---|
| 179 | eval {
|
---|
| 180 | require YAML;
|
---|
| 181 | YAML->import();
|
---|
| 182 | };
|
---|
| 183 | if ($@) {
|
---|
| 184 | eval {
|
---|
| 185 | # No YAML found using a more std but less complete one. Old perl only
|
---|
| 186 | require Module::Build::YAML;
|
---|
| 187 | Module::Build::YAML->import();
|
---|
| 188 | };
|
---|
| 189 | if ($@) {
|
---|
| 190 | eval {
|
---|
| 191 | # No YAML found using a more std but less complete one. Old perl only
|
---|
| 192 | require YAML::Tiny;
|
---|
| 193 | YAML::Tiny->import();
|
---|
| 194 | };
|
---|
| 195 | if ($@) {
|
---|
| 196 | # Here we use an embedded YAML code for distro lacking any YAML module
|
---|
| 197 | if (not defined ($ENV{'PBSETUPV'})) {
|
---|
| 198 | # Don't do that for setupv only for other scripts
|
---|
| 199 | # as the module is already embedded and would conflict
|
---|
| 200 | require ProjectBuilder::YAML;
|
---|
| 201 | ProjectBuilder::YAML->import();
|
---|
| 202 | };
|
---|
| 203 | $dpfunc = \&pb_Dump;
|
---|
[2500] | 204 | $ldfunc = \&pb_LoadFile;
|
---|
[2598] | 205 | } else {
|
---|
| 206 | $dpfunc = \&YAML::Tiny::Dump;
|
---|
[2500] | 207 | $ldfunc = \&YAML::Tiny::LoadFile;
|
---|
[2598] | 208 | }
|
---|
| 209 | } else {
|
---|
| 210 | $dpfunc = \&Module::Build::YAML::Dump;
|
---|
[2500] | 211 | $ldfunc = \&Module::Build::YAML::LoadFile;
|
---|
[2598] | 212 | }
|
---|
| 213 | } else {
|
---|
| 214 | $dpfunc = \&YAML::Dump;
|
---|
[2500] | 215 | $ldfunc = \&YAML::LoadFile;
|
---|
[2598] | 216 | }
|
---|
| 217 | } else {
|
---|
| 218 | $dpfunc = \&YAML::XS::Dump;
|
---|
[2500] | 219 | $ldfunc = \&YAML::XS::LoadFile;
|
---|
[2598] | 220 | }
|
---|
[505] | 221 | }
|
---|
[2500] | 222 | }
|
---|
[505] | 223 |
|
---|
| 224 |
|
---|
[1495] | 225 | =item B<pb_conf_cache>
|
---|
[505] | 226 |
|
---|
[2250] | 227 | This function caches the configuration file content passed as first parameter into the hash passed in second parameter
|
---|
[1495] | 228 | It returns the modified hash
|
---|
| 229 | Can be used in correlation with the %h hash to store permanently values or not if temporarily.
|
---|
| 230 |
|
---|
| 231 | =cut
|
---|
| 232 |
|
---|
| 233 | sub pb_conf_cache {
|
---|
| 234 |
|
---|
| 235 | my $cf = shift;
|
---|
| 236 | my $lh = shift;
|
---|
| 237 |
|
---|
[2077] | 238 | # Read the content of the config file and cache it in the %h hash then available for queries
|
---|
[2279] | 239 | if ($PBCONFVER < 1) {
|
---|
[2434] | 240 | open(CONF,$cf) || (cluck "Unable to open $cf" && return($lh));
|
---|
[2176] | 241 | # This is the original conf file format for versions up to 0.14
|
---|
| 242 | while(<CONF>) {
|
---|
| 243 | next if (/^#/);
|
---|
| 244 | if (/^\s*([A-z0-9-_.]+)\s+([[A-z0-9-_.\?\[\]\*\+\\]+)\s*=\s*(.*)$/) {
|
---|
| 245 | pb_log(3,"DEBUG: 1:$1 2:$2 3:$3\n");
|
---|
[2253] | 246 | my ($what, $var, $value) = ($1, $2, $3);
|
---|
| 247 | # Add support for multi-lines
|
---|
| 248 | while ($value =~ s/\\\s*$//o) {
|
---|
| 249 | $_ = <CONF>;
|
---|
| 250 | die "Still processing continuations for $what $var at EOF" if (not defined $_);
|
---|
| 251 | s/[\r\n]//go;
|
---|
| 252 | $value .= "\n$_";
|
---|
| 253 | }
|
---|
| 254 | $lh->{$what}->{$var}=$value;
|
---|
| 255 | } elsif ((/^\s*#/o) || (/^\s*$/o)) {
|
---|
| 256 | # ignore
|
---|
| 257 | } else {
|
---|
| 258 | chomp();
|
---|
[2256] | 259 | warn "unexpected line '$_' in $cf";
|
---|
[2176] | 260 | }
|
---|
[1495] | 261 | }
|
---|
[2176] | 262 | close(CONF);
|
---|
[2500] | 263 |
|
---|
[2176] | 264 | } else {
|
---|
[2491] | 265 | # Have we already handled that conf file ?
|
---|
[2494] | 266 | next if ((defined $lh) && (defined $lh->{'__cf'}) && (defined $lh->{'__cf'}->{$cf}) && ($lh->{'__cf'}->{$cf} eq 1));
|
---|
[2491] | 267 |
|
---|
[2261] | 268 | pb_log(1,"Loading YAML conf file $cf\n");
|
---|
[2402] | 269 | my $lh0;
|
---|
| 270 | eval { $lh0 = $ldfunc->($cf); };
|
---|
| 271 | if ($@) {
|
---|
| 272 | # Repeat to get the YAML error line
|
---|
| 273 | $lh0 = $ldfunc->($cf);
|
---|
| 274 | die "Unable to analyze YAML conf file $cf\n";
|
---|
| 275 | }
|
---|
[2263] | 276 | foreach my $k (keys %$lh0) {
|
---|
| 277 | if (defined $lh->{$k}) {
|
---|
| 278 | foreach my $k2 (keys %{$lh0->{$k}}) {
|
---|
| 279 | $lh->{$k}->{$k2} = $lh0->{$k}->{$k2};
|
---|
| 280 | }
|
---|
| 281 | } else {
|
---|
| 282 | $lh->{$k} = $lh0->{$k};
|
---|
| 283 | }
|
---|
| 284 | }
|
---|
[2491] | 285 | # Remember we've seen that conf file
|
---|
| 286 | $lh->{'__cf'}->{$cf} = 1;
|
---|
[1495] | 287 | }
|
---|
| 288 | return($lh);
|
---|
| 289 | }
|
---|
| 290 |
|
---|
[409] | 291 | =item B<pb_conf_add>
|
---|
| 292 |
|
---|
[1495] | 293 | This function adds the configuration file to the list last, and cache their content in the %h hash
|
---|
[409] | 294 |
|
---|
| 295 | =cut
|
---|
| 296 |
|
---|
| 297 | sub pb_conf_add {
|
---|
| 298 |
|
---|
[1495] | 299 | my $lh;
|
---|
[898] | 300 |
|
---|
| 301 | foreach my $cf (@_) {
|
---|
[1495] | 302 | if (! -r $cf) {
|
---|
| 303 | pb_log(0,"WARNING: pb_conf_add can not read $cf\n");
|
---|
| 304 | next;
|
---|
| 305 | }
|
---|
[898] | 306 | # Skip already used conf files
|
---|
[1495] | 307 | return($lh) if (defined $pbconffiles{$cf});
|
---|
| 308 |
|
---|
[2491] | 309 | pb_log(2,"DEBUG: pb_conf_add with $cf\n");
|
---|
[2154] | 310 | # The new conf file overload values already managed
|
---|
[898] | 311 | my $num = keys %pbconffiles;
|
---|
[1495] | 312 | pb_log(2,"DEBUG: pb_conf_cache of $cf at position $num\n");
|
---|
[898] | 313 | $pbconffiles{$cf} = $num;
|
---|
[1495] | 314 |
|
---|
| 315 | # Read the content of the config file
|
---|
| 316 | $lh = pb_conf_cache($cf,$lh);
|
---|
| 317 | # and cache it in the %h hash for further queries but after the previous
|
---|
| 318 | # as we load conf files in reverse order (most precise first)
|
---|
| 319 | pb_conf_add_last_in_hash($lh)
|
---|
[409] | 320 | }
|
---|
[898] | 321 | }
|
---|
[409] | 322 |
|
---|
[1495] | 323 |
|
---|
[405] | 324 | =item B<pb_conf_read_if>
|
---|
| 325 |
|
---|
| 326 | This function returns a table of pointers on hashes
|
---|
| 327 | corresponding to the keys in a configuration file passed in parameter.
|
---|
| 328 | If that file doesn't exist, it returns undef.
|
---|
| 329 |
|
---|
[1495] | 330 | The file read is forgotten after its usage. If you want permanent caching of the data, use pb_conf_add then pb_conf_get
|
---|
| 331 |
|
---|
[405] | 332 | =cut
|
---|
| 333 |
|
---|
| 334 | sub pb_conf_read_if {
|
---|
| 335 |
|
---|
| 336 | my $conffile = shift;
|
---|
| 337 | my @param = @_;
|
---|
| 338 |
|
---|
| 339 | open(CONF,$conffile) || return((undef));
|
---|
| 340 | close(CONF);
|
---|
| 341 | return(pb_conf_read($conffile,@param));
|
---|
| 342 | }
|
---|
| 343 |
|
---|
| 344 | =item B<pb_conf_read>
|
---|
| 345 |
|
---|
| 346 | This function is similar to B<pb_conf_read_if> except that it dies when the file in parameter doesn't exist.
|
---|
| 347 |
|
---|
| 348 | =cut
|
---|
| 349 |
|
---|
| 350 | sub pb_conf_read {
|
---|
| 351 |
|
---|
| 352 | my $conffile = shift;
|
---|
| 353 | my @param = @_;
|
---|
| 354 | my @ptr;
|
---|
[1495] | 355 | my $lh;
|
---|
[405] | 356 |
|
---|
[1495] | 357 | $lh = pb_conf_cache($conffile,$lh);
|
---|
| 358 |
|
---|
| 359 | foreach my $param (@param) {
|
---|
| 360 | push @ptr,$lh->{$param};
|
---|
[405] | 361 | }
|
---|
[1495] | 362 | return(@ptr);
|
---|
| 363 | }
|
---|
[405] | 364 |
|
---|
[1904] | 365 | =item B<pb_conf_write>
|
---|
[1495] | 366 |
|
---|
[2278] | 367 | This function writes in the file passed as first parameter the hash of values passed as second parameter
|
---|
[1495] | 368 |
|
---|
[1904] | 369 | =cut
|
---|
| 370 |
|
---|
| 371 | sub pb_conf_write {
|
---|
| 372 |
|
---|
| 373 | my $conffile = shift;
|
---|
[1905] | 374 | my $h = shift;
|
---|
[1904] | 375 |
|
---|
[1905] | 376 | confess "No configuration file defined to write into !" if (not defined $conffile);
|
---|
| 377 | confess "No hash defined to read from !" if (not defined $h);
|
---|
[2434] | 378 | open(CONF,"> $conffile") || (cluck "Unable to write into $conffile" && return);
|
---|
[1904] | 379 |
|
---|
[2279] | 380 | if ($PBCONFVER < 1) {
|
---|
[2176] | 381 | # This is the original conf file format for versions up to 0.14
|
---|
| 382 | foreach my $p (sort keys %$h) {
|
---|
| 383 | my $j = $h->{$p};
|
---|
| 384 | foreach my $k (sort keys %$j) {
|
---|
| 385 | print CONF "$p $k = $j->{$k}\n";
|
---|
| 386 | }
|
---|
[1904] | 387 | }
|
---|
[2176] | 388 | } else {
|
---|
[2261] | 389 | pb_log(1,"Writing YAML conf file $conffile\n");
|
---|
[2494] | 390 | delete $h->{'__cf'};
|
---|
[2249] | 391 | print CONF $dpfunc->($h);
|
---|
[1904] | 392 | }
|
---|
| 393 | close(CONF);
|
---|
| 394 | }
|
---|
| 395 |
|
---|
| 396 |
|
---|
| 397 |
|
---|
[1495] | 398 | =item B<pb_conf_get_in_hash_if>
|
---|
| 399 |
|
---|
[1594] | 400 | This function returns a table, corresponding to a set of values queried in the hash passed in parameter or undef if it doesn't exist.
|
---|
| 401 | It takes a table of keys as an input parameter.
|
---|
[1495] | 402 |
|
---|
| 403 | =cut
|
---|
| 404 |
|
---|
| 405 | sub pb_conf_get_in_hash_if {
|
---|
| 406 |
|
---|
| 407 | my $lh = shift || return(());
|
---|
| 408 | my @params = @_;
|
---|
| 409 | my @ptr = ();
|
---|
| 410 |
|
---|
[2488] | 411 | pb_log(3,"DEBUG: pb_conf_get_in_hash_if on params ".join(' ',@params)."\n");
|
---|
[1495] | 412 | foreach my $k (@params) {
|
---|
| 413 | push @ptr,$lh->{$k};
|
---|
[405] | 414 | }
|
---|
[1495] | 415 |
|
---|
[2488] | 416 | pb_log(3,"DEBUG: pb_conf_get_in_hash_if returns\n".Dumper(@ptr));
|
---|
[405] | 417 | return(@ptr);
|
---|
| 418 | }
|
---|
| 419 |
|
---|
[1495] | 420 |
|
---|
| 421 |
|
---|
[409] | 422 | =item B<pb_conf_get_if>
|
---|
[405] | 423 |
|
---|
[1495] | 424 | 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.
|
---|
[405] | 425 |
|
---|
[409] | 426 | =cut
|
---|
| 427 |
|
---|
| 428 | sub pb_conf_get_if {
|
---|
| 429 |
|
---|
[2154] | 430 | my @param = @_;
|
---|
| 431 | my @return = pb_conf_get_in_hash_if($h,@_);
|
---|
| 432 | my $proj = undef;
|
---|
| 433 |
|
---|
| 434 | if (not defined $ENV{'PBPROJ'}) {
|
---|
| 435 | $proj = "unknown";
|
---|
| 436 | } else {
|
---|
| 437 | $proj = $ENV{'PBPROJ'};
|
---|
[405] | 438 | }
|
---|
[409] | 439 |
|
---|
[2154] | 440 | foreach my $i (0..$#param) {
|
---|
| 441 | if (not defined $return[$i]->{$proj}) {
|
---|
| 442 | $return[$i]->{$proj} = $return[$i]->{'default'} if (defined $return[$i]->{'default'});
|
---|
| 443 | }
|
---|
| 444 | }
|
---|
| 445 | return(@return);
|
---|
| 446 | }
|
---|
| 447 |
|
---|
[1495] | 448 | =item B<pb_conf_add_last_in_hash>
|
---|
[405] | 449 |
|
---|
[1495] | 450 | 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)
|
---|
[405] | 451 |
|
---|
[1495] | 452 | It is used internally by pb_conf_add and is not exported.
|
---|
[409] | 453 |
|
---|
| 454 | =cut
|
---|
| 455 |
|
---|
[1495] | 456 | sub pb_conf_add_last_in_hash {
|
---|
[409] | 457 |
|
---|
[1907] | 458 | my $ptr = shift;
|
---|
[409] | 459 |
|
---|
[1495] | 460 | return if (not defined $ptr);
|
---|
| 461 | # TODO: test $ptr is a hash pointer
|
---|
[405] | 462 |
|
---|
[1509] | 463 | # When called without correct initialization, try to work anyway with default as project
|
---|
| 464 | pb_conf_init("default") if (not defined $ENV{'PBPROJ'});
|
---|
| 465 |
|
---|
[1495] | 466 | my @params = (sort keys %$ptr);
|
---|
[405] | 467 |
|
---|
[1495] | 468 | # Everything is returned via @h
|
---|
| 469 | # @h contains the values overloading what @ptr may contain.
|
---|
[2154] | 470 | my @h = pb_conf_get_in_hash_if($h,@params);
|
---|
[1495] | 471 | my @ptr = pb_conf_get_in_hash_if($ptr,@params);
|
---|
[409] | 472 |
|
---|
[405] | 473 | my $p1;
|
---|
| 474 | my $p2;
|
---|
| 475 |
|
---|
[2488] | 476 | pb_log(3,"DEBUG: pb_conf_add_last_in_hash params: ".Dumper(@params)."\n");
|
---|
| 477 | pb_log(3,"DEBUG: pb_conf_add_last_in_hash current hash: ".Dumper(@h)."\n");
|
---|
| 478 | pb_log(3,"DEBUG: pb_conf_add_last_in_hash new inputs: ".Dumper(@ptr)."\n");
|
---|
[405] | 479 |
|
---|
[1495] | 480 | foreach my $i (0..$#params) {
|
---|
| 481 | $p1 = $h[$i];
|
---|
| 482 | $p2 = $ptr[$i];
|
---|
[2154] | 483 | # Always try to take the param from h in priority
|
---|
[1495] | 484 | # in order to mask what could be defined already in ptr
|
---|
[405] | 485 | if (not defined $p2) {
|
---|
[415] | 486 | # exit if no p1 either
|
---|
[1509] | 487 | next if (not defined $p1);
|
---|
[405] | 488 | } else {
|
---|
[409] | 489 | # Ref found in p2
|
---|
[405] | 490 | if (not defined $p1) {
|
---|
[409] | 491 | # No ref in p1 so use p2's value
|
---|
[405] | 492 | $p1 = $p2;
|
---|
| 493 | } else {
|
---|
| 494 | # Both are defined - handling the overloading
|
---|
[2154] | 495 | # Now copy back into p1 all p2 content
|
---|
| 496 | # as p1 content always has priority over p2
|
---|
[405] | 497 | if (not defined $p1->{$ENV{'PBPROJ'}}) {
|
---|
| 498 | if (defined $p2->{$ENV{'PBPROJ'}}) {
|
---|
[1594] | 499 | $p1->{$ENV{'PBPROJ'}} = $p2->{$ENV{'PBPROJ'}};
|
---|
[405] | 500 | }
|
---|
| 501 | }
|
---|
| 502 | # Now copy back into p1 all p2 content which doesn't exist in p1
|
---|
[2154] | 503 | # # p1 content always has priority over p2
|
---|
[405] | 504 | foreach my $k (keys %$p2) {
|
---|
| 505 | $p1->{$k} = $p2->{$k} if (not defined $p1->{$k});
|
---|
| 506 | }
|
---|
| 507 | }
|
---|
| 508 | }
|
---|
[1495] | 509 | $h->{$params[$i]} = $p1;
|
---|
[405] | 510 | }
|
---|
[1495] | 511 | pb_log(2,"DEBUG: pb_conf_add_last_in_hash output: ".Dumper($h)."\n");
|
---|
[405] | 512 | }
|
---|
| 513 |
|
---|
[409] | 514 | =item B<pb_conf_get>
|
---|
[405] | 515 |
|
---|
[409] | 516 | This function is the same B<pb_conf_get_if>, except that it tests each returned value as they need to exist in that case.
|
---|
| 517 |
|
---|
| 518 | =cut
|
---|
| 519 |
|
---|
| 520 | sub pb_conf_get {
|
---|
| 521 |
|
---|
| 522 | my @param = @_;
|
---|
| 523 | my @return = pb_conf_get_if(@param);
|
---|
[932] | 524 | my $proj = undef;
|
---|
[409] | 525 |
|
---|
[932] | 526 | if (not defined $ENV{'PBPROJ'}) {
|
---|
| 527 | $proj = "unknown";
|
---|
| 528 | } else {
|
---|
| 529 | $proj = $ENV{'PBPROJ'};
|
---|
| 530 | }
|
---|
[409] | 531 |
|
---|
[1538] | 532 | confess "No params found for $proj" if (not @return);
|
---|
[932] | 533 |
|
---|
[409] | 534 | foreach my $i (0..$#param) {
|
---|
[1507] | 535 | confess "No $param[$i] defined for $proj" if (not defined $return[$i]);
|
---|
[409] | 536 | }
|
---|
| 537 | return(@return);
|
---|
| 538 | }
|
---|
| 539 |
|
---|
[1495] | 540 |
|
---|
[1694] | 541 | =item B<pb_conf_get_all>
|
---|
| 542 |
|
---|
[2077] | 543 | This function returns an array with all configuration parameters
|
---|
[1694] | 544 |
|
---|
| 545 | =cut
|
---|
| 546 |
|
---|
| 547 | sub pb_conf_get_all {
|
---|
| 548 |
|
---|
[2510] | 549 | my $ah;
|
---|
| 550 | foreach my $i (sort keys %$h) {
|
---|
| 551 | $ah->{$i} = $h->{$i} if ($i !~ /^__cf/);
|
---|
[1694] | 552 | }
|
---|
[2510] | 553 | return(sort keys %$ah);
|
---|
| 554 | }
|
---|
[1694] | 555 |
|
---|
[2077] | 556 |
|
---|
| 557 | =item B<pb_conf_get_hash>
|
---|
| 558 |
|
---|
| 559 | This function returns a pointer to the hash with all configuration parameters
|
---|
| 560 |
|
---|
| 561 | =cut
|
---|
| 562 |
|
---|
| 563 | sub pb_conf_get_hash {
|
---|
| 564 |
|
---|
| 565 | return($h);
|
---|
| 566 | }
|
---|
| 567 |
|
---|
[2253] | 568 | =item B<pb_conf_update_v0>
|
---|
| 569 |
|
---|
| 570 | This function transform the old configuration v0 file as first param into a new v1 one as second param
|
---|
| 571 |
|
---|
| 572 | =cut
|
---|
| 573 |
|
---|
| 574 | sub pb_conf_update_v0 {
|
---|
| 575 |
|
---|
| 576 | my $orig = shift;
|
---|
| 577 | my $dest = shift;
|
---|
| 578 |
|
---|
[2434] | 579 | open(ORIG,$orig) || (cluck "Unable to open $orig" && return);
|
---|
[2253] | 580 | confess "Will not erase existing $dest while transforming $orig" if (-f $dest);
|
---|
[2434] | 581 | open(DEST,"> $dest") || (cluck "Unable to write into $dest" && close(ORIG) && return);
|
---|
[2257] | 582 | print DEST "---\n";
|
---|
[2253] | 583 | my $pbconfverbkp = $PBCONFVER;
|
---|
| 584 | # We force migration from v0 to v1
|
---|
| 585 | $PBCONFVER = 0;
|
---|
| 586 | my $lh0;
|
---|
[2257] | 587 | my $lh1;
|
---|
[2253] | 588 | $lh0 = pb_conf_cache($orig,$lh0);
|
---|
[2263] | 589 | pb_log(2,"lh0:\n".Dumper($lh0)."\n");
|
---|
[2253] | 590 | $PBCONFVER = $pbconfverbkp;
|
---|
| 591 |
|
---|
[2264] | 592 | pb_log(0,"Converting v0 conf file $orig to v1 conf file $dest\n");
|
---|
[2402] | 593 | # We can't just write the YAML if we want to keep comments !
|
---|
[2253] | 594 | while (<ORIG>) {
|
---|
| 595 | if ($_ =~ /^#/) {
|
---|
| 596 | # Keep comments
|
---|
| 597 | print DEST $_;
|
---|
[2257] | 598 | } elsif ($_ =~ /^\s*$/) {
|
---|
| 599 | # Replace empty lines by comments
|
---|
| 600 | print DEST "#\n";;
|
---|
[2253] | 601 | } else {
|
---|
| 602 | if (/^\s*([A-z0-9-_]+)\s+(.+)$/) {
|
---|
| 603 | # Handle parameters
|
---|
[2257] | 604 | my ($param,$void) = ($1, $2);
|
---|
| 605 | if (not defined $lh1->{$param}) {
|
---|
| 606 | pb_log(2,"Converting parameter $param\n");
|
---|
[2300] | 607 | my $param2 = $param;
|
---|
| 608 | # param pburl in v0 is now pbprojurl in v1
|
---|
| 609 | $param2 =~ s/pburl/pbprojurl/;
|
---|
| 610 | print DEST "$param2:\n";
|
---|
[2257] | 611 | foreach my $k (keys %{$lh0->{$param}}) {
|
---|
| 612 | pb_log(2,"Handling key $k\n");
|
---|
[2264] | 613 | if ($lh0->{$param}->{$k} =~ /^\s*$/) {
|
---|
| 614 | print DEST " $k: !!str \"\"\n";
|
---|
| 615 | } else {
|
---|
| 616 | print DEST " $k: $lh0->{$param}->{$k}\n";
|
---|
| 617 | }
|
---|
[2257] | 618 | }
|
---|
| 619 | $lh1->{$param} = 1;
|
---|
| 620 | }
|
---|
[2253] | 621 | } else {
|
---|
[2257] | 622 | pb_log(0,"Unable to convert line $_\n");
|
---|
[2253] | 623 | }
|
---|
| 624 | }
|
---|
| 625 | }
|
---|
| 626 | close(ORIG);
|
---|
| 627 | close(DEST);
|
---|
| 628 | return();
|
---|
| 629 | }
|
---|
| 630 |
|
---|
[405] | 631 | =back
|
---|
| 632 |
|
---|
| 633 | =head1 WEB SITES
|
---|
| 634 |
|
---|
| 635 | The 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/>.
|
---|
| 636 |
|
---|
| 637 | =head1 USER MAILING LIST
|
---|
| 638 |
|
---|
| 639 | None exists for the moment.
|
---|
| 640 |
|
---|
| 641 | =head1 AUTHORS
|
---|
| 642 |
|
---|
| 643 | The Project-Builder.org team L<http://trac.project-builder.org/> lead by Bruno Cornec L<mailto:bruno@project-builder.org>.
|
---|
| 644 |
|
---|
| 645 | =head1 COPYRIGHT
|
---|
| 646 |
|
---|
| 647 | Project-Builder.org is distributed under the GPL v2.0 license
|
---|
| 648 | described in the file C<COPYING> included with the distribution.
|
---|
| 649 |
|
---|
| 650 | =cut
|
---|
| 651 |
|
---|
| 652 |
|
---|
| 653 | 1;
|
---|