source: devel/pb-modules/lib/ProjectBuilder/Base.pm @ 1528

Last change on this file since 1528 was 1528, checked in by bruno, 7 years ago
  • Add Copyrights specified by HP Open Source Review Board (Eric Anderson)
  • Clarification of copyrights, dates and licences (Bruno Cornec)
File size: 13.4 KB
Line 
1#!/usr/bin/perl -w
2#
3# Base subroutines brought by the the Project-Builder project
4# which can be easily used by whatever perl project
5#
6# Copyright B. Cornec 2007-2012
7# Eric Anderson's changes are (c) Copyright 2012 Hewlett Packard
8# Provided under the GPL v2
9#
10# $Id$
11#
12
13package ProjectBuilder::Base;
14
15use strict;
16use lib qw (lib);
17use Carp qw/confess cluck/;
18use Cwd;
19use File::Path;
20use File::Temp qw(tempdir);
21use Data::Dumper;
22use Time::localtime qw(localtime);
23use Pod::Usage;
24use English;
25use POSIX qw(locale_h);
26use ProjectBuilder::Version;
27
28# Inherit from the "Exporter" module which handles exporting functions.
29 
30use vars qw($VERSION $REVISION @ISA @EXPORT);
31use Exporter;
32 
33# Export, by default, all the functions into the namespace of
34# any code which uses this module.
35 
36our $pbdebug = 0;       # Global debug level
37our $pbLOG = \*STDOUT;  # File descriptor of the log file
38our $pbsynmsg = "Error";    # Global error message
39our $pbdisplaytype = "text";
40                        # default display mode for messages
41our $pblocale = "C";
42
43our @ISA = qw(Exporter);
44our @EXPORT = qw(pb_mkdir_p pb_system pb_rm_rf pb_get_date pb_log pb_log_init pb_get_uri pb_get_content pb_set_content pb_display_file pb_syntax_init pb_syntax pb_temp_init pb_get_arch pb_get_osrelease pb_check_requirements pb_check_req pb_path_expand $pbdebug $pbLOG $pbdisplaytype $pblocale);
45($VERSION,$REVISION) = pb_version_init();
46
47=pod
48
49=head1 NAME
50
51ProjectBuilder::Base, part of the project-builder.org - module dealing with generic functions suitable for perl project development
52
53=head1 DESCRIPTION
54
55This module provides generic functions suitable for perl project development
56
57=head1 SYNOPSIS
58
59  use ProjectBuilder::Base;
60
61  #
62  # Create a directory and its parents
63  #
64  pb_mkdir_p("/tmp/foo/bar");
65
66  #
67  # Remove recursively a directory and its children
68  #
69  pb_rm_rf("/tmp/foo");
70
71  #
72  # Encapsulate the system call for better output and return value test
73  #
74  pb_system("ls -l", "Printing directory content");
75
76  #
77  # Analysis a URI and return its components in a table
78  #
79  my ($scheme, $account, $host, $port, $path) = pb_get_uri("svn+ssh://ac@my.server.org:port/path/to/dir");
80
81  #
82  # Gives the current date in a table
83  #
84  @date = pb_get_date();
85
86  #
87  # Manages logs of the program
88  #
89  pb_log_init(2,\*STDOUT);
90  pb_log(1,"Message to print\n");
91
92  #
93  # Manages content of a file
94  #
95  pb_display_file("/etc/passwd",\*STDERR);
96  my $cnt = pb_get_content("/etc/passwd");
97
98=head1 USAGE
99
100=over 4
101
102=item B<pb_mkdir_p>
103
104Internal mkdir -p function. Forces mode to 755. Supports multiple parameters.
105
106Based on File::Path mkpath.
107
108=cut
109
110sub pb_mkdir_p {
111my @dir = @_;
112my $ret = eval { mkpath(@dir, 0, 0755) };
113confess "pb_mkdir_p @dir failed in ".getcwd().": $@" if ($@);
114return($ret);
115}
116
117=item B<pb_rm_rf>
118
119Internal rm -rf function. Supports multiple parameters.
120
121Based on File::Path rmtree.
122
123=cut
124
125sub pb_rm_rf {
126my @dir = @_;
127my $ret = rmtree(@dir, 0, 0);
128return($ret);
129}
130
131=item B<pb_system>
132
133Encapsulate the "system" call for better output and return value test.
134Needs a $ENV{'PBTMP'} variable which is created by calling the pb_mktemp_init function.
135Needs pb_log support, so pb_log_init should have been called before.
136
137The first parameter is the shell command to call. This command should NOT use redirections.
138The second parameter is the message to print on screen. If none is given, then the command is printed.
139The third parameter print the result of the command after correct execution if value is verbose. If value is noredir, it avoids redirecting outputs (e.g. for vi). If value is quiet, doesn't print anything at all.
140The fourth parameter determines whether failure of the command is ok even if $Global::pb_stop_on_error is set, because the caller will be handling the error.
141This function returns as a result the return value of the system command.
142
143If no error reported, it prints OK on the screen, just after the message. Else it prints the errors generated.
144
145=cut
146
147sub pb_system {
148
149my $cmd=shift;
150my $cmt=shift || $cmd;
151my $verbose=shift || undef;
152my $failure_ok = shift || 0;
153my $redir = "";
154
155pb_log(0,"$cmt... ") if ((! defined $verbose) || ($verbose ne "quiet"));
156pb_log(1,"Executing $cmd\n");
157unlink("$ENV{'PBTMP'}/system.$$.log") if (-f "$ENV{'PBTMP'}/system.$$.log");
158$redir = "2>> $ENV{'PBTMP'}/system.$$.log 1>> $ENV{'PBTMP'}/system.$$.log" if ((! defined $verbose) || ($verbose ne "noredir"));
159
160# If sudo used, then be more verbose
161pb_log(0,"Executing $cmd\n") if (($pbdebug < 1) && ($cmd =~ /^\s*\S*sudo/o));
162
163system("$cmd $redir");
164my $res = $?;
165# Exit now if the command may fail
166if ((defined $verbose) and ($verbose eq "mayfail")) {
167    pb_log(0,"N/A\n") if ($res != 0);
168    pb_log(0,"OK\n") if ($res == 0);
169    return($res) 
170    }
171
172my $cwd = getcwd;
173my $error = undef;
174$error = "failed to execute ($cmd) in $cwd: $!\n" if ($res == -1);
175$error = "child ($cmd) died with signal ".($res & 127).", ".($res & 128) ? 'with' : 'without'." coredump\n" if ($res & 127);
176$error = "child ($cmd) cwd=$cwd exited with value ".($res >> 8)."\n" if ($res != 0);
177
178if (defined $error) {
179    pb_log(0, $error) if (((! defined $verbose) || ($verbose ne "quiet")) || ($Global::pb_stop_on_error && ! $failure_ok));
180    pb_display_file("$ENV{'PBTMP'}/system.$$.log") if ((-f "$ENV{'PBTMP'}/system.$$.log") and ((! defined $verbose) || ($verbose ne "quiet") || $Global::pb_stop_on_error));
181    if (($Global::pb_stop_on_error) && (! $failure_ok)) {
182        confess "error running command ($cmd) with cwd=$cwd, pid=$$";
183    }
184} else {
185    pb_log(0,"OK\n") if ((! defined $verbose) || ($verbose ne "quiet"));
186    pb_display_file("$ENV{'PBTMP'}/system.$$.log") if ((-f "$ENV{'PBTMP'}/system.$$.log") and (defined $verbose) and ($verbose ne "quiet"));
187}
188
189return($res);
190}
191
192=item B<pb_get_uri>
193
194This function returns a list of 6 parameters indicating the protocol, account, password, server, port, and path contained in the URI passed in parameter.
195
196A URI has the format protocol://[ac@]host[:port][path[?query][#fragment]].
197
198Cf man URI.
199
200=cut
201
202sub pb_get_uri {
203
204my $uri = shift || undef;
205
206pb_log(2,"DEBUG: uri:" . (defined $uri ? $uri : '') . "\n");
207my ($scheme, $authority, $path, $query, $fragment) =
208         $uri =~ m|(?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*)(?:\?([^#]*))?(?:#(.*))?| if (defined $uri);
209my ($account,$host,$port) = $authority =~ m|(?:([^\@]+)\@)?([^:]+)(:(?:[0-9]+))?| if (defined $authority);
210
211$scheme = "" if (not defined $scheme);
212$authority = "" if (not defined $authority);
213$path = "" if (not defined $path);
214$account = "" if (not defined $account);
215$host = "" if (not defined $host);
216if (not defined $port) {
217    $port = "" 
218} else {
219    # Remove extra : at start
220    $port =~ s/^://;
221}
222
223pb_log(2,"DEBUG: scheme:$scheme ac:$account host:$host port:$port path:$path\n");
224return($scheme, $account, $host, $port, $path);
225}
226
227=item B<pb_get_date>
228
229This function returns a list of 9 parameters indicating the seconds, minutes, hours, day, month, year, day in the week, day in the year, and daylight saving time flag of the current time.
230
231Cf: man ctime and description of the struct tm.
232
233=cut
234
235sub pb_get_date {
236   
237return(localtime->sec(), localtime->min(), localtime->hour(), localtime->mday(), localtime->mon(), localtime->year(), localtime->wday(), localtime->yday(), localtime->isdst());
238}
239
240=item B<pb_log_init>
241
242This function initializes the global variables used by the pb_log function.
243
244The first parameter is the debug level which will be considered during the run of the program?
245The second parameter is a pointer on a file descriptor used to print the log info.
246
247As an example, if you set the debug level to 2 in that function, every call to pb_log which contains a value less or equal than 2 will be printed. Calls with a value greater than 2 won't be printed.
248
249The call to B<pb_log_init> is typically done after getting a parameter on the CLI indicating the level of verbosity expected.
250
251=cut
252
253sub pb_log_init {
254
255$pbdebug = shift || 0;
256$pbLOG = shift || \*STDOUT;
257pb_log(1,"Debug value: $pbdebug\n");
258
259} 
260
261=item B<pb_log>
262
263This function logs the messages passed as the second parameter if the value passed as first parameter is lesser or equal than the value passed to the B<pb_log_init> function.
264
265Here is a usage example:
266
267  pb_log_init(2,\*STDERR);
268  pb_log(1,"Hello World 1\n");
269  pb_log(2,"Hello World 2\n");
270  pb_log(3,"Hello World 3\n");
271
272  will print:
273 
274  Hello World 1
275  Hello World 2
276
277=cut 
278
279sub pb_log {
280
281my $dlevel = shift;
282my $msg = shift;
283
284print $pbLOG "$msg" if ($dlevel <= $pbdebug);
285print "$msg" if (($dlevel == 0) && ($pbLOG != \*STDOUT));
286}
287
288
289=item B<pb_display_file>
290
291This function print the content of the file passed in parameter.
292If a second parameter is given, this is the descriptor of the logfile to write to in addtion to STDOUT.
293
294This is a cat equivalent function.
295
296=cut
297
298sub pb_display_file {
299
300my $file=shift;
301my $desc=shift || undef;
302
303return if (not -f $file);
304my $cnt = pb_get_content($file);
305print "$cnt\n";
306print $desc "$cnt\n" if (defined $desc);
307}
308
309=item B<pb_get_content>
310
311This function returns the content of the file passed in parameter.
312
313=cut
314
315sub pb_get_content {
316
317my $file=shift;
318
319my $bkp = $/;
320undef $/;
321open(R,$file) || die "Unable to open $file: $!";
322my $content=<R>;
323close(R);
324chomp($content);
325$/ = $bkp;
326return($content);
327}
328
329
330=item B<pb_set_content>
331
332This function put the content of a variable passed as second parameter into the file passed as first parameter.
333
334=cut
335
336sub pb_set_content {
337
338my $file=shift;
339my $content=shift;
340
341my $bkp = $/;
342undef $/;
343open(R,"> $file") || die "Unable to write to $file: $!";
344print R "$content";
345close(R);
346$/ = $bkp;
347}
348
349=item B<pb_syntax_init>
350
351This function initializes the global variable used by the pb_syntax function.
352
353The parameter is the message string which will be printed when calling pb_syntax
354
355=cut
356
357sub pb_syntax_init {
358
359$pbsynmsg = shift || "Error";
360}
361
362=item B<pb_syntax>
363
364This function prints the syntax expected by the application, based on pod2usage, and exits.
365The first parameter is the return value of the exit.
366The second parameter is the verbosity as expected by pod2usage.
367
368Cf: man Pod::Usage
369
370=cut
371
372sub pb_syntax {
373
374my $exit_status = shift || -1;
375my $verbose_level = shift || 0;
376
377my $filehandle = \*STDERR;
378
379$filehandle = \*STDOUT if ($exit_status == 0);
380
381pod2usage( { -message => $pbsynmsg,
382             -exitval => $exit_status  ,
383             -verbose => $verbose_level,
384             -output  => $filehandle } );
385}
386
387=item B<pb_temp_init>
388
389This function initializes the environemnt variable PBTMP to a random value. This directory can be safely used during the whole program, it will be removed at the end automatically.
390
391=cut
392
393sub pb_temp_init {
394
395if (not defined $ENV{'TMPDIR'}) {
396    $ENV{'TMPDIR'}="/tmp";
397}
398$ENV{'PBTMP'} = tempdir( "pb.XXXXXXXXXX", DIR => $ENV{'TMPDIR'}, CLEANUP => 1 );
399}
400
401=item B<pb_get_osrelease>
402
403This function returns the release of our operating system
404
405=cut
406
407sub pb_get_osrelease {
408
409# On linux can also use /proc/sys/kernel/osrelease
410my $rel = `uname -r`;
411chomp($rel);
412return($rel);
413}
414
415
416=item B<pb_get_arch>
417
418This function returns the architecture of our local environment and
419standardize on i386 for those platforms. It also solves issues where a i386 VE on x86_64 returns x86_64 wrongly
420
421=cut
422
423sub pb_get_arch {
424
425my $arch = `uname -m`;
426chomp($arch);
427$arch =~ s/i.86/i386/;
428# For Solaris
429$arch =~ s/i86pc/i386/;
430
431return($arch);
432}
433
434=item B<pb_check_requirements>
435
436This function checks that the commands needed for the subsystem are indeed present.
437The required commands are passed as a coma separated string as first parameter.
438The optional commands are passed as a coma separated string as second parameter.
439
440=cut
441
442sub pb_check_requirements {
443
444my $req = shift || undef;
445my $opt = shift || undef;
446my $appname = shift || undef;
447
448my ($req2,$opt2) = (undef,undef);
449$req2 = $req->{$appname} if (defined $req and defined $appname);
450$opt2 = $opt->{$appname} if (defined $opt and defined $appname);
451
452# cmds is a string of coma separated commands
453if (defined $req2) {
454    foreach my $file (split(/,/,$req2)) {
455        pb_check_req($file,0);
456    }
457}
458
459# opts is a string of coma separated commands
460if (defined $opt2) {
461    foreach my $file (split(/,/,$opt2)) {
462        pb_check_req($file,1);
463    }
464}
465}
466
467=item B<pb_check_req>
468
469This function checks existence of a command and return its full pathname or undef if not found.
470The command name is passed as first parameter.
471The second parameter should be 0 if the command is mandatory, 1 if optional.
472
473=cut
474
475sub pb_check_req {
476
477my $file = shift;
478my $opt = shift || 1;
479my $found = undef;
480
481pb_log(2,"Checking availability of $file...");
482# Check for all dirs in the PATH
483foreach my $p (split(/:/,$ENV{'PATH'})) {
484    if (-x "$p/$file") {
485        $found =  "$p/$file";
486        last;
487    }
488}
489
490if (not $found) {
491    pb_log(2,"KO\n");
492    if ($opt eq 1) {
493        pb_log(2,"Unable to find optional command $file\n");
494    } else {
495        die pb_log(0,"Unable to find required command $file\n");
496    }
497} else {
498    pb_log(2,"OK\n");
499}
500return($found);
501}
502
503=item B<pb_path_expand>
504
505Expand out a path by environment variables as ($ENV{XXX}) and ~
506
507=cut
508
509sub pb_path_expand {
510
511my $path = shift;
512
513eval { $path =~ s/(\$ENV.+\})/$1/eeg; };
514$path =~ s/^\~/$ENV{HOME}/;
515
516return($path);
517}
518
519=back
520
521=head1 WEB SITES
522
523The 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/>.
524
525=head1 USER MAILING LIST
526
527None exists for the moment.
528
529=head1 AUTHORS
530
531The Project-Builder.org team L<http://trac.project-builder.org/> lead by Bruno Cornec L<mailto:bruno@project-builder.org>.
532
533=head1 COPYRIGHT
534
535Project-Builder.org is distributed under the GPL v2.0 license
536described in the file C<COPYING> included with the distribution.
537
538=cut
539
5401;
Note: See TracBrowser for help on using the repository browser.