source: devel/pb/lib/ProjectBuilder/Filter.pm @ 1367

Last change on this file since 1367 was 1367, checked in by bruno, 8 years ago
  • Fix a bug in the recursive function pb_list_bfiles where file handle should not be global
  • patch command and option are now variables in p.conf under ospatchcmd and ospatchopt
  • Add support for patches for deb family of distributions
File size: 10.2 KB
Line 
1#!/usr/bin/perl -w
2#
3# ProjectBuilder Filter module
4# Filtering subroutines brought by the the Project-Builder project
5# which can be easily used by pbinit
6#
7# $Id$
8#
9# Copyright B. Cornec 2007
10# Provided under the GPL v2
11
12package ProjectBuilder::Filter;
13
14use strict 'vars';
15use Data::Dumper;
16use English;
17use File::Basename;
18use File::Copy;
19use lib qw (lib);
20use ProjectBuilder::Version;
21use ProjectBuilder::Base;
22use ProjectBuilder::Conf;
23use ProjectBuilder::Distribution;
24use ProjectBuilder::Changelog;
25
26# Inherit from the "Exporter" module which handles exporting functions.
27 
28use vars qw($VERSION $REVISION @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_get_filters pb_filter_file_pb pb_filter_file_inplace pb_filter_file);
36($VERSION,$REVISION) = pb_version_init();
37
38=pod
39
40=head1 NAME
41
42ProjectBuilder::Filter, part of the project-builder.org
43
44=head1 DESCRIPTION
45
46This module provides filtering functions suitable for pbinit calls.
47
48=over 4
49
50=item B<pb_get_filters>
51
52This function gets all filters to apply. They're cumulative from the less specific to the most specific.
53
54Suffix of those filters is .pbf. Filter all.pbf applies to whatever distribution. The pbfilter directory may be global under pbconf or per package, for overloading values. Then in order filters are loaded for distribution type, distribution family, distribution name, distribution name-version.
55
56The first parameter is the package name.
57The second parameter is OS hash
58
59The function returns a pointer on a hash of filters.
60
61=cut
62
63sub pb_get_filters {
64
65my @ffiles;
66my ($ffile00, $ffile0, $ffile1, $ffile2, $ffile3, $ffile4, $ffile5);
67my ($mfile00, $mfile0, $mfile1, $mfile2, $mfile3, $mfile4, $mfile5);
68my $pbpkg = shift || die "No package specified";
69my $pbos = shift;
70my $ptr = undef; # returned value pointer on the hash of filters
71my %h;
72
73pb_log(2,"Entering pb_get_filters - pbpkg: $pbpkg - pbos: ".Dumper($pbos)."\n");
74# Global filter files first, then package specificities
75if (-d "$ENV{'PBROOTDIR'}/pbfilter") {
76    $mfile00 = "$ENV{'PBROOTDIR'}/pbfilter/all.pbf" if (-f "$ENV{'PBROOTDIR'}/pbfilter/all.pbf");
77    if (defined $pbos) {
78        $mfile0 = "$ENV{'PBROOTDIR'}/pbfilter/$pbos->{'os'}.pbf" if ((defined $pbos->{'os'}) && (-f "$ENV{'PBROOTDIR'}/pbfilter/$pbos->{'os'}.pbf"));
79        $mfile1 = "$ENV{'PBROOTDIR'}/pbfilter/$pbos->{'type'}.pbf" if ((defined $pbos->{'type'}) && (-f "$ENV{'PBROOTDIR'}/pbfilter/$pbos->{'type'}.pbf"));
80        $mfile2 = "$ENV{'PBROOTDIR'}/pbfilter/$pbos->{'family'}.pbf" if ((defined $pbos->{'family'}) && (-f "$ENV{'PBROOTDIR'}/pbfilter/$pbos->{'family'}.pbf"));
81        $mfile3 = "$ENV{'PBROOTDIR'}/pbfilter/$pbos->{'name'}.pbf" if ((defined $pbos->{'name'}) && (-f "$ENV{'PBROOTDIR'}/pbfilter/$pbos->{'name'}.pbf"));
82        $mfile4 = "$ENV{'PBROOTDIR'}/pbfilter/$pbos->{'name'}-$pbos->{'version'}.pbf" if ((defined $pbos->{'name'}) && (defined $pbos->{'version'}) && (-f "$ENV{'PBROOTDIR'}/pbfilter/$pbos->{'name'}-$pbos->{'version'}.pbf"));
83        $mfile5 = "$ENV{'PBROOTDIR'}/pbfilter/$pbos->{'name'}-$pbos->{'version'}-$pbos->{'arch'}.pbf" if ((defined $pbos->{'name'}) && (defined $pbos->{'version'}) && (defined $pbos->{'arch'}) && (-f "$ENV{'PBROOTDIR'}/pbfilter/$pbos->{'name'}-$pbos->{'version'}-$pbos->{'arch'}.pbf"));
84    }
85
86    push @ffiles,$mfile00 if (defined $mfile00);
87    push @ffiles,$mfile0 if (defined $mfile0);
88    push @ffiles,$mfile1 if (defined $mfile1);
89    push @ffiles,$mfile2 if (defined $mfile2);
90    push @ffiles,$mfile3 if (defined $mfile3);
91    push @ffiles,$mfile4 if (defined $mfile4);
92    push @ffiles,$mfile5 if (defined $mfile5);
93}
94
95if (-d "$ENV{'PBROOTDIR'}/$pbpkg/pbfilter") {
96    $ffile00 = "$ENV{'PBROOTDIR'}/$pbpkg/pbfilter/all.pbf" if (-f "$ENV{'PBROOTDIR'}/$pbpkg/pbfilter/all.pbf");
97    if (defined $pbos) {
98        $ffile0 = "$ENV{'PBROOTDIR'}/$pbpkg/pbfilter/$pbos->{'os'}.pbf" if ((defined $pbos->{'os'}) && (-f "$ENV{'PBROOTDIR'}/$pbpkg/pbfilter/$pbos->{'os'}.pbf"));
99        $ffile1 = "$ENV{'PBROOTDIR'}/$pbpkg/pbfilter/$pbos->{'type'}.pbf" if ((defined $pbos->{'type'}) && (-f "$ENV{'PBROOTDIR'}/$pbpkg/pbfilter/$pbos->{'type'}.pbf"));
100        $ffile2 = "$ENV{'PBROOTDIR'}/$pbpkg/pbfilter/$pbos->{'family'}.pbf" if ((defined $pbos->{'family'}) && (-f "$ENV{'PBROOTDIR'}/$pbpkg/pbfilter/$pbos->{'family'}.pbf"));
101        $ffile3 = "$ENV{'PBROOTDIR'}/$pbpkg/pbfilter/$pbos->{'name'}.pbf" if ((defined $pbos->{'name'}) && (-f "$ENV{'PBROOTDIR'}/$pbpkg/pbfilter/$pbos->{'name'}.pbf"));
102        $ffile4 = "$ENV{'PBROOTDIR'}/$pbpkg/pbfilter/$pbos->{'name'}-$pbos->{'version'}.pbf" if ((defined $pbos->{'name'}) && (defined $pbos->{'version'}) && (-f "$ENV{'PBROOTDIR'}/$pbpkg/pbfilter/$pbos->{'name'}-$pbos->{'version'}.pbf"));
103        $ffile5 = "$ENV{'PBROOTDIR'}/$pbpkg/pbfilter/$pbos->{'name'}-$pbos->{'version'}-$pbos->{'arch'}.pbf" if ((defined $pbos->{'name'}) && (defined $pbos->{'version'}) && (defined $pbos->{'arch'}) && (-f "$ENV{'PBROOTDIR'}/$pbpkg/pbfilter/$pbos->{'name'}-$pbos->{'version'}-$pbos->{'arch'}.pbf"));
104    }
105    push @ffiles,$ffile00 if (defined $ffile00);
106    push @ffiles,$ffile0 if (defined $ffile0);
107    push @ffiles,$ffile1 if (defined $ffile1);
108    push @ffiles,$ffile2 if (defined $ffile2);
109    push @ffiles,$ffile3 if (defined $ffile3);
110    push @ffiles,$ffile4 if (defined $ffile4);
111    push @ffiles,$ffile5 if (defined $ffile5);
112}
113if (@ffiles) {
114    pb_log(2,"DEBUG ffiles: ".Dumper(\@ffiles)."\n");
115
116    foreach my $f (@ffiles) {
117        pb_log(3,"DEBUG processing filter file $f\n");
118        open(CONF,$f) || next;
119        while(<CONF>)  {
120            if (/^\s*([A-z0-9-_]+)\s+([[A-z0-9-_]+)\s*=\s*(.+)$/) {
121                pb_log(3,"DEBUG creating entry $1, key $2, value $3\n");
122                $h{$1}{$2}=$3;
123            }
124        }
125        close(CONF);
126    }
127    $ptr = $h{"filter"};
128}
129pb_log(2,"DEBUG f:".Dumper($ptr)."\n") if (defined $ptr);
130return($ptr);
131}
132
133=item B<pb_filter_file>
134
135This function applies all filters to files.
136
137It takes 4 parameters.
138
139The first parameter is the file to filter.
140The second parameter is the pointer on the hash of filters. If undefined no filtering will occur.
141The third parameter is the destination file after filtering.
142The fourth parameter is the pointer on the hash of variables to filter (tag, ver, ...)
143
144=cut
145
146sub pb_filter_file {
147
148my $f=shift;
149my $ptr=shift;
150my %filter;
151if (defined $ptr) {
152    %filter=%$ptr;
153} else {
154    %filter = ();
155}
156my $destfile=shift;
157my $pb=shift;
158my $tuple = "unknown";
159$tuple = "$pb->{'pbos'}->{'name'}-$pb->{'pbos'}->{'version'}-$pb->{'pbos'}->{'arch'}" if (defined $pb->{'pbos'});
160
161pb_log(2,"DEBUG: From $f to $destfile (tuple: $tuple)\n");
162pb_log(3,"DEBUG($tuple): pb ".Dumper($pb)."\n");
163pb_mkdir_p(dirname($destfile)) if (! -d dirname($destfile));
164open(DEST,"> $destfile") || die "Unable to create $destfile: $!";
165open(FILE,"$f") || die "Unable to open $f: $!";
166while (<FILE>) {
167    my $line = $_;
168    foreach my $s (keys %filter) {
169        # Process single variables
170        my $tmp = $filter{$s};
171        next if (not defined $tmp);
172        pb_log(3,"DEBUG filter{$s}: $filter{$s}\n");
173        # Expand variables if any single one found
174        if ($tmp =~ /\$/) {
175            pb_log(3,"*** Filtering variable in $tmp ***\n");
176            # Order is important as we need to handle hashes refs before simple vars
177            # (?: introduce a Non-capturing groupings cf man perlretut
178            eval { $tmp =~ s/(\$\w+(?:-\>\{\'\w+\'\})*)/$1/eeg };
179            if (($s =~ /^PBDESC$/) && ($line =~ /^ PBDESC/)) {
180                # if on debian, we need to preserve the space before each desc line
181                pb_log(3,"*** DEBIAN CASE ADDING SPACE ***\n");
182                $tmp =~ s/\$\//\$\/ /g;
183                pb_log(3,"*** tmp:$tmp ***\n");
184            }
185            eval { $tmp =~ s/(\$\/)/$1/eeg };
186        } elsif (($s =~ /^PBLOG$/) && ($line =~ /^PBLOG$/)) {
187            # special case for ChangeLog only for pb
188            pb_log(3,"DEBUG filtering PBLOG\n");
189            pb_changelog($pb, \*DEST, $tmp);
190            $tmp = "";
191        } elsif (($s =~ /^PBPATCHSRC$/) && ($line =~ /^PBPATCHSRC$/)) {
192            pb_log(3,"DEBUG($tuple) filtering PBPATCHSRC\n");
193            my $i = 0;
194            pb_log(3,"DEBUG($tuple): pb ".Dumper($pb)."\n");
195            pb_log(3,"DEBUG($tuple): pb/patches/tuple $pb->{'patches'}->{$tuple}\n");
196            if (defined $pb->{'patches'}->{$tuple}) {
197                foreach my $p (split(/,/,$pb->{'patches'}->{$tuple})) {
198                    pb_log(3,"DEBUG($tuple) Adding patch $i ".basename($p)."\n");
199                    print DEST "Patch$i:         ".basename($p).".gz\n";
200                    $i++;
201                }
202            }
203            $tmp = "";
204        } elsif (($s =~ /^PBMULTISRC$/) && ($line =~ /^PBMULTISRC$/)) {
205            pb_log(3,"DEBUG($tuple) filtering PBMULTISRC\n");
206            my $i = 1;
207            if (defined $pb->{'sources'}->{$tuple}) {
208                foreach my $p (split(/,/,$pb->{'sources'}->{$tuple})) {
209                    pb_log(3,"DEBUG($tuple) Adding source $i ".basename($p)."\n");
210                    print DEST "Source$i:         ".basename($p)."\n";
211                    $i++;
212                }
213            }
214            $tmp = "";
215        } elsif (($s =~ /^PBPATCHCMD$/) && ($line =~ /^PBPATCHCMD$/)) {
216            pb_log(3,"DEBUG($tuple) filtering PBPATCHCMD\n");
217            my $i = 0;
218            if (defined $pb->{'patches'}->{$tuple}) {
219                my ($patchcmd,$patchopt) = pb_distro_get_param($pb->{'pbos'},pb_conf_get_if("ospatchcmd","ospatchopt"));
220                foreach my $p (split(/,/,$pb->{'patches'}->{$tuple})) {
221                    pb_log(3,"DEBUG($tuple) Adding patch command $i\n");
222                    print DEST "%patch$i $patchopt\n";
223                    $i++;
224                }
225            }
226            print DEST "\n";
227            $tmp = "";
228        }
229        $line =~ s|$s|$tmp|g;
230    }
231    print DEST $line;
232}
233close(FILE);
234close(DEST);
235}
236
237=item B<pb_filter_file_inplace>
238
239This function applies all filters to a file in place.
240
241It takes 3 parameters.
242
243The first parameter is the pointer on the hash of filters.
244The second parameter is the destination file after filtering.
245The third parameter is the pointer on the hash of variables to filter (tag, ver, ...)
246
247=cut
248
249# Function which applies filter on files (external call)
250sub pb_filter_file_inplace {
251
252my $ptr=shift;
253my $destfile=shift;
254my $pb=shift;
255
256my $cp = "$ENV{'PBTMP'}/".basename($destfile).".$$";
257copy($destfile,$cp) || die "Unable to copy $destfile to $cp";
258
259pb_filter_file($cp,$ptr,$destfile,$pb);
260unlink $cp;
261}
262
263
264=back
265
266=head1 WEB SITES
267
268The 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/>.
269
270=head1 USER MAILING LIST
271
272None exists for the moment.
273
274=head1 AUTHORS
275
276The Project-Builder.org team L<http://trac.project-builder.org/> lead by Bruno Cornec L<mailto:bruno@project-builder.org>.
277
278=head1 COPYRIGHT
279
280Project-Builder.org is distributed under the GPL v2.0 license
281described in the file C<COPYING> included with the distribution.
282
283=cut
284
2851;
Note: See TracBrowser for help on using the repository browser.