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

Last change on this file since 2426 was 2426, checked in by Bruno Cornec, 5 years ago

Start adding install and test target for pb - local install works already

File size: 30.9 KB
Line 
1#!/usr/bin/perl -w
2#
3# Creates common environment for distributions
4#
5# Copyright B. Cornec 2007-2016
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_getlsb pb_distro_installdeps pb_distro_getdeps pb_distro_only_deps_needed pb_distro_setuprepo pb_distro_setuposrepo pb_distro_setuprepo_gen pb_distro_get_param 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_get();
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_get() 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_param($pbos,pb_conf_get("osuseminorrel"));
177$pbos->{'family'} = pb_distro_get_param($pbos,pb_conf_get("osfamily"));
178$pbos->{'type'} = pb_distro_get_param($pbos,pb_conf_get("ostype"));
179($pbos->{'os'},$pbos->{'install'},$pbos->{'suffix'},$pbos->{'nover'},$pbos->{'rmdot'},$pbos->{'update'}) = pb_distro_get_param($pbos,pb_conf_get("os","osins","ossuffix","osnover","osremovedotinver","osupd"));
180($pbos->{'localinstall'}) = pb_distro_get_param($pbos,pb_conf_get_if("oslocalins"));
181#($pbos->{'family'},$pbos->{'type'},$pbos->{'os'},$pbos->{'install'},$pbos->{'suffix'},$pbos->{'nover'},$pbos->{'rmdot'},$pbos->{'update'}) = pb_distro_get_param($pbos,pb_conf_get("osfamily","ostype","os","osins","ossuffix","osnover","osremovedotinver","osupd"));
182
183# Some OS have no interesting version
184$pbos->{'version'} = "nover" if ((defined $pbos->{'nover'}) && ($pbos->{'nover'} eq "true"));
185
186# For some OS remove the . in version name for extension
187my $dver2 = $pbos->{'version'};
188$dver2 =~ s/\.//g if ((defined $pbos->{'rmdot'}) && ($pbos->{'rmdot'} eq "true"));
189
190if ((not defined $pbos->{'suffix'}) || ($pbos->{'suffix'} eq "")) {
191 # By default suffix is a concatenation of name and version
192 $pbos->{'suffix'} = ".$pbos->{'name'}$dver2"
193} else {
194 # concat just the version to what has been found
195 $pbos->{'suffix'} = ".$pbos->{'suffix'}$dver2";
196}
197
198# if ($arch eq "x86_64") {
199# $opt="--exclude=*.i?86";
200# }
201pb_log(2,"DEBUG: pb_distro_init: ".Dumper($pbos)."\n");
202
203return($pbos);
204}
205
206=item B<pb_distro_get>
207
208This 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.
209
210On my home machine it would currently report ("mandriva","2010.2").
211
212=cut
213
214sub pb_distro_get {
215
216# 1: List of files that unambiguously indicates what distro we have
217# 2: List of files that ambiguously indicates what distro we have
218# 3: Should have the same keys as the previous one. If ambiguity, which other distributions should be checked
219# 4: Matching Rg. Expr to detect distribution and version
220my ($single_rel_files, $ambiguous_rel_files,$distro_similar,$distro_match,$nover) = pb_conf_get("osrelfile","osrelambfile","osambiguous","osrelexpr","osnover");
221
222my $release;
223my $distro;
224
225# Begin to test presence of non-ambiguous files
226# that way we reduce the choice
227my ($d,$r);
228while (($d,$r) = each %$single_rel_files) {
229 if (defined $ambiguous_rel_files->{$d}) {
230 print STDERR "The key $d is considered as both unambiguous and ambiguous.\n";
231 confess "Please fix your configuration file.\n"
232 }
233 if (-f "$r" && ! -l "$r") {
234 my $tmp=pb_get_content("$r");
235 # Found the only possibility.
236 # Try to get version and return
237 if (defined ($distro_match->{$d})) {
238 ($release) = $tmp =~ m/$distro_match->{$d}/m;
239 } else {
240 if (not defined ($nover->{$d})) {
241 print STDERR "Unable to find $d version in $r (non-ambiguous)\n";
242 confess "Please report to the maintainer bruno_at_project-builder.org\n";
243 }
244 $release = "unknown";
245 }
246 return($d,$release);
247 }
248}
249
250# Now look at ambiguous files
251# Ubuntu before 10.04 includes a /etc/debian_version file that creates an ambiguity with debian
252# So we need to look at distros in reverse alphabetic order to treat ubuntu always first via lsb
253my $found = 0;
254foreach $d (reverse keys %$ambiguous_rel_files) {
255 $r = $ambiguous_rel_files->{$d};
256 if (-f "$r" && !-l "$r") {
257 # Found one possibility.
258 # Get all distros concerned by that file
259 my $tmp = pb_get_content("$r");
260 my $ptr = $distro_similar->{$d};
261 pb_log(2,"amb: ".Dumper($ptr)."\n");
262 $release = "unknown";
263 foreach my $dd (split(/,/,$ptr)) {
264 pb_log(2,"check $dd\n");
265 # Try to check pattern
266 if (defined $distro_match->{$dd}) {
267 pb_log(2,"cmp: $distro_match->{$dd} - vs - $tmp\n");
268 ($release) = $tmp =~ m/$distro_match->{$dd}/m;
269 if ((defined $release) && ($release ne "unknown")) {
270 $distro = $dd;
271 $found = 1;
272 last;
273 }
274 }
275 }
276 last if ($found == 1);
277 }
278}
279if ($found == 0) {
280 #
281 # Now look at the os-release file to see if we have a std distribution description
282 #
283 foreach my $r ("/usr/lib/os-release","/etc/os-release") {
284 if (-r $r) {
285 my $tmp = pb_get_content("$r");
286 ($release) = $tmp =~ m/.*\nVERSION_ID=[\"\']*([0-9a-z\._-]+)[\"\']*\n/m;
287 ($distro) = $tmp =~ m/.*\nID=[\"\']*([0-9A-z\._-]+)[\"\']*\n/m;
288 # Remove the leap suffix if present (OpenSUSE)
289 $distro =~ s/-leap//;
290 if ((defined $release) && (defined $distro)) {
291 $found = 1;
292 last;
293 }
294 }
295 }
296}
297if ($found == 0) {
298 print STDERR "Unable to find a version in ".join(' ',keys %$ambiguous_rel_files)." (ambiguous)\n";
299 confess "Please report to the maintainer bruno_at_project-builder.org\n";
300} else {
301 return($distro,$release);
302}
303}
304
305=item B<pb_distro_getlsb>
306
307This function returns the 5 lsb values LSB version, distribution ID, Description, release and codename.
308As entry it takes an optional parameter to specify whether the output is short or not.
309
310=cut
311
312sub pb_distro_getlsb {
313
314my $s = shift;
315pb_log(3,"Entering pb_distro_getlsb\n");
316
317my ($ambiguous_rel_files) = pb_conf_get("osrelambfile");
318my $lsbf = $ambiguous_rel_files->{"lsb"};
319
320# LSB has not been configured.
321if (not defined $lsbf) {
322 print STDERR "no lsb entry defined for osrelambfile\n";
323 confess "You modified upstream delivery and lost !\n";
324}
325
326if (-r $lsbf) {
327 my $rep = pb_get_content($lsbf);
328 # Create elementary fields
329 my ($c, $r, $d, $i, $l) = ("", "", "", "", "");
330 for my $f (split(/\n/,$rep)) {
331 pb_log(3,"Reading file part ***$f***\n");
332 $c = $f if ($f =~ /^DISTRIB_CODENAME/);
333 $c =~ s/DISTRIB_CODENAME=/Codename:\t/;
334 $r = $f if ($f =~ /^DISTRIB_RELEASE/);
335 $r =~ s/DISTRIB_RELEASE=/Release:\t/;
336 $d = $f if ($f =~ /^DISTRIB_DESCRIPTION/);
337 $d =~ s/DISTRIB_DESCRIPTION=/Description:\t/;
338 $d =~ s/"//g;
339 $i = $f if ($f =~ /^DISTRIB_ID/);
340 $i =~ s/DISTRIB_ID=/Distributor ID:\t/;
341 $l = $f if ($f =~ /^LSB_VERSION/);
342 $l =~ s/LSB_VERSION=/LSB Version:\t/;
343 }
344 my $regexp = "^[A-z ]*:[\t ]*";
345 $c =~ s/$regexp// if (defined $s);
346 $r =~ s/$regexp// if (defined $s);
347 $d =~ s/$regexp// if (defined $s);
348 $i =~ s/$regexp// if (defined $s);
349 $l =~ s/$regexp// if (defined $s);
350 return($l, $i, $d, $r, $c);
351} else {
352 print STDERR "Unable to read $lsbf file\n";
353 confess "Please report to the maintainer bruno_at_project-builder.org\n";
354}
355}
356
357# Internal function
358
359sub pb_apply_conf_proxy {
360my ($pbos) = @_;
361
362my $ftp_proxy = pb_distro_get_param($pbos,pb_conf_get_if("ftp_proxy"));
363my $http_proxy = pb_distro_get_param($pbos,pb_conf_get_if("http_proxy"));
364my $https_proxy = pb_distro_get_param($pbos,pb_conf_get_if("https_proxy"));
365
366# We do not overwrite shell settings
367$ENV{'ftp_proxy'} ||= $ftp_proxy if ((defined $ftp_proxy) && ($ftp_proxy ne ""));
368$ENV{'http_proxy'} ||= $http_proxy if ((defined $http_proxy) && ($http_proxy ne ""));
369$ENV{'https_proxy'} ||= $https_proxy if ((defined $https_proxy) && ($https_proxy ne ""));
370}
371
372=item B<pb_distro_installdeps>
373
374This function install the dependencies required to build the package on a distro.
375If $forcerepo is defined then do not assume packages are alredy installed, but reinstall them
376(useful if you add a repo which contains more up to date packages that you need)
377Dependencies can be passed as the 4th parameter in which case they are not computed
378
379=cut
380
381sub pb_distro_installdeps {
382
383# SPEC file
384my $f = shift;
385my $pbos = shift;
386my $forcerepo = shift;
387my $deps = shift; # optional list of deps to install
388my $local = shift; # optional should we install local packages or remote (for deb command is different)
389
390# Protection
391confess "Missing install command for $pbos->{name}-$pbos->{version}-$pbos->{arch}" unless (defined $pbos->{install} && $pbos->{install} =~ /\w/);
392pb_apply_conf_proxy($pbos);
393pb_log(1, "ftp_proxy=$ENV{'ftp_proxy'}\n") if (defined $ENV{'ftp_proxy'});
394pb_log(1, "http_proxy=$ENV{'http_proxy'}\n") if (defined $ENV{'http_proxy'});
395pb_log(1, "https_proxy=$ENV{'https_proxy'}\n") if (defined $ENV{'https_proxy'});
396
397# Get dependencies in the build file if not forced
398$deps = pb_distro_getdeps($f,$pbos, $forcerepo) if ((not defined $deps) || (defined $forcerepo));
399pb_log(2,"deps: $deps\n");
400return if ((not defined $deps) || ($deps =~ /^\s*$/));
401
402# This may not be // proof. We should test for availability of repo and sleep if not
403my $cmd = "$pbos->{'install'} $deps";
404$cmd = "$pbos->{'localinstall'} $deps" if ((defined $local) && (defined $pbos->{'localinstall'}) && ($pbos->{'localinstall'} !~ /[ ]*/));
405my $ret = pb_system($cmd, "Installing dependencies ($cmd)","mayfail");
406# Try to accomodate deficient proxies
407if ($ret != 0) {
408 pb_system($cmd, "Re-trying installing dependencies ($cmd)");
409}
410# Check that all deps have been installed correctly
411# This time we don't forcerepo to avoid getting a list as a return as we have
412# already forced it previously, and this time we just want to check
413$deps = pb_distro_getdeps($f, $pbos, undef);
414confess "Some dependencies did not install ($deps)" if ((defined $deps) && ($deps =~ /\S/) && ($Global::pb_stop_on_error));
415}
416
417=item B<pb_distro_getdeps>
418
419This function computes the dependencies indicated in the build file and return them as a string of packages to install
420
421=cut
422
423sub pb_distro_getdeps {
424
425my $f = shift;
426my $pbos = shift;
427my $forcerepo = shift;
428
429my $regexp = "";
430my $deps = "";
431my $sep = $/;
432
433# Protection
434return("") if (not defined $pbos->{'type'});
435return("") if (not defined $f);
436
437pb_log(3,"entering pb_distro_getdeps: $pbos->{'type'} - $f\n");
438if ($pbos->{'type'} eq "rpm") {
439 # In RPM this could include files, but we do not handle them atm.
440 $regexp = '^BuildRequires:(.*)$';
441} elsif ($pbos->{'type'} eq "deb") {
442 $regexp = '^Build-Depends:(.*)$';
443} elsif ($pbos->{'type'} eq "apk") {
444 $regexp = '^makedepends=(.*)$';
445} elsif ($pbos->{'type'} eq "ebuild") {
446 $sep = '"'.$/;
447 $regexp = '^DEPEND="(.*)"\n';
448} else {
449 # No idea
450 return("");
451}
452pb_log(2,"regexp: $regexp\n");
453
454# Preserve separator before using the one we need
455my $oldsep = $/;
456$/ = $sep;
457open(DESC,"$f") || cluck "Unable to open $f" && return("");
458while (<DESC>) {
459 pb_log(4,"read: $_\n");
460 next if (! /$regexp/);
461 chomp();
462
463 my $nextline;
464 # Support multi-lines deps for .deb
465 if ($pbos->{type} eq 'deb') {
466 while ($nextline = <DESC>) {
467 last unless $nextline =~ /^\s+(.+)$/o;
468 $_ .= $1;
469 }
470 }
471
472 # What we found with the regexp is the list of deps.
473 pb_log(2,"found deps: $_\n");
474 s/$regexp/$1/i;
475 pb_log(4,"found deps 1: $_\n");
476 # Remove conditions in the middle and at the end for deb
477 s/\([><=]+[^,]*,/,/g;
478 pb_log(4,"found deps 2: $_\n");
479 s/\([><=]+[^,]*$//g;
480 pb_log(4,"found deps 3: $_\n");
481 # Same for rpm
482 s/[><=]+[^,]*,/,/g;
483 pb_log(4,"found deps 4: $_\n");
484 s/[><=]+.*$//g;
485 pb_log(4,"found deps 5: $_\n");
486 # Improve string format (remove , and spaces at start, end and in double
487 s/,/ /g;
488 pb_log(4,"found deps 6: $_\n");
489 s/^\s*//;
490 pb_log(4,"found deps 7: $_\n");
491 # $ here removes the \n
492 s/\s*$//;
493 pb_log(4,"found deps 8: $_\n");
494 s/\s+/ /g;
495 pb_log(4,"found deps 9: $_\n");
496 $deps .= " ".$_;
497 pb_log(4,"found deps end: $deps\n");
498
499 # Support multi-lines deps for .deb (fwup)
500 if (defined $nextline) {
501 $_ = $nextline;
502 redo;
503 }
504}
505close(DESC);
506$/ = $oldsep;
507pb_log(2,"now deps: $deps\n");
508if (defined $forcerepo) {
509 # We want to force installation of all pkgs
510 # because a repo was setup in between, which may contains updated versions
511 pb_log(0,"Forcing installation of all packages due to previous repo setup\n");
512 return($deps);
513} else {
514 pb_log(0,"Installation of only necessary packages\n");
515 my $deps2 = pb_distro_only_deps_needed($pbos,$deps);
516 return($deps2);
517}
518}
519
520
521=item B<pb_distro_only_deps_needed>
522
523This function returns only the dependencies not yet installed
524
525=cut
526
527sub pb_distro_only_deps_needed {
528
529my $pbos = shift;
530my $deps = shift;
531
532return("") if ((not defined $deps) || ($deps =~ /^\s*$/));
533my $deps2 = "";
534# Avoid to install what is already there
535delete $ENV{'COLUMNS'};
536foreach my $p (split(/\s+/,$deps)) {
537 next if $p =~ /^\s*$/o;
538 if ($pbos->{'type'} eq "rpm") {
539 my $rpmcmd = "rpm -q --whatprovides --quiet";
540 # whatprovides doesn't work for RH6.2
541 $rpmcmd = "rpm -q --quiet" if (($pbos->{'name'} eq "redhat") && ($pbos->{'version'} =~ /6/));
542 my $res = pb_system("$rpmcmd $p","Looking for $p","mayfail");
543 next if ($res eq 0);
544 pb_log(1, "INFO: missing dependency $p\n");
545 } elsif ($pbos->{'type'} eq "deb") {
546 my $res = pb_system("dpkg -L $p","Looking for $p","mayfail");
547 next if ($res eq 0);
548 open(CMD,"dpkg -l $p |") || cluck "Unable to run dpkg -l $p: $!" && next;
549 my $ok = 0;
550 while (<CMD>) {
551 $ok = 1 if /^ii\s+$p/;
552 }
553 close(CMD);
554 next if $ok;
555 pb_log(1, "INFO: missing dependency $p\n");
556 } elsif ($pbos->{'type'} eq "ebuild") {
557 } elsif ($pbos->{'type'} eq "apk") {
558 my $res = pb_system("apk -e info $p","Looking for $p","mayfail");
559 next if ($res eq 0);
560 pb_log(1, "INFO: missing dependency $p\n");
561 } else {
562 # Not reached
563 }
564 pb_log(2,"found deps2: $p\n");
565 $deps2 .= " $p";
566}
567
568$deps2 =~ s/^\s*//;
569pb_log(2,"now deps2: $deps2\n");
570return($deps2);
571}
572
573# Internal
574sub pb_distro_compare_repo {
575
576my $src = shift;
577my $dest = shift;
578
579if (not -f $dest) {
580 pb_log(1, "INFO: Creating new file $dest\n");
581} elsif (-f $dest && -s $dest == 0) {
582 pb_log(1, "INFO: Overwriting empty file $dest\n");
583} elsif (-f $dest && compare("$src", $dest) == 0) {
584 pb_log(1, "INFO: Overwriting identical file $dest\n");
585} else {
586 pb_log(0, "ERROR: destination file $dest exists and is different than source $src\n");
587 pb_system("cat $dest","INFO: Dest...\n","verbose");
588 pb_system("cat $src","INFO: New...\n","verbose");
589 pb_log(1, "INFO: Returning...\n");
590 return(1);
591}
592return(0);
593}
594
595
596=item B<pb_distro_setuposrepo>
597
598This function sets up potential additional repository for the setup phase
599
600=cut
601
602sub pb_distro_setuposrepo {
603
604my $pbos = shift;
605
606pb_log(3, "INFO: Adding osrepo from config file\n");
607my %h;
608my $h = \%h;
609# 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
610$h = pb_conf_cache(pb_distro_conffile(),$h);
611my ($osrepo) = pb_conf_get_in_hash_if($h,"osrepo");
612return(pb_distro_setuprepo_gen($pbos,$osrepo->{$ENV{'PBPROJ'}}));
613}
614
615=item B<pb_distro_setuprepo>
616
617This function sets up potential additional repository to the build/install/test environment
618
619=cut
620
621sub pb_distro_setuprepo {
622
623my $pbos = shift;
624my $repotype = shift;
625
626my %h;
627my $h = \%h;
628# 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
629$h = pb_conf_cache("$ENV{'PBROOTDIR'}/$ENV{'PBPROJ'}.yml",$h) if ((defined $ENV{'PBROOTDIR'}) && (-f "$ENV{'PBROOTDIR'}/$ENV{'PBPROJ'}.yml"));
630$h = pb_conf_cache("$ENV{'PBDESTDIR'}/pbrc.yml",$h) if ((defined $ENV{'PBDESTDIR'}) && (-f "$ENV{'PBDESTDIR'}/pbrc.yml"));
631
632pb_log(3, "INFO: Adding addrepo from config file for $repotype\n");
633if ($repotype =~ /install/) {
634 # Give a probable default if nothing is provided to avoid overloading conf files
635 #
636 my ($addrepo) = pb_conf_get_in_hash_if($h,"addinstallrepo");
637 if ((not defined $addrepo) || (not defined $addrepo->{$ENV{'PBPROJ'}})) {
638 my ($pbrepo) = pb_conf_get_in_hash_if($h,"pbrepo");
639 return undef if (not defined $pbrepo);
640 my $url = "$pbrepo->{$ENV{'PBPROJ'}}";
641 my ($testver,$delivery) = pb_conf_get_in_hash_if($h,"testver","delivery");
642 $delivery->{$ENV{'PBPROJ'}} = "" if (not defined $delivery->{$ENV{'PBPROJ'}});
643 $url .= "/$delivery->{$ENV{'PBPROJ'}}/";
644 my $repotag = "";
645 $repotag = "-$delivery->{$ENV{'PBPROJ'}}" if ($delivery->{$ENV{'PBPROJ'}} ne "");
646 $url .= "/$pbos->{'name'}/$pbos->{'version'}/$pbos->{'arch'}/$ENV{PBPROJ}$repotag.";
647 my $ext = "";
648 if ($pbos->{'type'} eq "rpm") {
649 $ext = "repo";
650 if ($pbos->{'family'} eq "md") {
651 $ext = "addmedia";
652 }
653 } elsif ($pbos->{'type'} eq "deb") {
654 $ext = ".sources.list";
655 }
656 $url .= $ext;
657 return(pb_distro_setuprepo_gen($pbos,$url));
658 } else {
659 my ($addrepo) = pb_conf_get_in_hash_if($h,"addinstallrepo");
660 return(pb_distro_setuprepo_gen($pbos,$addrepo->{$ENV{'PBPROJ'}}));
661 }
662} else {
663 my ($addrepo) = pb_conf_get_in_hash_if($h,"add".$repotype."repo");
664 return(pb_distro_setuprepo_gen($pbos,$addrepo->{$ENV{'PBPROJ'}}));
665}
666}
667
668=item B<pb_distro_setuprepo_gen>
669
670This function sets up in a generic way potential additional repository passed as a param
671
672=cut
673
674sub pb_distro_setuprepo_gen {
675
676my $pbos = shift;
677my $param = shift;
678
679return if (not defined $param);
680
681pb_apply_conf_proxy($pbos);
682
683# Loop on the list of additional repo
684foreach my $i (split(/,/,$param)) {
685
686 pb_log(1,"Adding repository defined by $i\n");
687 my ($scheme, $account, $host, $port, $path) = pb_get_uri($i);
688 my $bn = basename($i);
689
690 # The repo file can be local or remote. download or copy at the right place
691 if (($scheme eq "ftp") || ($scheme =~ /http/)) {
692 pb_system("wget -O $ENV{'PBTMP'}/$bn $i","Downloading additional repository file $i");
693 } else {
694 copy($i,"$ENV{'PBTMP'}/$bn");
695 }
696
697 # The repo file can be a real file or a package
698 if ($pbos->{'type'} eq "rpm") {
699 if ($bn =~ /\.rpm$/) {
700 my $pn = $bn;
701 $pn =~ s/\.rpm//;
702 if (pb_system("rpm -q --quiet $pn","","mayfail") != 0) {
703 pb_system("sudo rpm -Uvh $ENV{'PBTMP'}/$bn","Adding package $bn to setup repository");
704 }
705 } elsif ($bn =~ /\.repo$/) {
706 my $dirdest = "";
707 my $reponame = "";
708 # TODO: could go in pb.yml in fact
709 if ($pbos->{install} =~ /\byum\b/) {
710 $reponame="yum";
711 $dirdest = "/etc/yum.repos.d";
712 } elsif ($pbos->{install} =~ /\bdnf\b/) {
713 $reponame="dnf";
714 $dirdest = "/etc/yum.repos.d";
715 } elsif ($pbos->{install} =~ /\bzypper\b/) {
716 $reponame="zypper";
717 $dirdest = "/etc/zypp/repos.d";
718 } else {
719 cluck "Unknown location for repository file for '$pbos->{install}' command";
720 next;
721 }
722 my $dest = "$dirdest/$bn";
723 return undef if (pb_distro_compare_repo("$ENV{'PBTMP'}/$bn",$dest) == 1);
724 if (! -d $dirdest) {
725 cluck "Missing directory $dirdest ($reponame)";
726 return undef;
727 }
728 pb_system("sudo mv $ENV{'PBTMP'}/$bn $dest","Adding $reponame repository") if (not -f "$dest");
729 # OpenSUSE does't seem to import keys automatically
730 # :-(
731 if ($pbos->{install} =~ /\bzypper\b/) {
732 my $keyfile = undef;
733 open(REPO,"$dest") || cluck "Unable to open $dest" && next;
734 while (<REPO>) {
735 $keyfile = $_;
736 if ($keyfile =~ /^gpgkey=/) {
737 $keyfile =~ s/gpgkey=//;
738 last;
739 }
740 }
741 close(REPO);
742 if (defined $keyfile) {
743 pb_system("wget -O $ENV{'PBTMP'}/$bn $keyfile","Downloading GPG key file $keyfile");
744 pb_system("sudo rpm --import $ENV{'PBTMP'}/$bn","Importing GPG key file $keyfile");
745 unlink("$ENV{'PBTMP'}/$bn");
746 }
747 }
748 } elsif ($bn =~ /\.addmedia/) {
749 # URPMI repo
750 # We should test that it's not already a urpmi repo
751 pb_system("chmod 755 $ENV{'PBTMP'}/$bn ; sudo $ENV{'PBTMP'}/$bn 2>&1 > /dev/null","Adding urpmi repository");
752 } else {
753 pb_log(0,"ERROR: Unable to deal with repository file $i on rpm distro ! Please report to dev team\n");
754 }
755 } elsif ($pbos->{'type'} eq "deb") {
756 if ($bn =~ /\.sources.list$/) {
757 my $dest = "/etc/apt/sources.list.d/$bn";
758 return if (pb_distro_compare_repo("$ENV{'PBTMP'}/$bn",$dest) == 1);
759 pb_system("sudo mv $ENV{'PBTMP'}/$bn $dest","Adding apt repository $dest");
760 # Check whether GPG keys for this repo are already known and if
761 # not add them
762 open(REPO,"$dest") || cluck "Unable to open $dest" && next;
763 my $debrepo;
764 while (<REPO>) {
765 if (/^deb\s/) {
766 $debrepo = $_;
767 chomp($debrepo);
768 $debrepo =~ s|^deb ([^\s]+)\s([^\s]+)\s([^\s]+)|$1/dists/$2|;
769 last;
770 }
771 }
772 close(REPO);
773 return if (not defined $debrepo);
774
775 pb_system("wget -O $ENV{'PBTMP'}/Release $debrepo/Release","Downloading $debrepo/Release");
776 pb_system("wget -O $ENV{'PBTMP'}/Release.gpg $debrepo/Release.gpg","Downloading $debrepo/Release.gpg");
777 my $signature = undef;
778 my ($pbgpgserver) = pb_conf_get("pbgpgserver");
779 confess "Unable to find a GPG server in configuration, please define pbgpgserver" if (not defined $pbgpgserver);
780 my $keyserver = $pbgpgserver->{$ENV{'PBPROJ'}};
781 $keyserver = $pbgpgserver->{'default'} if (not defined $keyserver);
782 confess "Unable to find a GPG server in configuration, please define correctly pbgpgserver" if (not defined $keyserver);
783 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;
784 while(<SIGN>) {
785 chomp();
786 if (/^gpg: .*key /) {
787 $signature = $_;
788 $signature =~ s/^gpg: .*key [ID ]*([A-Z0-9]+)/$1/;
789 pb_system("gpg --recv-keys --keyserver $keyserver $signature","Importing GPG signature for $signature");
790 last;
791 }
792 }
793 close(SIGN);
794 return if (not defined $signature);
795
796 pb_log(3, "GnuPG repo verify returned: $signature\n");
797 pb_system("gpg -a --export -o $ENV{'PBTMP'}/apt.sig \'$signature\'","Exporting GnuPG signature of $signature");
798 pb_system("sudo apt-key add $ENV{'PBTMP'}/apt.sig","Adding GnuPG signature of $signature to APT key ring");
799 pb_system("sudo apt-get update","Updating apt repository");
800 } else {
801 pb_log(0,"ERROR: Unable to deal with repository file $i on deb distro ! Please report to dev team\n");
802 }
803 } else {
804 pb_log(0,"ERROR: Unable to deal with repository file $i on that distro ! Please report to dev team\n");
805 }
806}
807return("forcerepo");
808}
809
810=item B<pb_distro_to_keylist>
811
812Given a pbos object (first param) and the generic key (second param), get the list of possible keys for looking up variable for
813filter names. The list will be sorted most-specific to least specific.
814
815=cut
816
817sub pb_distro_to_keylist ($$) {
818
819my ($pbos, $generic) = @_;
820
821foreach my $key (qw/name version arch family type os/) {
822 confess "missing pbos key $key" unless (defined $pbos->{$key});
823}
824
825my @keylist = ("$pbos->{'name'}-$pbos->{'version'}-$pbos->{'arch'}", "$pbos->{'name'}-$pbos->{'version'}");
826
827# Loop to include also previous minor versions
828# if configured so
829if ((defined $pbos->{'useminor'}) && ($pbos->{'useminor'} eq "true") && ($pbos->{'version'} =~ /^(\d+)\.(\d+)$/o)) {
830 my ($major, $minor) = ($1, $2);
831 while ($minor > 0) {
832 $minor--;
833 push (@keylist, "$pbos->{'name'}-${major}.$minor");
834 }
835 push (@keylist, "$pbos->{'name'}-$major");
836}
837
838push (@keylist, $pbos->{'name'}, $pbos->{'family'}, $pbos->{'type'}, $pbos->{'os'}, $generic);
839return @keylist;
840}
841
842=item B<pb_distro_get_param>
843
844This function gets the parameter in the conf file from the most precise tuple up to default
845
846=cut
847
848sub pb_distro_get_param {
849
850my @param = ();
851my $pbos = shift;
852
853my @keylist = pb_distro_to_keylist($pbos,"default");
854pb_log(2,"DEBUG: pb_distro_get_param on $pbos->{'name'}-$pbos->{'version'}-$pbos->{'arch'} for ".Dumper(@_)."\n");
855foreach my $opt (@_) {
856 my $param = "";
857 foreach my $key (@keylist) {
858 if (defined $opt->{$key}) {
859 $param = $opt->{$key};
860 last;
861 }
862 }
863 # Allow replacement of variables inside the parameter such as name, version, arch for rpmbootstrap
864 # but not shell variable which are backslashed
865 if ($param =~ /[^\\]\$/) {
866 pb_log(3,"Expanding variable on $param\n");
867 eval { $param =~ s/(\$\w+->\{\'\w+\'\})/$1/eeg };
868 }
869 push @param,$param;
870}
871
872pb_log(2,"DEBUG: pb_distro_get_param on $pbos->{'name'}-$pbos->{'version'}-$pbos->{'arch'} returns ==".Dumper(@param)."==\n");
873
874# Return one param if user only asked for one lookup, an array if not.
875my $nb = @param;
876if ($nb eq 1) {
877 return($param[0]);
878} else {
879 return(@param);
880}
881}
882
883=item B<pb_distro_get_context>
884
885This function gets the OS context passed as parameter and return the corresponding distribution hash
886If passed undef or "" then auto-detects
887
888=cut
889
890
891sub pb_distro_get_context {
892
893my $os = shift;
894my $pbos;
895
896if ((defined $os) && ($os ne "")) {
897 my ($name,$ver,$darch) = split(/-/,$os);
898 pb_log(0,"Bad format for $os") if ((not defined $name) || (not defined $ver) || (not defined $darch)) ;
899 chomp($darch);
900 $pbos = pb_distro_init($name,$ver,$darch);
901} else {
902 $pbos = pb_distro_init();
903}
904return($pbos);
905}
906
907=item B<pb_distro_conf_print>
908
909This 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.
910
911=cut
912
913sub pb_distro_conf_print {
914
915my $pbos = shift;
916my @keys = @_;
917my $all = 0;
918
919if ($#keys == -1) {
920 pb_log(0,"Full pb configuration for project $ENV{'PBPROJ'}\n");
921 pb_log(0,"================================================\n");
922 @keys = pb_conf_get_all();
923 $all = 1;
924}
925if (defined $ENV{'PBV'}) {
926 pb_log(1,"Distribution $ENV{'PBV'}\n");
927 pb_log(1,"========================\n");
928} else {
929 pb_log(1,"Local Distribution\n");
930 pb_log(1,"==================\n");
931}
932
933my %rep;
934my $i = 0;
935# Index on distro
936foreach my $r (pb_distro_get_param($pbos,pb_conf_get(@keys))) {
937 $rep{$keys[$i]} = $r if (defined $keys[$i]);
938 $i++;
939}
940$i = 0;
941# Then Index on prj to overwrite previous value if needed
942foreach my $r (pb_conf_get(@keys)) {
943 $rep{$keys[$i]} = $r->{'default'} if (defined $r->{'default'});
944 $rep{$keys[$i]} = $r->{$ENV{'PBPROJ'}} if (defined $r->{$ENV{'PBPROJ'}});
945 $i++;
946}
947foreach my $r (keys %rep) {
948 pb_log(1, "$r => ");
949 pb_log(0, "$rep{$r}\n") if ($all == 0);
950 pb_log(0, "$r = $rep{$r}\n") if ($all == 1);
951}
952}
953
954
955=back
956
957=head1 WEB SITES
958
959The 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/>.
960
961=head1 USER MAILING LIST
962
963None exists for the moment.
964
965=head1 AUTHORS
966
967The Project-Builder.org team L<http://trac.project-builder.org/> lead by Bruno Cornec L<mailto:bruno@project-builder.org>.
968
969=head1 COPYRIGHT
970
971Project-Builder.org is distributed under the GPL v2.0 license
972described in the file C<COPYING> included with the distribution.
973
974=cut
975
976
9771;
Note: See TracBrowser for help on using the repository browser.