1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
|
# 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/
# -----------------------------------------------------------------------------
# example.pm
# - an example implementation of the OSPlugin API (i.e. an os-plugin)
# -----------------------------------------------------------------------------
package OpenSLX::OSPlugin::example;
use strict;
use warnings;
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;
my $self = {
name => 'example',
};
return bless $self, $class;
}
sub getInfo
{
my $self = shift;
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 by means
# of slxconfig.
return {
# attribute 'active' is mandatory for all plugins
'example::active' => {
applies_to_systems => 1,
applies_to_clients => 0,
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 => 0,
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 => 0,
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 installationPhase
{ # 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;
my $pluginRepositoryPath = shift;
# 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;
# 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");
# 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/");
# }
# name of current os
# $self->{'os-plugin-engine'}->{'vendor-os-name'}
return;
}
sub removalPhase
{ # 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, relative to the vendor-OS root
my $pluginTempPath = shift;
# the temporary folder, relative to the vendor-OS root
return;
}
1;
|
