* refactored common stuff from PrebootCD into Preboot, as there will be other

  variants, later (like PrebootDisk, etc.)
* adjusted naming to follow our style better (no more all-caps)

git-svn-id: http://svn.openslx.org/svn/openslx/openslx/trunk@2535 95ad53e4-c205-0410-b2fa-d234c58c8868

4 files changed, 228 insertions, 177 deletions

diff --git a/boot-env/OpenSLX/BootEnvironment/PREBOOT_CD.pm b/boot-env/OpenSLX/BootEnvironment/Preboot.pm
index a10a7f6b..eb6fa730 100644
--- a/boot-env/OpenSLX/BootEnvironment/PREBOOT_CD.pm
+++ b/boot-env/OpenSLX/BootEnvironment/Preboot.pm
@@ -8,10 +8,10 @@
 #
 # General information about OpenSLX can be found at http://openslx.org/
 # -----------------------------------------------------------------------------
-# BootEnvironment::PREBOOT_CD.pm
-#    - provides CD-specific implementation of the BootEnvironment API.
+# BootEnvironment::Preboot.pm
+#    - provides general preboot implementation of the BootEnvironment API.
 # -----------------------------------------------------------------------------
-package OpenSLX::BootEnvironment::PREBOOT_CD;
+package OpenSLX::BootEnvironment::Preboot;
 
 use strict;
 use warnings;
@@ -23,36 +23,8 @@ use File::Basename;
 use File::Path;
 
 use OpenSLX::Basics;
-use OpenSLX::MakeInitRamFS::Engine::PrebootCD;
 use OpenSLX::Utils;
 
-sub initialize
-{
-    my $self   = shift;
-    my $params = shift;
-    
-    return if !$self->SUPER::initialize($params);
-
-    $self->{'original-path'} = "$openslxConfig{'public-path'}/preboot-cd";
-    $self->{'target-path'}   = "$openslxConfig{'public-path'}/preboot-cd.new";
-
-    if (!$self->{'dry-run'}) {
-        mkpath([$self->{'original-path'}]);
-        rmtree($self->{'target-path'});
-        mkpath("$self->{'target-path'}/client-config");
-    }
-
-    return 1;
-}
-
-sub finalize
-{
-    my $self   = shift;
-    my $delete = shift;
-
-    return $self->SUPER::finalize($delete);
-}
-
 sub writeBootloaderMenuFor
 {
     my $self             = shift;
@@ -162,71 +134,6 @@ sub _pickSystemWithNewestKernel
     return $systemWithNewestKernel;
 }
 
-sub _createImage
-{
-    my $self   = shift;
-    my $client = shift;
-    my $info   = shift;
-    
-    vlog(
-        0, 
-        _tr(
-            "\ncreating CD-image for client %s (based on %s) ...", 
-            $client->{name}, $info->{name}
-        )
-    );
-
-    my $imageDir = "$openslxConfig{'public-path'}/images/$client->{name}";
-    mkpath($imageDir)   unless $self->{'dry-run'};
-
-    # copy static data and init script
-    my $dataDir = "$openslxConfig{'base-path'}/share/boot-env/preboot-cd";
-    slxsystem(qq{rsync -rlpt $dataDir/iso "$imageDir/"})
-        unless $self->{'dry-run'};
-
-    # copy kernel (take the one from the given system info)
-    my $kernelFile = $info->{'kernel-file'};
-    my $kernelName = basename($kernelFile);
-    slxsystem(qq{cp -p "$kernelFile" "$imageDir/iso/isolinux/vmlinuz"})
-        unless $self->{'dry-run'};
-
-    # create initramfs
-    my $initramfsName = qq{"$imageDir/iso/isolinux/initramfs"};
-    $self->_makePrebootInitRamFS($info, $initramfsName);
-
-    # write trivial isolinux config
-    my $isolinuxConfig = unshiftHereDoc(<<"    End-of-Here");
-        DEFAULT OpenSLX
-        LABEL OpenSLX
-        SAY Now loading OpenSLX preboot environment ...
-        KERNEL vmlinuz
-        APPEND initrd=initramfs
-    End-of-Here
-    spitFile("$imageDir/iso/isolinux/isolinux.cfg", $isolinuxConfig);
-
-    my $mkisoCmd = unshiftHereDoc(<<"    End-of-Here");
-        mkisofs 
-            -o "$imageDir/../$client->{name}.iso"
-            -b isolinux/isolinux.bin -no-emul-boot -boot-load-size 4 
-            -r -J -l -boot-info-table -joliet-long
-            -publisher "OpenSLX Project - http://www.openslx.org" 
-            -p "OpenSLX Project - openslx-devel\@openslx.org" 
-            -V "OpenSLX BootCD"
-            -volset "OpenSLX Project - PreBoot CD for non PXE/TFTP start of a Linux Stateless Client"
-            -c isolinux/boot.cat "$imageDir/iso"
-    End-of-Here
-    $mkisoCmd =~ s{\n\s*}{ }gms;
-    my $logFile = "$imageDir/../$client->{name}.iso.log";
-    if (slxsystem(qq{$mkisoCmd 2>"$logFile"})) {
-        my $log = slurpFile($logFile);
-        die _tr("unable to create ISO-image - log follows:\n%s", $log);
-    }
-
-#    rmtree($imageDir);
-
-    return 1;
-}
-
 sub _makePrebootInitRamFS
 {
     my $self       = shift;
@@ -262,8 +169,7 @@ sub _makePrebootInitRamFS
         $params->{'debug-level'} = $debugLevel;
     }
 
-    my $makeInitRamFSEngine 
-        = OpenSLX::MakeInitRamFS::Engine::PrebootCD->new($params);
+    my $makeInitRamFSEngine = $self->{'initramfs-factory'}->($params);
     $makeInitRamFSEngine->execute($self->{'dry-run'});
 
     # copy back kernel-params, as they might have been changed (by plugins)
diff --git a/boot-env/OpenSLX/BootEnvironment/PrebootCD.pm b/boot-env/OpenSLX/BootEnvironment/PrebootCD.pm
new file mode 100644
index 00000000..6da11577
--- /dev/null
+++ b/boot-env/OpenSLX/BootEnvironment/PrebootCD.pm
@@ -0,0 +1,119 @@
+# Copyright (c) 2008 - OpenSLX GmbH
+#
+# This program is free software distributed under the GPL version 2.
+# See http://openslx.org/COPYING
+#
+# If you have any feedback please consult http://openslx.org/feedback and
+# send your suggestions, praise, or complaints to feedback@openslx.org
+#
+# General information about OpenSLX can be found at http://openslx.org/
+# -----------------------------------------------------------------------------
+# BootEnvironment::PrebootCD.pm
+#    - provides CD-specific implementation of the BootEnvironment API.
+# -----------------------------------------------------------------------------
+package OpenSLX::BootEnvironment::PrebootCD;
+
+use strict;
+use warnings;
+
+use base qw(OpenSLX::BootEnvironment::Preboot);
+
+use Clone qw(clone);
+use File::Basename;
+use File::Path;
+
+use OpenSLX::Basics;
+use OpenSLX::MakeInitRamFS::Engine::PrebootCD;
+use OpenSLX::Utils;
+
+sub initialize
+{
+    my $self   = shift;
+    my $params = shift;
+    
+    return if !$self->SUPER::initialize($params);
+
+    $self->{'original-path'} = "$openslxConfig{'public-path'}/preboot-cd";
+    $self->{'target-path'}   = "$openslxConfig{'public-path'}/preboot-cd.new";
+
+    if (!$self->{'dry-run'}) {
+        mkpath([$self->{'original-path'}]);
+        rmtree($self->{'target-path'});
+        mkpath("$self->{'target-path'}/client-config");
+    }
+
+    $self->{'initramfs-factory'} = sub {
+        my $makeInitRamFSEngine 
+            = OpenSLX::MakeInitRamFS::Engine::PrebootCD->new(shift);
+        return $makeInitRamFSEngine;
+    };
+
+    return 1;
+}
+
+sub _createImage
+{
+    my $self   = shift;
+    my $client = shift;
+    my $info   = shift;
+    
+    vlog(
+        0, 
+        _tr(
+            "\ncreating CD-image for client %s (based on %s) ...", 
+            $client->{name}, $info->{name}
+        )
+    );
+
+    my $imageDir = "$openslxConfig{'public-path'}/images/$client->{name}";
+    mkpath($imageDir)   unless $self->{'dry-run'};
+
+    # copy static data and init script
+    my $dataDir = "$openslxConfig{'base-path'}/share/boot-env/preboot-cd";
+    slxsystem(qq{rsync -rlpt $dataDir/iso "$imageDir/"})
+        unless $self->{'dry-run'};
+
+    # copy kernel (take the one from the given system info)
+    my $kernelFile = $info->{'kernel-file'};
+    my $kernelName = basename($kernelFile);
+    slxsystem(qq{cp -p "$kernelFile" "$imageDir/iso/isolinux/vmlinuz"})
+        unless $self->{'dry-run'};
+
+    # create initramfs
+    my $initramfsName = qq{"$imageDir/iso/isolinux/initramfs"};
+    $self->_makePrebootInitRamFS($info, $initramfsName);
+
+    # write trivial isolinux config
+    my $isolinuxConfig = unshiftHereDoc(<<"    End-of-Here");
+        DEFAULT OpenSLX
+        LABEL OpenSLX
+        SAY Now loading OpenSLX preboot environment ...
+        KERNEL vmlinuz
+        APPEND initrd=initramfs
+    End-of-Here
+    spitFile("$imageDir/iso/isolinux/isolinux.cfg", $isolinuxConfig);
+
+    my $mkisoCmd = unshiftHereDoc(<<"    End-of-Here");
+        mkisofs 
+            -o "$imageDir/../$client->{name}.iso"
+            -b isolinux/isolinux.bin -no-emul-boot -boot-load-size 4 
+            -r -J -l -boot-info-table -joliet-long
+            -publisher "OpenSLX Project - http://www.openslx.org" 
+            -p "OpenSLX Project - openslx-devel\@openslx.org" 
+            -V "OpenSLX BootCD"
+            -volset "OpenSLX Project - PreBoot CD for non PXE/TFTP start of a Linux Stateless Client"
+            -c isolinux/boot.cat "$imageDir/iso"
+    End-of-Here
+    $mkisoCmd =~ s{\n\s*}{ }gms;
+    my $logFile = "$imageDir/../$client->{name}.iso.log";
+    if (slxsystem(qq{$mkisoCmd 2>"$logFile"})) {
+        my $log = slurpFile($logFile);
+        die _tr("unable to create ISO-image - log follows:\n%s", $log);
+    }
+
+    rmtree($imageDir);
+
+    return 1;
+}
+
+1;
diff --git a/boot-env/OpenSLX/MakeInitRamFS/Engine/Preboot.pm b/boot-env/OpenSLX/MakeInitRamFS/Engine/Preboot.pm
new file mode 100644
index 00000000..81074bce
--- /dev/null
+++ b/boot-env/OpenSLX/MakeInitRamFS/Engine/Preboot.pm
@@ -0,0 +1,102 @@
+# Copyright (c) 2006-2008 - OpenSLX GmbH
+#
+# This program is free software distributed under the GPL version 2.
+# See http://openslx.org/COPYING
+#
+# If you have any feedback please consult http://openslx.org/feedback and
+# send your suggestions, praise, or complaints to feedback@openslx.org
+#
+# General information about OpenSLX can be found at http://openslx.org/
+# -----------------------------------------------------------------------------
+# MakeInitialRamFS::Engine::Preboot.pm
+#    - provides driver engine for MakeInitialRamFS API, implementing the
+#      base of all preboot variants.
+# -----------------------------------------------------------------------------
+package OpenSLX::MakeInitRamFS::Engine::Preboot;
+
+use strict;
+use warnings;
+
+use base qw(OpenSLX::MakeInitRamFS::Engine::Base);
+
+use OpenSLX::Basics;
+use OpenSLX::Utils;
+
+################################################################################
+### implementation methods
+################################################################################
+sub _collectCMDs
+{
+    my $self = shift;
+    
+    $self->{CMDs} = [];
+
+    $self->_setupBuildPath();
+
+    $self->_writeInitramfsSetup();
+    $self->_writeSlxSystemConf();
+
+    $self->_copyUclibcRootfs();
+    $self->_copyVariantSpecificFiles();
+
+    $self->{distro}->applyChanges($self);
+
+    $self->_copyKernelModules();
+    
+    $self->_createInitRamFS();
+
+    return;
+}
+
+sub _setupBuildPath
+{
+    my $self = shift;
+    
+    my $buildPath = "$openslxConfig{'temp-path'}/slx-initramfs";
+    $self->addCMD("rm -rf $buildPath");
+
+    my @stdFolders = qw(
+        bin 
+        dev 
+        etc
+        lib
+        mnt 
+        proc 
+        root 
+        sbin
+        sys 
+        tmp 
+        var/lib
+        var/run
+    );
+    $self->addCMD(
+        'mkdir -p ' . join(' ', map { "$buildPath/$_"; } @stdFolders)
+    );
+    
+    $self->{'build-path'} = $buildPath;
+    
+    return;
+}
+    
+sub _copyUclibcRootfs
+{
+    my $self = shift;
+
+    my $uclibcRootfs = "$openslxConfig{'base-path'}/share/uclib-rootfs";
+    
+    my @excludes = qw(
+    );
+
+    # exclude strace unless this system is in debug mode
+    if (!$self->{'debug-level'}) {
+        push @excludes, 'strace';
+    }
+
+    my $exclOpts = join ' ', map { "--exclude $_" } @excludes;
+
+    $self->addCMD("rsync $exclOpts -rlpt $uclibcRootfs/ $self->{'build-path'}");
+    
+    return 1;
+}
+
+1;
diff --git a/boot-env/OpenSLX/MakeInitRamFS/Engine/PrebootCD.pm b/boot-env/OpenSLX/MakeInitRamFS/Engine/PrebootCD.pm
index b5714cdd..1f6aa045 100644
--- a/boot-env/OpenSLX/MakeInitRamFS/Engine/PrebootCD.pm
+++ b/boot-env/OpenSLX/MakeInitRamFS/Engine/PrebootCD.pm
@@ -10,16 +10,14 @@
 # -----------------------------------------------------------------------------
 # MakeInitialRamFS::Engine::PrebootCD.pm
 #    - provides driver engine for MakeInitialRamFS API, implementing the
-#      preboot behaviour applicable for CDs.
+#      preboot behaviour that is specific for CDs.
 # -----------------------------------------------------------------------------
 package OpenSLX::MakeInitRamFS::Engine::PrebootCD;
 
 use strict;
 use warnings;
 
-use base qw(OpenSLX::MakeInitRamFS::Engine::Base);
-
-use File::Find;
+use base qw(OpenSLX::MakeInitRamFS::Engine::Preboot);
 
 use OpenSLX::Basics;
 use OpenSLX::Utils;
@@ -27,81 +25,7 @@ use OpenSLX::Utils;
 ################################################################################
 ### implementation methods
 ################################################################################
-sub _collectCMDs
-{
-    my $self = shift;
-    
-    $self->{CMDs} = [];
-
-    $self->_setupBuildPath();
-
-    $self->_writeInitramfsSetup();
-    $self->_writeSlxSystemConf();
-
-    $self->_copyUclibcRootfs();
-    $self->_copyInit();
-
-    $self->{distro}->applyChanges($self);
-
-    $self->_copyKernelModules();
-    
-    $self->_createInitRamFS();
-
-    return;
-}
-
-sub _setupBuildPath
-{
-    my $self = shift;
-    
-    my $buildPath = "$openslxConfig{'temp-path'}/slx-initramfs";
-    $self->addCMD("rm -rf $buildPath");
-
-    my @stdFolders = qw(
-        bin 
-        dev 
-        etc
-        lib
-        mnt 
-        proc 
-        root 
-        sbin
-        sys 
-        tmp 
-        var/lib
-        var/run
-    );
-    $self->addCMD(
-        'mkdir -p ' . join(' ', map { "$buildPath/$_"; } @stdFolders)
-    );
-    
-    $self->{'build-path'} = $buildPath;
-    
-    return;
-}
-    
-sub _copyUclibcRootfs
-{
-    my $self = shift;
-
-    my $uclibcRootfs = "$openslxConfig{'base-path'}/share/uclib-rootfs";
-    
-    my @excludes = qw(
-    );
-
-    # exclude strace unless this system is in debug mode
-    if (!$self->{'debug-level'}) {
-        push @excludes, 'strace';
-    }
-
-    my $exclOpts = join ' ', map { "--exclude $_" } @excludes;
-
-    $self->addCMD("rsync $exclOpts -rlpt $uclibcRootfs/ $self->{'build-path'}");
-    
-    return 1;
-}
-
-sub _copyInit
+sub _copyVariantSpecificFiles
 {
     my $self = shift;