source: ProjectBuilder/devel/pb/lib/ProjectBuilder/Base.pm@ 99

Last change on this file since 99 was 99, checked in by Bruno Cornec, 17 years ago

topdir also fixed for delivery

  • Property svn:executable set to *
File size: 10.9 KB
Line 
1#!/usr/bin/perl -w
2#
3# Base subroutines for the Project-Builder project
4#
5# $Id$
6#
7
8use strict;
9use lib qw (lib);
10use File::Basename;
11use File::Path;
12use File::Temp qw /tempdir/;
13use AppConfig qw(ARGCOUNT_HASH);
14use Data::Dumper;
15
16$ENV{'PBETC'} = "$ENV{'HOME'}/.pbrc";
17
18sub pb_env_init {
19
20my $proj=shift;
21my $ver;
22my $tag;
23
24#
25# Check project name
26# Could be with env var PBPROJ
27# or option -p
28# if not define take the first in conf file
29#
30if ((defined $ENV{'PBPROJ'}) &&
31 (not (defined $proj))) {
32 $proj = $ENV{'PBPROJ'};
33}
34
35#
36# We get the pbrc file for that project
37# and use its content
38#
39my ($pbrc) = pb_conf_read("$ENV{'PBETC'}","pbrc");
40print "DEBUG pbrc: ".Dumper($pbrc)."\n" if ($debug >= 1);
41
42%pbrc = %$pbrc;
43if (not defined $proj) {
44 # Take the first as the default project
45 $proj = (keys %pbrc)[0];
46 print $LOG "Using $proj as default project as none has been specified\n" if (($debug >= 0) and (defined $proj));
47}
48die "No project defined - use env var PBPROJ or -p proj" if (not (defined $proj));
49
50#
51# Set delivery directory
52#
53my $topdir=dirname($pbrc{$proj});
54chdir $topdir || die "Unable to change directory to $topdir";
55$ENV{'PBDESTDIR'}=$topdir."/delivery";
56
57#
58# Use project configuration file if needed
59#
60if (not defined $ENV{'PBROOT'}) {
61 if (-f $pbrc{$proj}) {
62 my ($pbroot) = pb_conf_read($pbrc{$proj},"pbroot");
63 my %pbroot = %$pbroot;
64 # All lines should point to the same pbroot so take the first
65 $ENV{'PBROOT'} = (values %$pbroot)[0] if (defined $pbroot);
66 print $LOG "Using $ENV{'PBROOT'} as default pbroot from $pbrc{$proj}\n" if (($debug >= 0) and (defined $ENV{'PBROOT'}));
67 }
68 die "No pbroot defined - use env var PBROOT or -r pbroot " if (not defined $ENV{'PBROOT'});
69}
70
71#
72# Check pb conf compliance
73#
74$ENV{'PBCONF'} = "$ENV{'PBROOT'}/pbconf";
75die "Project $proj not Project-Builder compliant. Please populate $ENV{'PBCONF'}" if ( not -d "$ENV{'PBCONF'}");
76
77my %version = ();
78
79if (-f "$ENV{'PBCONF'}/$proj.pb") {
80 # List of pkg to build by default (mandatory)
81 # List of additional pkg to build when all is called (optional)
82 # Valid version names (optional)
83 # List of files to filter (optional)
84 my ($defpkgdir, $extpkgdir, $version, $filteredfiles) = pb_conf_read("$ENV{'PBCONF'}/$proj.pb","defpkgdir","extpkgdir","version","filteredfiles");
85 print "DEBUG: defpkgdir: ".Dumper($defpkgdir)."\n" if ($debug >= 1);
86 print "DEBUG: extpkgdir: ".Dumper($extpkgdir)."\n" if ($debug >= 1);
87 print "DEBUG: version: ".Dumper($version)."\n" if ($debug >= 1);
88 print "DEBUG: filteredfiles: ".Dumper($filteredfiles)."\n" if ($debug >= 1);
89 die "Unable to find defpkgdir in $ENV{'PBCONF'}/$proj.pb" if (not defined $defpkgdir);
90 # Global
91 %defpkgdir = %$defpkgdir;
92 # Global
93 %extpkgdir = ();
94 %extpkgdir = %$defpkgdir if (defined $defpkgdir);
95 %version = ();
96 %version = %$version if (defined $version);
97 # Global
98 %filteredfiles = ();
99 %filteredfiles = %$filteredfiles if (defined $filteredfiles);
100} else {
101 die "Unable to open $ENV{'PBCONF'}/$proj.pb";
102}
103
104#
105# Set temp directory
106#
107if (not defined $ENV{'TMPDIR'}) {
108 $ENV{'TMPDIR'}="/tmp";
109}
110$ENV{'PBTMP'} = tempdir( "pb.XXXXXXXXXX", DIR => $ENV{'TMPDIR'}, CLEANUP => 1 );
111
112#
113# Get global Version/Tag
114#
115my ($pkgv, $pkgt) = pb_conf_read("$ENV{'PBCONF'}/$proj.pb","projver","projtag");
116
117if (not defined $ENV{'PBVER'}) {
118 if ((defined $pkgv) && (defined $pkgv->{$proj})) {
119 $ENV{'PBVER'}=$pkgv->{$proj};
120 } else {
121 die "No projver found in $ENV{'PBCONF'}/$proj.pb";
122 }
123}
124die "Invalid version name $ENV{'PBVER'} in $ENV{'PBCONF'}/$proj.pb" if (($ENV{'PBVER'} !~ /[0-9.]+/) && (not exists $version{$ENV{'PBVER'}}));
125
126if (not defined $ENV{'PBTAG'}) {
127 if ((defined $pkgt) && (defined $pkgt->{$proj})) {
128 $ENV{'PBTAG'}=$pkgt->{$proj};
129 } else {
130 die "No projtag found in $ENV{'PBCONF'}/$proj.pb";
131 }
132}
133die "Invalid tag name $ENV{'PBTAG'} in $ENV{'PBCONF'}/$proj.pb" if ($ENV{'PBTAG'} !~ /[0-9.]+/);
134
135#
136# Removes all directory existing below the delivery dir
137# as they are temp dir only
138# Files stay and have to be cleaned up manually
139#
140if (-d $ENV{'PBDESTDIR'}) {
141 opendir(DIR,$ENV{'PBDESTDIR'}) || die "Unable to open directory $ENV{'PBDESTDIR'}: $!";
142 foreach my $d (readdir(DIR)) {
143 next if ($d =~ /^\./);
144 next if (-f "$ENV{'PBDESTDIR'}/$d");
145 pb_rm_rf("$ENV{'PBDESTDIR'}/$d") if (-d "$ENV{'PBDESTDIR'}/$d");
146 }
147 closedir(DIR);
148}
149if (! -d "$ENV{'PBDESTDIR'}") {
150 pb_mkdir_p($ENV{'PBDESTDIR'}) || die "Unable to recursively create $ENV{'PBDESTDIR'}";
151}
152
153#
154# Set build directory
155#
156$ENV{'PBBUILDDIR'}=$topdir."/build";
157pb_rm_rf($ENV{'PBBUILDDIR'}) if (-d "$ENV{'PBBUILDDIR'}");
158pb_mkdir_p($ENV{'PBBUILDDIR'}) || die "Unable to recursively create $ENV{'PBBUILDDIR'}";
159
160umask 0022;
161return($proj);
162}
163
164# Internal mkdir -p function
165sub pb_mkdir_p {
166my @dir = @_;
167my $ret = mkpath(@dir, 0, 0755);
168return($ret);
169}
170
171# Internal rm -rf function
172sub pb_rm_rf {
173my @dir = @_;
174my $ret = rmtree(@dir, 0, 0);
175return($ret);
176}
177
178# Internal system function
179sub pb_system {
180
181my $cmd=shift;
182my $cmt=shift || $cmd;
183
184print $LOG "$cmt... ";
185system("$cmd");
186if ($? == -1) {
187 print $LOG "failed to execute: $!\n" if ($debug >= 0);
188} elsif ($? & 127) {
189 printf $LOG "child died with signal %d, %s coredump\n", ($? & 127), ($? & 128) ? 'with' : 'without' if ($debug >= 0);
190} else {
191 print $LOG "OK\n" if ($debug >= 0);
192}
193}
194
195# Function which returns a pointer on a hash
196# corresponding to a declaration (arg2) in the main conf file
197# and test the returned vaue as they need to exist in that case
198sub pb_conf_get {
199
200my @param = @_;
201
202my @ptr = pb_conf_read("$ENV{'PBETC'}", @param);
203
204foreach my $i (0..$#param) {
205 die "No $param[$i] defined for $ENV{'PBPROJ'}" if (not defined $ptr[$i]);
206 my $p = $ptr[$i];
207 $p->{$ENV{'PBPROJ'}} = $p->{'default'} if (not defined $p->{$ENV{'PBPROJ'}});
208 die "No $param[$i] defined for $ENV{'PBPROJ'}" if (not defined $p->{$ENV{'PBPROJ'}});
209}
210print "DEBUG: param: ".Dumper(@ptr)."\n" if ($debug >= 1);
211return(@ptr);
212}
213
214# Function which returns a pointer on a hash
215# corresponding to a declaration (arg2) in a conf file (arg1)
216sub pb_conf_read {
217
218my $conffile = shift;
219my @param = @_;
220my $trace;
221my @ptr;
222
223if ($debug > 0) {
224 $trace = 1;
225} else {
226 $trace = 0;
227}
228
229
230my $config = AppConfig->new({
231 # Auto Create variables mentioned in Conf file
232 CREATE => 1,
233 DEBUG => $trace,
234 GLOBAL => {
235 # Each conf item is a hash
236 ARGCOUNT => ARGCOUNT_HASH,
237 },
238 });
239$config->file($conffile);
240for my $param (@param) {
241 push @ptr,$config->get($param);
242}
243print "DEBUG: params: ".Dumper(@param)." ".Dumper(@ptr)."\n" if ($debug >= 1);
244return(@ptr);
245}
246
247# Setup environment for CMS system
248sub pb_cms_init {
249
250my $proj = shift || undef;
251my $ret;
252
253my ($cms) = pb_conf_get("cms");
254# This one is optional
255my ($cvsroot) = pb_conf_read($ENV{'PBETC'},"cvsroot");
256
257if ($cms->{$proj} eq "svn") {
258 $ENV{'PBREVISION'}=`(cd "$ENV{'PBROOT'}" ; svnversion .)`;
259 chomp($ENV{'PBREVISION'});
260 $ENV{'PBCMSLOG'}="svn log";
261 $ENV{'PBCMSLOGFILE'}="svn.log";
262 $ENV{'PBCMSEXP'}="svn export";
263} elsif ($cms->{$proj} eq "cvs") {
264 $ENV{'PBREVISION'}=`(cd "$ENV{'PBROOT'}" ; cvs rannotate -f . 2>&1 | awk '{print \$1}' | grep -E '^[0-9]' | cut -d. -f2 |sort -nu | tail -1)`;
265 chomp($ENV{'PBREVISION'});
266 $ENV{'PBCMSLOG'}="cvs log";
267 $ENV{'PBCMSLOGFILE'}="cvs.log";
268 $ENV{'PBCMSEXP'}="cvs export";
269 #
270 # Export content if needed
271 #
272 $ENV{'CVSROOT'} = $cvsroot->{$proj} if (defined $cvsroot->{$proj});
273} else {
274 die "cms $cms->{$proj} unknown";
275}
276}
277
278# Get all filters to apply
279# They're cumulative from less specific to most specific
280# suffix is .pbf
281
282sub pb_get_filters {
283
284my @ffiles;
285my ($ffile0, $ffile1, $ffile2, $ffile3);
286my $pbpkg = shift || die "No package specified";
287my $dtype = shift || die "No dtype specified";
288my $dfam = shift || die "No dfam specified";
289my $ddir = shift || die "No ddir specified";
290my $dver = shift || die "No dver specified";
291my $ptr; # returned value pointer on the hash of filters
292my %ptr;
293
294if (-d "$ENV{'PBCONF'}/$pbpkg/pbfilter") {
295 $ffile0 = "$ENV{'PBCONF'}/$pbpkg/pbfilter/$dtype.pbf" if (-f "$ENV{'PBCONF'}/$pbpkg/pbfilter/$dtype.pbf");
296 $ffile1 = "$ENV{'PBCONF'}/$pbpkg/pbfilter/$dfam.pbf" if (-f "$ENV{'PBCONF'}/$pbpkg/pbfilter/$dfam.pbf");
297 $ffile2 = "$ENV{'PBCONF'}/$pbpkg/pbfilter/$ddir.pbf" if (-f "$ENV{'PBCONF'}/$pbpkg/pbfilter/$ddir.pbf");
298 $ffile3 = "$ENV{'PBCONF'}/$pbpkg/pbfilter/$ddir-$dver.pbf" if (-f "$ENV{'PBCONF'}/$pbpkg/pbfilter/$ddir-$dver.pbf");
299
300 push @ffiles,$ffile0 if (defined $ffile0);
301 push @ffiles,$ffile1 if (defined $ffile1);
302 push @ffiles,$ffile2 if (defined $ffile2);
303 push @ffiles,$ffile3 if (defined $ffile3);
304}
305if (@ffiles) {
306 print $LOG "DEBUG ffiles: ".Dumper(\@ffiles)."\n" if ($debug >= 1);
307
308 my $config = AppConfig->new({
309 # Auto Create variables mentioned in Conf file
310 CREATE => 1,
311 DEBUG => 0,
312 GLOBAL => {
313 # Each conf item is a hash
314 ARGCOUNT => AppConfig::ARGCOUNT_HASH
315 }
316 });
317
318 $config->file(@ffiles);
319 $ptr = $config->get("filter");
320 print $LOG "DEBUG f:".Dumper($ptr)."\n" if ($debug >= 1);
321} else {
322 $ptr = { };
323}
324%ptr = %$ptr;
325return(\%ptr);
326}
327
328# Function which applies filter on files (only for pb)
329sub pb_filter_file_pb {
330
331my $f=shift;
332my $ptr=shift;
333my %filter=%$ptr;
334my $destfile=shift;
335my $dtype=shift;
336my $pbsuf=shift;
337my $pbpkg=shift;
338my $pbver=shift;
339my $pbtag=shift;
340my $pbrev=shift;
341my $pbdate=shift;
342
343print $LOG "DEBUG: From $f to $destfile\n" if ($debug >= 1);
344pb_mkdir_p(dirname($destfile)) if (! -d dirname($destfile));
345open(DEST,"> $destfile") || die "Unable to create $destfile";
346open(FILE,"$f") || die "Unable to open $f: $!";
347while (<FILE>) {
348 my $line = $_;
349 foreach my $s (keys %filter) {
350 # Process single variables
351 print $LOG "DEBUG filter{$s}: $filter{$s}\n" if ($debug >= 1);
352 my $tmp = $filter{$s};
353 next if (not defined $tmp);
354 # Expand variables if any single one found
355 print $LOG "DEBUG tmp: $tmp\n" if ($debug >= 1);
356 if ($tmp =~ /\$/) {
357 eval { $tmp =~ s/(\$\w+)/$1/eeg };
358 # special case for ChangeLog only for pb
359 } elsif (($tmp =~ /^yes$/) && ($s =~ /^PBLOG$/) && ($line =~ /^PBLOG$/)) {
360 $tmp = "";
361 my $p = $defpkgdir{$pbpkg};
362 $p = $extpkgdir{$pbpkg} if (not defined $p);
363 pb_changelog($dtype, $pbpkg, $pbtag, $pbsuf, $p, \*DEST);
364 }
365 $line =~ s|$s|$tmp|;
366 }
367 print DEST $line;
368}
369close(FILE);
370close(DEST);
371}
372
373# Function which applies filter on files (external call)
374sub pb_filter_file {
375
376my $f=shift;
377my $ptr=shift;
378my %filter=%$ptr;
379my $destfile=shift;
380my $pbsuf=shift;
381my $pbpkg=shift;
382my $pbver=shift;
383my $pbtag=shift;
384my $pbrev=shift;
385my $pbdate=shift;
386
387print $LOG "DEBUG: From $f to $destfile\n" if ($debug >= 1);
388pb_mkdir_p(dirname($destfile)) if (! -d dirname($destfile));
389open(DEST,"> $destfile") || die "Unable to create $destfile";
390open(FILE,"$f") || die "Unable to open $f: $!";
391while (<FILE>) {
392 my $line = $_;
393 foreach my $s (keys %filter) {
394 # Process single variables
395 print $LOG "DEBUG filter{$s}: $filter{$s}\n" if ($debug > 1);
396 my $tmp = $filter{$s};
397 next if (not defined $tmp);
398 # Expand variables if any single one found
399 if ($tmp =~ /\$/) {
400 eval { $tmp =~ s/(\$\w+)/$1/eeg };
401 }
402 $line =~ s|$s|$tmp|;
403 }
404 print DEST $line;
405}
406close(FILE);
407close(DEST);
408}
409
410
4111;
Note: See TracBrowser for help on using the repository browser.