Skip to content

Commit

Permalink
Powershell based plugin sample
Browse files Browse the repository at this point in the history
  • Loading branch information
Tim Mackey committed Oct 1, 2013
1 parent e58ea42 commit 0211a9b
Show file tree
Hide file tree
Showing 7 changed files with 226 additions and 0 deletions.
45 changes: 45 additions & 0 deletions PowerShell/HelloWorld.ps1
@@ -0,0 +1,45 @@
#Load DLLs
[reflection.assembly]::loadwithpartialname('system.windows.forms')
$SelectedObjectNames=@();
$XenCenterNodeSelected = 0;
#the object info array contains hashmaps, each of which represent a parameter set and describe a target in the XenCenter resource list
foreach($parameterSet in $ObjInfoArray)
{
if ($parameterSet["class"] -eq "blank")
{
#When the XenCenter node is selected a parameter set is created for each of your connected servers with the class and objUuid keys marked as blank
if ($XenCenterNodeSelected)
{
continue
}
$XenCenterNodeSelected = 1;
$SelectedObjectNames += "XenCenter"
}
elseif ($parameterSet["sessionRef"] -eq "null")
{
#When a disconnected server is selected there is no session information, we get null for everything except class
$SelectedObjectNames += "a disconnected server"
}
else
{
Connect-XenServer -url $parameterSet["url"] -opaqueref $parameterSet["sessionRef"]
#Use $class to determine which server objects to get
#-properties allows us to filter the results to just include the selected object
$exp = "Get-XenServer:{0} -properties @{{uuid='{1}'}}" -f $parameterSet["class"], $parameterSet["objUuid"]
$obj = Invoke-Expression $exp
$SelectedObjectNames += $obj.name_label;
}
}
#now a bit of pretty string formatting
$NameString = "Hello from {0}" -f $SelectedObjectNames[0];
if ($SelectedObjectNames.length -gt 1)
{
#we are aiming for "name_1, name_2, name_3...name_n-1 and name_n"
for ($i=1; $i -lt $SelectedObjectNames.length - 1; $i++)
{
$NameString += ", {0}" -f $SelectedObjectNames[$i]
}
$NameString += " and {0}" -f $SelectedObjectNames[$SelectedObjectNames.length - 1]
}
#show an alert dialog with the text
[system.Windows.Forms.MessageBox]::show($NameString, "Hello World")
141 changes: 141 additions & 0 deletions PowerShell/HelloWorld.resx
@@ -0,0 +1,141 @@
<?xml version="1.0" encoding="utf-8"?>
<root>
<!--
Microsoft ResX Schema
Version 2.0
The primary goals of this format is to allow a simple XML format
that is mostly human readable. The generation and parsing of the
various data types are done through the TypeConverter classes
associated with the data types.
Example:
... ado.net/XML headers & schema ...
<resheader name="resmimetype">text/microsoft-resx</resheader>
<resheader name="version">2.0</resheader>
<resheader name="reader">System.Resources.ResXResourceReader, System.Windows.Forms, ...</resheader>
<resheader name="writer">System.Resources.ResXResourceWriter, System.Windows.Forms, ...</resheader>
<data name="Name1"><value>this is my long string</value><comment>this is a comment</comment></data>
<data name="Color1" type="System.Drawing.Color, System.Drawing">Blue</data>
<data name="Bitmap1" mimetype="application/x-microsoft.net.object.binary.base64">
<value>[base64 mime encoded serialized .NET Framework object]</value>
</data>
<data name="Icon1" type="System.Drawing.Icon, System.Drawing" mimetype="application/x-microsoft.net.object.bytearray.base64">
<value>[base64 mime encoded string representing a byte array form of the .NET Framework object]</value>
<comment>This is a comment</comment>
</data>
There are any number of "resheader" rows that contain simple
name/value pairs.
Each data row contains a name, and value. The row also contains a
type or mimetype. Type corresponds to a .NET class that support
text/value conversion through the TypeConverter architecture.
Classes that don't support this are serialized and stored with the
mimetype set.
The mimetype is used for serialized objects, and tells the
ResXResourceReader how to depersist the object. This is currently not
extensible. For a given mimetype the value must be set accordingly:
Note - application/x-microsoft.net.object.binary.base64 is the format
that the ResXResourceWriter will generate, however the reader can
read any of the formats listed below.
mimetype: application/x-microsoft.net.object.binary.base64
value : The object must be serialized with
: System.Runtime.Serialization.Formatters.Binary.BinaryFormatter
: and then encoded with base64 encoding.
mimetype: application/x-microsoft.net.object.soap.base64
value : The object must be serialized with
: System.Runtime.Serialization.Formatters.Soap.SoapFormatter
: and then encoded with base64 encoding.
mimetype: application/x-microsoft.net.object.bytearray.base64
value : The object must be serialized into a byte array
: using a System.ComponentModel.TypeConverter
: and then encoded with base64 encoding.
-->
<xsd:schema id="root" xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
<xsd:import namespace="http://www.w3.org/XML/1998/namespace" />
<xsd:element name="root" msdata:IsDataSet="true">
<xsd:complexType>
<xsd:choice maxOccurs="unbounded">
<xsd:element name="metadata">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="value" type="xsd:string" minOccurs="0" />
</xsd:sequence>
<xsd:attribute name="name" use="required" type="xsd:string" />
<xsd:attribute name="type" type="xsd:string" />
<xsd:attribute name="mimetype" type="xsd:string" />
<xsd:attribute ref="xml:space" />
</xsd:complexType>
</xsd:element>
<xsd:element name="assembly">
<xsd:complexType>
<xsd:attribute name="alias" type="xsd:string" />
<xsd:attribute name="name" type="xsd:string" />
</xsd:complexType>
</xsd:element>
<xsd:element name="data">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
<xsd:element name="comment" type="xsd:string" minOccurs="0" msdata:Ordinal="2" />
</xsd:sequence>
<xsd:attribute name="name" type="xsd:string" use="required" msdata:Ordinal="1" />
<xsd:attribute name="type" type="xsd:string" msdata:Ordinal="3" />
<xsd:attribute name="mimetype" type="xsd:string" msdata:Ordinal="4" />
<xsd:attribute ref="xml:space" />
</xsd:complexType>
</xsd:element>
<xsd:element name="resheader">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
</xsd:sequence>
<xsd:attribute name="name" type="xsd:string" use="required" />
</xsd:complexType>
</xsd:element>
</xsd:choice>
</xsd:complexType>
</xsd:element>
</xsd:schema>
<resheader name="resmimetype">
<value>text/microsoft-resx</value>
</resheader>
<resheader name="version">
<value>2.0</value>
</resheader>
<resheader name="reader">
<value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
</resheader>
<resheader name="writer">
<value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
</resheader>
<data name="hello-menu-item.description" xml:space="preserve">
<value> Displays 'Hello World' from the selected object.</value>
</data>
<data name="hello-menu-item.icon" xml:space="preserve">
<value>Plugins\Citrix\HelloWorld\HelloWorld.png </value>
</data>
<data name="hello-menu-item.label" xml:space="preserve">
<value> Hello World! </value>
</data>
<data name="HelloWorld.copyright" xml:space="preserve">
<value> © Citrix Systems Inc. 2009 </value>
</data>
<data name="HelloWorld.description" xml:space="preserve">
<value> XenServer PowerShell plugin example. </value>
</data>
<data name="HelloWorld.link" xml:space="preserve">
<value> http://community.citrix.com/xencenter</value>
</data>
<data name="String1" xml:space="preserve">
<value />
</data>
</root>
15 changes: 15 additions & 0 deletions PowerShell/HelloWorld.xcplugin.xml
@@ -0,0 +1,15 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE XenCenterPlugin PUBLIC "-//XENCENTERPLUGIN//DTD XENCENTERPLUGIN1//EN" "xencenter-1.dtd">
<XenCenterPlugin
xmlns="http://www.citrix.com/XenCenter/Plugins/schema"
version="1">
<MenuItem
name="hello-menu-item"
menu="view"
serialized="none">
<XenServerPowerShell
filename="Plugins\xenserver.org\HelloWorld\HelloWorld.ps1"
window="false"
/>
</MenuItem>
</XenCenterPlugin>
Empty file.
Binary file added PowerShell/images/HelloWorld.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
25 changes: 25 additions & 0 deletions PowerShell/make.cmd
@@ -0,0 +1,25 @@
Echo Run this make file from a Visual Sutdio Command Prompt
Echo PowerShell version 2.0 or higher is required to run this
Echo WiX 2.0 or higher is assumed installed to compile the installer
Echo Building resources ..
Del .\plugins\xenserver.org\HelloWorld\*.* /q
Del .\plugins\xenserver.org\HelloWorld\images\*.* /q
Del .\plugins\*.* /q
cd .\output
Del *.* /q
ResGen ../HelloWorld.resx HelloWorld.resources
al /t:lib /embed:HelloWorld.resources /culture:0x007F /out:HelloWorld.resoures.dll
cd ..
copy *.xml .\plugins\xenserver.org\HelloWorld
copy *.ps1 .\plugins\xenserver.org\HelloWorld
copy .\images\*.png .\plugins\xenserver.org\HelloWorld\images
copy .\output\*.dll .\plugins\xenserver.org\HelloWorld


Echo creating installer
powershell -ExecutionPolicy ByPass -File ..\PluginInstaller\Create-PluginInstaller.ps1 -out .\output\HelloWorld.msi -title "XenCenter HelloWorld Plugin" -description "Sample plugin for XenCenter" -manufacturer "XenServer.org" -upgrade_code $([System.Guid]::NewGuid().ToString())

Del .\output\*.r* /q
Del .\output\*.w* /q

Echo Done.
Empty file.

0 comments on commit 0211a9b

Please sign in to comment.