From 530745cf3fd1c50be2c89a0f101ea8fc5bac2e9a Mon Sep 17 00:00:00 2001 From: Oliver Tappe Date: Tue, 8 Jan 2008 15:50:42 +0000 Subject: * implemented automatic synchronization of new/changed attributes (either from core or plugins) into the default system * reworked the way plugins pass out their attribute info git-svn-id: http://svn.openslx.org/svn/openslx/trunk@1451 95ad53e4-c205-0410-b2fa-d234c58c8868 --- os-plugins/OpenSLX/OSPlugin/Base.pm | 130 +++++++++++++++++++++ os-plugins/OpenSLX/OSPlugin/Engine.pm | 52 +++++++++ os-plugins/OpenSLX/OSPlugin/Roster.pm | 56 +++++++++ .../plugins/Example/OpenSLX/OSPlugin/Example.pm | 111 ++++++++++++------ .../plugins/VMware/OpenSLX/OSPlugin/VMware.pm | 87 ++------------ 5 files changed, 324 insertions(+), 112 deletions(-) create mode 100644 os-plugins/OpenSLX/OSPlugin/Base.pm create mode 100644 os-plugins/OpenSLX/OSPlugin/Roster.pm (limited to 'os-plugins') diff --git a/os-plugins/OpenSLX/OSPlugin/Base.pm b/os-plugins/OpenSLX/OSPlugin/Base.pm new file mode 100644 index 00000000..0f2123d7 --- /dev/null +++ b/os-plugins/OpenSLX/OSPlugin/Base.pm @@ -0,0 +1,130 @@ +# Copyright (c) 2006, 2007 - 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/ +# ----------------------------------------------------------------------------- +# Base.pm +# - provides empty base of the OpenSLX OSPlugin API. +# ----------------------------------------------------------------------------- +package OpenSLX::OSPlugin::Base; + +use strict; +use warnings; + +our $VERSION = 1.01; # API-version . implementation-version + +use OpenSLX::Basics; + +################################################################################ +# 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 +{ + confess "Creating OpenSLX::OSPlugin::Base-objects directly makes no sense!"; +} + +sub initialize +{ + my $self = shift; + + # The os-plugin-engine drives us, it provides some useful services relevant + # to installing stuff into the vendor-OS, like downloading functionality, + # access to meta-packager, ... + $self->{'os-plugin-engine'} = shift; +} + +sub getInfo +{ # returns a hash-ref with administrative information about this plugin + # (what does it do and how does it relate to other plugins) + my $self = shift; + + return { + # a short (one-liner) description of this plugin + description => '', + # a list of plugins that must have completed before this plugin can + # be executed + 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 & client + # by means of slxconfig. + return { + # attribute 'active' is mandatory for all plugins + # attribute 'precedence' is mandatory for all plugins + }; +} + +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 +} + +sub installationPhase +{ # called while chrooted to the vendor-OS root, most plugins will do all + # their installation work here + my $self = shift; + my $pluginRepositoryPath = shift; + # the repository folder, this time from inside the chroot + my $pluginTempPath = shift; + # the temporary folder, this time from inside the chroot +} + +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; +} + +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 +} + +sub removalPhase +{ # called while chrooted to the vendor-OS root, most plugins will do all + # their uninstallation work here + my $self = shift; + my $pluginRepositoryPath = shift; + # the repository folder, this time from inside the chroot + my $pluginTempPath = shift; + # the temporary folder, this time from inside the chroot +} + +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; +} diff --git a/os-plugins/OpenSLX/OSPlugin/Engine.pm b/os-plugins/OpenSLX/OSPlugin/Engine.pm index 57850229..bdf259f4 100644 --- a/os-plugins/OpenSLX/OSPlugin/Engine.pm +++ b/os-plugins/OpenSLX/OSPlugin/Engine.pm @@ -64,6 +64,9 @@ sub initialize vlog(1, "plugin path is '$self->{'plugin-path'}'"); $self->{'plugin'} = $self->_loadPlugin(); + return if !$self->{'plugin'}; + + return 1; } sub installPlugin @@ -98,6 +101,10 @@ sub installPlugin ); $self->{plugin}->postInstallationPhase($pluginRepoPath, $pluginTempPath); + + $self->_addInstalledPluginToDB(); + + return 1; } sub getPlugin @@ -119,6 +126,51 @@ sub _loadPlugin my $plugin = instantiateClass( $pluginModule, { pathToClass => $self->{'plugin-path'} } ); + return if !$plugin; + $plugin->initialize($self); + return $plugin; } + +sub _addInstalledPluginToDB +{ + my $self = shift; + + my $openslxDB = instantiateClass("OpenSLX::ConfigDB"); + $openslxDB->connect(); + my $vendorOS = $openslxDB->fetchVendorOSByFilter( { + name => $self->{'vendor-os-name'}, + } ); + if (!$vendorOS) { + die _tr( + 'unable to find vendor-OS "%s" in DB!', $self->{'vendor-os-name'} + ); + } + $openslxDB->addInstalledPlugin($vendorOS->{id}, $self->{'plugin-name'}); + $openslxDB->disconnect(); + + return 1; +} + +sub _removeInstalledPluginFromDB +{ + my $self = shift; + + my $openslxDB = instantiateClass("OpenSLX::ConfigDB"); + $openslxDB->connect(); + my $vendorOS = $openslxDB->fetchVendorOSByFilter( { + name => $self->{'vendor-os-name'}, + } ); + if (!$vendorOS) { + die _tr( + 'unable to find vendor-OS "%s" in DB!', $self->{'vendor-os-name'} + ); + } + $openslxDB->removeInstalledPlugin($vendorOS->{id}, $self->{'plugin-name'}); + $openslxDB->disconnect(); + + return 1; +} + +1; diff --git a/os-plugins/OpenSLX/OSPlugin/Roster.pm b/os-plugins/OpenSLX/OSPlugin/Roster.pm new file mode 100644 index 00000000..776907e4 --- /dev/null +++ b/os-plugins/OpenSLX/OSPlugin/Roster.pm @@ -0,0 +1,56 @@ +# Copyright (c) 2006, 2007 - 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/ +# ----------------------------------------------------------------------------- +# OSPlugin::Roster.pm +# - provides information about all available plugins +# ----------------------------------------------------------------------------- +package OpenSLX::OSPlugin::Roster; + +use strict; +use warnings; + +use OpenSLX::Basics; + +=item C + +Fetches attribute info from all available plugins and adds it to the given +hash-ref. + +=over + +=item Return Value + +1 + +=back + +=cut + +sub addAllDefaultAttributesToHash +{ + my $class = shift; + my $attrInfo = shift; + + my $pluginPath = "$openslxConfig{'base-path'}/lib/plugins"; + foreach my $modulePath (glob("$pluginPath/*")) { + next if $modulePath !~ m{/([^/]+)$}; + my $pluginName = $1; + my $class = "OpenSLX::OSPlugin::$pluginName"; + vlog(2, "loading plugin $class from path '$modulePath'"); + my $plugin = instantiateClass($class, { pathToClass => $modulePath }); + my $pluginAttrInfo = $plugin->getAttrInfo(); + foreach my $attr (keys %$pluginAttrInfo) { + $attrInfo->{$attr} = $pluginAttrInfo->{$attr}; + } + } + return 1; +} + +1; diff --git a/os-plugins/plugins/Example/OpenSLX/OSPlugin/Example.pm b/os-plugins/plugins/Example/OpenSLX/OSPlugin/Example.pm index 9ade866a..ec5dd03d 100644 --- a/os-plugins/plugins/Example/OpenSLX/OSPlugin/Example.pm +++ b/os-plugins/plugins/Example/OpenSLX/OSPlugin/Example.pm @@ -16,7 +16,7 @@ package OpenSLX::OSPlugin::Example; use strict; use warnings; -our $VERSION = 1.01; # API-version . implementation-version +use base qw(OpenSLX::OSPlugin::Base); use OpenSLX::Basics; use OpenSLX::Utils; @@ -26,8 +26,6 @@ use OpenSLX::Utils; # implementation, please drop a mail to: ot@openslx.com, or join the IRC-channel # '#openslx' (on freenode). ################################################################################ -### interface methods -################################################################################ sub new { my $class = shift; @@ -37,27 +35,63 @@ sub new return bless $self, $class; } -sub initialize +sub getInfo { my $self = shift; - # The os-plugin-engine drives us, it provides some useful services relevant - # to installing stuff into the vendor-OS, like downloading functionality, - # access to meta-packager, ... - $self->{'os-plugin-engine'} = shift; - - # Any other static initialization necessary for a plugin should be done - # here, more often than not, this will involve a configurational hash - # representing the default settings for this plugin. - # At a later stage, the user will be able to change plugin-specific settings - # (on a per-system/client basis) via slxconfig, such that the actual - # configuration will be stored in the DB. - # Currently, though, you have to change the settings here: - $self->{config} = { - 'active' => 1, # set to 0 in order to deactivate - 'precedence' => 10, # runlevel precedence - 'preferred_side' => 'left', # just a silly example - } + return { + description => unshiftHereDoc(<<' End-of-Here'), + just an exemplary plugin that prints a smiley when the client boots + 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 & client + # by means of slxconfig. + return { + # attribute 'active' is mandatory for all plugins + 'example::active' => { + applies_to_systems => 1, + applies_to_clients => 1, + description => unshiftHereDoc(<<' End-of-Here'), + should the 'Example'-plugin be executed during boot? + End-of-Here + content_regex => qr{^(0|1)$}, + content_descr => '1 means active - 0 means inactive', + default => '1', + }, + # attribute 'precedence' is mandatory for all plugins + 'example::precedence' => { + applies_to_systems => 1, + applies_to_clients => 1, + description => unshiftHereDoc(<<' End-of-Here'), + the execution precedence of the 'Example' plugin + End-of-Here + content_regex => qr{^\d\d$}, + content_descr => 'allowed range is from 01-99', + default => 50, + }, + + # plugin specific attributes start here ... + 'example::preferred_side' => { + applies_to_systems => 1, + applies_to_clients => 1, + description => unshiftHereDoc(<<' End-of-Here'), + determines to which side you have to tilt your head in order + to read the smiley + End-of-Here + content_regex => qr{^(left|right)$}, + content_descr => q{'left' will print ';-)' - 'right' will print '(-;'}, + default => 'left', + }, + }; } sub preInstallationPhase @@ -98,25 +132,34 @@ sub postInstallationPhase # in this example plugin, there's no need to do anything here ... } -sub getConfig -{ # called from the config-demuxer in order ot access the configurational - # hash, which will then be written to a file (in this case: - # /opt/openslx/plugin-conf/Example.conf), that will be transported to each - # client as part of the conf-TGZ. - my $self = shift; - - return $self->{config}; -} - 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 } sub removalPhase -{ +{ # called while chrooted to the vendor-OS root, most plugins will do all + # their uninstallation work here + my $self = shift; + my $pluginRepositoryPath = shift; + # the repository folder, this time from inside the chroot + my $pluginTempPath = shift; + # the temporary folder, this time from inside the chroot } 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; } +1; diff --git a/os-plugins/plugins/VMware/OpenSLX/OSPlugin/VMware.pm b/os-plugins/plugins/VMware/OpenSLX/OSPlugin/VMware.pm index 4167ffdd..6fddf78c 100644 --- a/os-plugins/plugins/VMware/OpenSLX/OSPlugin/VMware.pm +++ b/os-plugins/plugins/VMware/OpenSLX/OSPlugin/VMware.pm @@ -16,7 +16,7 @@ package OpenSLX::OSPlugin::VMware; use strict; use warnings; -our $VERSION = 1.01; # API-version . implementation-version +use base qw(OpenSLX::OSPlugin::Base); use OpenSLX::Basics; use OpenSLX::Utils; @@ -37,85 +37,16 @@ sub new return bless $self, $class; } -sub initialize +sub getInfo { my $self = shift; - # The os-plugin-engine drives us, it provides some useful services relevant - # to installing stuff into the vendor-OS, like downloading functionality, - # access to meta-packager, ... - $self->{'os-plugin-engine'} = shift; - - # Any other static initialization necessary for a plugin should be done - # here, more often than not, this will involve a configurational hash - # representing the default settings for this plugin. - # At a later stage, the user will be able to change plugin-specific settings - # (on a per-system/client basis) via slxconfig, such that the actual - # configuration will be stored in the DB. - # Currently, though, you have to change the settings here: - $self->{config} = { - 'active' => 0, # set to 0 in order to deactivate - 'precedence' => 10, # runlevel precedence - } -} - -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 ... -} - -sub installationPhase -{ # called while chrooted to the vendor-OS root, most plugins will do all - # their installation work here - my $self = shift; - my $pluginRepositoryPath = shift; - # the repository folder, this time from inside the chroot - my $pluginTempPath = shift; - # the temporary folder, this time from inside the chroot - - # 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 ... -} - -sub getConfig -{ # called from the config-demuxer in order ot access the configurational - # hash, which will then be written to a file (in this case: - # /opt/openslx/plugin-conf/VMware.conf), that will be transported to each - # client as part of the conf-TGZ. - my $self = shift; - - return $self->{config}; -} - -sub preRemovalPhase -{ -} - -sub removalPhase -{ -} - -sub postRemovalPhase -{ + return { + description => unshiftHereDoc(<<' End-of-Here'), + !!! descriptive text missing here !!! + End-of-Here + mustRunAfter => [], + }; } +1; -- cgit v1.2.3-55-g7522