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

Last change on this file since 473 was 473, checked in by bruno, 11 years ago

Working announce action for pb

File size: 9.3 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::Base;
21use ProjectBuilder::Changelog;
22
23# Inherit from the "Exporter" module which handles exporting functions.
24 
25use Exporter;
26 
27# Export, by default, all the functions into the namespace of
28# any code which uses this module.
29 
30our @ISA = qw(Exporter);
31our @EXPORT = qw(pb_get_filters pb_filter_file_pb pb_filter_file_inplace pb_filter_file);
32
33=pod
34
35=head1 NAME
36
37ProjectBuilder::Filter, part of the project-builder.org
38
39=head1 DESCRIPTION
40
41This module provides filtering functions suitable for pbinit calls.
42
43=over 4
44
45=item B<pb_get_filters>
46
47This function gets all filters to apply. They're cumulative from the less specific to the most specific.
48
49Suffix 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.
50
51The first parameter is the package name.
52The second parameter is the distribution type.
53The third parameter is the distribution family.
54The fourth parameter is the distribution name.
55The fifth parameter is the distribution version.
56
57The function returns a pointer on a hash of filters.
58
59=cut
60
61sub pb_get_filters {
62
63my @ffiles;
64my ($ffile00, $ffile0, $ffile1, $ffile2, $ffile3);
65my ($mfile00, $mfile0, $mfile1, $mfile2, $mfile3);
66my $pbpkg = shift || die "No package specified";
67my $dtype = shift || "";
68my $dfam = shift || "";
69my $ddir = shift || "";
70my $dver = shift || "";
71my $ptr = undef; # returned value pointer on the hash of filters
72my %h;
73
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    $mfile0 = "$ENV{'PBROOTDIR'}/pbfilter/$dtype.pbf" if (-f "$ENV{'PBROOTDIR'}/pbfilter/$dtype.pbf");
78    $mfile1 = "$ENV{'PBROOTDIR'}/pbfilter/$dfam.pbf" if (-f "$ENV{'PBROOTDIR'}/pbfilter/$dfam.pbf");
79    $mfile2 = "$ENV{'PBROOTDIR'}/pbfilter/$ddir.pbf" if (-f "$ENV{'PBROOTDIR'}/pbfilter/$ddir.pbf");
80    $mfile3 = "$ENV{'PBROOTDIR'}/pbfilter/$ddir-$dver.pbf" if (-f "$ENV{'PBROOTDIR'}/pbfilter/$ddir-$dver.pbf");
81
82    push @ffiles,$mfile00 if (defined $mfile00);
83    push @ffiles,$mfile0 if (defined $mfile0);
84    push @ffiles,$mfile1 if (defined $mfile1);
85    push @ffiles,$mfile2 if (defined $mfile2);
86    push @ffiles,$mfile3 if (defined $mfile3);
87}
88
89if (-d "$ENV{'PBROOTDIR'}/$pbpkg/pbfilter") {
90    $ffile00 = "$ENV{'PBROOTDIR'}/$pbpkg/pbfilter/all.pbf" if (-f "$ENV{'PBROOTDIR'}/$pbpkg/pbfilter/all.pbf");
91    $ffile0 = "$ENV{'PBROOTDIR'}/$pbpkg/pbfilter/$dtype.pbf" if (-f "$ENV{'PBROOTDIR'}/$pbpkg/pbfilter/$dtype.pbf");
92    $ffile1 = "$ENV{'PBROOTDIR'}/$pbpkg/pbfilter/$dfam.pbf" if (-f "$ENV{'PBROOTDIR'}/$pbpkg/pbfilter/$dfam.pbf");
93    $ffile2 = "$ENV{'PBROOTDIR'}/$pbpkg/pbfilter/$ddir.pbf" if (-f "$ENV{'PBROOTDIR'}/$pbpkg/pbfilter/$ddir.pbf");
94    $ffile3 = "$ENV{'PBROOTDIR'}/$pbpkg/pbfilter/$ddir-$dver.pbf" if (-f "$ENV{'PBROOTDIR'}/$pbpkg/pbfilter/$ddir-$dver.pbf");
95
96    push @ffiles,$ffile00 if (defined $ffile00);
97    push @ffiles,$ffile0 if (defined $ffile0);
98    push @ffiles,$ffile1 if (defined $ffile1);
99    push @ffiles,$ffile2 if (defined $ffile2);
100    push @ffiles,$ffile3 if (defined $ffile3);
101}
102if (@ffiles) {
103    pb_log(2,"DEBUG ffiles: ".Dumper(\@ffiles)."\n");
104
105    foreach my $f (@ffiles) {
106        open(CONF,$f) || next;
107        while(<CONF>)  {
108            if (/^\s*([A-z0-9-_]+)\s+([[A-z0-9-_]+)\s*=\s*(.+)$/) {
109                $h{$1}{$2}=$3;
110            }
111        }
112        close(CONF);
113
114        $ptr = $h{"filter"};
115        pb_log(2,"DEBUG f:".Dumper($ptr)."\n");
116    }
117}
118return($ptr);
119}
120
121=item B<pb_filter_file_pb>
122
123This function applies all filters to pb build files.
124
125It takes 15 parameters. To be filtered a variable has to be passed to that function.
126
127The first parameter is the file to filter.
128The second parameter is the pointer on the hash of filters.
129The third parameter is the destination file after filtering.
130The fourth parameter is the distribution type.
131The fifth parameter is the suffix of the distribution.
132The sixth parameter is the package name.
133The seventh parameter is the version of the package.
134The eighth parameter is the tag of the package.
135The nineth parameter is the revision of the package.
136The tenth parameter is the current date.
137The eleventh parameter is the list of required packages.
138The twelveth parameter is the list of optional packages.
139The thirteenth parameter is the packager name.
140The fourteenth parameter is the changelog.
141The fifteenth parameter is the project.
142The sixteenth parameter is the repo.
143
144=cut
145
146sub pb_filter_file_pb {
147
148my $f=shift;
149my $ptr=shift;
150my %filter=%$ptr;
151my $destfile=shift;
152my $dtype=shift;
153my $pbsuf=shift;
154my $pbpkg=shift;
155my $pbver=shift;
156my $pbtag=shift;
157my $pbrev=shift;
158my $pbdate=shift;
159my $defpkgdir = shift;
160my $extpkgdir = shift;
161my $pbpackager = shift;
162my $chglog = shift || undef;
163my $pbproj = shift;
164my $pbrepo = shift;
165
166pb_log(2,"DEBUG: From $f to $destfile\n");
167pb_mkdir_p(dirname($destfile)) if (! -d dirname($destfile));
168open(DEST,"> $destfile") || die "Unable to create $destfile: $!";
169open(FILE,"$f") || die "Unable to open $f: $!";
170while (<FILE>) {
171    my $line = $_;
172    foreach my $s (keys %filter) {
173        # Process single variables
174        pb_log(2,"DEBUG filter{$s}: $filter{$s}\n");
175        my $tmp = $filter{$s};
176        next if (not defined $tmp);
177        # Expand variables if any single one found
178        pb_log(2,"DEBUG tmp: $tmp\n");
179        if ($tmp =~ /\$/) {
180            eval { $tmp =~ s/(\$\w+)/$1/eeg };
181            eval { $tmp =~ s/(\$\/)/$1/eeg };
182        # special case for ChangeLog only for pb
183        } elsif (($s =~ /^PBLOG$/) && ($line =~ /^PBLOG$/)) {
184            my $p = $defpkgdir->{$pbpkg};
185            $p = $extpkgdir->{$pbpkg} if (not defined $p);
186            pb_changelog($dtype, $pbpkg, $pbver, $pbtag, $pbsuf, $p, \*DEST, $tmp, $chglog);
187            $tmp = "";
188        }
189        $line =~ s|$s|$tmp|;
190    }
191    print DEST $line;
192}
193close(FILE);
194close(DEST);
195}
196
197=item B<pb_filter_file_inplace>
198
199This function applies all filters to a file in place.
200
201It takes 9 parameters.
202
203The first parameter is the pointer on the hash of filters.
204The second parameter is the destination file after filtering.
205The third parameter is the package name.
206The fourth parameter is the version of the package.
207The fifth parameter is the tag of the package.
208The sixth parameter is the revision of the package.
209The seventh parameter is the current date.
210The eighth parameter is the packager name.
211The nineth parameter is the project name.
212The tenth parameter is the repo.
213
214=cut
215
216# Function which applies filter on files (external call)
217sub pb_filter_file_inplace {
218
219my $ptr=shift;
220my %filter=%$ptr;
221my $destfile=shift;
222my $pbpkg=shift;
223my $pbver=shift;
224my $pbtag=shift;
225my $pbrev=shift;
226my $pbdate=shift;
227my $pbpackager=shift;
228my $pbproj=shift;
229my $pbrepo = shift;
230
231my $cp = "$ENV{'PBTMP'}/".basename($destfile);
232copy($destfile,$cp) || die "Unable to create $cp";
233
234pb_filter_file($cp,$ptr,$destfile,$pbpkg,$pbver,$pbtag,$pbrev,$pbdate,$pbpackager,$pbproj,$pbrepo);
235unlink $cp;
236}
237
238=item B<pb_filter_file>
239
240This function applies all filters on a file to generate a new filtered one.
241
242It takes 10 parameters. To be filtered a variable has to be passed to that function.
243
244The first parameter is the original file to filter.
245The second parameter is the pointer on the hash of filters.
246The third parameter is the destination file after filtering.
247The fourth parameter is the package name.
248The fifth parameter is the version of the package.
249The sixth parameter is the tag of the package.
250The seventh parameter is the revision of the package.
251The eighth parameter is the current date.
252The nineth parameter is the packager name.
253The tenth parameter is the project name.
254The eleventh parameter is the repo.
255
256=cut
257
258
259# Function which applies filter on files (external call)
260sub pb_filter_file {
261
262my $f=shift;
263my $ptr=shift;
264my %filter=%$ptr;
265my $destfile=shift;
266my $pbpkg=shift;
267my $pbver=shift;
268my $pbtag=shift;
269my $pbrev=shift;
270my $pbdate=shift;
271my $pbpackager=shift;
272my $pbproj=shift;
273my $pbrepo = shift;
274
275pb_log(2,"DEBUG: From $f to $destfile\n");
276pb_mkdir_p(dirname($destfile)) if (! -d dirname($destfile));
277open(DEST,"> $destfile") || die "Unable to create $destfile";
278open(FILE,"$f") || die "Unable to open $f: $!";
279while (<FILE>) {
280    my $line = $_;
281    foreach my $s (keys %filter) {
282        # Process single variables
283        pb_log(2,"DEBUG filter{$s}: $filter{$s}\n");
284        my $tmp = $filter{$s};
285        next if (not defined $tmp);
286        # Expand variables if any single one found
287        if ($tmp =~ /\$/) {
288            eval { $tmp =~ s/(\$\w+)/$1/eeg };
289            eval { $tmp =~ s/(\$\/)/$1/eeg };
290        }
291        $line =~ s|$s|$tmp|;
292    }
293    print DEST $line;
294}
295close(FILE);
296close(DEST);
297}
298
299=back
300
301=head1 WEB SITES
302
303The 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/>.
304
305=head1 USER MAILING LIST
306
307None exists for the moment.
308
309=head1 AUTHORS
310
311The Project-Builder.org team L<http://trac.project-builder.org/> lead by Bruno Cornec L<mailto:bruno@project-builder.org>.
312
313=head1 COPYRIGHT
314
315Project-Builder.org is distributed under the GPL v2.0 license
316described in the file C<COPYING> included with the distribution.
317
318=cut
319
3201;
Note: See TracBrowser for help on using the repository browser.