Pass parameters around in a data structure.

Instead of static variables and functions taking a dozen arguments we
now use a single data structure, nssm_service_t, for the service.

The code is easier to read and understand, especially when adding more
variables through to functions.

Added set_expand_string() and set_number().

Helper functions to set REG_EXPAND_SZ and REG_DWORD values in the
registry.

Added strip_basename() function.

Helper function to determine the parent directory of a path.

Enforce maximum report delay when starting service.

We were not changing the service's state to running until the restart
throttling threshold had passed.  However best practice is to change the
status to running or stopped as quickly as possible.  Therefore we we
now report the status after no more than 20000 milliseconds regardless
of the throttle setting.

NSSM 2.18.

Allow the Escape key to close the GUI.

Turns out IDCANCEL is a magic resource name.  If a button has that name
it automatically responds to Escape.

Don't automatically close the GUI on error.

If a parameter in the GUI was missing or invalid we were closing the
dialogue and forcing the user to relaunch the installer/remover.
Instead we now loop until the service has successfully been
installed/removed or the user cancelled the operation.

Spawn a separate thread for stop_service().

We must acknowledge a STOP or SHUTDOWN control promptly but the
termination of the application may take a significant amount of time if
one of the AppStopMethod* registry values is set.

We now spawn a separate thread to try to stop the process and to call
await_shutdown() while the main thread immediately acknowledges receipt
of the STOP request.  Once the worker thread has updated the service
status to say that application is really stopped we will be
automatically cleaned up by the system.

If for some reason we can't spawn a new thread we log an error and
ignore user-supplied timeouts so as to ensure we tidy up promptly.

Use await_shutdown().

Use the new await_shutdown() funtion to wait for the application to stop
rather than calling WaitForSingleObject() directly, so we can update the
service status periodically.

Added await_shutdown() function.

The system expects service STOP requests to be honoured promptly.  If
service shutdown will take longer than 30 seconds we must update the
service status checkpoint variable before then.

We also need to ensure that the service status wait hint time is
strictly increasing every time we update the checkpoint, otherwise the
service will be considered to be hung after 60 seconds.

Prevent buffer overrun in log_event().

We were only expecting six message strings but we could possible receive
more.

Allow overriding time to wait when trying to kill the application.

Three new registry entries can be used to specify a wait time in
milliseconds after attempting a stop method.

  AppStopMethodConsole
  AppStopMethodWindow
  AppStopMethodThreads

The default for each remains the same, 1500ms.

Thanks Russ Holmann.

Use override_milliseconds() to find throttle restart delay.

Use the new override_milliseconds() helper to find the override for the
amount of time to wait when throttling restarts.

Added override_milliseconds() helper.

Helper function to retrieve a REG_DWORD value from the registry and
assign it to a variable, substituting a default value if the registry
entry is invalid or missing.  The function is specifically tailored
toward setting a value in milliseconds, hence the name.

Calculate service stop wait hint correctly.

The wait hint when changing the service status to stopped failed to take
into account the grace period after sending a Control-C event.  It also
failed to consider the case where one or more stop methods were
disabled.

Typos and formatting etc.

NSSM 2.17.

Fix tabbing between GUI fields.

The tab key didn't switch between fields in the GUI because we didn't
insert a call to IsDialogMessage() in the message loop.

Try to throttle using a critical section.

The first implementation of service restart throttling used a condition
variable in a critical section to sleep for the required amount of time.
The implementation was changed to use a waitable timer because Windows
2000 does not support SleepConditionVariableCS() or
WakeConditionVariable().

Since we are now using LoadLibrary() and GetProcAddress() to use newer
functions dynamically without having to build OS-specific binaries, we
can now use a critical section where it's supported and fall back to a
waitable timer when running on Windows 2000.

AttachConsole() isn't available in Windows 2000.

Instead of calling AttachConsole() directory use a function pointer in
the new global imports struct.  It's safe to skip any attempt to attach
to the console when the function isn't available.

Compiler food.

Silence any compiler warnings relating to the use of _(v)snprintf() -
not _(v)snprintf_s() - and type conversions.

Updated nssm.dsp with missing dependencies.

Opening nssm.dsp in Visual Studio 2010 and accepting conversion to the
latest project format produced a project which would not build because
io.cpp, io.h, process.cpp, process.h and shlwapi.lib had not been added
to nssm.dsp.

They were present in nssm.vcproj from Visual Studio 2008 and it was
possible to load that project and convert to a format which worked.

Thanks Guy Brousseau.

Try harder not to restart the application when stopping.

Try even harder to avoid race conditions whereby one thread reacts to an
application exit and performs a restart even after another thread has
committed to handling a stop control.

Thanks Runner Mei.

Delay report that the service is running.

Wait until the application has been running for long enough to be exempt
from restart throttling before reporting a status of SERVICE_RUNNING to
the operating system.

Thanks Tom Saul.

Skip some or all methods of stopping the application.

Use the AppStopMethodSkip bit field to specify any method(s) which
should not be employed when stopping the application.

Fixed Control-C race.

A typo in kill_console() could cause the application to be restarted
when it was supposed to stop.

When kill_console() successfully generated a Control-C event and the
application exited, the function was supposed to return 0, indicating to
its parent function kill_process() that the application had been killed.

Due to a mistake in the test of WaitForSingleObject()'s return code,
kill_console() would instead return non-zero when the application exited
in response to Control-C.  This would lead NSSM to continue with other
methods of trying to kill the application, leading to a race when
another thread detected that the application had exited without
recognising that it had done so in response to a stop control.

Thanks Barrett Lewis.

Rudimentary file versioning.

Embed file version info in the resource file so that right-clicking the
executable shows the application version.

Unfortunately the version field must be formatted in a particular way so
we can't reuse the NSSM_VERSION #define from nssm.h but instead must
create a new #define and remember to update it when making a release.

Thanks fREW Schmidt.

Fixed missing io.cpp and io.h.

The files were inadvertently not pushed along with the stream
redirection code.

Thanks Runner Mei.

Notes on escaping quotes.

Brian Baxter points out that to install a service from the command
prompt with quotes in the options it is necessary to quote the quotes as
follows:

  nssm install service "c:\Program Files\app.exe" """C:\Path with spaces"""

Allow specifying output streams.

Allow starting the monitor application with one or more of stdin,
stdout and stderr redirected to a file or anything which can be
opened with CreateFile().

New registry values corresponding to CreateFile() arguments for
stdin (and analogously for stdout and stderr):

AppStdin: Path to open.
AppStdinShareMode: Sharing mode.
AppStdinCreationDisposition: Creation disposition.
AppStdinFlagsAndAtrributes: Flags and attributes.

All are optional.  If no path is given for a particular stream it
will not be redirected.  If a path is given but any of the other
values are omitted they will receive sensible defaults.

Overload expand_parameter() like get_number().

Allow expand_parameter() to accept the optional must_exist flag.

Added get_number() helper.

Retrieve a number (specifically an unsigned long) from the registry.
Allow the value to be optional by setting the must_exist parameter.
Overload the function definition such that must_exist can be omitted.

Try to send Control-C event to application console.

Try to attach to the application's console and send a Control-C event when
shutting down.  If a console exists, is successfully attached and successfully
sent the event, allow a grace period for the application to exit before sending
window messages or eventually calling TerminateProcess().

Now console applications which register shutdown handlers, such as java
launched from a batch file, have a chance to clean up and shut down gracefully.

Thanks Eric Cheldelin.

Fix build on Visual Studio Express.

Visual Studio Express doesn't ship with MFC so the afxres.h header isn't
available.  Since we don't actually use it, it's safe to replace that
header with a standard #include and #define.

Note that Visual Studio Express also ships without mc.exe so you will
also need to download the Windows SDK and set up your PATH in order to
build NSSM.

Ignore INTERROGATE control.

NSSM periodically logs that it received an unhandled INTERROGATE
control.  The control is sent by the system to request an update of the
service's status but NSSM always keeps the status up-to-date so no
action is needed on receipt of the control.

Rather than fill the logs with instances of such a message, NSSM will
now simply ignore the INTERROGATE control silently.

NSSM 2.16.

Fixed crash when stopping the service.

NSSM tidies up by looking for processes whose parent PID matches the PID
of the monitored application.  Because process IDs are reused, however,
it's possible for NSSM to kill a process which was not a child of the
monitored application if that process had a now-exited parent process
whose PID was reused.  On UNIX the PPID would show as 1 for an orphaned
process but under Windows, at least when querying a process with the
Toolhelp32 toolkit, we see the original PPID of the process even if the
parent is no longer running.  Thus it is not sufficient to compare
parent PIDs when checking if a process was launched by our application.

In the worst case scenario NSSM could even terminate itself and trigger
a bluescreen.

When we find process with matching PPID we now also check that it was
created after our application was created and before our application
exited.

NSSM 2.15.

Italian translations.

Resources and messages for version 2.14.

Signed-off-by: Iain Patterson <me@iain.cx>

Fixed buffer length adding a service via the GUI.

The path to the monitored application and the arguments to the
application are both allowed to be sufficiently large to fit in the
maximum allowable registry value size.  The GUI itself, however, was
restricting input fields to 256 characters.

Whitespace.

NSSM 2.14.

Missing text typo.

Fixed default language.

The GUI was appearing in French if the display language was set to
anything other than English.  Ensure English is the default language by
defining the English resources as English US not English UK.

Spotted by Emilio Frini but apologies must go to François-Régis Tardy
who included the change along with his translations.  I didn't apply it
because I didn't realise that things wouldn't work without it.

Log exit messages more intuitively.

In the case where the application crashed and NSSM then cleaned up its
child processes the events logged were confusing.  First we'd log that
we were going to kill the process tree with exit code X then we'd log
that the service had ended with exit code X.

Logging that the application exited before doing the process tree kill
makes it clearer that the cleanup is in response to the application
exit.

NSSM 2.13.

Windows 2000 optimisation.

Windows 2000 takes a few seconds to time out when trying and failing to
connect to the service manager if NSSM was run with no arguments.

Check for stdin first.  It won't exist if we are running in a service
context so we can skip the connection attempt unless we're unsure.

Localised (almost) all messages.

Use FormatMessage() to localise messages printed to the console or shown
in MessageBoxes.

The new messages are allocated IDs starting at 501 so as not to clash
with event log messages starting at 1001.

Once again French translations were provided by François-Régis Tardy.

Updated translation from François-Régis Tardy.

Signed-off-by: Iain Patterson <me@iain.cx>

Handle running without administrator privileges.

If the service is configured to run as an unprivileged user NSSM will
not be able to perform certain tasks which are not critical and will
therefore log some errors which can be ignored.

It will not be able to register itself as an event log source.
It will not be able to create a default AppExit key.
It will not be able to configure service failure handling.

Try to perform these tasks where first installing the service (which
we are guaranteed to do with administrator rights) as well as at
runtime, and don't log the errors if the runtime actions can't be
performed.

Fixed incomplete set_service_recovery().

A rogue return prevented set_service_recovery() from actually doing anything.
Also we weren't checking for failure in ChangeServiceConfig2().  We expect
ERROR_INVALID_LEVEL on pre-Vista Windows but other errors were not detected.

French translation by François-Régis Tardy.

Log that we received control messages.

Send a message to the event log when we receive a service control.

Use a fake message for starting a service so we can reuse code.
No SERVICE_CONTROL_START control is defined or used by the Windows
API.

French translations by François-Régis Tardy.

French translations.

Resources and messages for version 2.12.

Signed-off-by: Iain Patterson <me@iain.cx>

NSSM 2.12.

Windows 2000 compatibility notes.

NSSM 2.11.

Removed run hack.

Previously we used to attempt to run as a service only when the "run"
argument was given, and printed a usage message if no arguments were
provided.

A more appropriate strategy is to check for StartServiceCtrlDispatcher()
returning ERROR_FAILED_SERVICE_CONTROLLER_CONNECT, as that means the
application is not running in a service context.

As a result we no longer write the undocumented "run" argument to the
registry when installing a service.  Technically this means that we
sacrifice backward compatibility with older versions.

Support srvany's AppEnvironment registry value.

Allow setting one or more environment variables for the application by
creating the AppEnvironment value of type REG_MULTI_SZ.  Each string
should be of the form KEY=VALUE.  VALUE may be omitted to set an empty
environment variable but the equals sign must be present.

This support is for compatibility with srvany.  In accordance with the
documented behaviour of srvany, only environment variables specified in
AppEnvironment will be passed to the service.  Any other variables, even
system variables such as %PATH%, will be ignored if they are not
explicitly listed.

Note that Windows supports adding environment variables to the service's
existing environment by creating the Environment value (also of type
REG_MULTI_SZ) under HKLM\SYSTEM\CurrentControlSet\Services\<service>
instead.  It is recommended that new services use this standard
functionality rather than AppEnvironment.

Thanks Rob Sharp.

Typo.

NSSM 2.10.

New URL and icon.

NSSM has a new website at http://nssm.cc/ and slightly-better red N
icon.  Contributions of a useful icon and logo would be gratefully
received.  Perhaps some kind of executable/service cogs mashup.

Check for administrator privileges.

If nssm is run without an administrator token it will fail to install or
remove services.  Check for the token and bomb out early rather than
waste the user's time filling in the form only to find the service can't
be managed.

Fixed compilation of messages.mc.

Compiling messages.mc failed in paths containing a space.  Eugene
Lifshitz advised how to construct a commandline which would work
in such paths.

More CreateProcess() fun.

Correctly handle the case where the application executable is under
a path which contains space and an executable sharing the initial
part of that path (up to a space) exists.

A (contrived) example is when Application is

  C:\stuff\app lications\foo.exe

and C:\stuff\app.exe also exists.

Thanks Eugene Lifshitz.

Added a changelog.

NSSM 2.9.

Timer safety.

Check we actually have a waitable timer before trying to use it.
Use the correct compiler food to ensure that 256000 milliseconds is
converted to a LARGE_INTEGER correctly.

Fix pre-Vista compatibility.

SleepConditionVariableCS() isn't available on Windows versions
prior to Vista.  Use a waitable timer instead.

NSSM 2.8.

Allow configuring throttling threshold.

Tweak minimum time for which a service must run by setting the threshold
number of milliseconds in AppThrottle (REG_DWORD).

Removed some legacy stuff.

What was #define GUI even for?
Why #define snprintf _snprintf in one file where we're using actual
_snprintf everywhere else?

Corrected restart throttling documentation.

The documentation said that the maximum throttle time was 60 seconds
whereas in fact it is 256 seconds.  The documentation now describes
it as four minutes.

Thread safety.

Multiple threads might call error_string() so a static buffer is
dangerous.  Use TLS for a safe buffer.

Read registry before each restart.

Read Application, AppDirectory and AppParameters before each restart so
a change to any one doesn't require restarting NSSM itself.

Tidyup TerminateProcess().

TerminateProcess() will fail if the process already died for some
reason.  Don't log an error in this case.

Log a more interesting message when recursing into kill_process_tree().

Fix event logging.

Some messages weren't being logged properly.  One common reason was that
one or more arguments to log_event() were longs but were interpreted
as strings.  Create a temporary buffer and sprintf the numbers to fix
that.
The other reason was that GetLastError() returns a long where a string
was expected.  Restore the previously removed error_string() function to
convert it into an error message.

Use GetWindowsDirectory() instead of %SYSTEMROOT%.

Though unlikely, it's possible that %SYSTEMROOT% might be undefined.

Strip quotes from directory name.

Windows directories aren't allowed to contain quotes so CreateProcess()
will fail if the AppDirectory is quoted.  Note that it succeeds even if
Application itself is quoted as the application plus parameters are
interpreted as a command line.

Fixed arguments when installing a service.

Only the first flag supplied on the command line was being added to
the registry.

Don't leak memory reading REG_SZ values.

Throttle restarts.

Back off from restarting the application immediately if it starts
successfully but exits too soon.

Handle resume messages from the service console to restart the
application immediately even if it is throttled.

Use service status wait hints to tell the operating system how long
start, stop and resume actions are likely to take.

Try to kill the process tree gracefully.

Before calling TerminateProcess() on all processes assocatiated with
the monitored application, enumerate all windows and threads and
post appropriate messages to them.  If the application bothers to
listen for such messages it has a chance to shut itself down gracefully.

If the application ignores this chance to do the right thing it's
fair game for termination.

NSSM 2.7.

Handle missing registry values.

Warn if AppParameters is missing.

Warn if AppDirectory is missing or unset and choose a fallback directory.
First try to find the parent directory of the application.  If that
fails, eg because the application path is just "notepad" or something,
expand %SYSTEMROOT%.  If THAT fails it's time to give up and go home.

Thanks Arve Knudsen.

Messages for kill_process_tree().

Kill process tree when stopping service.

Ensure that all child processes of the monitored application are
killed when the service stops by recursing through all running
processes and terminating those whose parent is the application
or one of its descendents.

NSSM 2.6.

Removed incorrect ExpandEnvironmentStrings() error.

A log_event() call was inadvertently left in the code causing an error
to be set to the eventlog saying that ExpandEnvironmentStrings() had
failed when it had actually succeeded.

NSSM 2.5.

Expand environment strings in parameters.

Allow use of REG_EXPAND_SZ values in the registry.

Don't suicide on exit status 0.

Suiciding when the application exits 0 will cause recovery actions to be
taken.  Usually this is inappropriate.  Only suicide if there is an
explicit AppExit value for 0 in the registry.

Technically such behaviour could be abused to do something like run a
script after successful completion of a service but in most cases a
suicide is undesirable when no actual failure occurred.

Handle startup failure.

Don't hang if startup parameters couldn't be determined.
Instead, signal that the service entered the STOPPED state.
Set START_PENDING state prior to actual startup.

NSSM 2.4.

Ensure systems recovery actions can happen.

In Windows versions earlier than Vista the service manager would only
consider a service failed (and hence eligible for recovery action) if
the service exited without setting its state to SERVICE_STOPPED, even if
it signalled an error exit code.
In Vista and later the service manager can be configured to treat a
graceful shutdown with error code as a failure but this is not the
default behaviour.

Try to configure the service manager to use the new behaviour when
starting the service so users who set AppExit to Exit can use recovery
actions as expected.

Also recognise the new AppExit option Suicide for use on pre-Vista
systems.  When AppExit is Suicide don't stop the service but exit
inelegantly, which should be seen as a failure.

NSSM 2.3

Fix path lengths.

Some buffers were being limited to MAX_PATH characters when higher
limits were more appropriate.
For example the maximum length of a command line is documented as 32768
characters with the application name part limited to MAX_PATH.
Long applications paths and arguments could be truncated when written to
the registry.

Thanks Joel Reingold.

Log messages properly.

Format messages from resource.  Use NSSM binary as the message source.
Note that replacing the binary is prevented if the event viewer is open.

Compile messages.

Don't spam the event log with warnings about not finding application
messages.
Every message currently uses the default event ID 1.

Don't break the window size.

The dialogue was being moved incorrectly, resulting in it inadvertently
changing size.

NSSM 2.2.