extern/shorewall_code
1
0
Fork 1
mirror of https://gitlab.com/shorewall/code.git synced 2024-12-16 03:10:39 +01:00
Code Issues Packages Projects Releases Wiki Activity

Comments and cleanup in Common Perl module

Browse Source 
git-svn-id: https://shorewall.svn.sourceforge.net/svnroot/shorewall/trunk@5948 fbd18981-670d-0410-9b5c-8dc0c1a9a2bb
This commit is contained in:
teastep 2007-04-16 19:04:13 +00:00
parent 60b3fd5976
commit 81d535fa09
1 changed files with 37 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
Shorewall-perl/Shorewall/Common.pm
View File

@ -37,7 +37,6 @@ our @EXPORT = qw(ALLIPv4
emit emit
emitj emitj
emit_unindented emit_unindented
emit_as_is
save_progress_message save_progress_message
save_progress_message_short save_progress_message_short
progress_message progress_message
@ -74,13 +73,12 @@ our $line = ''; # Current config file line
our ( $command, $doing, $done ) = qw/ compile Compiling Compiled/; #describe the current command, it's present progressive, and it's completion. our ( $command, $doing, $done ) = qw/ compile Compiling Compiled/; #describe the current command, it's present progressive, and it's completion.
our $verbose; our $verbose; # Verbosity setting. 0 = almost silent, 1 = major progress messages only, 2 = all progress messages (very noisy)
my $timestamp; my $timestamp; # If true, we are to timestamp each progress message
my $object = 0; # Object (script) file Handle Reference
my $object = 0; # Object file Handle Reference
my $lastlineblank = 0; # Avoid extra blank lines in the output my $lastlineblank = 0; # Avoid extra blank lines in the output
my $indent = ''; my $indent = ''; # Current indentation
my ( $dir, $file ); # Object's Directory and File my ( $dir, $file ); # Object's Directory and File
my $tempfile; # Temporary File Name my $tempfile; # Temporary File Name
@ -158,29 +156,30 @@ sub emit_unindented( $ ) {
} }
# #
# Write passed message to the object with no indentation or added newline. # Write a progress_message2 command with surrounding blank lines to the output file.
#
sub emit_as_is( $ ) {
print $object "$_[0]" if $object;
}
#
# Write a progress_message2 command to the output file.
# #
sub save_progress_message( $ ) { sub save_progress_message( $ ) {
emit "\nprogress_message2 @_\n" if $object; emit "\nprogress_message2 @_\n" if $object;
} }
#
# Write a progress_message command to the output file.
#
sub save_progress_message_short( $ ) { sub save_progress_message_short( $ ) {
emit "progress_message $_[0]" if $object; emit "progress_message $_[0]" if $object;
} }
#
# Print the current TOD to STDOUT.
#
sub timestamp() { sub timestamp() {
my ($sec, $min, $hr) = ( localtime ) [0,1,2]; my ($sec, $min, $hr) = ( localtime ) [0,1,2];
printf '%02d:%02d:%02d ', $hr, $min, $sec; printf '%02d:%02d:%02d ', $hr, $min, $sec;
} }
#
# Write a message if $verbose >= 2
#
sub progress_message { sub progress_message {
if ( $verbose > 1 ) { if ( $verbose > 1 ) {
timestamp if $timestamp; timestamp if $timestamp;
@ -190,6 +189,9 @@ sub progress_message {
} }
} }
#
# Write a message if $verbose >= 1
#
sub progress_message2 { sub progress_message2 {
if ( $verbose > 0 ) { if ( $verbose > 0 ) {
timestamp if $timestamp; timestamp if $timestamp;
@ -197,6 +199,9 @@ sub progress_message2 {
} }
} }
#
# Write a message if $verbose >= 0
#
sub progress_message3 { sub progress_message3 {
if ( $verbose >= 0 ) { if ( $verbose >= 0 ) {
timestamp if $timestamp; timestamp if $timestamp;
@ -233,6 +238,9 @@ sub copy( $ ) {
} }
} }
#
# This one handles line continuation.
sub copy1( $ ) { sub copy1( $ ) {
if ( $object ) { if ( $object ) {
my $file = $_[0]; my $file = $_[0];
@ -257,6 +265,10 @@ sub copy1( $ ) {
} }
} }
#
# Create the temporary object file -- the passed file name is the name of the final file.
# We create a temporary file in the same directory so that we can use rename to finalize it.
#
sub create_temp_object( $ ) { sub create_temp_object( $ ) {
my $objectfile = $_[0]; my $objectfile = $_[0];
my $suffix; my $suffix;
@ -278,7 +290,7 @@ sub create_temp_object( $ ) {
( $object, $tempfile ) = tempfile ( 'tempfileXXXX' , DIR => $dir ); ( $object, $tempfile ) = tempfile ( 'tempfileXXXX' , DIR => $dir );
}; };
die $@ if $@; die if $@;
$file = "$file.$suffix" if $suffix; $file = "$file.$suffix" if $suffix;
$dir .= '/' unless substr( $dir, -1, 1 ) eq '/'; $dir .= '/' unless substr( $dir, -1, 1 ) eq '/';
@ -286,6 +298,9 @@ sub create_temp_object( $ ) {
} }
#
# Finalize the object file
#
sub finalize_object( $ ) { sub finalize_object( $ ) {
my $export = $_[0]; my $export = $_[0];
close $object; close $object;
@ -295,6 +310,9 @@ sub finalize_object( $ ) {
progress_message3 "Shorewall configuration compiled to $file" unless $export; progress_message3 "Shorewall configuration compiled to $file" unless $export;
} }
#
# Create the temporary aux config file.
#
sub create_temp_aux_config() { sub create_temp_aux_config() {
eval { eval {
( $object, $tempfile ) = tempfile ( 'tempfileXXXX' , DIR => $dir ); ( $object, $tempfile ) = tempfile ( 'tempfileXXXX' , DIR => $dir );
@ -304,6 +322,9 @@ sub create_temp_aux_config() {
} }
#
# Finalize the aux config file.
#
sub finalize_aux_config() { sub finalize_aux_config() {
close $object; close $object;
$object = 0; $object = 0;