source: ProjectBuilder/devel/pb-modules/lib/ProjectBuilder/Distribution.pm@ 2490

Last change on this file since 2490 was 2490, checked in by Bruno Cornec, 4 years ago

Fix cases where a param could be undefined

File size: 33.3 KB
Line 
1#!/usr/bin/perl -w
2#
3# Creates common environment for distributions
4#
5# Copyright B. Cornec 2007-today
6# Eric Anderson's changes are (c) Copyright 2012 Hewlett Packard
7# Provided under the GPL v2
8#
9# $Id$
10#
11
12package ProjectBuilder::Distribution;
13
14use strict;
15use Data::Dumper;
16use Carp qw/cluck confess/;
17use ProjectBuilder::Version;
18use ProjectBuilder::Base;
19use ProjectBuilder::Conf;
20use File::Basename;
21use File::Copy;
22# requires perl 5.004 minimum in VM/VE
23use File::Compare;
24
25# Global vars
26# Inherit from the "Exporter" module which handles exporting functions.
27
28use vars qw($VERSION $REVISION $PBCONFVER @ISA @EXPORT);
29use Exporter;
30
31# Export, by default, all the functions into the namespace of
32# any code which uses this module.
33
34our @ISA = qw(Exporter);
35our @EXPORT = qw(pb_distro_init pb_distro_conffile pb_distro_sysconffile pb_distro_api pb_distro_get pb_distro_get_if pb_distro_getlsb pb_distro_installdeps pb_distro_installpkgs pb_distro_getdeps pb_distro_only_deps_needed pb_distro_setuprepo pb_distro_setuposrepo pb_distro_setuprepo_gen pb_distro_get_context pb_distro_to_keylist pb_distro_conf_print pb_apply_conf_proxy);
36($VERSION,$REVISION,$PBCONFVER) = pb_version_init();
37
38=pod
39
40=head1 NAME
41
42ProjectBuilder::Distribution, part of the project-builder.org - module dealing with distribution detection
43
44=head1 DESCRIPTION
45
46This modules provides functions to allow detection of Linux distributions, and giving back some attributes concerning them.
47
48=head1 SYNOPSIS
49
50 use ProjectBuilder::Distribution;
51
52 #
53 # Return information on the running distro
54 #
55 my $pbos = pb_distro_get_context();
56 print "distro tuple: ".Dumper($pbos->name, $pbos->ver, $pbos->fam, $pbos->type, $pbos->pbsuf, $pbos->pbupd, $pbos->pbins, $pbos->arch)."\n";
57 #
58 # Return information on the requested distro
59 #
60 my $pbos = pb_distro_get_context("ubuntu-7.10-x86_64");
61 print "distro tuple: ".Dumper($pbos->name, $pbos->ver, $pbos->fam, $pbos->type, $pbos->pbsuf, $pbos->pbupd, $pbos->pbins, $pbos->arch)."\n";
62 #
63 # Return information on the running distro
64 #
65 my ($ddir,$dver) = pb_distro_guess();
66
67=head1 USAGE
68
69=over 4
70
71=item B<pb_distro_api>
72
73This function returns the mandatory configuration file used for api
74
75=cut
76
77sub pb_distro_api {
78
79return("CCCC/api.yml");
80}
81
82
83=item B<pb_distro_conffile>
84
85This function returns the mandatory configuration file used for distribution/OS detection
86
87=cut
88
89sub pb_distro_conffile {
90
91if ($PBCONFVER < 1) {
92 return("CCCC/pb.conf");
93} else {
94 return("CCCC/pb.yml");
95}
96}
97
98=item B<pb_distro_sysconffile>
99
100This function returns the optional configuration file used for local customization
101
102=cut
103
104sub pb_distro_sysconffile {
105
106if ($PBCONFVER < 1) {
107 return("SSSS/pb.conf");
108} else {
109 return("SSSS/pb.yml");
110}
111}
112
113
114=item B<pb_distro_init>
115
116This function returns a hash of parameters indicating the distribution name, version, family, type of build system, suffix of packages, update command line, installation command line and architecture of the underlying Linux distribution. The value of the fields may be "unknown" in case the function was unable to recognize on which distribution it is running.
117
118As an example, Ubuntu and Debian are in the same "du" family. As well as RedHat, RHEL, CentOS, fedora are on the same "rh" family.
119Mandriva, Open SuSE and Fedora have all the same "rpm" type of build system. Ubuntu and Debian have the same "deb" type of build system.
120And "fc" is the extension generated for all Fedora packages (Version will be added by pb).
121All this information is stored in an external configuration file typically at /etc/pb/pb.yml
122
123When passing the distribution name and version as parameters, the B<pb_distro_init> function returns the parameter of that distribution instead of the underlying one.
124
125Cf: http://linuxmafia.com/faq/Admin/release-files.html
126Ideas taken from http://search.cpan.org/~kerberus/Linux-Distribution-0.14/lib/Linux/Distribution.pm
127
128=cut
129
130
131sub pb_distro_init {
132
133my $pbos = {
134 'name' => undef,
135 'version' => undef,
136 'arch' => undef,
137 'family' => "unknown",
138 'suffix' => "unknown",
139 'update' => "unknown",
140 'install' => "unknown",
141 'type' => "unknown",
142 'os' => "unknown",
143 'nover' => "false",
144 'rmdot' => "false",
145 'useminor' => "false",
146 };
147$pbos->{'name'} = shift;
148$pbos->{'version'} = shift;
149$pbos->{'arch'} = shift;
150
151# Adds conf file for distribution description
152# the location of the conf file is finalyzed at install time
153# depending whether we deal with package install or tar file install
154
155pb_conf_add(pb_distro_sysconffile());
156
157# Similarly for the local file available for sysadmin. After the previous one to allow overwrite to work
158pb_conf_add(pb_distro_conffile());
159
160# If we don't know which distribution we're on, then guess it
161($pbos->{'name'},$pbos->{'version'}) = pb_distro_guess() if ((not defined $pbos->{'name'}) || (not defined $pbos->{'version'}));
162
163# For some rare cases, typically nover ones
164$pbos->{'name'} = "unknown" if (not defined $pbos->{'name'});
165$pbos->{'version'} = "unknown" if (not defined $pbos->{'version'});
166
167# Initialize arch
168$pbos->{'arch'} = pb_get_arch() if (not defined $pbos->{'arch'});
169# Solves a bug on Red Hat 6.x where real arch is not detected when using setarch and a chroot
170# As it was only i386 forcing it here.
171$pbos->{'arch'} = "i386" if (($pbos->{'name'} eq "redhat") && ($pbos->{'version'} =~ /^6\./));
172
173# Dig into the tuple to find the best answer
174# Do NOT factorize here, as it won't work as of now for hash creation
175# Do NOT change order without caution
176$pbos->{'useminor'} = pb_distro_get($pbos,"osuseminorrel");
177$pbos->{'family'} = pb_distro_get($pbos,"osfamily");
178$pbos->{'type'} = pb_distro_get($pbos,"ostype");
179($pbos->{'os'},$pbos->{'install'},$pbos->{'update'}) = pb_distro_get($pbos,("os","osins","osupd"));
180($pbos->{'localinstall'},$pbos->{'nover'},$pbos->{'rmdot'},$pbos->{'suffix'}) = pb_distro_get_if($pbos,"oslocalins","osnover","osremovedotinver","ossuffix");
181
182# Some OS have no interesting version
183$pbos->{'version'} = "nover" if ((defined $pbos->{'nover'}) && ($pbos->{'nover'} eq "true"));
184
185# For some OS remove the . in version name for extension
186my $dver2 = $pbos->{'version'};
187$dver2 =~ s/\.//g if ((defined $pbos->{'rmdot'}) && ($pbos->{'rmdot'} eq "true"));
188
189if ((not defined $pbos->{'suffix'}) || ($pbos->{'suffix'} eq "")) {
190 # By default suffix is a concatenation of name and version
191 $pbos->{'suffix'} = ".$pbos->{'name'}$dver2"
192} else {
193 # concat just the version to what has been found
194 $pbos->{'suffix'} = ".$pbos->{'suffix'}$dver2";
195}
196
197# if ($arch eq "x86_64") {
198# $opt="--exclude=*.i?86";
199# }
200pb_log(2,"DEBUG: pb_distro_init: ".Dumper($pbos)."\n");
201
202return($pbos);
203}
204
205=item B<pb_distro_guess>
206
207This function returns a list of 2 parameters indicating the distribution name and version of the underlying Linux distribution. The value of those 2 fields may be "unknown" in case the function was unable to recognize on which distribution it is running.
208
209On my home machine it would currently report ("mandriva","2010.2").
210
211=cut
212
213sub pb_distro_guess {
214
215# 1: List of files that unambiguously indicates what distro we have
216# 2: List of files that ambiguously indicates what distro we have
217# 3: Should have the same keys as the previous one. If ambiguity, which other distributions should be checked
218# 4: Matching Rg. Expr to detect distribution and version
219my ($single_rel_files, $ambiguous_rel_files,$distro_similar,$distro_match,$nover) = pb_conf_get("osrelfile","osrelambfile","osambiguous","osrelexpr","osnover");
220
221my $release;
222my $distro;
223
224# Begin to test presence of non-ambiguous files
225# that way we reduce the choice
226my ($d,$r);
227while (($d,$r) = each %$single_rel_files) {
228 if (defined $ambiguous_rel_files->{$d}) {
229 print STDERR "The key $d is considered as both unambiguous and ambiguous.\n";
230 confess "Please fix your configuration file.\n"
231 }
232 if (-f "$r" && ! -l "$r") {
233 my $tmp=pb_get_content("$r");
234 # Found the only possibility.
235 # Try to get version and return
236 if (defined ($distro_match->{$d})) {
237 ($release) = $tmp =~ m/$distro_match->{$d}/m;
238 } else {
239 if (not defined ($nover->{$d})) {
240 print STDERR "Unable to find $d version in $r (non-ambiguous)\n";
241 confess "Please report to the maintainer bruno_at_project-builder.org\n";
242 }
243 $release = "unknown";
244 }
245 return($d,$release);
246 }
247}
248
249# Now look at ambiguous files
250# Ubuntu before 10.04 includes a /etc/debian_version file that creates an ambiguity with debian
251# So we need to look at distros in reverse alphabetic order to treat ubuntu always first via lsb
252my $found = 0;
253foreach $d (reverse keys %$ambiguous_rel_files) {
254 $r = $ambiguous_rel_files->{$d};
255 if (-f "$r" && !-l "$r") {
256 # Found one possibility.
257 # Get all distros concerned by that file
258 my $tmp = pb_get_content("$r");
259 my $ptr = $distro_similar->{$d};
260 pb_log(2,"amb: ".Dumper($ptr)."\n");
261 $release = "unknown";
262 foreach my $dd (split(/,/,$ptr)) {
263 pb_log(2,"check $dd\n");
264 # Try to check pattern
265 if (defined $distro_match->{$dd}) {
266 pb_log(2,"cmp: $distro_match->{$dd} - vs - $tmp\n");
267 ($release) = $tmp =~ m/$distro_match->{$dd}/m;
268 if ((defined $release) && ($release ne "unknown")) {
269 $distro = $dd;
270 $found = 1;
271 last;
272 }
273 }
274 }
275 last if ($found == 1);
276 }
277}
278if ($found == 0) {
279 #
280 # Now look at the os-release file to see if we have a std distribution description
281 #
282 foreach my $r ("/usr/lib/os-release","/etc/os-release") {
283 if (-r $r) {
284 my $tmp = pb_get_content("$r");
285 ($release) = $tmp =~ m/.*\nVERSION_ID=[\"\']*([0-9a-z\._-]+)[\"\']*\n/m;
286 ($distro) = $tmp =~ m/.*\nID=[\"\']*([0-9A-z\._-]+)[\"\']*\n/m;
287 # Remove the leap suffix if present (OpenSUSE)
288 $distro =~ s/-leap//;
289 if ((defined $release) && (defined $distro)) {
290 $found = 1;
291 last;
292 }
293 }
294 }
295}
296if ($found == 0) {
297 print STDERR "Unable to find a version in ".join(' ',keys %$ambiguous_rel_files)." (ambiguous)\n";
298 confess "Please report to the maintainer bruno_at_project-builder.org\n";
299} else {
300 return($distro,$release);
301}
302}
303
304=item B<pb_distro_getlsb>
305
306This function returns the 5 lsb values LSB version, distribution ID, Description, release and codename.
307As entry it takes an optional parameter to specify whether the output is short or not.
308
309=cut
310
311sub pb_distro_getlsb {
312
313my $s = shift;
314pb_log(3,"Entering pb_distro_getlsb\n");
315
316my ($ambiguous_rel_files) = pb_conf_get("osrelambfile");
317my $lsbf = $ambiguous_rel_files->{"lsb"};
318
319# LSB has not been configured.
320if (not defined $lsbf) {
321 print STDERR "no lsb entry defined for osrelambfile\n";
322 confess "You modified upstream delivery and lost !\n";
323}
324
325if (-r $lsbf) {
326 my $rep = pb_get_content($lsbf);
327 # Create elementary fields
328 my ($c, $r, $d, $i, $l) = ("", "", "", "", "");
329 for my $f (split(/\n/,$rep)) {
330 pb_log(3,"Reading file part ***$f***\n");
331 $c = $f if ($f =~ /^DISTRIB_CODENAME/);
332 $c =~ s/DISTRIB_CODENAME=/Codename:\t/;
333 $r = $f if ($f =~ /^DISTRIB_RELEASE/);
334 $r =~ s/DISTRIB_RELEASE=/Release:\t/;
335 $d = $f if ($f =~ /^DISTRIB_DESCRIPTION/);
336 $d =~ s/DISTRIB_DESCRIPTION=/Description:\t/;
337 $d =~ s/"//g;
338 $i = $f if ($f =~ /^DISTRIB_ID/);
339 $i =~ s/DISTRIB_ID=/Distributor ID:\t/;
340 $l = $f if ($f =~ /^LSB_VERSION/);
341 $l =~ s/LSB_VERSION=/LSB Version:\t/;
342 }
343 my $regexp = "^[A-z ]*:[\t ]*";
344 $c =~ s/$regexp// if (defined $s);
345 $r =~ s/$regexp// if (defined $s);
346 $d =~ s/$regexp// if (defined $s);
347 $i =~ s/$regexp// if (defined $s);
348 $l =~ s/$regexp// if (defined $s);
349 return($l, $i, $d, $r, $c);
350} else {
351 print STDERR "Unable to read $lsbf file\n";
352 confess "Please report to the maintainer bruno_at_project-builder.org\n";
353}
354}
355
356# Internal function
357
358sub pb_apply_conf_proxy {
359my ($pbos) = @_;
360
361my $ftp_proxy = pb_distro_get_if($pbos,"ftp_proxy");
362my $http_proxy = pb_distro_get_if($pbos,"http_proxy");
363my $https_proxy = pb_distro_get_if($pbos,"https_proxy");
364
365# We do not overwrite shell settings
366$ENV{'ftp_proxy'} ||= $ftp_proxy if ((defined $ftp_proxy) && ($ftp_proxy ne ""));
367$ENV{'http_proxy'} ||= $http_proxy if ((defined $http_proxy) && ($http_proxy ne ""));
368$ENV{'https_proxy'} ||= $https_proxy if ((defined $https_proxy) && ($https_proxy ne ""));
369}
370
371=item B<pb_distro_installpkgs>
372
373This function install the packages passed as parameters on a distribution.
374
375=cut
376
377sub pb_distro_installpkgs {
378
379my $pbos = shift;
380my $pkgs = shift; # list of pkgs to install
381my $local = shift; # optional should we install local packages or remote (for deb command is different)
382
383# Protection
384confess "Missing install command for $pbos->{name}-$pbos->{version}-$pbos->{arch}" unless (defined $pbos->{install} && $pbos->{install} =~ /\w/);
385pb_apply_conf_proxy($pbos);
386pb_log(1, "ftp_proxy=$ENV{'ftp_proxy'}\n") if (defined $ENV{'ftp_proxy'});
387pb_log(1, "http_proxy=$ENV{'http_proxy'}\n") if (defined $ENV{'http_proxy'});
388pb_log(1, "https_proxy=$ENV{'https_proxy'}\n") if (defined $ENV{'https_proxy'});
389
390# This may not be // proof. We should test for availability of repo and sleep if not
391my $cmd = "$pbos->{'install'} $pkgs";
392$cmd = "$pbos->{'localinstall'} $pkgs" if ((defined $local) && (defined $pbos->{'localinstall'}) && ($pbos->{'localinstall'} !~ /[ ]*/));
393my $ret = pb_system($cmd, "Installing packages ($cmd)","mayfail");
394# Try to accomodate deficient proxies
395if ($ret != 0) {
396 $ret = pb_system($cmd, "Re-trying installing packages ($cmd)");
397}
398confess "Some packages did not install" if (($ret != 0) && ($Global::pb_stop_on_error));
399}
400
401
402=item B<pb_distro_installdeps>
403
404This function install the dependencies required to build the package on a distro.
405If $forcerepo is defined then do not assume packages are alredy installed, but reinstall them
406(useful if you add a repo which contains more up to date packages that you need)
407Dependencies can be passed as the 4th parameter in which case they are not computed
408
409=cut
410
411sub pb_distro_installdeps {
412
413# SPEC file
414my $f = shift;
415my $pbos = shift;
416my $forcerepo = shift;
417my $deps = shift; # optional list of deps to install
418my $local = shift; # optional should we install local packages or remote (for deb command is different)
419
420# Get dependencies in the build file if not forced
421$deps = pb_distro_getdeps($f,$pbos, $forcerepo) if ((not defined $deps) || (defined $forcerepo));
422pb_log(2,"deps: $deps\n");
423return if ((not defined $deps) || ($deps =~ /^\s*$/));
424
425pb_distro_installpkgs($pbos,$deps,$local);
426# Check that all deps have been installed correctly
427# This time we don't forcerepo to avoid getting a list as a return as we have
428# already forced it previously, and this time we just want to check
429$deps = pb_distro_getdeps($f, $pbos, undef);
430confess "Some dependencies did not install ($deps)" if ((defined $deps) && ($deps =~ /\S/) && ($Global::pb_stop_on_error));
431}
432
433=item B<pb_distro_getdeps>
434
435This function computes the dependencies indicated in the build file and return them as a string of packages to install
436
437=cut
438
439sub pb_distro_getdeps {
440
441my $f = shift;
442my $pbos = shift;
443my $forcerepo = shift;
444
445my $regexp = "";
446my $deps = "";
447my $sep = $/;
448
449# Protection
450return("") if (not defined $pbos->{'type'});
451return("") if (not defined $f);
452
453pb_log(3,"entering pb_distro_getdeps: $pbos->{'type'} - $f\n");
454if ($pbos->{'type'} eq "rpm") {
455 # In RPM this could include files, but we do not handle them atm.
456 $regexp = '^BuildRequires:(.*)$';
457} elsif ($pbos->{'type'} eq "deb") {
458 $regexp = '^Build-Depends:(.*)$';
459} elsif ($pbos->{'type'} eq "apk") {
460 $regexp = '^makedepends=(.*)$';
461} elsif ($pbos->{'type'} eq "ebuild") {
462 $sep = '"'.$/;
463 $regexp = '^DEPEND="(.*)"\n';
464} else {
465 # No idea
466 return("");
467}
468pb_log(2,"regexp: $regexp\n");
469
470# Preserve separator before using the one we need
471my $oldsep = $/;
472$/ = $sep;
473open(DESC,"$f") || (cluck "Unable to open $f" && return(""));
474while (<DESC>) {
475 pb_log(4,"read: $_\n");
476 next if (! /$regexp/);
477 chomp();
478
479 my $nextline;
480 # Support multi-lines deps for .deb
481 if ($pbos->{type} eq 'deb') {
482 while ($nextline = <DESC>) {
483 last unless $nextline =~ /^\s+(.+)$/o;
484 $_ .= $1;
485 }
486 }
487
488 # What we found with the regexp is the list of deps.
489 pb_log(2,"found deps: $_\n");
490 s/$regexp/$1/i;
491 pb_log(4,"found deps 1: $_\n");
492 # Remove conditions in the middle and at the end for deb
493 s/\([><=]+[^,]*,/,/g;
494 pb_log(4,"found deps 2: $_\n");
495 s/\([><=]+[^,]*$//g;
496 pb_log(4,"found deps 3: $_\n");
497 # Same for rpm
498 s/[><=]+[^,]*,/,/g;
499 pb_log(4,"found deps 4: $_\n");
500 s/[><=]+.*$//g;
501 pb_log(4,"found deps 5: $_\n");
502 # Improve string format (remove , and spaces at start, end and in double
503 s/,/ /g;
504 pb_log(4,"found deps 6: $_\n");
505 s/^\s*//;
506 pb_log(4,"found deps 7: $_\n");
507 # $ here removes the \n
508 s/\s*$//;
509 pb_log(4,"found deps 8: $_\n");
510 s/\s+/ /g;
511 pb_log(4,"found deps 9: $_\n");
512 $deps .= " ".$_;
513 pb_log(4,"found deps end: $deps\n");
514
515 # Support multi-lines deps for .deb (fwup)
516 if (defined $nextline) {
517 $_ = $nextline;
518 redo;
519 }
520}
521close(DESC);
522$/ = $oldsep;
523pb_log(2,"now deps: $deps\n");
524if (defined $forcerepo) {
525 # We want to force installation of all pkgs
526 # because a repo was setup in between, which may contains updated versions
527 pb_log(0,"Forcing installation of all packages due to previous repo setup\n");
528 return($deps);
529} else {
530 pb_log(0,"Installation of only necessary packages\n");
531 my $deps2 = pb_distro_only_deps_needed($pbos,$deps);
532 return($deps2);
533}
534}
535
536
537=item B<pb_distro_only_deps_needed>
538
539This function returns only the dependencies not yet installed
540
541=cut
542
543sub pb_distro_only_deps_needed {
544
545my $pbos = shift;
546my $deps = shift;
547
548return("") if ((not defined $deps) || ($deps =~ /^\s*$/));
549my $deps2 = "";
550# Avoid to install what is already there
551delete $ENV{'COLUMNS'};
552foreach my $p (split(/\s+/,$deps)) {
553 next if $p =~ /^\s*$/o;
554 if ($pbos->{'type'} eq "rpm") {
555 my $rpmcmd = "rpm -q --whatprovides --quiet";
556 # whatprovides doesn't work for RH6.2
557 $rpmcmd = "rpm -q --quiet" if (($pbos->{'name'} eq "redhat") && ($pbos->{'version'} =~ /6/));
558 my $res = pb_system("$rpmcmd $p","Looking for $p","mayfail");
559 next if ($res eq 0);
560 pb_log(1, "INFO: missing dependency $p\n");
561 } elsif ($pbos->{'type'} eq "deb") {
562 my $res = pb_system("dpkg -L $p","Looking for $p","mayfail");
563 next if ($res eq 0);
564 open(CMD,"dpkg -l $p |") || (cluck "Unable to run dpkg -l $p: $!" && next);
565 my $ok = 0;
566 while (<CMD>) {
567 $ok = 1 if /^ii\s+$p/;
568 }
569 close(CMD);
570 next if $ok;
571 pb_log(1, "INFO: missing dependency $p\n");
572 } elsif ($pbos->{'type'} eq "ebuild") {
573 } elsif ($pbos->{'type'} eq "apk") {
574 my $res = pb_system("apk -e info $p","Looking for $p","mayfail");
575 next if ($res eq 0);
576 pb_log(1, "INFO: missing dependency $p\n");
577 } else {
578 # Not reached
579 }
580 pb_log(2,"found deps2: $p\n");
581 $deps2 .= " $p";
582}
583
584$deps2 =~ s/^\s*//;
585pb_log(2,"now deps2: $deps2\n");
586return($deps2);
587}
588
589# Internal
590sub pb_distro_compare_repo {
591
592my $src = shift;
593my $dest = shift;
594
595if (not -f $dest) {
596 pb_log(1, "INFO: Creating new file $dest\n");
597} elsif (-f $dest && -s $dest == 0) {
598 pb_log(1, "INFO: Overwriting empty file $dest\n");
599} elsif (-f $dest && compare("$src", $dest) == 0) {
600 pb_log(1, "INFO: Overwriting identical file $dest\n");
601} else {
602 pb_log(0, "ERROR: destination file $dest exists and is different than source $src\n");
603 pb_system("cat $dest","INFO: Dest...\n","verbose");
604 pb_system("cat $src","INFO: New...\n","verbose");
605 pb_log(1, "INFO: Returning...\n");
606 return(1);
607}
608return(0);
609}
610
611
612=item B<pb_distro_setuposrepo>
613
614This function sets up potential additional repository for the setup phase
615
616=cut
617
618sub pb_distro_setuposrepo {
619
620my $pbos = shift;
621
622pb_log(3, "INFO: Adding osrepo from config file\n");
623my %h;
624my $h = \%h;
625# Adds conf file for availability of conf elements either from the local build env or from a VE/VM/RM in which the conf file has been passed
626$h = pb_conf_cache(pb_distro_conffile(),$h);
627#my $repo = pb_distro_get_param($pbos,$osrepo);
628my $repo = pb_distro_get_in_hash_if($pbos,$h,"osrepo");
629return(pb_distro_setuprepo_gen($pbos,$repo));
630}
631
632=item B<pb_distro_setuprepo>
633
634This function sets up potential additional repository to the build/install/test environment
635If done, it returns forcerepo if a repo was added, if not undef
636
637=cut
638
639sub pb_distro_setuprepo {
640
641my $pbos = shift;
642my $repotype = shift;
643
644my %h;
645my $h = \%h;
646# Adds conf file for availability of conf elements either from the local build env or from a VE/VM/RM in which the conf file has been passed
647$h = pb_conf_cache("$ENV{'PBROOTDIR'}/$ENV{'PBPROJ'}.yml",$h) if ((defined $ENV{'PBROOTDIR'}) && (-f "$ENV{'PBROOTDIR'}/$ENV{'PBPROJ'}.yml"));
648$h = pb_conf_cache("$ENV{'PBDESTDIR'}/pbrc.yml",$h) if ((defined $ENV{'PBDESTDIR'}) && (-f "$ENV{'PBDESTDIR'}/pbrc.yml"));
649
650my $repo = pb_distro_get_in_hash_if($pbos,$h,"add".$repotype."repo");
651# If no repo then set it up as undef so the return value is correct from pb_distro_setuprepo_gen
652$repo = undef if ((defined $repo) && ($repo eq ""));
653if ($repotype =~ /install/) {
654 # Give a probable default if nothing is provided to avoid overloading conf files
655 #
656 if (not defined $repo) {
657 my ($pbrepo) = pb_conf_get_in_hash_if($h,"pbrepo");
658 if (not defined $pbrepo) {
659 cluck("No pbrepo parameter defined in your project configuration file, please fix !");
660 return(undef);
661 }
662 my $url = "$pbrepo->{$ENV{'PBPROJ'}}";
663 my ($testver,$delivery) = pb_conf_get_in_hash_if($h,"testver","delivery");
664 $delivery->{$ENV{'PBPROJ'}} = "" if (not defined $delivery->{$ENV{'PBPROJ'}});
665 $url .= "/$delivery->{$ENV{'PBPROJ'}}/";
666 my $repotag = "";
667 $repotag = "-$delivery->{$ENV{'PBPROJ'}}" if ($delivery->{$ENV{'PBPROJ'}} ne "");
668 $url .= "/$pbos->{'name'}/$pbos->{'version'}/$pbos->{'arch'}/$ENV{PBPROJ}$repotag.";
669 my $ext = "";
670 if ($pbos->{'type'} eq "rpm") {
671 $ext = "repo";
672 if ($pbos->{'family'} eq "md") {
673 $ext = "addmedia";
674 }
675 } elsif ($pbos->{'type'} eq "deb") {
676 $ext = ".sources.list";
677 }
678 $repo = $url.$ext;
679 }
680}
681pb_log(1, "INFO: Adding $repo from config file for $repotype step\n") if (defined $repo);
682return(pb_distro_setuprepo_gen($pbos,$repo));
683}
684
685=item B<pb_distro_setuprepo_gen>
686
687This functionthe sets up in a generic way potential additional repository passed as a param
688It returns forcerepo if one was added, else undef
689
690=cut
691
692sub pb_distro_setuprepo_gen {
693
694my $pbos = shift;
695my $param = shift;
696
697return(undef) if (not defined $param);
698
699pb_apply_conf_proxy($pbos);
700
701# Loop on the list of additional repo
702foreach my $i (split(/,/,$param)) {
703
704 pb_log(1,"Adding repository defined by $i\n");
705 my ($scheme, $account, $host, $port, $path) = pb_get_uri($i);
706 my $bn = basename($i);
707
708 # The repo file can be local or remote. download or copy at the right place
709 if (($scheme eq "ftp") || ($scheme =~ /http/)) {
710 pb_system("wget -O $ENV{'PBTMP'}/$bn $i","Downloading additional repository file $i");
711 } else {
712 copy($i,"$ENV{'PBTMP'}/$bn");
713 }
714
715 # The repo file can be a real file or a package
716 if ($pbos->{'type'} eq "rpm") {
717 if ($bn =~ /\.rpm$/) {
718 my $pn = $bn;
719 $pn =~ s/\.rpm//;
720 if (pb_system("rpm -q --quiet $pn","","mayfail") != 0) {
721 pb_system("sudo rpm -Uvh $ENV{'PBTMP'}/$bn","Adding package $bn to setup repository");
722 }
723 } elsif ($bn =~ /\.repo$/) {
724 my $dirdest = "";
725 my $reponame = "";
726 # TODO: could go in pb.yml in fact
727 if ($pbos->{install} =~ /\byum\b/) {
728 $reponame="yum";
729 $dirdest = "/etc/yum.repos.d";
730 } elsif ($pbos->{install} =~ /\bdnf\b/) {
731 $reponame="dnf";
732 $dirdest = "/etc/yum.repos.d";
733 } elsif ($pbos->{install} =~ /\bzypper\b/) {
734 $reponame="zypper";
735 $dirdest = "/etc/zypp/repos.d";
736 } else {
737 cluck "Unknown location for repository file for '$pbos->{install}' command";
738 next;
739 }
740 my $dest = "$dirdest/$bn";
741 return(undef) if (pb_distro_compare_repo("$ENV{'PBTMP'}/$bn",$dest) == 1);
742 if (! -d $dirdest) {
743 cluck "Missing directory $dirdest ($reponame)";
744 return(undef);
745 }
746 pb_system("sudo mv $ENV{'PBTMP'}/$bn $dest","Adding $reponame repository") if (not -f "$dest");
747 # OpenSUSE does't seem to import keys automatically
748 # :-(
749 if ($pbos->{install} =~ /\bzypper\b/) {
750 my $keyfile = undef;
751 open(REPO,"$dest") || (cluck "Unable to open $dest" && next);
752 while (<REPO>) {
753 $keyfile = $_;
754 if ($keyfile =~ /^gpgkey=/) {
755 $keyfile =~ s/gpgkey=//;
756 last;
757 }
758 }
759 close(REPO);
760 if (defined $keyfile) {
761 pb_system("wget -O $ENV{'PBTMP'}/$bn $keyfile","Downloading GPG key file $keyfile");
762 pb_system("sudo rpm --import $ENV{'PBTMP'}/$bn","Importing GPG key file $keyfile");
763 unlink("$ENV{'PBTMP'}/$bn");
764 }
765 }
766 } elsif ($bn =~ /\.addmedia/) {
767 # URPMI repo
768 # We should test that it's not an already setup urpmi repo
769 open(URPMI,"/etc/urpmi/urpmi.cfg") || (cluck "Unable to open /etc/urpmi/urpmi.cfg" && next);
770 my $found = 0;
771 my $entry = $bn;
772 $entry =~ s/.addmedia$//;
773 while (<URPMI>) {
774 $found = 1 if ($_ =~ /^$entry /);
775 }
776 pb_system("chmod 755 $ENV{'PBTMP'}/$bn ; sudo $ENV{'PBTMP'}/$bn 2>&1 > /dev/null","Adding urpmi repository") if ($found == 0);
777 pb_log(0,"INFO urpmi $bn already set up\n") if ($found == 1);
778 } else {
779 pb_log(0,"ERROR: Unable to deal with repository file $i on rpm distro ! Please report to dev team\n");
780 }
781 } elsif ($pbos->{'type'} eq "deb") {
782 if ($bn =~ /\.sources.list$/) {
783 my $dest = "/etc/apt/sources.list.d/$bn";
784 return(undef) if (pb_distro_compare_repo("$ENV{'PBTMP'}/$bn",$dest) == 1);
785 pb_system("sudo mv $ENV{'PBTMP'}/$bn $dest","Adding apt repository $dest");
786 # Check whether GPG keys for this repo are already known and if
787 # not add them
788 open(REPO,"$dest") || (cluck "Unable to open $dest" && next);
789 my $debrepo;
790 while (<REPO>) {
791 if (/^deb\s/) {
792 $debrepo = $_;
793 chomp($debrepo);
794 $debrepo =~ s|^deb ([^\s]+)\s([^\s]+)\s([^\s]+)|$1/dists/$2|;
795 last;
796 }
797 }
798 close(REPO);
799 return(undef) if (not defined $debrepo);
800
801 pb_system("wget -O $ENV{'PBTMP'}/Release $debrepo/Release","Downloading $debrepo/Release");
802 pb_system("wget -O $ENV{'PBTMP'}/Release.gpg $debrepo/Release.gpg","Downloading $debrepo/Release.gpg");
803 my $signature = undef;
804 my ($pbgpgserver) = pb_conf_get("pbgpgserver");
805 confess "Unable to find a GPG server in configuration, please define pbgpgserver" if (not defined $pbgpgserver);
806 my $keyserver = $pbgpgserver->{$ENV{'PBPROJ'}};
807 $keyserver = $pbgpgserver->{'default'} if (not defined $keyserver);
808 confess "Unable to find a GPG server in configuration, please define correctly pbgpgserver" if (not defined $keyserver);
809 open(SIGN,"LANGUAGE=C LANG=C gpg --verify --keyid-format=long $ENV{'PBTMP'}/Release.gpg $ENV{'PBTMP'}/Release 2>&1 |") || (cluck "Unable to verify GPG signature from Release.gpg\n" && next);
810 while(<SIGN>) {
811 chomp();
812 if (/^gpg: .*key /) {
813 $signature = $_;
814 $signature =~ s/^gpg: .*key [ID ]*([A-Z0-9]+)/$1/;
815 pb_system("gpg --recv-keys --keyserver $keyserver $signature","Importing GPG signature for $signature");
816 last;
817 }
818 }
819 close(SIGN);
820 return(undef) if (not defined $signature);
821
822 pb_log(3, "GnuPG repo verify returned: $signature\n");
823 pb_system("gpg -a --export -o $ENV{'PBTMP'}/apt.sig \'$signature\'","Exporting GnuPG signature of $signature");
824 pb_system("sudo apt-key add $ENV{'PBTMP'}/apt.sig","Adding GnuPG signature of $signature to APT key ring");
825 pb_system("sudo apt-get update","Updating apt repository");
826 } else {
827 pb_log(0,"ERROR: Unable to deal with repository file $i on deb distro ! Please report to dev team\n");
828 }
829 } else {
830 pb_log(0,"ERROR: Unable to deal with repository file $i on that distro ! Please report to dev team\n");
831 }
832}
833return("forcerepo");
834}
835
836=item B<pb_distro_to_keylist>
837
838Given a pbos object (first param) and the generic key (second param), get the list of possible keys for looking up variable for
839filter names. The list will be sorted most-specific to least specific.
840
841=cut
842
843sub pb_distro_to_keylist ($$) {
844
845my ($pbos, $generic) = @_;
846
847foreach my $key (qw/name version arch family type os/) {
848 confess "missing pbos key $key" unless (defined $pbos->{$key});
849}
850
851my @keylist = ("$pbos->{'name'}-$pbos->{'version'}-$pbos->{'arch'}", "$pbos->{'name'}-$pbos->{'version'}");
852
853# Loop to include also previous minor versions
854# if configured so
855if ((defined $pbos->{'useminor'}) && ($pbos->{'useminor'} eq "true") && ($pbos->{'version'} =~ /^(\d+)\.(\d+)$/o)) {
856 my ($major, $minor) = ($1, $2);
857 while ($minor > 0) {
858 $minor--;
859 push (@keylist, "$pbos->{'name'}-${major}.$minor");
860 }
861 push (@keylist, "$pbos->{'name'}-$major");
862}
863
864push (@keylist, $pbos->{'name'}, $pbos->{'family'}, $pbos->{'type'}, $pbos->{'os'}, $generic);
865return @keylist;
866}
867
868=item B<pb_distro_get_param>
869
870This internal function gets the parameters in the conf file from the most precise tuple up to default
871
872=cut
873
874sub pb_distro_get_param {
875
876my $pbos = shift;
877my $var = shift;
878my @param = ();
879my $i = 0;
880pb_log(3,"var: ".Dumper($var));
881
882my @keylist = pb_distro_to_keylist($pbos,"default");
883pb_log(3,"keylist: ".Dumper(@keylist));
884
885my $p = $var->{"ptr"};
886foreach my $opt (@$p) {
887 pb_log(3,'opt: '.Dumper($opt));
888 my $param = undef;
889 my $fkey = undef;
890 foreach my $key (@keylist) {
891 pb_log(3,"key: $key\n");
892 if (defined $opt->{$key}) {
893 $param = $opt->{$key};
894 $fkey = $key;
895 last;
896 }
897 }
898 my $field = $var->{"val"};
899 pb_log(3,"field: ".Dumper($field));
900 $fkey = "default" if (not defined $fkey);
901 pb_log(3,"key: $fkey\n");
902 pb_log(2,"DEBUG: pb_distro_get_if on $pbos->{'name'}-$pbos->{'version'}-$pbos->{'arch'} for $field->[$i]".'{'.$fkey.'}'." returns ");
903 if (defined $param) {
904 # Allow replacement of variables inside the parameter such as name, version, arch for rpmbootstrap
905 # but not shell variable which are backslashed
906 if ($param =~ /[^\\]\$/) {
907 pb_log(3,"Expanding variable on $param\n");
908 eval { $param =~ s/(\$\w+->\{\'\w+\'\})/$1/eeg };
909 }
910 pb_log(2,"$param\n");
911 } else {
912 pb_log(2,"undefined\n");
913 }
914 push @param,$param;
915 $i++;
916}
917
918# Return one param if user only asked for one lookup, an array if not.
919my $nb = @param;
920pb_log(3,"Param".Dumper(@param)." has $nb members\n");
921if ($nb eq 1) {
922 pb_log(3,"Return param $param[0]\n") if (defined $param[0]);
923 return($param[0]);
924} else {
925 return(@param);
926}
927}
928
929
930=item B<pb_distro_get_if>
931
932This function gets the parameters in the conf file from the most precise tuple up to default
933
934=cut
935
936sub pb_distro_get_if {
937
938my $pbos = shift;
939my @ptr = pb_conf_get_if(@_);
940my $var;
941$var->{"ptr"} = \@ptr;
942$var->{"val"} = \@_;
943return(pb_distro_get_param($pbos,$var));
944}
945
946=item B<pb_distro_get>
947
948This function gets the parameters in the conf file from the most precise tuple up to default.
949Aborts of one param doesn't exist whereas it should
950
951=cut
952
953sub pb_distro_get {
954
955my $pbos = shift;
956my @param = @_;
957my @return = pb_distro_get_if($pbos,@param);
958
959foreach my $i (0..$#param) {
960 confess "No $param[$i] defined for $pbos->{'name'}-$pbos->{'version'}-$pbos->{'arch'}" if (not defined $return[$i]);
961}
962my $nb = @return;
963if ($nb eq 1) {
964 return($return[0]);
965} else {
966 return(@return);
967}
968}
969
970=item B<pb_distro_get_in_hash_if>
971
972This function gets the parameters in the conf file passed as hash from the most precise tuple up to default
973
974=cut
975
976sub pb_distro_get_in_hash_if {
977
978my $pbos = shift;
979my $lh = shift || return(());
980
981my @ptr = pb_conf_get_in_hash_if($lh,@_);
982my $var;
983$var->{"ptr"} = \@ptr;
984$var->{"val"} = \@_;
985return(pb_distro_get_param($pbos,$var));
986}
987
988=item B<pb_distro_get_in_conf_if>
989
990This function gets the parameters in the conf file passed as name from the most precise tuple up to default
991
992=cut
993
994sub pb_distro_get_in_conf_if {
995
996my $pbos = shift;
997my $conffile = shift;
998
999my @ptr = pb_conf_read($conffile,@_);
1000my $var;
1001$var->{"ptr"} = \@ptr;
1002$var->{"val"} = \@_;
1003return(pb_distro_get_param($pbos,$var));
1004}
1005
1006=item B<pb_distro_get_context>
1007
1008This function gets the OS context passed as parameter and return the corresponding distribution hash
1009If passed undef or "" then auto-detects
1010
1011=cut
1012
1013
1014sub pb_distro_get_context {
1015
1016my $os = shift;
1017my $pbos;
1018
1019if ((defined $os) && ($os ne "")) {
1020 my ($name,$ver,$darch) = split(/-/,$os);
1021 pb_log(0,"Bad format for $os") if ((not defined $name) || (not defined $ver) || (not defined $darch)) ;
1022 chomp($darch);
1023 $pbos = pb_distro_init($name,$ver,$darch);
1024} else {
1025 $pbos = pb_distro_init();
1026}
1027return($pbos);
1028}
1029
1030=item B<pb_distro_conf_print>
1031
1032This function prints every configuration parameter in order to help debug stacking issues with conf files. If a VM/VE/RM is given, restrict display to this distribution. If parameters are passed, restrict again the display to these values only.
1033
1034=cut
1035
1036sub pb_distro_conf_print {
1037
1038my $pbos = shift;
1039my @keys = @_;
1040my $all = 0;
1041
1042if ($#keys == -1) {
1043 pb_log(0,"Full pb configuration for project $ENV{'PBPROJ'}\n");
1044 pb_log(0,"================================================\n");
1045 @keys = pb_conf_get_all();
1046 $all = 1;
1047}
1048if (defined $ENV{'PBV'}) {
1049 pb_log(1,"Distribution $ENV{'PBV'}\n");
1050 pb_log(1,"========================\n");
1051} else {
1052 pb_log(1,"Local Distribution\n");
1053 pb_log(1,"==================\n");
1054}
1055
1056my %rep;
1057my $i = 0;
1058# Index on distro
1059foreach my $r (pb_distro_get($pbos,@keys)) {
1060 $rep{$keys[$i]} = $r if (defined $keys[$i]);
1061 $i++;
1062}
1063$i = 0;
1064# Then Index on prj to overwrite previous value if needed
1065foreach my $r (pb_conf_get(@keys)) {
1066 $rep{$keys[$i]} = $r->{'default'} if (defined $r->{'default'});
1067 $rep{$keys[$i]} = $r->{$ENV{'PBPROJ'}} if (defined $r->{$ENV{'PBPROJ'}});
1068 $i++;
1069}
1070foreach my $r (keys %rep) {
1071 pb_log(1, "$r => ");
1072 pb_log(0, "$rep{$r}\n") if ($all == 0);
1073 pb_log(0, "$r = $rep{$r}\n") if ($all == 1);
1074}
1075}
1076
1077
1078=back
1079
1080=head1 WEB SITES
1081
1082The 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/>.
1083
1084=head1 USER MAILING LIST
1085
1086None exists for the moment.
1087
1088=head1 AUTHORS
1089
1090The Project-Builder.org team L<http://trac.project-builder.org/> lead by Bruno Cornec L<mailto:bruno@project-builder.org>.
1091
1092=head1 COPYRIGHT
1093
1094Project-Builder.org is distributed under the GPL v2.0 license
1095described in the file C<COPYING> included with the distribution.
1096
1097=cut
1098
1099
11001;
Note: See TracBrowser for help on using the repository browser.