* adjusted plugin-API according to recent discussion with Volker:

  + dropped pre- and post-methods as they are not really needed, since ...
  + we now bind-mount /opt/openslx into /mnt/openslx of the vendor-OS chroot,
    so plugins can copy any required files from there
* cleaned up existing plugin implementations
* improved documentation for plugin developers (available via 
  'perldoc os-plugins/OpenSLX/OSPlugins/Base.pm').


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

4 files changed, 63 insertions, 124 deletions

diff --git a/os-plugins/plugins/example/OpenSLX/OSPlugin/example.pm b/os-plugins/plugins/example/OpenSLX/OSPlugin/example.pm
index 8f9dd620..69c5c2c7 100644
--- a/os-plugins/plugins/example/OpenSLX/OSPlugin/example.pm
+++ b/os-plugins/plugins/example/OpenSLX/OSPlugin/example.pm
@@ -96,89 +96,59 @@ sub getAttrInfo
 	};
 }
 
-sub preInstallationPhase
-{	# called before chrooting into vendor-OS root, should be used if any files
-	# have to be downloaded outside of the chroot (which might be necessary
-	# if the required files can't be installed via the meta-packager)
-	my $self = shift;
-	my $pluginRepositoryPath = shift;
-		# the folder where the stage1-plugin should store all files
-		# required by the corresponding stage3 runlevel script
-	my $pluginTempPath = shift;
-		# a temporary playground that will be cleaned up automatically
-	
-	# in this example plugin, there's no need to do anything here ...
-	
-	# uncomment the following if you need to copy files
-	## get path of files we need to install
-	#my $pluginName = $self->{'name'};
-
-	##my $pluginFilesPath
-	#	= "$openslxConfig{'base-path'}/lib/plugins/$pluginName/files";
-
-	## copy all needed files now
-	#my @files = ("file1", "file2");
-	#foreach my $file (@files) {
-	#	copyFile("$pluginFilesPath/$file", "$pluginRepositoryPath");
-	#}
-}
-
 sub installationPhase
-{	# called while chrooted to the vendor-OS root, most plugins will do all
-	# their installation work here
+{	# called while chrooted to the vendor-OS root in order to give the plugin
+	# a chance to install required files into the vendor-OS.
 	my $self = shift;
 	
-	# name of current os
-	# $self->{'os-plugin-engine'}->{'vendor-os-name'} 
-	
 	my $pluginRepositoryPath = shift;
-		# the repository folder, this time from inside the chroot
+		# The folder where the stage1-plugin should store all files
+		# required by the corresponding stage3 runlevel script.
+		# As this method is being executed while chrooted into the vendor-OS,
+		# this path is relative to that root (i.e. directly usable).
 	my $pluginTempPath = shift;
-		# the temporary folder, this time from inside the chroot
+		# A temporary playground that will be cleaned up automatically.
+		# As this method is being executed while chrooted into the vendor-OS,
+		# this path is relative to that root (i.e. directly usable).
+	my $openslxPath = shift;
+		# the openslx base path bind-mounted into the chroot (/mnt/openslx)
 	
 	# for this example plugin, we simply create two files:
 	spitFile("$pluginRepositoryPath/right", "(-;\n");
 	spitFile("$pluginRepositoryPath/left", ";-)\n");
-}
 
-sub postInstallationPhase
-{	# called after having returned from chrooted environment, should be used
-	# to cleanup any leftovers, if any such thing is necessary
-	my $self                 = shift;
-	my $pluginRepositoryPath = shift;
-	my $pluginTempPath       = shift;
-	
-	# in this example plugin, there's no need to do anything here ...
-}
+	# Some plugins have to copy files from their plugin folder into the
+	# vendor-OS. In order to make this possible while chrooted, the host's
+	# /opt/openslx folder will be mounted to /mnt/openslx in the vendor-OS. 
+	# So each plugin could copy some files like this:
+	#
+	# # get our own name:
+	# my $pluginName = $self->{'name'};
+	#
+	# # get our own base path:
+	# my $pluginBasePath = "/mnt/openslx/lib/plugins/$pluginName";
+	#     
+	# # copy all needed files now:
+	# foreach my $file ( qw( file1, file2 ) ) {
+	#     copyFile("$pluginBasePath/$file", "$pluginRepositoryPath/");
+	# }
 
-sub preRemovalPhase
-{	# called before chrooting into vendor-OS root, should be used if any
-	# preparations outside of the chroot have to be made before the plugin 
-	# can be removed
-	my $self = shift;
-	my $pluginRepositoryPath = shift;
-		# the folder where the stage1-plugin has stored all files
-		# required by the corresponding stage3 runlevel script
-	my $pluginTempPath = shift;
-		# a temporary playground that will be cleaned up automatically
+	# name of current os
+	# $self->{'os-plugin-engine'}->{'vendor-os-name'} 
+
+	return;
 }
 
 sub removalPhase
-{	# called while chrooted to the vendor-OS root, most plugins will do all
-	# their uninstallation work here
+{	# called while chrooted to the vendor-OS root in order to give the plugin
+	# a chance to uninstall no longer required files from the vendor-OS.
 	my $self = shift;
 	my $pluginRepositoryPath = shift;
-		# the repository folder, this time from inside the chroot
+		# the repository folder, relative to the vendor-OS root
 	my $pluginTempPath = shift;
-		# the temporary folder, this time from inside the chroot
-}
+		# the temporary folder, relative to the vendor-OS root
 
-sub postRemovalPhase
-{	# called after having returned from chrooted environment, should be used
-	# to cleanup any leftovers, if any such thing is necessary
-	my $self                 = shift;
-	my $pluginRepositoryPath = shift;
-	my $pluginTempPath       = shift;
+	return;
 }
 
 1;
diff --git a/os-plugins/plugins/theme/OpenSLX/OSPlugin/theme.pm b/os-plugins/plugins/theme/OpenSLX/OSPlugin/theme.pm
index 4bd83c69..11bef626 100644
--- a/os-plugins/plugins/theme/OpenSLX/OSPlugin/theme.pm
+++ b/os-plugins/plugins/theme/OpenSLX/OSPlugin/theme.pm
@@ -49,15 +49,10 @@ sub getInfo
 }
 
 sub getAttrInfo
-{	# returns a hash-ref with information about all attributes supported
-	# by this specific plugin
+{
 	my $self = shift;
 
-	# This default configuration will be added as attributes to the default
-	# system, such that it can be overruled for any specific system by means
-	# of slxconfig.
 	return {
-		# attribute 'active' is mandatory for all plugins
 		'theme::active' => {
 			applies_to_systems => 1,
 			applies_to_clients => 0,
@@ -68,7 +63,6 @@ sub getAttrInfo
 			content_descr => '1 means active - 0 means inactive',
 			default => '1',
 		},
-		# attribute 'precedence' is mandatory for all plugins
 		'theme::precedence' => {
 			applies_to_systems => 1,
 			applies_to_clients => 0,
diff --git a/os-plugins/plugins/vmchooser/OpenSLX/OSPlugin/vmchooser.pm b/os-plugins/plugins/vmchooser/OpenSLX/OSPlugin/vmchooser.pm
index 3d26ef55..406e18e6 100644
--- a/os-plugins/plugins/vmchooser/OpenSLX/OSPlugin/vmchooser.pm
+++ b/os-plugins/plugins/vmchooser/OpenSLX/OSPlugin/vmchooser.pm
@@ -8,6 +8,9 @@
 #
 # General information about OpenSLX can be found at http://openslx.org/
 # -----------------------------------------------------------------------------
+# vmchooser.pm
+#	- allows user to pick from a list of virtual machin images
+# -----------------------------------------------------------------------------
 package OpenSLX::OSPlugin::vmchooser;
 
 use strict;
@@ -18,11 +21,6 @@ use base qw(OpenSLX::OSPlugin::Base);
 use OpenSLX::Basics;
 use OpenSLX::Utils;
 
-################################################################################
-# if you have any questions regarding the concept of OS-plugins and their
-# implementation, please drop a mail to: ot@openslx.com, or join the IRC-channel
-# '#openslx' (on freenode).
-################################################################################
 sub new
 {
 	my $class = shift;
@@ -40,22 +38,17 @@ sub getInfo
 
 	return {
 		description => unshiftHereDoc(<<'		End-of-Here'),
-			this plugin will over a list of different, chooseable virtualmachine images
+			allows user to pick from a list of different virtual machine images
 		End-of-Here
 		mustRunAfter => [],
 	};
 }
 
 sub getAttrInfo
-{	# returns a hash-ref with information about all attributes supported
-	# by this specific plugin
+{
 	my $self = shift;
 
-	# This default configuration will be added as attributes to the default
-	# system, such that it can be overruled for any specific system by means
-	# of slxconfig.
 	return {
-		# attribute 'active' is mandatory for all plugins
 		'vmchooser::active' => {
 			applies_to_systems => 0,
 			applies_to_clients => 0,
@@ -66,7 +59,6 @@ sub getAttrInfo
 			content_descr => '1 means active - 0 means inactive',
 			default => '1',
 		},
-		# attribute 'precedence' is mandatory for all plugins
 		'vmchooser::precedence' => {
 			applies_to_systems => 1,
 			applies_to_clients => 1,
@@ -80,29 +72,4 @@ sub getAttrInfo
 	};
 }
 
-sub preInstallationPhase
-{	# called before chrooting into vendor-OS root, should be used if any files
-	# have to be downloaded outside of the chroot (which might be necessary
-	# if the required files can't be installed via the meta-packager)
-	my $self = shift;
-	my $pluginRepositoryPath = shift;
-		# the folder where the stage1-plugin should store all files
-		# required by the corresponding stage3 runlevel script
-	my $pluginTempPath = shift;
-		# a temporary playground that will be cleaned up automatically
-	
-	# uncomment the following if you need to copy files
-	## get path of files we need to install
-	#my $pluginName = $self->{'name'};
-
-	##my $pluginFilesPath
-	#	= "$openslxConfig{'base-path'}/lib/plugins/$pluginName/files";
-
-	## copy all needed files now
-	#my @files = ("file1", "file2");
-	#foreach my $file (@files) {
-	#	copyFile("$pluginFilesPath/$file", "$pluginRepositoryPath");
-	#}
-}
-
 1;
diff --git a/os-plugins/plugins/vmware/OpenSLX/OSPlugin/vmware.pm b/os-plugins/plugins/vmware/OpenSLX/OSPlugin/vmware.pm
index 91ff3289..af4df603 100644
--- a/os-plugins/plugins/vmware/OpenSLX/OSPlugin/vmware.pm
+++ b/os-plugins/plugins/vmware/OpenSLX/OSPlugin/vmware.pm
@@ -18,6 +18,8 @@ use warnings;
 
 use base qw(OpenSLX::OSPlugin::Base);
 
+use File::Path;
+
 use OpenSLX::Basics;
 use OpenSLX::Utils;
 
@@ -90,27 +92,33 @@ sub getAttrInfo
 	};
 }
 
-sub preInstallationPhase
-{	# called before chrooting into vendor-OS root, should be used if any files
-	# have to be downloaded outside of the chroot (which might be necessary
-	# if the required files can't be installed via the meta-packager)
-	my $self = shift;
+sub installationPhase
+{
+	my $self                 = shift;
 	my $pluginRepositoryPath = shift;
-		# the folder where the stage1-plugin should store all files
-		# required by the corresponding stage3 runlevel script
-	my $pluginTempPath = shift;
-		# a temporary playground that will be cleaned up automatically
+	my $pluginTempPath       = shift;
+	my $openslxPath          = shift;
 
 	# get path of files we need to install
-	my $pluginName = $self->{'name'};
-	my $pluginFilesPath
-		= "$openslxConfig{'base-path'}/lib/plugins/$pluginName/files";
+	my $pluginFilesPath = "$openslxPath/lib/plugins/$self->{'name'}/files";
 
 	# copy all needed files now
-	my @files = ("dhcpd.conf", "nat.conf", "nvram.5.0", "runvmware-v2");
+	my @files = qw( dhcpd.conf nat.conf nvram.5.0 runvmware-v2 );
 	foreach my $file (@files) {
-		copyFile("$pluginFilesPath/$file", "$pluginRepositoryPath");
+		copyFile("$pluginFilesPath/$file", $pluginRepositoryPath);
 	}
 }
 
+sub removalPhase
+{
+	my $self                 = shift;
+	my $pluginRepositoryPath = shift;
+	my $pluginTempPath       = shift;
+	my $openslxPath          = shift;
+	
+	rmtree ( [ $pluginRepositoryPath ] );
+	
+	return;
+}
+
 1;