remove dead breaks and returns

Try to create messages at install time.

If the service was never run under a privileged account we might not
have been able to set the message source in the registry.

Set the message source when installing the service, as we are guaranteed
to have the necessary rights.

Compiler food.

SetConsoleCtrlHandler() returns BOOL which is not bool.

Added list command to enumerate NSSM services.

Use "nssm list" to print all services which are managed by NSSM.

Technically we should stop ignoring Control-C.

Before signalling our application we implement a null Control-C handler
so we don't get killed ourselves when signalling the process group.  We
should probably restore the default behaviour after signalling.

Don't ignore must_exist in open_registry().

A typo meant that we were passing true to the overloaded open_registry()
which also takes an HKEY as a parameter.

As a result we would end up spamming ERROR_FILE_NOT_FOUND when updating
a service via the GUI if there were no hooks to update, ironically in a
section of code whose purpose was to check that it didn't need to do or
report anything.

Thanks Igor Zenkov and James Gleason.

Not an error if no hook found in the registry.

Hooks are optional so we shouldn't log an error if one wasn't found.

Thanks Mathias Breiner.

Alternative open_registry_key() signature.

Allow passing a pointer to an HKEY and having the function return the
result of RegCreateKeyEx()/RegOpenKeyEx().  Existing functions wrap the
new invocation so no code changes are needed.

The new function can be used to handle ERROR_FILE_NOT_FOUND as success
when must_exist is false.

Help git figure out how to diff .mc and .rc files.

Visual Studio wants .mc and .rc files to be UTF-16LE, which git thinks
are binary.  Use .gitattributes to force treating them as text only when
diffing, explicitly not handling them as text when submitting as they
must retain their encoding to keep Visual Studio happy.

Thanks to Mathias Breiner for proposing the use of .gitattributes in the
repo.  I had the rules in .git/info/exclude in my working copy for a
long time and forgot about the issue!

Use CRLF consistently.

The mismatch of line endings has long been an annoyance.

Thanks Mathias Breiner for advocating finally doing something about it.

Use service_registry_path() in create_exit_action().

As a result of registry function refactoring we were constructing the
default path to AppExit incorrectly.  Using the function created for the
purpose works correctly, unsurprisingly.

Thanks Igor Zenkov.

Workaround for Resource Compiler warnings/errors under VS2010.

VS2010 RC.exe yielded lots of warnings and some errors when including some (unnecessary) platform header files via nssm.h. So now including only what is really required.
This includes a workaround for error RC2247 found here: http://stackoverflow.com/a/18317658

Fix compilation on VS2015.

Paul Baxter and Mathias Breiner independently reported fixes to get the
project to compile on Visual Studio 2015.

EventMessageFile should be unquoted.

We were writing a quoted message source path to the registry.
Stefan and Michael Scherer point out that it should be unquoted.

Compiler food.

Fix crash on Windows XP.

The pointer returned by GetEnvironmentStrings() on Unicode versions of
Windows XP was to the raw environment block, not a copy as described in
the documentation.  Retrieving it into service->initial_env and keeping
it around for the lifetime of the service could cause a crash.  Instead
we now copy the memory and immediately call FreeEnvironmentStrings().

Thanks Scott Ware.

Clean up Parameters properly.

If create_parameters() failed to write Application, AppParameters or
AppDirectory it would try to clean up by deleting the Parameters key.
The method used to do so was flawed.  It would attempt to delete the key
defined by the NSSM_REGISTRY macro but that macro contains a printf
control string and is not suitable for standalone use.

Incorrect capitalisation of AppStderrCopyAndTruncate.

Describe startup environment in the README.

Abstracted open_registry().

Added service_registry_path() to construct a registry path for a service
which may contain the Parameters subkey and optional sub-subkey.  If no
Parameters subkey is needed the constructed path references the native
service parameters.

The open_registry() function is now a wrapper around the new
open_registry_key() function which opens an arbitrary key.

The new open_service_resgistry() function also wraps open_registry_key()
to access native parameters.

Use nssm_imagepath().

We were calling GetModuleFileName() in a number of places.  Use
nssm_imagepath() instead.

Ensure that a quoted path is used for the service image path when
creating the service, thus avoiding a theoretical security vulnerability
whereby the service manager could be tricked into launching the wrong
program.

When setting the path to NSSM in the environment for event hooks we
still use the unquoted path, as environment variables are typically
unquoted.

Thanks Gerald Haider.

Added nssm_imagepath() and nssm_unquoted_imagepath().

Functions to retrieve the path to nssm.exe both with and without path
quoting.

Save the environment.

Before the previous two commits we used to read the environment from the
registry and set it using an optimisation which modified the retrieved
block in-place.

Now we need to set the environment twice after querying the registry -
once in get_parameters() and once just before CreateProcess(), which
means we can't use the in-place optimisation and must copy the block
before operating on it.

Additionally, nssm_hook() cleans the environment so we have to reinstate
it immediately prior to launching the application.

Compiler food.

Missing header from previous commit.

Set the environment before querying the registry.

Handle AppEnvironment and AppEnvironmentExtra before querying registry
parameters.  Doing so allows paths and arguments passed to the service
to reference such environment variables.

Thanks Yuriy Lesiuk.

Formatting.

Start service in a new thread so we don't block stop controls.

Run hooks in response to certain events.

User-configurable hooks will be run before and/or after certain events,
eg after the application starts successfully.

Hooks will run with the environment of the application, with additional
environment variables providing information about the service status and
the hook which has been called.

Don't create registry keys needlessly.

Don't log an error when trying to access a registry key which doesn't
exist when it's expected that it might not be present.

Don't open a key with RegCreateKeyEx() when we are potentially going to
delete a value.  Instead try RegOpenKeyEx() and return success if it
already isn't present.

Fixed permissions check in open_registry().

We were checking for the presence of KEY_WRITE in the SAM to decide
whether to call RegCreateKeyEx() or RegOpenKeyEx().  KEY_WRITE is an
alias for STANDARD_RIGHTS_WRITE | KEY_SET_VALUE | KEY_CREATE_SUB_KEY so
the function was incorrectly calling RegCreateKeyEx() even when
RegOpenKeyEx() would be more appropriate.

Don't time out waiting for service status change.

Wait for service to start (or fail to start) or stop instead of timing
out after five seconds.

An NSSM service which doesn't start properly and temporarily enters
paused state may end up reporting running state in response to a stop
control.  Therefore we now consider SERVICE_RUNNING to be a valid
response to SERVICE_CONTROL_STOP.

RegisterPowerSettingNotification is unnecessary.

We were importing RegisterPowerSettingNotification but not actually
calling it.  This didn't matter because including
SERVICE_ACCEPT_POWEREVENT in the accepted controls list is sufficient to
receive power notifications.

Restrict acceptance of service controls.

Don't accept a pause/continue control unless the service is marked as
paused.
Don't accept any control until startup is pending.
Don't accept any control after processing a stop control.

More StringFileInfo parameters.

The CompanyName and OriginalFileName parameters are mandatory according
to the spec, so we now provide them.

Refactor kill functions to be independent of services.

Removed most explicit references to service data in kill functions so
they can be used to kill arbitrary process trees.

The function to wait for service status change has been renamed
await_single_handle() to reflect that it can wait for any single object
not just a service's process handle.

Single waiting function.

Use a single function to wait for service status to change, regardless
of if we are waiting for the service to run for a minimum period of time
to be unthrottled or for it to shut down..

Allow slow service startup again.

Previously we enforced a maximum delay in reporting to the service
manager that the service was started, and waited for the application to
become unthrottled in the background.

Users may prefer that the service not report a started state until the
application is unthrottled.  Therefore we now loop and increment the
status checkpoint and wait hint to satisfy the service manager that we
aren't hung.

Thanks Tom Saul.

Typo millisencondes.

Don't try to operate on freed data structure.

We were calling HeapFree() on the logger structure then trying to
call CloseHandle() on one of its elements.

Copy/truncate file rotation.

Some processes, notably Logstash, open files for reading without setting
the FILE_SHARE_READ share mode.  If NSSM is using such a file for I/O
redirection and it tries to rotate the file, its MoveFile() call will
fail.

If the new (REG_DWORD) value(s) AppStdoutCopyAndTruncate and/or
AppStderrCopyAndTruncate are non-zero, NSSM will instead try to rotate
the file(s) by calling CopyFile() to create a copy of the file then
calling SetEndOfFile() to truncate the original file to zero size.
Doing so allows the rotation to succeed at the cost of time and disk
space to create a full copy of the file.

If the new (REG_DWORD) value AppRotateDelay is non-zero, NSSM will sleep
for the given number of milliseconds after rotation, regardless of the
rotation method used.  Testing with Logstash specifically has shown that
introducing a delay of 1000ms may be sufficient to avoid an issue
whereby the reading application loses the final line of input from the
old file due to not noticing that it has been truncated.

Thanks Miguel Angel Terrón.

Allow skipping kill_process_tree().

Don't try to kill the application's process tree - just the application
itself - if the REG_DWORD value AppKillProcessTree is 0.

Thanks Barrett Lewis.

Import RegisterPowerSettingNotification().

Restart in response to PBT_APMRESUMEAUTOMATIC event.

NSSM 2.24.

Terminate the correct process.

We were calling TerminateProcess() on the service process handle in
instead of the handle passed to kill_process().

Thanks Sam Townsend.

NSSM 2.23.

Use CloseServiceHandle() on service handles.

We were incorrectly calling CloseHandle() to close service handles.
CloseServiceHandle() is not only for service manager handles and should
be used on service handles as well.

Fixed some typos and whitespace errors.

Fixed running service under local username.

Trying to set a local account to run the service would fail with
LsaLookupNames() complaining that the name could not be looked up.

Thanks Allen Vailliencourt.

Suppress ERROR_PROC_NOT_FOUND events.

Don't log "The specified procedure could not be found" if
GetProcAddress() fails.  ERROR_PROC_NOT_FOUND is expected when running a
version of Windows which doesn't support the desired. function

Thanks Alain Douangpraseuth.

Typos.

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

NSSM 2.22.

Latest French translations.

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

Disable console window's close menu item.

We can't trap Control-C in a service context but we can grey out the
close window button on the console window.  Doing so goes some way
toward preventing accidental closure.

Thanks Hadrien Kohl.

Fixed broken environment on restart.

We were calling duplicate_environment() to copy the service's initial
environment prior to restarting it.  However the duplicate_environment()
function modified its input by replacing = characters with NULLs.  That
is not allowed; the memory returned by GetEnvironmentStrings() must be
treated as readonly.

After two restarts the application would run with a null environment and
probably crash.

We now copy the initial environment on to the heap and operate on the
copy, ensuring that the corruption does not occur.

Thanks Alessandro Gherardi.

Allow editing service dependencies.

Service dependencies can now be queried or set on the command line via
the DependOnService and DependOnGroup parameters, or via the GUI in the
new Dependencies tab.

Service dependencies can be set using either their key name or display
name.  For example:

    nssm set <servicename> DependOnService RpcSs

which is equivalent to:

    nssm set <servicename> DependOnService "Remote Procedure Call (RPC)"

Group dependencies can be set with or without the group identifier
prefix, which for some reason is not actually described in the
documentation; instead readers are invited to consult the header files
for the value of SC_GROUP_IDENTIFIER, which it turns out is the +
symbol.  For example:

    nssm set <servicename> DependOnGroup +UIGroup

which is equivalent to:

    nssm set <servicename> DependOnGroup UIGroup

The prefix is always printed when query group dependencies.

The GUI presents a editbox into which either service or group
dependencies can be typed.  The group prefix is mandatory when editing
dependencies via the GUI.

Really get canonical name in open_service().

The open_service() function would return the canonical service name if
passed a display name but would return the requested name as-is when
called with a valid service name.  We now retrieve the display name and
map back to the key name so that the returned string is capitalised
exactly as it appears in the services database.

HeapFree() before GetLastError().

Successful HeapFree() will set the last error to 0 so the GetLastError()
call will not be meaningful.

Correct CloseHandle() call.

Closing a service handle is done with CloseHandle() not
CloseServiceHandle().

Skip blank lines in format_double_null().

Ignore blank lines when formatting, so the user doesn't need to worry
about entering environment variables or dependency names in the exactly
correct format.

Renamed un/format_environment().

The format_environment() and unformat_environment() functions could be
used to format any double null-terminated string list, and are not
specificially tied to formatting environment blocks.

Don't crash when installing a service.

install_service() calls edit_service() with a null username, causing
well_known_username() to segfault.

Thanks Czenda Czendov.

UAC awareness.

Relaunch NSSM with administrator privileges if an attempt to install,
edit or remove a service fails.

The new process won't inherit the original console so its output won't
be visible.  For that reason we don't attempt to elevate for operations
which need to be able to display messages, such as controlling a service
or editing parameters.

Thanks to various people for requesting the feature but mainly to Marco
Certelli for advice on the implementation.

Open services with minimal privileges.

Ask for the minimal access rights required to manage a service, so
users don't need to be administrators to perform operations permitted by
the service (manager) ACL.

Argument consistency.

Use "<args> ..." in the usage message to indicate that the arguments are
not the literal string "args" and that there can be an arbitrary number
of them.

The Italian message was already like this but the English and French
were not.

Latest Italian translations.

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

Tidy up Edit Service buttons.

The French and Italian versions of Edit Service didn't fit as well as
the English version.

Don't complain if the service has no ObjectName.

Not all service types run under an account.

Format the exit action dropdown.

The longer messages didn't fully fit in the exit actions dropdown.  Make
it wide enough to accommodate them.

Credit for latest Italian translations.

Removed redundant NSSM_EVENT_STDIN_CREATEPIPE_FAILED.

We aren't faking stdin with a pipe any longer so the message isn't
needed.

Command arguments no longer called options.

The things appended to a program path in order to make a command line
are more appropriately called Arguments than Options.

Thanks Marco Certelli.

Latest Italian translations.

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

Use well-known account aliases.

Jump through a few hoops to make the Windows service control panel to
localise service ObjectNames if they are set to LocalSystem,
LocalService or NetworkService.

Those aren't the canonical names of the accounts as returned by
LsaLookupSids() so attempting to call ChangeServiceConfig() with a
username of, eg, NetworkService will fail, even though writing
NetworkService directly to the registry would work.  Calling
ChangeServiceConfig() with a username of "NT Authority\Network Service"
will work, since that's the canonical name returned by LsaLookupSids()
but it won't be localised in the control panel.

The solution is to write "NT Authority\NetworkService" to the registry
and it will appear correctly.

At this point I'm not sure whether to label it a bug or a feature that
"nssm get <service> ObjectName" will return the actual value in the
registry and not the localised name.

Thanks Marco Certelli.

Handle well-known account names.

Certain well-known accounts can be used to start a service without
entering a password.

"LocalSystem" is the default value of ObjectName in the registry.  It is
not a real account but is an alias for the "NT Authority\System"
account.

"NT Authority\Local Service" has minimal local and no network
privileges.

"NT Authority\Network Service" has minimal local and network privileges.

NSSM now recognises these well-known accounts and will accept them as
ObjectName parameters without complaining that no password was enter.
With the exception of LocalSystem, each can be specified without the "NT
Authority" pseudo-domain prefix.

Added CreateWellKnownSid and IsWellKnownSid imports.

Visual Studio 2008 doesn't recognise the functions so we need to load
them to the imports table.

Fixed argument parsing for setting ObjectName.

Setting ObjectName needs a username and password, except when it
doesn't.  We can't make the extra argument mandatory because it isn't.

Correct label on file rotation GUI.

AppRotateBytes is, as the name implies, a measure of bytes.  The GUI
incorrectly said kB.

Thanks Marco Certelli.

Kill process tree from the top down.

On Windows 8.1 (and maybe other versions), attempting to kill
conhost.exe before its parent cmd.exe will cause the attempt to kill the
latter to fail and the console window to remain active after the service
ends.

We now kill the members of the process tree in reverse order, so the
problem doesn't occur.

Thanks Czenda Czendov.

Ensure we have a valid service exit time.

Sometimes GetProcessTimes() will succeed but return 0 for the process
exit time, leading check_parent() to conclude that the service had
exited before a child process had started, and thus that the child
process was not part of the service's tree.

We now use initialise the service exit time to the current time before
attempting to get the real exit time, and only override the value if
it's valid.

Thanks Czenda Czendov.

Send Control-C to the right window.

We were always trying to send Control-C to the console of the parent
process rather than any subprocesses found in kill_process_tree().

Enough with the small buffers already.

Sledgehammer, meet nut.

Fixed service context detection when built with VS2013.

Visual Studio 2013 includes a C runtime which assigns stdin, stdout and
stderr the file descriptors 0, 1 and 2 - just like UNIX does - even if
there are no streams available.  Thus we can no longer use "_fileno(stdin)
< 0" as a check for running in a service context.

Instead we check for "GetStdHandle(STD_INPUT_HANDLE) == 0" which works
when compiled with older or newer versions of Visual Studio.

Thanks Czenda Czendov.

Don't expand parameters when editing a service.

Environment variables were still being expanded when retrieving strings
to display in the GUI.

Really fix warning when file disposition isn't set.

If AppStdoutDisposition and AppStderrDisposition are both missing from
the registry, the service editing GUI would still incorrectly complain
that the current configuration couldn't be represented in the interface
even though a previous commit claimed to fix that.

Split get_output_handles() into get_io_parameters().

Separate retrieving parameters from the registry and opening output
handles.

Restart throttling happens after calling get_output_handles(), so if the
service was throttled we'd end up with a useless console window
appearing during the pause.

Moved console functions to a new file.

Functions for allocating and setting up a console are moved to
console.cpp.

Allocate new console by default.

Since the whole purpose of NSSM is to be able to make services out of
applications which expect to have a standard desktop environment, let's
simply allocate a new console for each one rather than do so only when
we try to redirect I/O.

A funky ASCII art banner identifies the console as belonging to the
service.  NSSM itself will detach from the console as soon as possible,
so if the service runs a graphical application the console may never be
seen.

The console can be suppressed by setting the REG_DWORD value
AppNoConsole to 1.

Note that services running console applications on Windows 2000 may
fail if the console is disabled.

Allocate a new console for stdin.

Allocate a new console for processes which require stdin instead of
using the pipe hack.

Fixed CreateFile() flags when opening log files.

Opening a file with FILE_APPEND_DATA access is not appropriate when not
truncating existing files or opening new files.  Redirected I/O would be
buffered and output would not be immediately visible to readers.

Revamped environment variables again.

A previous commit changed how environment variables were managed.
Initially we were calling SetEnvironmentVariable() on each variable
defined in AppEnvironmentExtra prior to starting the service.  That
behaviour was changed because it was technically incorrect, potentially
resulting in NSSM's own environment being harmed.

Unfortunately the changed method, creating a new environment block by
calling GetEnvironmentStrings() (or using the block from AppEnvironment
if that and AppEnvironmentExtra were both defined), failed if users did
something like set AppEnvironmentExtra to PATH=C:\bin;%PATH%.  That
would result in the process being started with a block which included
TWO occurrences of the PATH variable; the system-defined one and the
appended one.  The latter would be ignored, possibly causing the
application to fail to start.

For this third attempt we now call GetEnvironmentStrings() once at
startup, storing the block in a new variable which is only freed at
exit.  Immediately prior to calling CreateProcess() to start the service
we use the new environment functions duplicate_environment() (on
AppEnvironment) and set_environment_block() (on AppEnvironmentExtra) to
set the variables.  Then immediately after calling CreateProcess() we
call duplicate_environment() again to restore the original block.

Because they are passed to expand_environment_string(), the environment
blocks are subject to expansion.  That means that setting PATH as
described in the example above would work.  Trying to append items to
the PATH by setting AppEnvironment in a similar way will probably not
work.

Thanks Bryan Senseman.

Added more environment functions.

useful_environment() skips the uninteresting variables at the start of
an environment block, returning a pointer to the first useful variable.

expand_environment_string() expands a string with
ExpandEnvironmentStrings() and returns a pointer to the expanded string,
which must be freed after use.

set_environment_block() iterates through all the variables in an
environment block, expands each one with expand_environment_string() and
calls SetEnvironmentVariable() with the expanded value.

clear_environment() removes all variables from the current environment.

duplicate_environment() duplicates an environment block by first calling
clear_environment() then set_environment_block() with the source block.
Thus it ensures that the variables in the block - and only those - are
set in the current environment.

Renamed set_environment().

The set_environment() function was poorly named.  It gets the
environment settings from the registry but doesn't actually set any
variables.  It is more appropriately named get_environment().

Moved environment functions to a new file.

Moved format_environment(), unformat_environment() and
test_environment() to env.cpp.

Fixed warning when file disposition isn't set.

If AppStdoutDisposition and AppStderrDisposition are both missing from
the registry, the service editing GUI would incorrectly complain that
the current configuration couldn't be represented in the interface.

Minor vcproj tidying.

Consistent file naming via the RelativePath attribute.

Fake stdin for applications which exit on EOF.

Some applications, like MonetDB server, expect to read commands on
stdin.  If they read a keyword, usually "exit" or "quit" or if stdin is
closed, they will exit.

Such applications will typically work when run in a service context via
NSSM, as Windows will allocate a console window for them.  However, when
the service is configured to redirect stdout and/or stderr but not
stdin, the application will exit immediately because it will see no
input and think that the user closed stdin.

To deal with this situation we interpret an AppStdin value of "|" (a
single pipe character) as requesting a hack mode whereby we open a pipe
and pass the reading end to the application as the stdin handle.  We
never actually write anything to the writing end of pipe but simply keep
it around until the application exits or the service receives a stop
control.  Closing the pipe on receipt of a stop request may even be
sufficient to close the application gracefully without resorting to any
of the other stop methods.

As an aside, MonetDB server can be run in batch mode, wherein it does
not attempt to read from stdin at all.  The hack is not necessary for it
or other applications with similar functionality.

Thanks Bryan Senseman.

Don't fail to restart if the service is stopped.

Treat a restart control on a stopped service as a start control.

Fixed NSSM_EVENT_DUPLICATEHANDLE_FAILED message.

We were supposed to add a parameter explaining which handle couldn't be
duplicated.

Fixed regression in file browser.

The GUI file browser was the only place in the code we were using new
and delete[] instead of HeapAlloc() and HeapFree().
The previous commit overlooked that fact and introduced a compiler error
by assuming that lpstrFile was a buffer of a known size instead of being
allocated with new.
Fix the regression and use HeapAlloc()/HeapFree() for consistency.