Added mandatory restart delay.
[nssm.git] / registry.cpp
index d226b83..caa0fb1 100644 (file)
@@ -29,42 +29,48 @@ int create_messages() {
 }\r
 \r
 int create_parameters(nssm_service_t *service, bool editing) {\r
-  /* Get registry */\r
-  TCHAR registry[KEY_LENGTH];\r
-  if (_sntprintf_s(registry, _countof(registry), _TRUNCATE, NSSM_REGISTRY, service->name) < 0) {\r
-    log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, _T("NSSM_REGISTRY"), _T("create_parameters()"), 0);\r
-    return 1;\r
-  }\r
-\r
   /* Try to open the registry */\r
-  HKEY key;\r
-  if (RegCreateKeyEx(HKEY_LOCAL_MACHINE, registry, 0, 0, REG_OPTION_NON_VOLATILE, KEY_WRITE, 0, &key, 0) != ERROR_SUCCESS) {\r
-    log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OPENKEY_FAILED, registry, error_string(GetLastError()), 0);\r
-    return 2;\r
-  }\r
+  HKEY key = open_registry(service->name, KEY_WRITE);\r
+  if (! key) return 1;\r
 \r
   /* Try to create the parameters */\r
   if (set_expand_string(key, NSSM_REG_EXE, service->exe)) {\r
     RegDeleteKey(HKEY_LOCAL_MACHINE, NSSM_REGISTRY);\r
     RegCloseKey(key);\r
-    return 3;\r
+    return 2;\r
   }\r
   if (set_expand_string(key, NSSM_REG_FLAGS, service->flags)) {\r
     RegDeleteKey(HKEY_LOCAL_MACHINE, NSSM_REGISTRY);\r
     RegCloseKey(key);\r
-    return 4;\r
+    return 3;\r
   }\r
   if (set_expand_string(key, NSSM_REG_DIR, service->dir)) {\r
     RegDeleteKey(HKEY_LOCAL_MACHINE, NSSM_REGISTRY);\r
     RegCloseKey(key);\r
-    return 5;\r
+    return 4;\r
   }\r
 \r
   /* Other non-default parameters. May fail. */\r
+  if (service->priority != NORMAL_PRIORITY_CLASS) set_number(key, NSSM_REG_PRIORITY, service->priority);\r
+  else if (editing) RegDeleteValue(key, NSSM_REG_PRIORITY);\r
+  if (service->affinity) {\r
+    TCHAR *string;\r
+    if (! affinity_mask_to_string(service->affinity, &string)) {\r
+      if (RegSetValueEx(key, NSSM_REG_AFFINITY, 0, REG_SZ, (const unsigned char *) string, (unsigned long) (_tcslen(string) + 1) * sizeof(TCHAR)) != ERROR_SUCCESS) {\r
+        log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_SETVALUE_FAILED, NSSM_REG_AFFINITY, error_string(GetLastError()), 0);\r
+        HeapFree(GetProcessHeap(), 0, string);\r
+        return 5;\r
+      }\r
+    }\r
+    if (string) HeapFree(GetProcessHeap(), 0, string);\r
+  }\r
+  else if (editing) RegDeleteValue(key, NSSM_REG_AFFINITY);\r
   unsigned long stop_method_skip = ~service->stop_method;\r
   if (stop_method_skip) set_number(key, NSSM_REG_STOP_METHOD_SKIP, stop_method_skip);\r
   else if (editing) RegDeleteValue(key, NSSM_REG_STOP_METHOD_SKIP);\r
   if (service->default_exit_action < NSSM_NUM_EXIT_ACTIONS) create_exit_action(service->name, exit_action_strings[service->default_exit_action], editing);\r
+  if (service->restart_delay) set_number(key, NSSM_REG_RESTART_DELAY, service->restart_delay);\r
+  else if (editing) RegDeleteValue(key, NSSM_REG_RESTART_DELAY);\r
   if (service->throttle_delay != NSSM_RESET_THROTTLE_RESTART) set_number(key, NSSM_REG_THROTTLE, service->throttle_delay);\r
   else if (editing) RegDeleteValue(key, NSSM_REG_THROTTLE);\r
   if (service->kill_console_delay != NSSM_KILL_CONSOLE_GRACE_PERIOD) set_number(key, NSSM_REG_KILL_CONSOLE_GRACE_PERIOD, service->kill_console_delay);\r
@@ -214,6 +220,65 @@ int set_environment(TCHAR *service_name, HKEY key, TCHAR *value, TCHAR **env, un
   return 0;\r
 }\r
 \r
+/* Replace NULL with CRLF. Leave NULL NULL as the end marker. */\r
+int format_environment(TCHAR *env, unsigned long envlen, TCHAR **formatted, unsigned long *newlen) {\r
+  unsigned long i, j;\r
+  *newlen = envlen;\r
+\r
+  if (! *newlen) {\r
+    *formatted = 0;\r
+    return 0;\r
+  }\r
+\r
+  for (i = 0; i < envlen; i++) if (! env[i] && env[i + 1]) ++*newlen;\r
+\r
+  *formatted = (TCHAR *) HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, *newlen * sizeof(TCHAR));\r
+  if (! *formatted) {\r
+    *newlen = 0;\r
+    return 1;\r
+  }\r
+\r
+  for (i = 0, j = 0; i < envlen; i++) {\r
+    (*formatted)[j] = env[i];\r
+    if (! env[i]) {\r
+      if (env[i + 1]) {\r
+        (*formatted)[j] = _T('\r');\r
+        (*formatted)[++j] = _T('\n');\r
+      }\r
+    }\r
+    j++;\r
+  }\r
+\r
+  return 0;\r
+}\r
+\r
+/* Strip CR and replace LF with NULL. */\r
+int unformat_environment(TCHAR *env, unsigned long envlen, TCHAR **unformatted, unsigned long *newlen) {\r
+  unsigned long i, j;\r
+  *newlen = 0;\r
+\r
+  if (! envlen) {\r
+    *unformatted = 0;\r
+    return 0;\r
+  }\r
+\r
+  for (i = 0; i < envlen; i++) if (env[i] != _T('\r')) ++*newlen;\r
+  /* Must end with two NULLs. */\r
+  *newlen += 2;\r
+\r
+  *unformatted = (TCHAR *) HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, *newlen * sizeof(TCHAR));\r
+  if (! *unformatted) return 1;\r
+\r
+  for (i = 0, j = 0; i < envlen; i++) {\r
+    if (env[i] == _T('\r')) continue;\r
+    if (env[i] == _T('\n')) (*unformatted)[j] = _T('\0');\r
+    else (*unformatted)[j] = env[i];\r
+    j++;\r
+  }\r
+\r
+  return 0;\r
+}\r
+\r
 int expand_parameter(HKEY key, TCHAR *value, TCHAR *data, unsigned long datalen, bool sanitise, bool must_exist) {\r
   TCHAR *buffer = (TCHAR *) HeapAlloc(GetProcessHeap(), 0, datalen);\r
   if (! buffer) {\r
@@ -334,23 +399,46 @@ void override_milliseconds(TCHAR *service_name, HKEY key, TCHAR *value, unsigned
   if (! ok) *buffer = default_value;\r
 }\r
 \r
-int get_parameters(nssm_service_t *service, STARTUPINFO *si) {\r
-  unsigned long ret;\r
-\r
+HKEY open_registry(const TCHAR *service_name, const TCHAR *sub, REGSAM sam) {\r
   /* Get registry */\r
   TCHAR registry[KEY_LENGTH];\r
-  if (_sntprintf_s(registry, _countof(registry), _TRUNCATE, NSSM_REGISTRY, service->name) < 0) {\r
-    log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, _T("NSSM_REGISTRY"), _T("get_parameters()"), 0);\r
-    return 1;\r
+  HKEY key;\r
+  int ret;\r
+\r
+  if (sub) ret = _sntprintf_s(registry, _countof(registry), _TRUNCATE, NSSM_REGISTRY _T("\\%s"), service_name, sub);\r
+  else ret = _sntprintf_s(registry, _countof(registry), _TRUNCATE, NSSM_REGISTRY, service_name);\r
+  if (ret < 0) {\r
+    log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, _T("NSSM_REGISTRY"), _T("open_registry()"), 0);\r
+    return 0;\r
   }\r
 \r
-  /* Try to open the registry */\r
-  HKEY key;\r
-  if (RegOpenKeyEx(HKEY_LOCAL_MACHINE, registry, 0, KEY_READ, &key) != ERROR_SUCCESS) {\r
-    log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OPENKEY_FAILED, registry, error_string(GetLastError()), 0);\r
-    return 2;\r
+  if (sam & KEY_WRITE) {\r
+    if (RegCreateKeyEx(HKEY_LOCAL_MACHINE, registry, 0, 0, REG_OPTION_NON_VOLATILE, sam, 0, &key, 0) != ERROR_SUCCESS) {\r
+      log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OPENKEY_FAILED, registry, error_string(GetLastError()), 0);\r
+      return 0;\r
+    }\r
+  }\r
+  else {\r
+    if (RegOpenKeyEx(HKEY_LOCAL_MACHINE, registry, 0, sam, &key) != ERROR_SUCCESS) {\r
+      log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OPENKEY_FAILED, registry, error_string(GetLastError()), 0);\r
+      return 0;\r
+    }\r
   }\r
 \r
+  return key;\r
+}\r
+\r
+HKEY open_registry(const TCHAR *service_name, REGSAM sam) {\r
+  return open_registry(service_name, 0, sam);\r
+}\r
+\r
+int get_parameters(nssm_service_t *service, STARTUPINFO *si) {\r
+  unsigned long ret;\r
+\r
+  /* Try to open the registry */\r
+  HKEY key = open_registry(service->name, KEY_READ);\r
+  if (! key) return 1;\r
+\r
   /* Try to get executable file - MUST succeed */\r
   if (expand_parameter(key, NSSM_REG_EXE, service->exe, sizeof(service->exe), false)) {\r
     RegCloseKey(key);\r
@@ -379,6 +467,32 @@ int get_parameters(nssm_service_t *service, STARTUPINFO *si) {
     log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_NO_DIR, NSSM_REG_DIR, service->name, service->dir, 0);\r
   }\r
 \r
+  /* Try to get processor affinity - may fail. */\r
+  TCHAR buffer[512];\r
+  if (expand_parameter(key, NSSM_REG_AFFINITY, buffer, sizeof(buffer), false, false) || ! buffer[0]) service->affinity = 0LL;\r
+  else if (affinity_string_to_mask(buffer, &service->affinity)) {\r
+    log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_BOGUS_AFFINITY_MASK, service->name, buffer);\r
+    service->affinity = 0LL;\r
+  }\r
+  else {\r
+    DWORD_PTR affinity, system_affinity;\r
+\r
+    if (GetProcessAffinityMask(GetCurrentProcess(), &affinity, &system_affinity)) {\r
+      _int64 effective_affinity = service->affinity & system_affinity;\r
+      if (effective_affinity != service->affinity) {\r
+        TCHAR *system = 0;\r
+        if (! affinity_mask_to_string(system_affinity, &system)) {\r
+          TCHAR *effective = 0;\r
+          if (! affinity_mask_to_string(effective_affinity, &effective)) {\r
+            log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_EFFECTIVE_AFFINITY_MASK, service->name, buffer, system, effective, 0);\r
+          }\r
+          HeapFree(GetProcessHeap(), 0, effective);\r
+        }\r
+        HeapFree(GetProcessHeap(), 0, system);\r
+      }\r
+    }\r
+  }\r
+\r
   /* Try to get environment variables - may fail */\r
   set_environment(service->name, key, NSSM_REG_ENV, &service->env, &service->envlen);\r
   /* Environment variables to add to existing rather than replace - may fail. */\r
@@ -420,6 +534,13 @@ int get_parameters(nssm_service_t *service, STARTUPINFO *si) {
     }\r
   }\r
 \r
+  /* Try to get priority - may fail. */\r
+  unsigned long priority;\r
+  if (get_number(key, NSSM_REG_PRIORITY, &priority, false) == 1) {\r
+    if (priority == (priority & priority_mask())) service->priority = priority;\r
+    else log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_BOGUS_PRIORITY, service->name, NSSM_REG_PRIORITY, 0);\r
+  }\r
+\r
   /* Try to get file rotation settings - may fail. */\r
   unsigned long rotate_files;\r
   if (get_number(key, NSSM_REG_ROTATE, &rotate_files, false) == 1) {\r
@@ -447,6 +568,9 @@ int get_parameters(nssm_service_t *service, STARTUPINFO *si) {
   /* Change back in case the startup directory needs to be deleted. */\r
   SetCurrentDirectory(cwd);\r
 \r
+  /* Try to get mandatory restart delay */\r
+  override_milliseconds(service->name, key, NSSM_REG_RESTART_DELAY, &service->restart_delay, 0, NSSM_EVENT_BOGUS_RESTART_DELAY);\r
+\r
   /* Try to get throttle restart delay */\r
   override_milliseconds(service->name, key, NSSM_REG_THROTTLE, &service->throttle_delay, NSSM_RESET_THROTTLE_RESTART, NSSM_EVENT_BOGUS_THROTTLE);\r
 \r
@@ -494,24 +618,28 @@ int get_parameters(nssm_service_t *service, STARTUPINFO *si) {
   return 0;\r
 }\r
 \r
-int get_exit_action(TCHAR *service_name, unsigned long *ret, TCHAR *action, bool *default_action) {\r
+/*\r
+  Sets the string for the exit action corresponding to the exit code.\r
+\r
+  ret is a pointer to an unsigned long containing the exit code.\r
+  If ret is NULL, we retrieve the default exit action unconditionally.\r
+\r
+  action is a buffer which receives the string.\r
+\r
+  default_action is a pointer to a bool which is set to false if there\r
+  was an explicit string for the given exit code, or true if we are\r
+  returning the default action.\r
+\r
+  Returns: 0 on success.\r
+           1 on error.\r
+*/\r
+int get_exit_action(const TCHAR *service_name, unsigned long *ret, TCHAR *action, bool *default_action) {\r
   /* Are we returning the default action or a status-specific one? */\r
   *default_action = ! ret;\r
 \r
-  /* Get registry */\r
-  TCHAR registry[KEY_LENGTH];\r
-  if (_sntprintf_s(registry, _countof(registry), _TRUNCATE, NSSM_REGISTRY _T("\\%s"), service_name, NSSM_REG_EXIT) < 0) {\r
-    log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, _T("NSSM_REG_EXIT"), _T("get_exit_action()"), 0);\r
-    return 1;\r
-  }\r
-\r
   /* Try to open the registry */\r
-  HKEY key;\r
-  long error = RegOpenKeyEx(HKEY_LOCAL_MACHINE, registry, 0, KEY_READ, &key);\r
-  if (error != ERROR_SUCCESS && error != ERROR_FILE_NOT_FOUND) {\r
-    log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OPENKEY_FAILED, registry, error_string(GetLastError()), 0);\r
-    return 2;\r
-  }\r
+  HKEY key = open_registry(service_name, NSSM_REG_EXIT, KEY_READ);\r
+  if (! key) return 1;\r
 \r
   unsigned long type = REG_SZ;\r
   unsigned long action_len = ACTION_LEN;\r