[2] | 1 | #!/usr/bin/perl -w
|
---|
| 2 | #
|
---|
[395] | 3 | # Base subroutines brought by the the Project-Builder project
|
---|
| 4 | # which can be easily used by whatever perl project
|
---|
[2] | 5 | #
|
---|
[395] | 6 | # Copyright B. Cornec 2007-2008
|
---|
| 7 | # Provided under the GPL v2
|
---|
| 8 | #
|
---|
[2] | 9 | # $Id$
|
---|
| 10 | #
|
---|
| 11 |
|
---|
[318] | 12 | package ProjectBuilder::Base;
|
---|
| 13 |
|
---|
[18] | 14 | use strict;
|
---|
[5] | 15 | use lib qw (lib);
|
---|
[9] | 16 | use File::Path;
|
---|
[318] | 17 | use File::Temp qw(tempdir);
|
---|
[8] | 18 | use Data::Dumper;
|
---|
[318] | 19 | use Time::localtime qw(localtime);
|
---|
[397] | 20 | use Pod::Usage;
|
---|
[328] | 21 | use English;
|
---|
[2] | 22 |
|
---|
[318] | 23 | # Inherit from the "Exporter" module which handles exporting functions.
|
---|
| 24 |
|
---|
| 25 | use Exporter;
|
---|
| 26 |
|
---|
| 27 | # Export, by default, all the functions into the namespace of
|
---|
| 28 | # any code which uses this module.
|
---|
| 29 |
|
---|
[397] | 30 | our $debug = 0; # Global debug level
|
---|
| 31 | our $LOG = \*STDOUT; # File descriptor of the log file
|
---|
| 32 | our $synmsg = "Error"; # Global error message
|
---|
[318] | 33 |
|
---|
| 34 | our @ISA = qw(Exporter);
|
---|
[405] | 35 | our @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_display_file pb_syntax_init pb_syntax pb_temp_init $debug $LOG);
|
---|
[318] | 36 |
|
---|
[395] | 37 | =pod
|
---|
[2] | 38 |
|
---|
[395] | 39 | =head1 NAME
|
---|
[2] | 40 |
|
---|
[395] | 41 | ProjectBuilder::Base, part of the project-builder.org - module dealing with generic functions suitable for perl project development
|
---|
[355] | 42 |
|
---|
[395] | 43 | =head1 DESCRIPTION
|
---|
[69] | 44 |
|
---|
[395] | 45 | This modules provides generic functions suitable for perl project development
|
---|
[69] | 46 |
|
---|
[395] | 47 | =head1 SYNOPSIS
|
---|
[69] | 48 |
|
---|
[395] | 49 | use ProjectBuilder::Base;
|
---|
[313] | 50 |
|
---|
[395] | 51 | #
|
---|
| 52 | # Create a directory and its parents
|
---|
| 53 | #
|
---|
| 54 | pb_mkdir_p("/tmp/foo/bar");
|
---|
[313] | 55 |
|
---|
[395] | 56 | #
|
---|
| 57 | # Remove recursively a directory and its children
|
---|
| 58 | #
|
---|
| 59 | pb_rm_rf("/tmp/foo");
|
---|
[313] | 60 |
|
---|
[395] | 61 | #
|
---|
| 62 | # Encapsulate the system call for better output and return value test
|
---|
| 63 | #
|
---|
| 64 | pb_system("ls -l", "Printing directory content");
|
---|
[314] | 65 |
|
---|
[395] | 66 | #
|
---|
| 67 | # Analysis a URI and return its components in a table
|
---|
| 68 | #
|
---|
| 69 | my ($scheme, $account, $host, $port, $path) = pb_get_uri("svn+ssh://ac@my.server.org/path/to/dir");
|
---|
[313] | 70 |
|
---|
[395] | 71 | #
|
---|
| 72 | # Gives the current date in a table
|
---|
| 73 | #
|
---|
| 74 | @date = pb_get_date();
|
---|
[2] | 75 |
|
---|
[395] | 76 | #
|
---|
| 77 | # Manages logs of the program
|
---|
| 78 | #
|
---|
| 79 | pb_log_init(2,\*STDOUT);
|
---|
| 80 | pb_log(1,"Message to print\n");
|
---|
[313] | 81 |
|
---|
[395] | 82 | #
|
---|
| 83 | # Manages content of a file
|
---|
| 84 | #
|
---|
| 85 | pb_display_file("/etc/passwd");
|
---|
| 86 | my $cnt = pb_get_content("/etc/passwd");
|
---|
[313] | 87 |
|
---|
[395] | 88 | =head1 USAGE
|
---|
[320] | 89 |
|
---|
[395] | 90 | =over 4
|
---|
[323] | 91 |
|
---|
[395] | 92 | =item B<pb_mkdir_p>
|
---|
[314] | 93 |
|
---|
[395] | 94 | Internal mkdir -p function. Forces mode to 755. Supports multiple parameters.
|
---|
[358] | 95 |
|
---|
[396] | 96 | Based on File::Path mkpath.
|
---|
| 97 |
|
---|
[395] | 98 | =cut
|
---|
[273] | 99 |
|
---|
[74] | 100 | sub pb_mkdir_p {
|
---|
[29] | 101 | my @dir = @_;
|
---|
| 102 | my $ret = mkpath(@dir, 0, 0755);
|
---|
| 103 | return($ret);
|
---|
[9] | 104 | }
|
---|
| 105 |
|
---|
[396] | 106 | =item B<pb_rm_rf>
|
---|
[395] | 107 |
|
---|
| 108 | Internal rm -rf function. Supports multiple parameters.
|
---|
| 109 |
|
---|
[396] | 110 | Based on File::Path rmtree.
|
---|
| 111 |
|
---|
[395] | 112 | =cut
|
---|
| 113 |
|
---|
[74] | 114 | sub pb_rm_rf {
|
---|
[29] | 115 | my @dir = @_;
|
---|
| 116 | my $ret = rmtree(@dir, 0, 0);
|
---|
| 117 | return($ret);
|
---|
[9] | 118 | }
|
---|
| 119 |
|
---|
[395] | 120 | =item B<pb_system>
|
---|
| 121 |
|
---|
| 122 | Encapsulate the "system" call for better output and return value test
|
---|
| 123 | Needs a $ENV{'PBTMP'} variable which is created by calling the pb_mktemp_init function
|
---|
| 124 | Needs pb_log support, so pb_log_init should have benn called before.
|
---|
| 125 |
|
---|
| 126 | The first parameter is the shell command to call.
|
---|
| 127 | The second parameter is the message to print on screen. If none is given, then the command is printed.
|
---|
| 128 | This function returns the result the return value of the system command.
|
---|
[396] | 129 |
|
---|
[395] | 130 | If no error reported, it prints OK on the screen, just after the message. Else it prints the errors generated.
|
---|
| 131 |
|
---|
| 132 | =cut
|
---|
| 133 |
|
---|
[74] | 134 | sub pb_system {
|
---|
[29] | 135 |
|
---|
| 136 | my $cmd=shift;
|
---|
[30] | 137 | my $cmt=shift || $cmd;
|
---|
[29] | 138 |
|
---|
[319] | 139 | pb_log(0,"$cmt... ");
|
---|
[395] | 140 | pb_log(1,"Executing $cmd\n");
|
---|
[293] | 141 | system($cmd);
|
---|
[347] | 142 | my $res = $?;
|
---|
| 143 | if ($res == -1) {
|
---|
[319] | 144 | pb_log(0,"failed to execute ($cmd) : $!\n");
|
---|
[106] | 145 | pb_display_file("$ENV{'PBTMP'}/system.log");
|
---|
[347] | 146 | } elsif ($res & 127) {
|
---|
[319] | 147 | pb_log(0, "child ($cmd) died with signal ".($? & 127).", ".($? & 128) ? 'with' : 'without'." coredump\n");
|
---|
[106] | 148 | pb_display_file("$ENV{'PBTMP'}/system.log");
|
---|
[347] | 149 | } elsif ($res == 0) {
|
---|
[319] | 150 | pb_log(0,"OK\n");
|
---|
[29] | 151 | } else {
|
---|
[319] | 152 | pb_log(0, "child ($cmd) exited with value ".($? >> 8)."\n");
|
---|
[106] | 153 | pb_display_file("$ENV{'PBTMP'}/system.log");
|
---|
[29] | 154 | }
|
---|
[347] | 155 | return($res);
|
---|
[30] | 156 | }
|
---|
[74] | 157 |
|
---|
[395] | 158 | =item B<pb_get_uri>
|
---|
| 159 |
|
---|
| 160 | This function returns a list of 6 parameters indicating the protocol, account, password, server, port, and path contained in the URI passed in parameter.
|
---|
| 161 |
|
---|
| 162 | A URI has the format protocol://[ac@]host[:port][path[?query][#fragment]].
|
---|
[396] | 163 |
|
---|
[395] | 164 | Cf man URI.
|
---|
| 165 |
|
---|
| 166 | =cut
|
---|
| 167 |
|
---|
[314] | 168 | sub pb_get_uri {
|
---|
[313] | 169 |
|
---|
[314] | 170 | my $uri = shift || undef;
|
---|
[313] | 171 |
|
---|
[318] | 172 | pb_log(2,"DEBUG: uri:$uri\n");
|
---|
[314] | 173 | my ($scheme, $authority, $path, $query, $fragment) =
|
---|
[318] | 174 | $uri =~ m|(?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*)(?:\?([^#]*))?(?:#(.*))?| if (defined $uri);
|
---|
| 175 | my ($account,$host,$port) = $authority =~ m|(?:([^\@]+)\@)?([^:]+)(:(?:[0-9]+))?| if (defined $authority);
|
---|
| 176 |
|
---|
| 177 | $scheme = "" if (not defined $scheme);
|
---|
| 178 | $authority = "" if (not defined $authority);
|
---|
| 179 | $path = "" if (not defined $path);
|
---|
| 180 | $account = "" if (not defined $account);
|
---|
| 181 | $host = "" if (not defined $host);
|
---|
| 182 | $port = "" if (not defined $port);
|
---|
| 183 |
|
---|
[315] | 184 | pb_log(2,"DEBUG: scheme:$scheme ac:$account host:$host port:$port path:$path\n");
|
---|
[314] | 185 | return($scheme, $account, $host, $port, $path);
|
---|
[313] | 186 | }
|
---|
| 187 |
|
---|
[395] | 188 | =item B<pb_get_date>
|
---|
[313] | 189 |
|
---|
[395] | 190 | This 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.
|
---|
[74] | 191 |
|
---|
[395] | 192 | Cf: man ctime and description of the struct tm.
|
---|
[74] | 193 |
|
---|
[395] | 194 | =cut
|
---|
[339] | 195 |
|
---|
[315] | 196 | sub pb_get_date {
|
---|
| 197 |
|
---|
| 198 | return(localtime->sec(), localtime->min(), localtime->hour(), localtime->mday(), localtime->mon(), localtime->year(), localtime->wday(), localtime->yday(), localtime->isdst());
|
---|
| 199 | }
|
---|
| 200 |
|
---|
[395] | 201 | =item B<pb_log_init>
|
---|
[315] | 202 |
|
---|
[395] | 203 | This function initializes the global variables used by the pb_log function.
|
---|
[106] | 204 |
|
---|
[395] | 205 | The first parameter is the debug level which will be considered during the run of the program?
|
---|
| 206 | The second parameter is a pointer on a file descriptor used to print the log info.
|
---|
[315] | 207 |
|
---|
[396] | 208 | As 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.
|
---|
| 209 |
|
---|
| 210 | The call to B<pb_log_init> is typically done after getting a parameter on the CLI indicating the level of verbosity expected.
|
---|
| 211 |
|
---|
[395] | 212 | =cut
|
---|
[319] | 213 |
|
---|
[315] | 214 | sub pb_log_init {
|
---|
[77] | 215 |
|
---|
[315] | 216 | $debug = shift || 0;
|
---|
| 217 | $LOG = shift || \*STDOUT;
|
---|
[423] | 218 | pb_log(1,"Debug value: $debug\n");
|
---|
[315] | 219 |
|
---|
| 220 | }
|
---|
| 221 |
|
---|
[396] | 222 | =item B<pb_log>
|
---|
| 223 |
|
---|
| 224 | This 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.
|
---|
| 225 |
|
---|
| 226 | Here is a usage example:
|
---|
| 227 |
|
---|
| 228 | pb_log_init(2,\*STDERR);
|
---|
| 229 | pb_log(1,"Hello World 1\n");
|
---|
| 230 | pb_log(2,"Hello World 2\n");
|
---|
| 231 | pb_log(3,"Hello World 3\n");
|
---|
| 232 |
|
---|
| 233 | will print:
|
---|
| 234 |
|
---|
| 235 | Hello World 1
|
---|
| 236 | Hello World 2
|
---|
| 237 |
|
---|
| 238 | =cut
|
---|
| 239 |
|
---|
[315] | 240 | sub pb_log {
|
---|
| 241 |
|
---|
| 242 | my $dlevel = shift;
|
---|
| 243 | my $msg = shift;
|
---|
| 244 |
|
---|
[318] | 245 | print $LOG "$msg" if ($dlevel <= $debug);
|
---|
[315] | 246 | }
|
---|
| 247 |
|
---|
[396] | 248 | =item B<pb_display_file>
|
---|
| 249 |
|
---|
| 250 | This function print the content of the file passed in parameter.
|
---|
| 251 |
|
---|
| 252 | This is a cat equivalent function.
|
---|
| 253 |
|
---|
| 254 | =cut
|
---|
| 255 |
|
---|
[395] | 256 | sub pb_display_file {
|
---|
[316] | 257 |
|
---|
[395] | 258 | my $file=shift;
|
---|
[316] | 259 |
|
---|
[395] | 260 | return if (not -f $file);
|
---|
| 261 | printf "%s\n",pb_get_content($file);
|
---|
[316] | 262 | }
|
---|
| 263 |
|
---|
[396] | 264 | =item B<pb_get_content>
|
---|
| 265 |
|
---|
| 266 | This function returns the content of the file passed in parameter.
|
---|
| 267 |
|
---|
| 268 | =cut
|
---|
| 269 |
|
---|
[395] | 270 | sub pb_get_content {
|
---|
[353] | 271 |
|
---|
[395] | 272 | my $file=shift;
|
---|
[353] | 273 |
|
---|
[395] | 274 | my $bkp = $/;
|
---|
| 275 | undef $/;
|
---|
| 276 | open(R,$file) || die "Unable to open $file: $!";
|
---|
| 277 | my $content=<R>;
|
---|
| 278 | close(R);
|
---|
| 279 | chomp($content);
|
---|
| 280 | $/ = $bkp;
|
---|
| 281 | return($content);
|
---|
[353] | 282 | }
|
---|
| 283 |
|
---|
[397] | 284 | =item B<pb_syntax_init>
|
---|
| 285 |
|
---|
| 286 | This function initializes the global variable used by the pb_syntax function.
|
---|
| 287 |
|
---|
| 288 | The parameter is the message string which will be printed when calling pb_syntax
|
---|
| 289 |
|
---|
| 290 | =cut
|
---|
| 291 |
|
---|
| 292 | sub pb_syntax_init {
|
---|
| 293 |
|
---|
| 294 | $synmsg = shift || "Error";
|
---|
| 295 | }
|
---|
| 296 |
|
---|
| 297 | =item B<pb_syntax>
|
---|
| 298 |
|
---|
| 299 | This function prints the syntax expected by the application, based on pod2usage, and exits.
|
---|
| 300 | The first parameter is the return value of the exit.
|
---|
| 301 | The second parameter is the verbosity as expected by pod2usage.
|
---|
| 302 |
|
---|
| 303 | Cf: man Pod::Usage
|
---|
| 304 |
|
---|
| 305 | =cut
|
---|
| 306 |
|
---|
| 307 | sub pb_syntax {
|
---|
| 308 |
|
---|
| 309 | my $exit_status = shift || -1;
|
---|
| 310 | my $verbose_level = shift || 0;
|
---|
| 311 |
|
---|
| 312 | my $filehandle = \*STDERR;
|
---|
| 313 |
|
---|
| 314 | $filehandle = \*STDOUT if ($exit_status == 0);
|
---|
| 315 |
|
---|
| 316 | pod2usage( { -message => $synmsg,
|
---|
| 317 | -exitval => $exit_status ,
|
---|
| 318 | -verbose => $verbose_level,
|
---|
| 319 | -output => $filehandle } );
|
---|
| 320 | }
|
---|
| 321 |
|
---|
| 322 | =item B<pb_temp_init>
|
---|
| 323 |
|
---|
| 324 | This 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.
|
---|
| 325 |
|
---|
| 326 | =cut
|
---|
| 327 |
|
---|
| 328 | sub pb_temp_init {
|
---|
| 329 |
|
---|
| 330 | if (not defined $ENV{'TMPDIR'}) {
|
---|
| 331 | $ENV{'TMPDIR'}="/tmp";
|
---|
| 332 | }
|
---|
| 333 | $ENV{'PBTMP'} = tempdir( "pb.XXXXXXXXXX", DIR => $ENV{'TMPDIR'}, CLEANUP => 1 );
|
---|
| 334 | }
|
---|
| 335 |
|
---|
| 336 | =back
|
---|
| 337 |
|
---|
| 338 | =head1 WEB SITES
|
---|
| 339 |
|
---|
| 340 | The 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/>.
|
---|
| 341 |
|
---|
| 342 | =head1 USER MAILING LIST
|
---|
| 343 |
|
---|
| 344 | None exists for the moment.
|
---|
| 345 |
|
---|
| 346 | =head1 AUTHORS
|
---|
| 347 |
|
---|
| 348 | The Project-Builder.org team L<http://trac.project-builder.org/> lead by Bruno Cornec L<mailto:bruno@project-builder.org>.
|
---|
| 349 |
|
---|
| 350 | =head1 COPYRIGHT
|
---|
| 351 |
|
---|
| 352 | Project-Builder.org is distributed under the GPL v2.0 license
|
---|
| 353 | described in the file C<COPYING> included with the distribution.
|
---|
| 354 |
|
---|
| 355 | =cut
|
---|
| 356 |
|
---|
[2] | 357 | 1;
|
---|