PSLeftConnectService.ps1
|
# # PSLeftConnectService.ps1 # <# region Description ############################################################################### # # # File name PSLeftConnectService.ps1 # # # # Description A sample service in a standalone PowerShell script # # # # Notes The source version of PSService.ps1 is available in GitHub# # repository https://github.com/JFLarvoire/SysToolsLib/ , # # in the PowerShell subdirectory. # # I remove unnecessary code and add parts regarding SOLR # ############################################################################### #endregion #Requires -version 2 <# .SYNOPSIS A sample Windows service, in a standalone PowerShell script. .DESCRIPTION This script demonstrates how to write a Windows service in pure PowerShell. It dynamically generates a small PSService.exe wrapper, that in turn invokes this PowerShell script again for its start and stop events. .PARAMETER Start Start the service. .PARAMETER Stop Stop the service. .PARAMETER Restart Stop then restart the service. .PARAMETER Status Get the current service status: Not installed / Stopped / Running .PARAMETER Setup Install the service. .PARAMETER Remove Uninstall the service. .PARAMETER Service Run the service in the background. Used internally by the script. Do not use, except for test purposes. .PARAMETER Control Send a control message to the service thread. .PARAMETER Version Display this script version and exit. .EXAMPLE # Setup the service and run it for the first time C:\PS>.\PSLeftConnectService.ps1 -Status Not installed C:\PS>.\PSLeftConnectService.ps1 -Setup C:\PS># At this stage, a copy of PSService.ps1 is present in the path C:\PS>PSLeftConnectService -Status Stopped C:\PS>PSLeftConnectService -Start C:\PS>PSLeftConnectService -Status Running C:\PS># Load the log file in Notepad.exe for review C:\PS>notepad ${ENV:windir}\Logs\PSService.log .EXAMPLE # Stop the service and uninstall it. C:\PS>PSLeftConnectService -Stop C:\PS>PSLeftConnectService -Status Stopped C:\PS>PSService -Remove C:\PS># At this stage, no copy of PSService.ps1 is present in the path anymore C:\PS>.\PSLeftConnectService.ps1 -Status Not installed .EXAMPLE # Send a control message to the service, and verify that it received it. C:\PS>PSLeftConnectService -Control Hello C:\PS>Notepad C:\Windows\Logs\PSLeftConnectService.log # The last lines should contain a trace of the reception of this Hello message #> [CmdletBinding(DefaultParameterSetName='Status')] Param( [Parameter(ParameterSetName='Start', Mandatory=$true)] [Switch]$Start, # Start the service [Parameter(ParameterSetName='Stop', Mandatory=$true)] [Switch]$Stop, # Stop the service [Parameter(ParameterSetName='Restart', Mandatory=$true)] [Switch]$Restart, # Restart the service [Parameter(ParameterSetName='Status', Mandatory=$false)] [Switch]$Status = $($PSCmdlet.ParameterSetName -eq 'Status'), # Get the current service status [Parameter(ParameterSetName='Setup', Mandatory=$true)] [Switch]$Setup, # Install the service [Parameter(ParameterSetName='Remove', Mandatory=$true)] [Switch]$Remove, # Uninstall the service [Parameter(ParameterSetName='Service', Mandatory=$true)] [Switch]$Service, # Run the service [Parameter(ParameterSetName='Control', Mandatory=$true)] [String]$Control = $null, # Control message to send to the service [Parameter(ParameterSetName='Version', Mandatory=$true)] [Switch]$Version # Get this script version ) # modify this to update script version used by Solr Service $scriptVersion = "2024-07-09" if( -not ([Security.Principal.WindowsPrincipal] [Security.Principal.WindowsIdentity]::GetCurrent()).IsInRole([Security.Principal.WindowsBuiltInRole] "Administrator")) { Write-Warning -Message "Please run script this with Administrator rights" return } #region left connect configuration $leftConnectStartCmd = "Powershell -command @{Start-AllPipelines}" $leftConnectStopCmd = "Powershell -command @{stop-AllPipelines}" #endregion # This script name, with various levels of details $argv0 = Get-Item $MyInvocation.MyCommand.Definition $script = $argv0.basename # Ex: PSLeftConnectService $scriptName = $argv0.name # Ex: PSLeftConnectService.ps1 $scriptFullName = $argv0.fullname # Ex: C:\Temp\PSLeftConnectService.ps1 write-host $scriptFullName # Global settings $serviceName = $script # A one-word name used for net start commands $serviceDisplayName = "IBS Datalab" $ServiceDescription = "Command relay between IBS datalab en local ressources" $installDir = Split-Path (Get-Module -ListAvailable ublionconnect).path # Where to install the service files #$installDir = "${ENV:windir}\System32" # Where to install the service files $scriptCopy = "$installDir\$scriptName" $exeName = "$serviceName.exe" $exeFullName = "$installDir\$exeName" $logDir = "${ENV:windir}\Logs" # Where to log the service messages $logFile = "$logDir\$serviceName.log" $logName = "Application" # Event Log name (Unrelated to the logFile!) # Note: The current implementation only supports "classic" (ie. XP-compatble) event logs. # To support new style (Vista and later) "Applications and Services Logs" folder trees, it would # be necessary to use the new *WinEvent commands instead of the XP-compatible *EventLog commands. # Gotcha: If you change $logName to "NEWLOGNAME", make sure that the registry key below does not exist: # HKLM\System\CurrentControlSet\services\eventlog\Application\NEWLOGNAME # Else, New-EventLog will fail, saying the log NEWLOGNAME is already registered as a source, # even though "Get-WinEvent -ListLog NEWLOGNAME" says this log does not exist! # If the -Version switch is specified, display the script version and exit. if ($Version) { Write-Output $scriptVersion return } #-----------------------------------------------------------------------------# # # # Function Now # # # # Description Get a string with the current time. # # # # Notes The output string is in the ISO 8601 format, except for # # a space instead of a T between the date and time, to # # improve the readability. # # # # History # # 2015-06-11 JFL Created this routine. # # # #-----------------------------------------------------------------------------# Function Now { Param ( [Switch]$ms, # Append milliseconds [Switch]$ns # Append nanoseconds ) $Date = Get-Date $now = "" $now += "{0:0000}-{1:00}-{2:00} " -f $Date.Year, $Date.Month, $Date.Day $now += "{0:00}:{1:00}:{2:00}" -f $Date.Hour, $Date.Minute, $Date.Second $nsSuffix = "" if ($ns) { if ("$($Date.TimeOfDay)" -match "\.\d\d\d\d\d\d") { $now += $matches[0] $ms = $false } else { $ms = $true $nsSuffix = "000" } } if ($ms) { $now += ".{0:000}$nsSuffix" -f $Date.MilliSecond } return $now } #-----------------------------------------------------------------------------# # # # Function $source # # # # Description C# source of the PSService.exe stub # # # # Arguments # # # # Notes The lines commented with "SET STATUS" and "EVENT LOG" are # # optional. (Or blocks between "// SET STATUS [" and # # "// SET STATUS ]" comments.) # # SET STATUS lines are useful only for services with a long # # startup time. # # EVENT LOG lines are useful for debugging the service. # # # # History # # # #-----------------------------------------------------------------------------# $scriptCopyCname = $scriptCopy -replace "\\", "\\" # Double backslashes. (The first \\ is a regexp with \ escaped; The second is a plain string.) $source = @" using System; using System.ServiceProcess; using System.Diagnostics; using System.Runtime.InteropServices; // SET STATUS using System.ComponentModel; // SET STATUS public enum ServiceType : int { // SET STATUS [ SERVICE_WIN32_OWN_PROCESS = 0x00000010, SERVICE_WIN32_SHARE_PROCESS = 0x00000020, }; // SET STATUS ] public enum ServiceState : int { // SET STATUS [ SERVICE_STOPPED = 0x00000001, SERVICE_START_PENDING = 0x00000002, SERVICE_STOP_PENDING = 0x00000003, SERVICE_RUNNING = 0x00000004, SERVICE_CONTINUE_PENDING = 0x00000005, SERVICE_PAUSE_PENDING = 0x00000006, SERVICE_PAUSED = 0x00000007, }; // SET STATUS ] [StructLayout(LayoutKind.Sequential)] // SET STATUS [ public struct ServiceStatus { public ServiceType dwServiceType; public ServiceState dwCurrentState; public int dwControlsAccepted; public int dwWin32ExitCode; public int dwServiceSpecificExitCode; public int dwCheckPoint; public int dwWaitHint; }; // SET STATUS ] public enum Win32Error : int { // WIN32 errors that we may need to use NO_ERROR = 0, ERROR_APP_INIT_FAILURE = 575, ERROR_FATAL_APP_EXIT = 713, ERROR_SERVICE_NOT_ACTIVE = 1062, ERROR_EXCEPTION_IN_SERVICE = 1064, ERROR_SERVICE_SPECIFIC_ERROR = 1066, ERROR_PROCESS_ABORTED = 1067, }; public class Service_$serviceName : ServiceBase { // $serviceName may begin with a digit; The class name must begin with a letter private System.Diagnostics.EventLog eventLog; // EVENT LOG private ServiceStatus serviceStatus; // SET STATUS public Service_$serviceName() { ServiceName = "$serviceName"; CanStop = true; CanPauseAndContinue = false; AutoLog = true; eventLog = new System.Diagnostics.EventLog(); // EVENT LOG [ if (!System.Diagnostics.EventLog.SourceExists(ServiceName)) { System.Diagnostics.EventLog.CreateEventSource(ServiceName, "$logName"); } eventLog.Source = ServiceName; eventLog.Log = "$logName"; // EVENT LOG ] EventLog.WriteEntry(ServiceName, "$exeName $serviceName()"); // EVENT LOG } [DllImport("advapi32.dll", SetLastError=true)] // SET STATUS private static extern bool SetServiceStatus(IntPtr handle, ref ServiceStatus serviceStatus); protected override void OnStart(string [] args) { EventLog.WriteEntry(ServiceName, "$exeName OnStart() // Entry. Starting script '$scriptCopyCname' -Service"); // EVENT LOG // Set the service state to Start Pending. // SET STATUS [ // Only useful if the startup time is long. Not really necessary here for a 2s startup time. serviceStatus.dwServiceType = ServiceType.SERVICE_WIN32_OWN_PROCESS; serviceStatus.dwCurrentState = ServiceState.SERVICE_START_PENDING; serviceStatus.dwWin32ExitCode = 0; serviceStatus.dwWaitHint = 2000; // It takes about 2 seconds to start PowerShell SetServiceStatus(ServiceHandle, ref serviceStatus); // SET STATUS ] // Start a child process with another copy of this script try { Process p = new Process(); // Redirect the output stream of the child process. p.StartInfo.UseShellExecute = false; p.StartInfo.RedirectStandardOutput = true; p.StartInfo.FileName = "PowerShell.exe"; p.StartInfo.Arguments = "-ExecutionPolicy Bypass -c & '$scriptCopyCname' -Service"; // Works if path has spaces, but not if it contains ' quotes. p.Start(); // Read the output stream first and then wait. (To avoid deadlocks says Microsoft!) string output = p.StandardOutput.ReadToEnd(); // Wait for the completion of the script startup code, that launches the -Service instance p.WaitForExit(); if (p.ExitCode != 0) throw new Win32Exception((int)(Win32Error.ERROR_APP_INIT_FAILURE)); // Success. Set the service state to Running. // SET STATUS serviceStatus.dwCurrentState = ServiceState.SERVICE_RUNNING; // SET STATUS } catch (Exception e) { EventLog.WriteEntry(ServiceName, "$exeName OnStart() // Failed to start $scriptCopyCname. " + e.Message, EventLogEntryType.Error); // EVENT LOG // Change the service state back to Stopped. // SET STATUS [ serviceStatus.dwCurrentState = ServiceState.SERVICE_STOPPED; Win32Exception w32ex = e as Win32Exception; // Try getting the WIN32 error code if (w32ex == null) { // Not a Win32 exception, but maybe the inner one is... w32ex = e.InnerException as Win32Exception; } if (w32ex != null) { // Report the actual WIN32 error serviceStatus.dwWin32ExitCode = w32ex.NativeErrorCode; } else { // Make up a reasonable reason serviceStatus.dwWin32ExitCode = (int)(Win32Error.ERROR_APP_INIT_FAILURE); } // SET STATUS ] } finally { serviceStatus.dwWaitHint = 0; // SET STATUS SetServiceStatus(ServiceHandle, ref serviceStatus); // SET STATUS EventLog.WriteEntry(ServiceName, "$exeName OnStart() // Exit"); // EVENT LOG } } protected override void OnStop() { EventLog.WriteEntry(ServiceName, "$exeName OnStop() // Entry"); // EVENT LOG // Start a child process with another copy of ourselves Process p = new Process(); // Redirect the output stream of the child process. p.StartInfo.UseShellExecute = false; p.StartInfo.RedirectStandardOutput = true; p.StartInfo.FileName = "PowerShell.exe"; p.StartInfo.Arguments = "-c & '$scriptCopyCname' -Stop"; // Works if path has spaces, but not if it contains ' quotes. p.Start(); // Read the output stream first and then wait. string output = p.StandardOutput.ReadToEnd(); // Wait for the PowerShell script to be fully stopped. p.WaitForExit(); // Change the service state back to Stopped. // SET STATUS serviceStatus.dwCurrentState = ServiceState.SERVICE_STOPPED; // SET STATUS SetServiceStatus(ServiceHandle, ref serviceStatus); // SET STATUS EventLog.WriteEntry(ServiceName, "$exeName OnStop() // Exit"); // EVENT LOG } public static void Main() { System.ServiceProcess.ServiceBase.Run(new Service_$serviceName()); } } "@ write-host $source #-----------------------------------------------------------------------------# # # # Function Main # # # # Description Execute the specified actions # # # # Arguments See the Param() block at the top of this script # # # # Notes # # # # History # # # #-----------------------------------------------------------------------------# # Check if we're running as a real user, or as the SYSTEM = As a service $identity = [Security.Principal.WindowsIdentity]::GetCurrent() $userName = $identity.Name # Ex: "NT AUTHORITY\SYSTEM" or "Domain\Administrator" $authority,$name = $username -split "\\" $isSystem = $identity.IsSystem # Do not test ($userName -eq "NT AUTHORITY\SYSTEM"), as this fails in non-English systems. # Log "# `$userName = `"$userName`" ; `$isSystem = $isSystem" if ($Setup) {Log ""} # Insert one blank line to separate test sessions logs Log $MyInvocation.Line # The exact command line that was used to start us # The following commands write to the event log, but we need to make sure the PSService source is defined. New-EventLog -LogName $logName -Source $serviceName -ea SilentlyContinue # Workaround for PowerShell v2 bug: $PSCmdlet Not yet defined in Param() block $Status = ($PSCmdlet.ParameterSetName -eq 'Status') if ($Start) { # Start the service if ($isSystem) { # If running as SYSTEM, ie. invoked as a service # Do whatever is necessary to start the service script instance Log "$scriptName -Start: Starting script '$scriptFullName' -Service" Write-EventLog -LogName $logName -Source $serviceName -EventId 1001 -EntryType Information -Message "$scriptName -Start: Starting script '$scriptFullName' -Service" Start-Process PowerShell.exe -ArgumentList ("-c & '$scriptFullName' -Service; while($true) {Start-Sleep -seconds 60}") } else { Write-Output "Starting service $serviceName" Write-EventLog -LogName $logName -Source $serviceName -EventId 1002 -EntryType Information -Message "$scriptName -Start: Starting service $serviceName" Start-Service $serviceName # Ask Service Control Manager to start it } return } if ($Stop) { # Stop the service if ($isSystem) { # If running as SYSTEM, ie. invoked as a service # Do whatever is necessary to stop the service script instance Write-EventLog -LogName $logName -Source $serviceName -EventId 1003 -EntryType Information -Message "$scriptName -Stop: Stopping script $scriptName -Service" Log "$scriptName -Stop: Stopping script $scriptName -Service" #region Solr stop &$leftConnectStopCmd #endregion } else { Write-Output "Stopping service $serviceName" Write-EventLog -LogName $logName -Source $serviceName -EventId 1004 -EntryType Information -Message "$scriptName -Stop: Stopping service $serviceName" Stop-Service $serviceName # Ask Service Control Manager to stop it } return } if ($Restart) { # Restart the service & $scriptFullName -Stop & $scriptFullName -Start return } if ($Status) { # Get the current service status $spid = $null $processes = @(Get-WmiObject Win32_Process -filter "Name = 'powershell.exe'" | Where-Object { $_.CommandLine -match ".*$scriptCopyCname.*-Service" }) foreach ($process in $processes) { # There should be just one, but be prepared for surprises. $spid = $process.ProcessId Write-Output "$serviceName Process ID = $spid" } # if (Test-Path "HKLM:\SYSTEM\CurrentControlSet\services\$serviceName") {} try { $pss = Get-Service $serviceName -ea stop # Will error-out if not installed } catch { "Not Installed" return } $pss.Status if (($pss.Status -eq "Running") -and (!$spid)) { # This happened during the debugging phase Write-Error "The Service Control Manager thinks $serviceName is started, but $serviceName.ps1 -Service is not running." exit 1 } return } if ($Setup) { # Install the service # Check if it's necessary try { $pss = Get-Service $serviceName -ea stop # Will error-out if not installed # Check if this script is newer than the installed copy. if ((Get-Item $scriptCopy -ea SilentlyContinue).LastWriteTime -lt (Get-Item $scriptFullName -ea SilentlyContinue).LastWriteTime) { Write-Output "Service $serviceName is already Installed, but requires upgrade" & $scriptFullName -Remove throw "continue" } else { Write-Output "Service $serviceName is already Installed, and up-to-date" } exit 0 } catch { # This is the normal case here. Do not throw or write any error! Write-Debug "Installation is necessary" # Also avoids a ScriptAnalyzer warning # And continue with the installation. } if (!(Test-Path $installDir)) { New-Item -ItemType directory -Path $installDir | Out-Null } # Copy the service script into the installation directory if ($ScriptFullName -ne $scriptCopy) { Write-Output "Installing $scriptCopy" Copy-Item $ScriptFullName $scriptCopy } # Generate the service .EXE from the C# source embedded in this script try { Write-Output "Compiling $exeFullName" Add-Type -TypeDefinition $source -Language CSharp -OutputAssembly $exeFullName -OutputType ConsoleApplication -ReferencedAssemblies "System.ServiceProcess" -Debug:$false } catch { $msg = $_.Exception.Message Write-error "Failed to create the $exeFullName service stub. $msg" exit 1 } # Register the service Write-Output "Registering service $serviceName" $pss = New-Service $serviceName $exeFullName -DisplayName $serviceDisplayName -Description $ServiceDescription -StartupType Automatic -Credential (Get-credential) return } if ($Remove) { # Uninstall the service # Check if it's necessary try { $pss = Get-Service $serviceName -ea stop # Will error-out if not installed } catch { Write-Output "Already uninstalled" return } Stop-Service $serviceName # Make sure it's stopped # In the absence of a Remove-Service applet, use sc.exe instead. Write-Output "Removing service $serviceName" $msg = sc.exe delete $serviceName if ($LastExitCode) { Write-Error "Failed to remove the service ${serviceName}: $msg" exit 1 } else { Write-Output $msg } # Remove the installed files if (Test-Path $installDir) { foreach ($ext in ("exe", "pdb", "ps1")) { $file = "$installDir\$serviceName.$ext" if (Test-Path $file) { Write-Output "Deleting file $file" Remove-Item $file } } if (!(@(Get-ChildItem $installDir -ea SilentlyContinue)).Count) { Write-Output "Removing directory $installDir" Remove-Item $installDir } } return } if ($Service) { # Run the service Write-EventLog -LogName $logName -Source $serviceName -EventId 1005 -EntryType Information -Message "$scriptName -Service # Beginning background job" # Do the service background job try { #region Solr start Log "$scriptName Starting $leftConnectStartCmd" # &$leftConnectStartCmd start Start-AllPipelines #endregion } catch { # An exception occurred while runnning the service $msg = $_.Exception.Message $line = $_.InvocationInfo.ScriptLineNumber Log "$scriptName -Service # Error at line ${line}: $msg" } finally { # Invoked in all cases: Exception or normally by -Stop # Flush all leftover events (There may be some that arrived after we exited the while event loop, but before we unregistered the events) $events = Get-Event | Remove-Event # Log a termination event, no matter what the cause is. Write-EventLog -LogName $logName -Source $serviceName -EventId 1006 -EntryType Information -Message "$script -Service # Exiting" Log "$scriptName -Service # Exiting" } return } |