Changeset 51

Timestamp:

05/02/08 16:00:33 (4 years ago)

Author:

bruno

Message:

• Use pb functions in scripts
• Update of concept doc
• Check errors in dploy-add2dhcp

Location:

devel

Files:

• dploy-common/lib/Dploy/Base.pm (modified) (2 diffs)
• dploy-dhcp/bin/dploy-add2dhcp (modified) (5 diffs)
• dploy-doc/concepts.odp (modified) (previous)
• dploy-pxe/bin/dploy-add2pxe (modified) (5 diffs)

devel/dploy-common/lib/Dploy/Base.pm

@@ -12 +12 @@
 use Pod::Usage;
 use English;
+use ProjectBuilder::Base;
 
 #use File::Basename;
@@ -30 +31 @@
 # any code which uses this module.
  
-our $debug = 0;
-our $LOG = \*STDOUT;
+our @ISA = qw(Exporter);
+our @EXPORT = qw(dploy_check_mac dploy_check_ip);
 
-our @ISA = qw(Exporter);
-our @EXPORT = qw(dploy_syntax $debug $LOG);
+sub dploy_check_mac {
 
-sub dploy_syntax {
+my $mac = shift;
 
-# Internal mkdir -p function
-sub dploy_mkdir_p {
-my @dir = @_;
-my $ret = mkpath(@dir, 0, 0755);
-return($ret);
+pb_syntax(-1,0) if (not defined $mac);
+if ($mac !~ /^(?:[[:xdigit:]]{1,2}[-:]){5}[[:xdigit:]]{1,2}$/) {
+    print "Wrong MAC address\n";
+    pb_syntax(-1,0);
+}
+# only lowercase for homogeneity in mac address
+$mac =~ tr/A-Z/a-z/;
+
+# newmac replaces : separator with - and only lowercase for dhcpd
+my $newmac = $mac;
+$newmac =~ s/:/-/g;
+
+return($newmac);
 }
 
-# Internal rm -rf function
-sub dploy_rm_rf {
-my @dir = @_;
-my $ret = rmtree(@dir, 0, 0);
-return($ret);
+sub dploy_check_ip {
+
+my $ip = shift;
+my $cmt = shift;
+
+pb_syntax(-1,0) if (not defined $ip);
+if ($ip !~ /^([1-9]?\d|1\d\d|2[0-4]\d|25[0-5])\.([1-9]?\d|1\d\d|2[0-4]\d|25[0-5])\.([1-9]?\d|1\d\d|2[0-4]\d|25[0-5])\.([1-9]?\d|1\d\d|2[0-4]\d|25[0-5])$/) {
+        print "$cmt\n";
+        pb_syntax(-1,0);
+    }
 }
 
-# Internal system function
-sub dploy_system {
-
-my $cmd=shift;
-my $cmt=shift || $cmd;
-
-dploy_log(0,"$cmt... ");
-#system("$cmd 2>&1 > $ENV{'PBTMP'}/system.log");
-system($cmd);
-dploy_log(1,"Executing $cmd\n");
-my $res = $?;
-if ($res == -1) {
-    dploy_log(0,"failed to execute ($cmd) : $!\n");
-    dploy_display_file("$ENV{'PBTMP'}/system.log");
-} elsif ($res & 127) {
-    dploy_log(0, "child ($cmd) died with signal ".($? & 127).", ".($? & 128) ? 'with' : 'without'." coredump\n");
-    dploy_display_file("$ENV{'PBTMP'}/system.log");
-} elsif ($res == 0) {
-    dploy_log(0,"OK\n");
-} else {
-    dploy_log(0, "child ($cmd) exited with value ".($? >> 8)."\n");
-    dploy_display_file("$ENV{'PBTMP'}/system.log");
-}
-return($res);
-}
-
-sub dploy_display_file {
-
-my $file=shift;
-
-return if (not -f $file);
-open(FILE,"$file");
-while (<FILE>) {
-    print $_;
-}
-close(FILE);
-}
-
-# Function which returns a pointer on a table
-# corresponding to a set of values queried in the conf file
-# and test the returned vaue as they need to exist in that case
-sub dploy_conf_get {
-
-my @param = @_;
-my @return = dploy_conf_get_if(@param);
-
-die "No params found for $ENV{'PBPROJ'}" if (not @return);
-
-foreach my $i (0..$#param) {
-    die "No $param[$i] defined for $ENV{'PBPROJ'}" if (not defined $return[$i]);
-}
-return(@return);
-}
-
-# Function which returns a pointer on a table
-# corresponding to a set of values queried in the conf file
-# Those value may be undef if they do not exist
-sub dploy_conf_get_if {
-
-my @param = @_;
-
-# Everything is returned via ptr1
-my @ptr1 = ();
-my @ptr2 = ();
-@ptr1 = dploy_conf_read_if("$ENV{'PBETC'}", @param) if (defined $ENV{'PBETC'});
-@ptr2 = dploy_conf_read_if("$ENV{'PBROOTDIR'}/$ENV{'PBPROJ'}.pb", @param) if ((defined $ENV{'PBROOTDIR'}) and (defined $ENV{'PBPROJ'}));
-
-my $p1;
-my $p2;
-
-dploy_log(2,"DEBUG: dploy_conf_get param1: ".Dumper(@ptr1)."\n");
-dploy_log(2,"DEBUG: dploy_conf_get param2: ".Dumper(@ptr2)."\n");
-
-foreach my $i (0..$#param) {
-    $p1 = $ptr1[$i];
-    $p2 = $ptr2[$i];
-    # Always try to take the param from the home dir conf file in priority
-    # in order to mask what could be defined under the CMS to allow for overloading
-    if (not defined $p2) {
-        # No ref in CMS project conf file so use the home dir one.
-        $p1->{$ENV{'PBPROJ'}} = $p1->{'default'} if ((not defined $p1->{$ENV{'PBPROJ'}}) && (defined $p1->{'default'}));
-    } else {
-        # Ref found in CMS project conf file
-        if (not defined $p1) {
-            # No ref in home dir project conf file so use the CMS one.
-            $p2->{$ENV{'PBPROJ'}} = $p2->{'default'} if ((not defined $p2->{$ENV{'PBPROJ'}}) && (defined $p2->{'default'}));
-            $p1 = $p2;
-        } else {
-            # Both are defined - handling the overloading
-            if (not defined $p1->{'default'}) {
-                if (defined $p2->{'default'}) {
-                    $p1->{'default'} = $p2->{'default'};
-                }
-            }
-
-            if (not defined $p1->{$ENV{'PBPROJ'}}) {
-                if (defined $p2->{$ENV{'PBPROJ'}}) {
-                    $p1->{$ENV{'PBPROJ'}} = $p2->{$ENV{'PBPROJ'}} if (defined $p2->{$ENV{'PBPROJ'}});
-                } else {
-                    $p1->{$ENV{'PBPROJ'}} = $p1->{'default'} if (defined $p1->{'default'});
-                }
-            }
-            # Now copy back into p1 all p2 content which doesn't exist in p1
-            # p1 content (local) always has priority over p2 (project)
-            foreach my $k (keys %$p2) {
-                $p1->{$k} = $p2->{$k} if (not defined $p1->{$k});
-            }
-        }
-    }
-    $ptr1[$i] = $p1;
-}
-dploy_log(2,"DEBUG: dploy_conf_get param ptr1: ".Dumper(@ptr1)."\n");
-return(@ptr1);
-}
-
-# Function which returns a pointer on a hash
-# corresponding to a declaration (arg2) in a conf file (arg1)
-# if that conf file doesn't exist returns undef 
-sub dploy_conf_read_if {
-
-my $conffile = shift;
-my @param = @_;
-
-open(CONF,$conffile) || return((undef));
-close(CONF);
-return(dploy_conf_read($conffile,@param));
-}
-
-# Function which returns a pointer on a hash
-# corresponding to a declaration (arg2) in a conf file (arg1)
-sub dploy_conf_read {
-
-my $conffile = shift;
-my @param = @_;
-my $trace;
-my @ptr;
-my %h;
-
-open(CONF,$conffile) || die "Unable to open $conffile";
-while(<CONF>) {
-    if (/^\s*([A-z0-9-_]+)\s+([[A-z0-9-_]+)\s*=\s*(.+)$/) {
-        dploy_log(3,"DEBUG: 1:$1 2:$2 3:$3\n");
-        $h{$1}{$2}=$3;
-    }
-}
-close(CONF);
-
-for my $param (@param) {
-    push @ptr,$h{$param};
-}
-return(@ptr);
-}
-
-# Analyze a url passed and return protocol, account, password, server, port, path
-sub dploy_get_uri {
-
-my $uri = shift || undef;
-
-dploy_log(2,"DEBUG: uri:$uri\n");
-# A URL has the format protocol://[ac@]host[:port][path[?query][#fragment]].
-# Cf man URI
-my ($scheme, $authority, $path, $query, $fragment) =
-         $uri =~ m|(?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*)(?:\?([^#]*))?(?:#(.*))?| if (defined $uri);
-my ($account,$host,$port) = $authority =~ m|(?:([^\@]+)\@)?([^:]+)(:(?:[0-9]+))?| if (defined $authority);
-
-$scheme = "" if (not defined $scheme);
-$authority = "" if (not defined $authority);
-$path = "" if (not defined $path);
-$account = "" if (not defined $account);
-$host = "" if (not defined $host);
-$port = "" if (not defined $port);
-
-dploy_log(2,"DEBUG: scheme:$scheme ac:$account host:$host port:$port path:$path\n");
-return($scheme, $account, $host, $port, $path);
-}
-
-
-sub dploy_get_date {
-    
-return(localtime->sec(), localtime->min(), localtime->hour(), localtime->mday(), localtime->mon(), localtime->year(), localtime->wday(), localtime->yday(), localtime->isdst());
-}
-
-sub dploy_log {
-
-my $dlevel = shift;
-my $msg = shift;
-
-print $LOG "$msg" if ($dlevel <= $debug);
-}
-
-sub dploy_syntax {
-
-my $exit_status = shift || -1;
-my $verbose_level = shift || 0;
-
-my $filehandle = \*STDERR;
-
-$filehandle = \*STDOUT if ($exit_status == 0);
-
-pod2usage( { -message => "Dploy.org Version PBVER-PBREV\n",
-             -exitval => $exit_status  ,
-             -verbose => $verbose_level,
-             -output  => $filehandle } );
-}
-
-
 1;

devel/dploy-dhcp/bin/dploy-add2dhcp

@@ -15 +15 @@
 use Getopt::Long qw(:config auto_abbrev no_ignore_case);
 use Data::Dumper;
+use ProjectBuilder::Base;
+use Dploy::Base;
 
 my $logfile = "/var/log/dploy.err";
 my $dhcpmain = "/etc/dhcpd.conf";
-my $dhcpsub = "";
+my $dploydir = "/etc/dploy";
+
+my $dhcpsub = undef;
 my %opts;
-my $mac = "";
-my $ip = "";
-my $gw = "";
-my $dns = "";
-my $pxe = "";
-my $ntp = "";
-my $netmask = "";
-my $iprange = "";
-my $cidr = "";
+my $mac = undef;
+my $iprange = undef;
+my $cidr = undef;
+
+=pod
+
+=head1 NAME
+
+dploy-add2dhcp - Update DHCP configuration file for dploy.org
+
+=head1 DESCRIPTION
+
+dploy-add2dhcp helps you keeping your DHCP configuration up to date 
+
+=head1 SYNOPSIS
+
+dploy-add2dhcp -m MAC-address -i IP-address -n IP-netmask [-g IP-Gateway -d IP-dns-server -p IP-PXE-server -t IP-NTP-server]
+
+dploy-add2dhcp --mac MAC-address --ip IP-address --netmask IP-netmask [--gw IP-Gateway --dns IP-dns-server --pxe IP-PXE-server --time IP-NTP-server]
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-h|--help>
+
+Print a brief help message and exits.
+
+=cut
+
+pb_syntax_init("dploy-add2dhcp Version PBVER-PBREV\n");
 
 GetOptions("help|?|h" => \$opts{'h'},
-            "mac|m=s" => \$opts{'mac'},
+        "mac|m=s" => \$opts{'mac'},
         "ip|i=s" => \$opts{'ip'},
         "netmask|n=s" => \$opts{'mask'},
@@ -38 +64 @@
         "pxe|p=s" => \$opts{'pxe'},
         "time|t=s" => \$opts{'ntp'},
-    ) || dploy_syntax(-1,0);
-
-# Mac address check
-if (defined $opts{'mac'}) {
-  $mac = $opts{'mac'};
-  if ($mac !~ /^(?:[[:xdigit:]]{1,2}[-:]){5}[[:xdigit:]]{1,2}$/) {
-    print "Syntax: dploy-add2dhcp MAC ip\n";
-    exit(-1);
-  }
-}
-# only lowercase for homogeneity in mac address
-$mac =~ tr/A-Z/a-z/;
-
-# newmac replaces : separator with - and only lowercase for dhcpd
-my $newmac = $mac;
-$newmac =~ s/:/-/g;
-
-# IP address check
-if (defined $opts{'ip'}) {
-  $ip = $opts{'ip'};
-  if ($ip !~ /^([1-9]?\d|1\d\d|2[0-4]\d|25[0-5])\.([1-9]?\d|1\d\d|2[0-4]\d|25[0-5])\.([1-9]?\d|1\d\d|2[0-4]\d|25[0-5])\.([1-9]?\d|1\d\d|2[0-4]\d|25[0-5])$/) {
-    print "Syntax: dploy-add2dhcp mac IP\n";
-    exit(-1);
-  }
-}
+    ) || pb_syntax(-1,0);
 
 # Other Parameters
 if (defined $opts{'h'}) {
-  dploy_syntax(0,1);
-}
-if (defined $opts{'mask'}) {
-  $netmask = $opts{'mask'};
-}
-if (defined $opts{'gw'}) {
-  $gw = $opts{'gw'};
-}
-if (defined $opts{'pxe'}) {
-  $pxe = $opts{'pxe'};
-}
+    pb_syntax(0,1);
+}
+
+# Mandatory params checks
+$mac = dploy_check_mac($opts{'mac'});
+dploy_check_ip($opts{'ip'},"Wrong IP address");
+dploy_check_ip($opts{'mask'},"Wrong Netmask");
 
 # Calculate IP subnet
-my  $block = new Net::Netmask ($ip, $netmask);
+my  $block = new Net::Netmask($opts{'ip'}, $opts{'mask'});
 $iprange = $block->base();
 $cidr = $block->bits(); 
 
 # Check if a DHCP conf file already exist for the subnet
-$dhcpsub="/etc/dploy/dhcp-$iprange-$cidr.conf";
-if (! -d "/etc/dploy" ) {
-  mkdir ("/etc/dploy",0755);
-}
+pb_mkdir_p("$dploydir");
+$dhcpsub="$dploydir/dhcp-$iprange-$cidr.conf";
 
 if (! -e "$dhcpsub" ) {
-  # Create a DHCP file for the IP subnet
-  open(DHCPSUBNEW,"> $dhcpsub.new") || die "Unable to create $dhcpsub.new: $!";
-    print DHCPSUBNEW "subnet $iprange netmask $netmask {\n";
-    print DHCPSUBNEW "  option routers              $gw;\n";
-    if (defined $opts{'dns'}) {
-      $dns = $opts{'dns'};
-      print DHCPSUBNEW "  option domain-name-servers  $dns;\n";
-    }
-    if (defined $opts{'ntp'}) {
-      $ntp = $opts{'ntp'};
-      print DHCPSUBNEW "  option ntp-servers          $ntp;\n";
-    }
-    print DHCPSUBNEW "  next-server                 $pxe;\n";
-    print DHCPSUBNEW "  authoritative;\n";
-    print DHCPSUBNEW "  if substring(option vendor-class-identifier, 0, 20) = \"PXEClient:Arch:00000\" {\n";
-    print DHCPSUBNEW "    filename \"pxelinux.bin\";\n";
-    print DHCPSUBNEW "  } else if substring(option vendor-class-identifier, 0, 20) = \"PXEClient:Arch:00002\" {\n";
-    print DHCPSUBNEW "    filename \"elilo-ia64.efi\";\n";
-    print DHCPSUBNEW "  }\n";
-    print DHCPSUBNEW "}\n";
-  close DHCPSUBNEW;
-  move("$dhcpsub.new",$dhcpsub);
+    # there are then more mandatory parameters
+    dploy_check_ip($opts{'gw'},"Wrong IP address for GW server");
+    my $gwobj = new Net::Netmask($opts{'gw'},$opts{'mask'});
+    if (($iprange != $gwobj->base()) || ($cidr != $gwobj->bits())) {
+        print "Gateway is not in the correct subnet \n";
+        pb_syntax(-1,0);
+    }
+    # Create a DHCP file for the IP subnet
+    open(DHCPSUBNEW,"> $dhcpsub.new") || die "Unable to create $dhcpsub.new: $!";
+    print DHCPSUBNEW "subnet $iprange netmask $opts{'mask'} {\n";
+    print DHCPSUBNEW "  option routers              $opts{'gw'};\n";
+    if (defined $opts{'dns'}) {
+        dploy_check_ip($opts{'dns'},"Wrong IP address for DNS server");
+        print DHCPSUBNEW "  option domain-name-servers  $opts{'dns'};\n";
+    }
+    if (defined $opts{'ntp'}) {
+        dploy_check_ip($opts{'ntp'},"Wrong IP address for NTP server");
+        print DHCPSUBNEW "  option ntp-servers          $opts{'ntp'};\n";
+    }
+    if (defined $opts{'pxe'}) {
+        dploy_check_ip($opts{'pxe'},"Wrong IP address for PXE server");
+        print DHCPSUBNEW "  next-server                 $opts{'pxe'};\n";
+        print DHCPSUBNEW "  authoritative;\n";
+        print DHCPSUBNEW "  if substring(option vendor-class-identifier, 0, 20) = \"PXEClient:Arch:00000\" {\n";
+        print DHCPSUBNEW "    filename \"pxelinux.bin\";\n";
+        print DHCPSUBNEW "  } else if substring(option vendor-class-identifier, 0, 20) = \"PXEClient:Arch:00002\" {\n";
+        print DHCPSUBNEW "    filename \"elilo-ia64.efi\";\n";
+        print DHCPSUBNEW "  }\n";
+    }
+    print DHCPSUBNEW "}\n";
+    close DHCPSUBNEW;
+    move("$dhcpsub.new",$dhcpsub);
 }
 
@@ -149 +155 @@
         $bracket--;
     }
-    if (/host host-$newmac {/ .. /}\n/) {
+    if (/host host-$mac {/ .. /}\n/) {
         # We need to replace the old content with the new one
         print "Skip $_";
@@ -161 +167 @@
 }
 
-print DHCPSUBNEW "  host host-$newmac {\n";
-print DHCPSUBNEW "  hardware ethernet $mac;\n";
-print DHCPSUBNEW "  fixed-address $ip;\n";
+print DHCPSUBNEW "  host host-$mac {\n";
+print DHCPSUBNEW "  hardware ethernet $opts{'mac'};\n";
+print DHCPSUBNEW "  fixed-address $opts{'ip'};\n";
 print DHCPSUBNEW "  }\n";
 print DHCPSUBNEW $lastline;
@@ -172 +178 @@
 
 # Relaunch DHCP server
-system("sudo /etc/init.d/dhcpd restart");
+pb_system("sudo /etc/init.d/dhcpd restart","Restarting DHCP server");
+
+=back 
+
+=head1 WEB SITES
+
+The main Web site of the project is available at L<http://www.dploy.org/>. Bug reports should be filled using the trac instance of the project at L<http://trac.dploy.org/>.
+
+=head1 USER MAILING LIST
+
+None exists for the moment.
+
+=head1 AUTHORS
+
+The dploy.org team L<http://trac.dploy.org/>.
+
+=head1 COPYRIGHT
+
+dploy.org is distributed under the GPL v2.0 license
+described in the file C<COPYING> included with the distribution.
+
+=cut
+

devel/dploy-pxe/bin/dploy-add2pxe

@@ -18 +18 @@
 my $ksdevice = "eth0";
 my $prefix = undef;
-my $mrserver = undef;
-my $mrpath = undef;
 
 GetOptions("help|?|h" => \$opts{'h'},
@@ -35 +33 @@
 
 # temporary mountpoint
-if (not defined $ENV {'TMPDIR'}) {
-    $ENV{'TMPDIR'} = "/tmp";
-}
-my $tmp=tempdir("dploy.XXXXXXXXXX", DIR => $ENV{'TMPDIR'}, CLEANUP => 1);
-my $mnt="$tmp/iso";
-my $mnt2="$tmp/nfs";
+pb_temp_init();
+my $mnt="$ENV{'PBTMP'}/iso";
+my $mnt2="$ENV{'PBTMP'}/nfs";
 
 # Check Mac consitency 
 my $mac = dploy_check_mac($opt{'mac'});
 
-# Check URL syntax
-if (defined $opts{'url'}) {
-    $url = $opts{'url'};
-}
-
-if ($url !~ /(\w+):\/\/([^\/:]+)(:\d+)?\/(.*)/) {
-    print "Syntax: dploy-add2pxe mac URL-TO-ISO\n";
-    exit(-1);
-}
-
-# Get Mondorescue values
-$mrserver = dploy_get_url();
-$mrpath = dploy_get_url();
+my ($scheme, $account, $mrserver, $port, $mrpath) = pb_get_uri($opts{'url'});
 
 # Get the ID given by LinuxCOE/MondoRescue to prepare kernel/initrd/ks
@@ -71 +54 @@
 mkdir "$mnt",0755;
 if ($opt{'type'} == "LinuxCOE") {
-    pb_system("sudo /bin/mount -o loop $linuxcoe/$iso $mnt","Error mounting $linuxcoe/$iso");
+    pb_system("sudo /bin/mount -o loop $linuxcoe/$iso $mnt","Mounting $linuxcoe/$iso");
 } else if ($opt{'type'} == "MondoRescue") {
-    pb_system("sudo /bin/mount -t nfs $mrserver:$mrpath $mnt2","Error mountig NFS $mrserver:$mrpath");
-    pb_system("sudo /bin/mount -o loop $mnt2/$prefix-1.iso $mnt","Error mounting LOOP $mnt2/$prefix-1.iso");
+    pb_system("sudo /bin/mount -t nfs $mrserver:$mrpath $mnt2","Mountig NFS $mrserver:$mrpath");
+    pb_system("sudo /bin/mount -o loop $mnt2/$prefix-1.iso $mnt","Mounting LOOP $mnt2/$prefix-1.iso");
 } else {
     # Type passed has parameter does not contain a valid value
@@ -85 +68 @@
 
 # Get the Command Line parameters for MondoRescue restoration
+my $cliparams;
 open(ISOLINUX, "$mnt/isolinux.cfg") || die "Unable to open $mnt/isolinux.cfg for writing";
 while ( <ISOLINUX> ) {
     if (/label nuke/) {
-        my $cliparams = <ISOLINUX>;     # kernel line
+        $cliparams = <ISOLINUX>;        # kernel line
         $cliparams = <ISOLINUX>;        # append line
     }
@@ -96 +80 @@
 close ISOLINUX;
 # All done with ISO image... umounting
-pb_system("sudo /bin/umount $mnt","Error umount ISO image);
+pb_system("sudo /bin/umount $mnt","Umount ISO image");
 
 # Updates PXElinux