Antigen Retrieve Update Number

Antigen_Retrieve_Update_Number.NoHost (WriteActionModuleType)

Retrieves the Update Version number for an engine from the registry

Element properties:

TypeWriteActionModuleType
IsolationAny
AccessibilityInternal
RunAsDefault
InputTypeSystem.BaseData
Comment{A6ED25F4-E15B-454F-9BEF-FC15F57FE70A}

Member Modules:

ID Module Type TypeId RunAs 
RunScriptAction WriteAction System.Mom.BackwardCompatibility.NoHost.ScriptResponse Default

Overrideable Parameters:

IDParameterTypeSelectorDisplay NameDescription
Enginestring$Config/Parameters/Engine$EngineSpecify engine name or "null" if engine name is retrieved from state variable
TextLogstring$Config/Parameters/TextLog$TextLogEnable / Disable text file logging in the script

Source Code:

<WriteActionModuleType ID="Antigen_Retrieve_Update_Number.NoHost" Accessibility="Internal" Comment="{A6ED25F4-E15B-454F-9BEF-FC15F57FE70A}">
<Configuration>
<IncludeSchemaTypes>
<SchemaType>MomBackwardCompatibility!System.Mom.BackwardCompatibility.AlertGenerationSchema</SchemaType>
</IncludeSchemaTypes>
<xsd:element xmlns:xsd="http://www.w3.org/2001/XMLSchema" name="AlertGeneration" type="AlertGenerationType"/>
<xsd:element xmlns:xsd="http://www.w3.org/2001/XMLSchema" name="InvokerType" type="xsd:integer"/>
<xsd:element xmlns:xsd="http://www.w3.org/2001/XMLSchema" name="Parameters" minOccurs="0">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="Engine" type="xsd:string" minOccurs="0"/>
<xsd:element name="TextLog" type="xsd:string" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</Configuration>
<OverrideableParameters>
<OverrideableParameter ID="Engine" Selector="$Config/Parameters/Engine$" ParameterType="string"/>
<OverrideableParameter ID="TextLog" Selector="$Config/Parameters/TextLog$" ParameterType="string"/>
</OverrideableParameters>
<ModuleImplementation>
<Composite>
<MemberModules>
<WriteAction ID="RunScriptAction" TypeID="MomBackwardCompatibility!System.Mom.BackwardCompatibility.NoHost.ScriptResponse">
<AlertGeneration>$Config/AlertGeneration$</AlertGeneration>
<InvokerType>$Config/InvokerType$</InvokerType>
<Body><Script>

'*******************************************************************************************
'*
'* File Name:
'* ---------
'* AntigenRetrieveUpdateNumber.vbs
'* $Revision: 5 $
'*
'* Purpose:
'* --------
'* Retrieves Update Number From Registry after an Engine Update
'*
'* Parameters:
'* -----------
'* TextLog
'*
'* Parameter definitions:
'* ----------------------
'* 1. TextLog =&gt; defines whether this scripts logs entries to a text file under the local
'* Antigen installation folder. Possible Values are true ; false
'*
'*******************************************************************************************


' Constant for controlling text file operations

Const FOR_READING = 1

'Registry Constants

Const HIVE = "HKEY_LOCAL_MACHINE\"
Const REG_KEY = "SOFTWARE\Sybari Software\"
Const NAME_KEY = "SYSTEM\CurrentControlSet\Control\ComputerName\ComputerName\"

' Error Constants
INSTALL_PATH_FAIL = 9501
ENG_UPDATE_NUM = 9525

Public AntigenInstallPath

' Retrieve script parameters

TextLogParameter = ScriptContext.Parameters.Get("TextLog")
EngineParameter = ScriptContext.Parameters.Get("Engine")

AntigenInstallPath = RetrieveRegValue (REG_KEY &amp; "Antigen For Exchange","InstalledPath", 1)
InstalledProduct = "Antigen For Exchange"

If IsNull(AntigenInstallPath) Then
AntigenInstallPath = RetrieveRegValue (REG_KEY &amp; "Antigen For SMTP","InstalledPath", 1)
InstalledProduct = "Antigen For SMTP"
End If

If IsNull(AntigenInstallPath) Then
WriteMOMEvent "TASK ERROR: Unable To Retrieve Antigen Installation Path", 1, INSTALL_PATH_FAIL
ScriptContext.Quit
End If

If EngineParameter = "null" Then
Description = State.get("DescriptionParameter")
EngineName = StripEngineName(Description)
Else
EngineName = EngineParameter
End If


If TextLogParameter = "true" then
CreateLogFolder(AntigenInstallPath)
End If

WriteLog "NULL"
WriteLog "Beginning Execution of RetrieveUpdateNumber Script to retrieve " &amp; EngineName &amp; " Update Number"

UpdateRegPath = REG_KEY &amp; InstalledProduct &amp; "\Scan Engines\" &amp; EngineName
ScriptContext.Sleep (15000)

UpdateNumber = RetrieveRegValue (UpdateRegPath, "Update Version", 2)

'If Update number is null, the engine was not found in the registry
If IsNull(UpdateNumber) or UpdateNumber = "" Then
WriteLog "WARNING: " &amp; EngineName &amp; " engine was not found on " &amp; ScriptContext.TargetComputer
WriteMOMEvent "WARNING: " &amp; EngineName &amp; " engine was not found on " &amp; ScriptContext.TargetComputer &amp; ". Update number could not be retrieved.", 2, NULL
ScriptContext.Quit
End If

WriteLog EngineName &amp; " Update Version = '" &amp; UpdateNumber &amp; "'"
WriteMOMEvent EngineName &amp; " Update Version = " &amp; UpdateNumber, 4, ENG_UPDATE_NUM

WriteLog "Finished Execution of RetrieveUpdateNumber Script"

'********************************************************************
'*
'* Function: StripEngineName
'*
'* Purpose: Strips Engine Name from Event descrition Text
'*
'********************************************************************

Function StripEngineName (EventText)

i = 1

Do While Mid(EventText, i, 1) &lt;&gt; " "
i = i + 1
loop

FirstChar = i + 1
j = i

Do
j = j + 1
Loop Until Mid(EventText, j, 1) = " "

StripEngineName = Mid(EventText, FirstChar, j-FirstChar)

End Function

'***********************************************************************
'*
'* Function: CreateLogFolder()
'*
'* Purpose: Creates Log subfolder under Antigen
'*
'***********************************************************************

Function CreateLogFolder (AntigenInstallPath)

Dim objFSO
set objFSO = CreateObject ("Scripting.FileSystemObject")

If objFSO.FolderExists(AntigenInstallPath &amp; "\MOMLogs") = 0 then
objFSO.CreateFolder(AntigenInstallPath &amp; "\MOMLogs")
End If

Set objFSP = Nothing

End Function


'***********************************************************************
'*
'* Function: WriteLog()
'*
'* Purpose: Writes script activity and errors to a log file
'*
'***********************************************************************

Function WriteLog (strLogText)

Dim objfs
Dim objf
Dim strTimeStamp

If TextLogParameter = "true" Then

On Error Resume Next
Err.Clear

Set objfs = CreateObject("Scripting.FileSystemObject")
Set objf = objfs.OpentextFile(AntigenInstallPath &amp; "\MOMLogs\" &amp; "Tasks.log", 8, False)


' If log file doesn't exist - create it
If Err.Number &lt;&gt; 0 Then
Set objf = objfs.CreatetextFile(AntigenInstallPath &amp; "\MOMLogs\" &amp; "Tasks.log", False)
Err.Clear
End If

If strLogText = "NULL" then
objf.WriteLine("")
Else
strTimeStamp = Date &amp; " " &amp; Time &amp; " "
objf.WriteLine(strTimeStamp &amp; strLogText)
End If
End If

Set objfs = Nothing
Set objf = Nothing

End Function


'********************************************************************
'*
'* Function: RetrieveRegValue
'*
'* Purpose: Retrieves String Value from Registry
'*
'********************************************************************

Function RetrieveRegValue (Key, strValueName, intValueType)

' intValueType -&gt; 1 = String Value
' -&gt; 2 = DWORD Value

const HKEY_LOCAL_MACHINE = &amp;H80000002
Dim strServerName
Dim objReg
Dim strRegValue


On Error Resume Next
Err.Clear
Set objReg=GetObject("winmgmts:\root\default:StdRegProv")
If Err.Number &lt;&gt; 0 Then
Err.Clear
strRegValue = NULL
Else

Select Case intValueType
Case 1
strErr = objReg.GetStringValue (HKEY_LOCAL_MACHINE, Key, strValueName, strRegValue)

Case 2
strErr = objReg.GetDWORDValue (HKEY_LOCAL_MACHINE, Key, strValueName, strRegValue)

End Select

' if reading the registry fails via wmi return error

If strErr &lt;&gt; 0 then
strRegValue = NULL
End If
End If

Set objReg = Nothing

RetrieveRegValue = strRegValue

End Function


'***********************************************************************
'*
'* Function: WriteMOMEvent()
'*
'* Purpose: Writes events to MOM EventLog
'*
'***********************************************************************

Function WriteMOMEvent(EventMessage, EventType, EventNumber)

Dim objEvt
Set objEvt = ScriptContext.CreateEvent

objEvt.Message = EventMessage
objEvt.EventType = EventType

If Not IsNull(EventNumber) Then
objEvt.EventNumber = EventNumber
End If

ScriptContext.Submit(objEvt)

set objEvt = Nothing

End Function
</Script></Body>
<Language>VBScript</Language>
<Name>Antigen Retrieve Update Number</Name>
<Parameters>
<Parameter>
<Name>Engine</Name>
<Value>$Config/Parameters/Engine$</Value>
</Parameter>
<Parameter>
<Name>TextLog</Name>
<Value>$Config/Parameters/TextLog$</Value>
</Parameter>
</Parameters>
<ManagementPackId>[Microsoft.Antigen.v9,,1.0.0.1]</ManagementPackId>
</WriteAction>
</MemberModules>
<Composition>
<Node ID="RunScriptAction"/>
</Composition>
</Composite>
</ModuleImplementation>
<InputType>SystemLibrary!System.BaseData</InputType>
</WriteActionModuleType>