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

Last change on this file since 899 was 899, checked in by Bruno Cornec, 11 years ago

r3617@localhost: bruno | 2009-11-15 13:33:01 +0100
Improve case where the build file description if undef (seen in cms2vm)

File size: 13.5 KB
Line 
1#!/usr/bin/perl -w
2#
3# Creates common environment for distributions
4#
5# $Id$
6#
7
8package ProjectBuilder::Distribution;
9
10use strict;
11use Data::Dumper;
12use ProjectBuilder::Base;
13use ProjectBuilder::Conf;
14use File::Basename;
15use File::Copy;
16
17# Inherit from the "Exporter" module which handles exporting functions.
18 
19use Exporter;
20 
21# Export, by default, all the functions into the namespace of
22# any code which uses this module.
23 
24our @ISA = qw(Exporter);
25our @EXPORT = qw(pb_distro_conffile pb_distro_init pb_distro_get pb_distro_installdeps pb_distro_getdeps pb_distro_only_deps_needed pb_distro_setuprepo pb_distro_get_param);
26
27=pod
28
29=head1 NAME
30
31ProjectBuilder::Distribution, part of the project-builder.org - module dealing with distribution detection
32
33=head1 DESCRIPTION
34
35This modules provides functions to allow detection of Linux distributions, and giving back some attributes concerning them.
36
37=head1 SYNOPSIS
38
39  use ProjectBuilder::Distribution;
40
41  #
42  # Return information on the running distro
43  #
44  my ($ddir, $dver, $dfam, $dtype, $pbsuf, $pbupd, $arch) = pb_distro_init();
45  print "distro tuple: ".Dumper($ddir, $dver, $dfam, $dtype, $pbsuf, $pbupd, $arch)."\n";
46  #
47  # Return information on the requested distro
48  #
49  my ($ddir, $dver, $dfam, $dtype, $pbsuf, $pbupd, $arch) = pb_distro_init("ubuntu","7.10","x86_64");
50  print "distro tuple: ".Dumper($ddir, $dver, $dfam, $dtype, $pbsuf, $pbupd, $arch)."\n";
51  #
52  # Return information on the running distro
53  #
54  my ($ddir,$dver) = pb_distro_get();
55  my ($ddir, $dver, $dfam, $dtype, $pbsuf, $pbupd, $arch) = pb_distro_init($ddir,$dver);
56  print "distro tuple: ".Dumper($ddir, $dver, $dfam, $dtype, $pbsuf, $pbupd, $arch)."\n";
57
58=head1 USAGE
59
60=over 4
61
62=item B<pb_distro_conffile>
63
64This function returns the mandatory configuration file used for distribution/OS detection
65
66=cut
67
68sub pb_distro_conffile {
69
70return("CCCC/pb.conf");
71}
72
73
74=over 4
75
76=item B<pb_distro_init>
77
78This function returns a list of 7 parameters indicating the distribution name, version, family, type of build system, suffix of packages, update command line and architecture of the underlying Linux distribution. The value of the 7 fields may be "unknown" in case the function was unable to recognize on which distribution it is running.
79
80As an example, Ubuntu and Debian are in the same "du" family. As well as RedHat, RHEL, CentOS, fedora are on the same "rh" family.
81Mandriva, Open SuSE and Fedora have all the same "rpm" type of build system. Ubuntu ad Debian have the same "deb" type of build system.
82And "fc" is the extension generated for all Fedora packages (Version will be added by pb).
83All these information are stored in an external configuration file typically at /etc/pb/pb.conf
84
85When 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.
86
87Cf: http://linuxmafia.com/faq/Admin/release-files.html
88Ideas taken from http://search.cpan.org/~kerberus/Linux-Distribution-0.14/lib/Linux/Distribution.pm
89
90=cut
91
92
93sub pb_distro_init {
94
95my $ddir = shift || undef;
96my $dver = shift || undef;
97my $dfam = "unknown";
98my $dtype = "unknown";
99my $dsuf = "unknown";
100my $dupd = "unknown";
101my $darch = shift || undef;
102my $dnover = "false";
103my $drmdot = "false";
104
105# Adds conf file for distribution description
106# the location of the conf file is finalyzed at install time
107# depending whether we deal with package install or tar file install
108pb_conf_add(pb_distro_conffile());
109
110# If we don't know which distribution we're on, then guess it
111($ddir,$dver) = pb_distro_get() if ((not defined $ddir) || (not defined $dver));
112
113# Initialize arch
114$darch=pb_get_arch() if (not defined $darch);
115
116my ($osfamily,$ostype,$osupd,$ossuffix,$osnover,$osremovedotinver) = pb_conf_get("osfamily","ostype","osupd","ossuffix","osnover","osremovedotinver");
117
118$dfam = pb_distro_get_param($ddir,$dver,$darch,$osfamily);
119$dtype = $ostype->{$dfam} if (defined $ostype->{$dfam});
120$dupd = pb_distro_get_param($ddir,$dver,$darch,$osupd,$dfam,$dtype);
121$dsuf = pb_distro_get_param($ddir,$dver,$darch,$ossuffix,$dfam,$dtype);
122$dnover = pb_distro_get_param($ddir,$dver,$darch,$osnover,$dfam,$dtype);
123$drmdot = pb_distro_get_param($ddir,$dver,$darch,$osremovedotinver,$dfam,$dtype);
124
125# Some OS have no interesting version
126$dver = "nover" if ($dnover eq "true");
127
128# For some OS remove the . in version name
129$dver =~ s/\.// if ($drmdot eq "true");
130
131if ((not defined $dsuf) || ($dsuf eq "unknown")) {
132    # By default suffix is a concatenation of .ddir and dver
133    $dsuf = ".$ddir$dver" 
134} else {
135    # concat just the version to what has been found
136    $dsuf = ".$dsuf$dver";
137}
138
139#   if ($arch eq "x86_64") {
140#   $opt="--exclude=*.i?86";
141#   }
142
143return($ddir, $dver, $dfam, $dtype, $dsuf, $dupd, $darch);
144}
145
146=item B<pb_distro_get>
147
148This 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.
149
150On my home machine it would currently report ("mandriva","2009.0").
151
152=cut
153
154sub pb_distro_get {
155
156# 1: List of files that unambiguously indicates what distro we have
157# 2: List of files that ambiguously indicates what distro we have
158# 3: Should have the same keys as the previous one. If ambiguity, which other distributions should be checked
159# 4: Matching Rg. Expr to detect distribution and version
160my ($single_rel_files, $ambiguous_rel_files,$distro_similar,$distro_match) = pb_conf_get("osrelfile","osrelambfile","osambiguous","osrelexpr");
161
162my $release;
163my $distro;
164
165# Begin to test presence of non-ambiguous files
166# that way we reduce the choice
167my ($d,$r);
168while (($d,$r) = each %$single_rel_files) {
169    if (-f "$r" && ! -l "$r") {
170        my $tmp=pb_get_content("$r");
171        # Found the only possibility.
172        # Try to get version and return
173        if (defined ($distro_match->{$d})) {
174            ($release) = $tmp =~ m/$distro_match->{$d}/m;
175        } else {
176            print STDERR "Unable to find $d version in $r\n";
177            print STDERR "Please report to the maintainer bruno_at_project-builder.org\n";
178            $release = "unknown";
179        }
180        return($d,$release);
181    }
182}
183
184# Now look at ambiguous files
185# Ubuntu includes a /etc/debian_version file that creates an ambiguity with debian
186# So we need to look at distros in reverse alphabetic order to treat ubuntu always first via lsb
187foreach $d (reverse keys %$ambiguous_rel_files) {
188    $r = $ambiguous_rel_files->{$d};
189    if (-f "$r" && !-l "$r") {
190        # Found one possibility.
191        # Get all distros concerned by that file
192        my $tmp=pb_get_content("$r");
193        my $found = 0;
194        my $ptr = $distro_similar->{$d};
195        pb_log(2,"amb: ".Dumper($ptr)."\n");
196        $release = "unknown";
197        foreach my $dd (split(/,/,$ptr)) {
198            pb_log(2,"check $dd\n");
199            # Try to check pattern
200            if (defined $distro_match->{$dd}) {
201                pb_log(2,"cmp: $distro_match->{$dd} - vs - $tmp\n");
202                ($release) = $tmp =~ m/$distro_match->{$dd}/m;
203                if ((defined $release) && ($release ne "unknown")) {
204                    $distro = $dd;
205                    $found = 1;
206                    last;
207                }
208            }
209        }
210        if ($found == 0) {
211            print STDERR "Unable to find $d version in $r\n";
212            print STDERR "Please report to the maintainer bruno_at_project-builder.org\n";
213            $release = "unknown";
214        } else {
215            return($distro,$release);
216        }
217    }
218}
219return("unknown","unknown");
220}
221
222
223=over 4
224
225=item B<pb_distro_installdeps>
226
227This function install the dependencies required to build the package on an RPM based distro
228dependencies can be passed as a parameter in which case they are not computed
229
230=cut
231
232sub pb_distro_installdeps {
233
234# SPEC file
235my $f = shift || undef;
236my $dtype = shift || undef;
237my $dupd = shift || undef;
238my $deps = shift || undef;
239
240# Protection
241return if (not defined $dupd);
242
243# Get dependecies in the build file if not forced
244$deps = pb_distro_getdeps($f, $dtype) if (not defined $deps);
245pb_log(2,"deps: $deps\n");
246return if ((not defined $deps) || ($deps =~ /^\s*$/));
247if ($deps !~ /^[    ]*$/) {
248    pb_system("$dupd $deps","Installing dependencies ($deps)");
249    }
250}
251
252=over 4
253
254=item B<pb_distro_getdeps>
255
256This function computes the dependencies indicated in the build file and return them as a string of packages to install
257
258=cut
259
260sub pb_distro_getdeps {
261
262my $f = shift || undef;
263my $dtype = shift || undef;
264
265my $regexp = "";
266my $deps = "";
267my $sep = $/;
268
269# Protection
270return("") if (not defined $dtype);
271return("") if (not defined $f);
272
273pb_log(3,"entering pb_distro_getdeps: $dtype - $f\n");
274if ($dtype eq  "rpm") {
275    # In RPM this could include files, but we do not handle them atm.
276    $regexp = '^BuildRequires:(.*)$';
277} elsif ($dtype eq "deb") {
278    $regexp = '^Build-Depends:(.*)$';
279} elsif ($dtype eq "ebuild") {
280    $sep = '"'.$/;
281    $regexp = '^DEPEND="(.*)"\n'
282} else {
283    # No idea
284    return("");
285}
286pb_log(2,"regexp: $regexp\n");
287
288# Preserve separator before using the one we need
289my $oldsep = $/;
290$/ = $sep;
291open(DESC,"$f") || die "Unable to open $f";
292while (<DESC>) {
293    pb_log(4,"read: $_\n");
294    next if (! /$regexp/);
295    chomp();
296    # What we found with the regexp is the list of deps.
297    pb_log(2,"found deps: $_\n");
298    s/$regexp/$1/i;
299    # Remove conditions in the middle and at the end for deb
300    s/\(\s*[><=]+.*\)\s*,/,/g;
301    s/\(\s*[><=]+.*$//g;
302    # Same for rpm
303    s/[><=]+.*,/,/g;
304    s/[><=]+.*$//g;
305    # Improve string format (remove , and spaces at start, end and in double
306    s/,/ /g;
307    s/^\s*//;
308    s/\s*$//;
309    s/\s+/ /g;
310    $deps .= " ".$_;
311}
312close(DESC);
313$/ = $oldsep;
314pb_log(2,"now deps: $deps\n");
315my $deps2 = pb_distro_only_deps_needed($dtype,$deps);
316return($deps2);
317}
318
319
320=over 4
321
322=item B<pb_distro_only_deps_needed>
323
324This function returns only the dependencies not yet installed
325
326=cut
327
328sub pb_distro_only_deps_needed {
329
330my $dtype = shift || undef;
331my $deps = shift || undef;
332
333return("") if ((not defined $deps) || ($deps =~ /^\s*$/));
334my $deps2 = "";
335# Avoid to install what is already there
336foreach my $p (split(/ /,$deps)) {
337    if ($dtype eq  "rpm") {
338        my $res = pb_system("rpm -q --whatprovides --quiet $p","","quiet");
339        next if ($res eq 0);
340    } elsif ($dtype eq "deb") {
341        my $res = pb_system("dpkg -L $p","","quiet");
342        next if ($res eq 0);
343    } elsif ($dtype eq "ebuild") {
344    } else {
345        # Not reached
346    }
347    pb_log(2,"found deps2: $p\n");
348    $deps2 .= " $p";
349}
350
351$deps2 =~ s/^\s*//;
352pb_log(2,"now deps2: $deps2\n");
353return($deps2);
354}
355
356=over 4
357
358=item B<pb_distro_setuprepo>
359
360This function sets up potential additional repository to the build environment
361
362=cut
363
364sub pb_distro_setuprepo {
365
366my $ddir = shift || undef;
367my $dver = shift;
368my $darch = shift;
369my $dtype = shift || undef;
370
371my ($addrepo) = pb_conf_read("$ENV{'PBDESTDIR'}/pbrc","addrepo");
372return if (not defined $addrepo);
373
374my $param = pb_distro_get_param($ddir,$dver,$darch,$addrepo);
375return if ($param eq "");
376
377# Loop on the list of additional repo
378foreach my $i (split(/,/,$param)) {
379
380    my ($scheme, $account, $host, $port, $path) = pb_get_uri($i);
381    my $bn = basename($i);
382
383    # The repo file can be local or remote. download or copy at the right place
384    if (($scheme eq "ftp") || ($scheme eq "http")) {
385        pb_system("wget -O $ENV{'PBTMP'}/$bn $i","Donwloading additional repository file $i");
386    } else {
387        copy($i,$ENV{'PBTMP'}/$bn);
388    }
389
390    # The repo file can be a real file or a package
391    if ($dtype eq "rpm") {
392        if ($bn =~ /\.rpm$/) {
393            my $pn = $bn;
394            $pn =~ s/\.rpm//;
395            if (pb_system("rpm -q --quiet $pn","","quiet") != 0) {
396                pb_system("sudo rpm -Uvh $ENV{'PBTMP'}/$bn","Adding package to setup repository");
397            }
398        } elsif ($bn =~ /\.repo$/) {
399            # Yum repo
400            pb_system("sudo mv $ENV{'PBTMP'}/$bn /etc/yum.repos.d","Adding yum repository") if (not -f "/etc/yum.repos.d/$bn");
401        } elsif ($bn =~ /\.addmedia/) {
402            # URPMI repo
403            # We should test that it's not already a urpmi repo
404            pb_system("chmod 755 $ENV{'PBTMP'}/$bn ; sudo $ENV{'PBTMP'}/$bn 2>&1 > /dev/null","Adding urpmi repository");
405        } else {
406            pb_log(0,"Unable to deal with repository file $i on rpm distro ! Please report to dev team\n");
407        }
408    } elsif ($dtype eq "deb") {
409        if (($bn =~ /\.sources.list$/) && (not -f "/etc/apt/sources.list.d/$bn")) {
410            pb_system("sudo mv $ENV{'PBTMP'}/$bn /etc/apt/sources.list.d","Adding apt repository");
411            pb_system("sudo apt-get update","Updating apt repository");
412        } else {
413            pb_log(0,"Unable to deal with repository file $i on deb distro ! Please report to dev team\n");
414        }
415    } else {
416        pb_log(0,"Unable to deal with repository file $i on that distro ! Please report to dev team\n");
417    }
418}
419return;
420}
421
422=over 4
423
424=item B<pb_distro_get_param>
425
426This function gets the parameter in the conf file from the most precise tuple up to default
427
428=cut
429
430sub pb_distro_get_param {
431
432my $param = "";
433my $ddir = shift;
434my $dver = shift;
435my $darch = shift;
436my $opt = shift;
437my $dfam = shift || "unknown";
438my $dtype = shift || "unknown";
439
440if (defined $opt->{"$ddir-$dver-$darch"}) {
441    $param = $opt->{"$ddir-$dver-$darch"};
442} elsif (defined $opt->{"$ddir-$dver"}) {
443    $param = $opt->{"$ddir-$dver"};
444} elsif (defined $opt->{"$ddir"}) {
445    $param = $opt->{"$ddir"};
446} elsif (defined $opt->{$dfam}) {
447    $param = $opt->{$dfam};
448} elsif (defined $opt->{$dtype}) {
449    $param = $opt->{$dtype};
450} elsif (defined $opt->{"default"}) {
451    $param = $opt->{"default"};
452} else {
453    $param = "unknown";
454}
455return($param);
456
457}
458
459
460=back
461
462=head1 WEB SITES
463
464The 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/>.
465
466=head1 USER MAILING LIST
467
468None exists for the moment.
469
470=head1 AUTHORS
471
472The Project-Builder.org team L<http://trac.project-builder.org/> lead by Bruno Cornec L<mailto:bruno@project-builder.org>.
473
474=head1 COPYRIGHT
475
476Project-Builder.org is distributed under the GPL v2.0 license
477described in the file C<COPYING> included with the distribution.
478
479=cut
480
481
4821;
Note: See TracBrowser for help on using the repository browser.