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.

Adjust buffer sizes.

Unicode applications can under certain circumstances access paths longer
than MAX_PATH characters.  Service names are limited to 256 characters.

Adjust our buffers to suit.

French CPUs are UCs.

Unité Centrale.

Fixed drawing of rotation GUI labels.

The "Restrict rotation" labels were slightly too large, resulting in
them bleeding into the associated editboxes if the window were redrawn.

Don't expand parameters when querying a service.

Calling, eg "nssm get <service> Application" should print the unexpanded
string from the registry.

Added get_string() and set_string().

Abstract expand_parameter() and set_expand_string() to allow working
with registry values of type REG_SZ as well a REG_EXPAND_SZ.

Fixed regression with offline rotation.

We weren't falling through to direct I/O when online rotation was
completely disabled, only when it was attempted but failed.
We weren't closing pipe handles after a failed attempt to enable online
rotation.
We were incorrectly complaining about I/O errors in the event log when the
application was exiting.

Formatting.

Tidy up online rotation.

Move the messy copy/paste of the logging thread setup into a separate function.
No longer incorrectly tread longs as bools.
Fixed some typos and incorrect logic.

s/stdout/stderr/

Again...

Allow restarting a service.

Running "nssm restart <service>" will try to send a stop control
followed by a start control.  It will fail if the service was stopped at
the outset or if it didn't respond to the stop control in a timely
manner.

Don't get stuck in SERVICE_CONTINUE_PENDING.

If we received SERVICE_CONTROL_CONTINUE and the service wasn't paused we
would incorrectly set SERVICE_CONTINUE_PENDING status.

The Windows services console won't allow a user to attempt to send a
continue control to a running service but other applications, like say
NSSM itself, might happily try, then get confused when the status wasn't
set to SERVICE_RUNNING.

More robust options for controlling a service.

Wait for the service status to change, eg from START_PENDING to RUNNING
before deciding whether a service control operation was successful.

Added service_status_text().

Function to get a string representation of a service status, eg
SERVICE_RUNNING.

Added fake NSSM_SERVICE_CONTROL_START constant.

There's no SERVICE_CONTROL_START constant so we were explicitly checking
for a fake control code of 0 when handling service start.  Now that we
have defined a custom control code (NSSM_SERVICE_CONTROL_ROTATE) we can
add NSSM_SERVICE_CONTROL_START for readability and consistency.

Added error message for missing subparameter.

Clarify the output when editing a service on the command line and a
mandatory subparameter was not supplied.

Thanks Chris Blaszczynski.

Enable on-demand rotation.

Running "nssm rotate <service>" will send user-defined service control
128 to the service, triggering a rotation of output files after the next
call to ReadFile(), regardless of the value of AppRotateBytes*.

Note that since ReadFile() is synchronous, we have no way to interrupt
it, hence there may be a significant delay before the rotation happens.

Fixed copy/paste bug with I/O.

The stderr file was incorrectly being created with stdout paramters.

More robust online rotation.

Try to differentiate between fatal and non-fatal I/O errors.  Give up on
logging only as a last resort.  Clean up logger data properly.  Report
when a file was rotated.

Bigger I/O buffer.

We set a small logging buffer size when testing.  The buffer should be
bigger for a final release.

Rotate files while the service is running.

If AppRotateOnline is set, set up a pipe between the application's
stdout/stderr and a new thread which reads all input and writes to the
configured output file(s).

If a file breaches the configured AppRotateBytes threshold while the
service is running, close and rotate the file then resume logging to
a new file.

This behaviour is not the default due to the potential for things to go
wrong.  We have to juggle file handles and might hit a read or write
error which causes logging to fail thus losing all output until the
service is restarted, etc etc.

Thanks Doug Watson.

Write canonical AppExit string.

If the user ran "nssm set <servicename> AppExit Default exit" the
default value of AppExit would be set verbatim to "exit" which is in
contrast the documented value "Exit" with normal capitalisation.

There's no harm to that fact, as AppExit is retrieved case-insensitively
but it was nonetheless not working as intended.

Copy environment block rather than setting extra variables.

If AppEnvironmentExtra is configured we were calling
SetEnvironmentVariable() to append each one to the existing environment.
That's arguably wrong as it could mess up NSSM's own environment.

Instead we now call GetEnvironmentStrings() and take a copy of the
current environment ebfore appending the extra environment as we were
doing before.

Force UTF-16 output.

If we were compiled as a Unicode application, set stdout and stderr
output mode to UTF-16 text.  Doing so allows French and Italian accented
characters to show up correctly on the console.

We currently have no analogous method for fixing the output of NSSM when
compiled as an ANSI application.

More compiler food.

Om nom nom.

Added mandatory restart delay.

The REG_DWORD AppRestartDelay entry specifies a minimum number of
milliseconds by which we will delay the restart (not the initial start)
of the managed application.  If the application exited soon enough to
trigger throttling, the actual delay will be whichever is longer of
AppRestartDelay and the calculated throttle time.

Thanks Andrew RedzMax.

Allow setting processor affinity.

The REG_SZ AppPriority entry specifies a list of processors which will
be converted to a mask and passed to SetProcessAffinityMask().

Processors are numbered from 0, must not exceed 63, and are separated
with commas or dashes, to specify a range.

Thanks Robert Middleton.

AppPriority is an optional parameter.

We were incorrectly requiring its presence and logging an error when it
wasn't found.  The parameter was not intended to be mandatory and no
error should be logged unless the parameter is present but invalid.

Overload str_number().

Allow passing the bogus pointer to str_number() in case we want to
inspect it later.

Corrected priority documentation.

The correct function name is SetPriorityClass() not
SetProcessPriorityClass().

Fixed year marker in build information.

The year wasn't being set reliably by version.cmd.

Allow setting application priority.

The REG_DWORD AppPriority entry corresponds to a priority class as
accepted by SetProcessPriorityClass().  If a valid value is set, it will
be passed to CreateProcess() and the application will start with the
requested priority.

Fixed message when RegSetValueEx() fails.

We were incorrectly displaying the error message associated with
RegDeleteValue().

Basic system translations.

Copy translations for the Details and Log on tabs from native Windows
tools.

Give up on older Visual Studio versions.

Tests show that Visual Studio 6 and 2005 won't build NSSM presumably
because there is no suitable platform SDK corresponding to those versions.
Carting around a legacy DSP and DSW file is therefore somewhat
pointless, especially as newer Visual Studio releases have freely
available Express versions and will compile the project.

Added messages to Visual Studio 6 workspace.

Added the messages.mc file was added to the workspace.
It's of limited usefulness given that the project won't build...

More appropriate LegalCopyright field.

It doesn't make a lot of sense to have a Copyright notice on a Public
Domain work.  The intention of including the LegalCopyright version
string was solely to assert authorship.  The new string should make that
clearer.

ANSI compiler food.

Extra product description tags.

Call ourselves NSSM not nssm.  Add 32/64-bit and release/debug specifiers.
Since we are adding them to the resource files as well we need to add the
_WIN64 preprocessor definition to the resources definition list explicitly.
To ensure that messages sent to the event log remain consistent we
define the event source separately and set it to the old lowercase name.

Fixed bugs when creating a service.

A null argument to grant_logon_as_service() would cause a crash.
We were calling CreateService() with the wrong access mask.
We weren't printing any error message when CreateService() failed.

Legacy quick'n'dirtiness.

On Windows 2000, StartService() and ControlService() return
ERROR_IO_PENDING immediately.  Later versions of Windows have a
builtin timeout before they will return that error.

As far as we're concerned, ERROR_IO_PENDING indicates that the service
control was sent successfully so we simply override the error and
return success.

If NSSM's service management functionality is ever expanded we can take
the time to handle service controls in a more robust way.

Allow querying a service's name.

Since we can now open a service by its display name it may be
interesting to know what its canonical name is.

Find out with:

    nssm get <displayname> Name

Added open_service().

New function to open a service either by name or display name.  Since no
service's display name may conflict with any other service's display
name or key name, we can safely use a display name as a key when opening
a service.

OpenService() expects a service name so if it fails with status
ERROR_SERVICE_DOES_NOT_EXIST we can enumerate all services and look for
one whose display name matches the argument passed to open_service(),
and open it.  As a side effect we can optionally store the canonical
name in a separate (or not) buffer.

Allow controlling services.

Send start/stop/query messages to services is easy so adding the ability
to do so is a quick win.

Allow service editing on the command line.

Individual service parameters can now be queried or edited on the
command line.  The syntax is designed to be intuitive and is
described in some detail in the README.  Some examples follow:

    nssm get Selenium Application

    nssm get "My Batch Job" AppExit 0

    nssm get Jenkins AppEnvironmentExtra CLASSPATH

    nssm get Netlogon ImagePath

    nssm set UT2004 Application C:\Games\UT2004\System\UCC.exe

    nssm set UT2004 AppParameters server

    nssm set UT2004 AppExit Default Exit

    nssm set Jenkins ObjectName DOMAIN\ci correct horse battery staple

    nssm set "My Batch Job" AppExit 0 Exit

    nssm set WowzaMediaServer362 Start SERVICE_DELAYED_START

    nssm set UT2004 Type SERVICE_INTERACTIVE_PROCESS

    nssm reset UT2004 AppEnvironment

    nssm reset UT2004 ObjectName

Added str_number().

Wrapper function around _tcstoul().

Be more Windowsy.

Now that the GUI is more functional, it should behave more like a real
Windows application.  That means having an icon and modal messageboxes.

Fixed srvany-compatible environment checkbox.

The checkbox was inverted.  If we were replacing the environment, like
srvany does, it was unchecked, suggesting that the environment would be
appended.

Added format_environment() and unformat_environment().

Added new functions to convert an environment block, with each KEY=value
pair separated by NULL NULL, to and from a string, with the pairs
separated by CRLF.

Added get_service_description().

New function to set or unset a service's description.

Added open_registry() function.

Moved RegOpenKeyEx() and RegCreateKeyEx() to a separate function
open_registry().

Added get_service_username().

New function to get the service username.

Added get_service_description().

New function to get the service description.

Added get_service_startup().

New function to retrieve the service startup type.

Remember to free info after QueryServiceConfig2().

We weren't freeing the SERVICE_CONFIG_DELAYED_AUTO_START_INFO buffer
after checking for delayed auto start.

Moved QueryServiceConfig() to a separate function.

The new function query_service_config() will return a pointer to a
QUERY_SERVICE_CONFIG data structure.

Detect if we were double-clicked.

Because we are compiled as a console subsystem application, if the user
double-clicks the executable it will pop up a new console window.  Then,
since no arguments were passed, we will dump a usage message which the
user won't have time to read, and exit.

We now detect this situation and redirect the usage message to a popup.

There are three likely cases to handle.

If we are running in a service context there won't be a console window.
GetConsoleWindow() will return a null handle.

If were launched from a command window, the process ID owning the
console handle will be different from as our process ID.

If the process IDs are the same, we were started with a new console.  We
call FreeConsole() to close it and subsequently direct the usage message
to a message box.

Fixed loading localised resources.

We weren't loading the correct resources for non-English languages when
compiled as a Unicode application.

We now explicitly call FindResourceEx(), LoadResource() and
CreateDialogIndirectParam() to ensure the appropriate windows are shown.

We now explicitly pass GetUserDefaultLangID() to FormatMessage(),
falling back to language neutral if it fails.

Resources and messages are now explicitly UTF-16LE.  That means that git
will treat them as binary and refuse to diff them.  To work around that,
add the following to .git/info/attributes:

    *.mc diff=utf16
    *.rc diff=utf16

and the following to .git/config:

    [diff "utf16"]
     textconv = "iconv -f utf-16le -t utf-8"

Fixed arguments to mbstowcs_s().

The third argument to mbstowcs_s() is a buffer size not a character
count.

Grant SeServiceLogonRight.

If the service is to be run under a user account, ensure that the
account has the right to log on as a service.

Fixed print_message() when out of memory.

We were passing NSSM_EVENT_OUT_OF_MEMORY to print_message() but
print_message() expects printf-style message strings and NSSM_EVENT_*
strings use %1, %2 etc.  Instead we now use the new message
NSSM_MESSAGE_OUT_OF_MEMORY when printing memory errors to the console.

Fixed changing service password.

Ensure that we still process a password change even if the username is
the same.
Ensure we handle all errors from edit_service().

Safer version.h creation.

Use a temporary file so Visual Studio doesn't detect a timestamp change
on the file and trigger a rebuild.

More detailed file properties.

Add build information, comments and copyright to the executable's
version info fields.

Generate version information as part of the build.

Use git (if it's available) to create a major and minor version number
based on the most recent tag name.  If we are not building from a
tagged commit, use the commit count since the last tag as the subminor
version.  If Jenkins is being used for the build, use the build number
as the subsubminor version.

Display canonical service name.

When editing or deleting a service we get the service information using the
name provided by the user.  The name is case-insensitive but case-preserving.
Use GetServiceKeyName() to retrieve the canonical name and display that
in any messages containing the service name.

Allow editing services.

"nssm edit <service>" brings up a GUI to edit an existing service.
Services not managed by NSSM can also be edited but only system
properties such as the display name will appear in the GUI.

Safer set_environment().

Ensure that the return parameters are set safely when things go wrong.

Fixed popup_message().

The second argument to _vsntprintf_s() is a count not a size.
The fallback errors weren't massively helpful.
The message buffer is too small for some larger messages.

Added delete_createfile_parameter().

Function to remove a value related to I/O redirection from the registry.

Disable interactive checkbox when a user is set.

A service can only interact with the desktop when running as LOCALSYSTEM
so disable the checkbox for that option when a user account is set.

Store I/O redirection and environment options.

Previously we queried I/O redirection and environment options from the
registry when starting the service.  We now add support for being able
to query those options and store them in the service data structure at
any time.  This will allow us to edit services later.

Changed arguments to nssm_gui().

The second argument to nssm_gui() is now an nssm_service_t pointer
rather than a string.  This will allow the function to be extended later
to edit existing services.

Set log on details in the GUI.

The GUI can now set service logon and desktop interactive details.

GUI tweaks.

The check_method_timeout() static function was used for processing
timeouts in milliseconds, hence the name.  We are now reusing it to
check arbitrary numbers, so the name is no longer appropriate.

Instead of having checkboxes to enable or disable file rotation
parameters we enable or disable the editboxes where the values are
entered, based on the state of the rotation checkbox.

Similarly, the editboxes for shutdown method timeouts are enabled and
disabled based on the state of the method checkboxes.

The throttle timeout editbox was poorly aligned.

Tidy up build directories.

Build object files in tmp/<configuration>/<platform> and link
executables in out/<configuration>/<platform>.

Now switching architectures doesn't require a full rebuild and the
working directoryis a bit cleaner.

Set service details in the GUI.

The GUI can now set the service display name, description and startup
type.

Fixed Unicode display of GetProcAddress() errors.

GetProcAddress() takes char *name as an argument but we were
trying to print TCHAR *name when logging that we couldn't find the
function pointer.

Correct arguments to GetDlgItemText().

The fourth argument to GetDlgItemText() is a character count not a
buffer size.

Fixed missing NULLs in log_event().

The last argument to log_event must be NULL or messages with too many
parameters may not be logged.

Formatting.

Rotate output files.

The files specified by AppStdout and AppStderr can now be rotated prior
to launching the application.  An existing file will be renamed with a
new suffix based on its last write time, to millisecond precision.

Rotation is controlled independently of the CreateFile() arguments used
when opening the files for writing.  It is possible to configure
rotation regardless of whether existing files would be appended or
replaced.

Four new REG_DWORD entries control how rotation happens.

If AppRotateFiles is 0 or missing, rotation is disabled.

If AppRotateSeconds is non-zero, a file will not be rotated if its last
write time is less than the given number of seconds in the past.

If AppRotateBytes is non-zero, a file will not be rotated if it is
smaller than the given number of bytes.

64-bit file sizes can be handled by specifying a high order part in
AppRotateBytesHigh.

Thanks Doug Watson.

Allow relative paths for I/O redirection.

Change to the startup directory before redirecting I/O streams so that
relative paths can be specified.  Then change back so we don't tie up
the directory.

Visual Studio notes.

Clarify that only Visual Studio 2008 and 2010 are known to work.
Visual Studio 2010 can be used to build executables which run on
Windows versions older than XP SP2 if the platform toolset is set
to v90.