Command to dump service configuration.
[nssm.git] / registry.cpp
index d20b2c2..93c034d 100644 (file)
@@ -67,6 +67,14 @@ int create_messages() {
   return 0;\r
 }\r
 \r
+long enumerate_registry_values(HKEY key, unsigned long *index, TCHAR *name, unsigned long namelen) {\r
+  unsigned long type;\r
+  unsigned long datalen = namelen;\r
+  long error = RegEnumValue(key, *index, name, &datalen, 0, &type, 0, 0);\r
+  if (error == ERROR_SUCCESS) ++*index;\r
+  return error;\r
+}\r
+\r
 int create_parameters(nssm_service_t *service, bool editing) {\r
   /* Try to open the registry */\r
   HKEY key = open_registry(service->name, KEY_WRITE);\r
@@ -232,48 +240,53 @@ int create_exit_action(TCHAR *service_name, const TCHAR *action_string, bool edi
 \r
 int get_environment(TCHAR *service_name, HKEY key, TCHAR *value, TCHAR **env, unsigned long *envlen) {\r
   unsigned long type = REG_MULTI_SZ;\r
+  unsigned long envsize;\r
+\r
+  *envlen = 0;\r
 \r
   /* Dummy test to find buffer size */\r
-  unsigned long ret = RegQueryValueEx(key, value, 0, &type, NULL, envlen);\r
+  unsigned long ret = RegQueryValueEx(key, value, 0, &type, NULL, &envsize);\r
   if (ret != ERROR_SUCCESS) {\r
     *env = 0;\r
-    *envlen = 0;\r
     /* The service probably doesn't have any environment configured */\r
     if (ret == ERROR_FILE_NOT_FOUND) return 0;\r
-    log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_QUERYVALUE_FAILED, value, error_string(GetLastError()), 0);\r
+    log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_QUERYVALUE_FAILED, value, error_string(ret), 0);\r
     return 1;\r
   }\r
 \r
   if (type != REG_MULTI_SZ) {\r
-    *env = 0;\r
-    *envlen = 0;\r
     log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_INVALID_ENVIRONMENT_STRING_TYPE, value, service_name, 0);\r
+    *env = 0;\r
     return 2;\r
   }\r
 \r
-  /* Probably not possible */\r
-  if (! *envlen) return 0;\r
+  /* Minimum usable environment would be A= NULL NULL. */\r
+  if (envsize < 4 * sizeof(TCHAR)) {\r
+    *env = 0;\r
+    return 3;\r
+  }\r
 \r
   /* Previously initialised? */\r
   if (*env) HeapFree(GetProcessHeap(), 0, *env);\r
 \r
-  *env = (TCHAR *) HeapAlloc(GetProcessHeap(), 0, *envlen);\r
+  *env = (TCHAR *) HeapAlloc(GetProcessHeap(), 0, envsize);\r
   if (! *env) {\r
-    *envlen = 0;\r
     log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, value, _T("get_environment()"), 0);\r
-    return 3;\r
+    return 4;\r
   }\r
 \r
-  /* Actually get the strings */\r
-  ret = RegQueryValueEx(key, value, 0, &type, (unsigned char *) *env, envlen);\r
+  /* Actually get the strings. */\r
+  ret = RegQueryValueEx(key, value, 0, &type, (unsigned char *) *env, &envsize);\r
   if (ret != ERROR_SUCCESS) {\r
-    log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_QUERYVALUE_FAILED, value, error_string(GetLastError()), 0);\r
+    log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_QUERYVALUE_FAILED, value, error_string(ret), 0);\r
     HeapFree(GetProcessHeap(), 0, *env);\r
     *env = 0;\r
-    *envlen = 0;\r
-    return 4;\r
+    return 5;\r
   }\r
 \r
+  /* Value retrieved by RegQueryValueEx() is SIZE not COUNT. */\r
+  *envlen = (unsigned long) environment_length(*env);\r
+\r
   return 0;\r
 }\r
 \r
@@ -292,14 +305,13 @@ int get_string(HKEY key, TCHAR *value, TCHAR *data, unsigned long datalen, bool
 \r
   unsigned long ret = RegQueryValueEx(key, value, 0, &type, (unsigned char *) buffer, &buflen);\r
   if (ret != ERROR_SUCCESS) {\r
-    unsigned long error = GetLastError();\r
     HeapFree(GetProcessHeap(), 0, buffer);\r
 \r
     if (ret == ERROR_FILE_NOT_FOUND) {\r
       if (! must_exist) return 0;\r
     }\r
 \r
-    log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_QUERYVALUE_FAILED, value, error_string(error), 0);\r
+    log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_QUERYVALUE_FAILED, value, error_string(ret), 0);\r
     return 2;\r
   }\r
 \r
@@ -390,7 +402,7 @@ int get_number(HKEY key, TCHAR *value, unsigned long *number, bool must_exist) {
     if (! must_exist) return 0;\r
   }\r
 \r
-  log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_QUERYVALUE_FAILED, value, error_string(GetLastError()), 0);\r
+  log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_QUERYVALUE_FAILED, value, error_string(ret), 0);\r
   if (ret == ERROR_FILE_NOT_FOUND) return -1;\r
 \r
   return -2;\r
@@ -432,32 +444,40 @@ int format_double_null(TCHAR *dn, unsigned long dnlen, TCHAR **formatted, unsign
   return 0;\r
 }\r
 \r
-/* Strip CR and replace LF with NULL. */\r
-int unformat_double_null(TCHAR *dn, unsigned long dnlen, TCHAR **unformatted, unsigned long *newlen) {\r
+/* Strip CR and replace LF with NULL.  */\r
+int unformat_double_null(TCHAR *formatted, unsigned long formattedlen, TCHAR **dn, unsigned long *newlen) {\r
   unsigned long i, j;\r
   *newlen = 0;\r
 \r
-  if (! dnlen) {\r
-    *unformatted = 0;\r
+  /* Don't count trailing NULLs. */\r
+  for (i = 0; i < formattedlen; i++) {\r
+    if (! formatted[i]) {\r
+      formattedlen = i;\r
+      break;\r
+    }\r
+  }\r
+\r
+  if (! formattedlen) {\r
+    *dn = 0;\r
     return 0;\r
   }\r
 \r
-  for (i = 0; i < dnlen; i++) if (dn[i] != _T('\r')) ++*newlen;\r
+  for (i = 0; i < formattedlen; i++) if (formatted[i] != _T('\r')) ++*newlen;\r
 \r
   /* Skip blank lines. */\r
-  for (i = 0; i < dnlen; i++) {\r
-    if (dn[i] == _T('\r') && dn[i + 1] == _T('\n')) {\r
+  for (i = 0; i < formattedlen; i++) {\r
+    if (formatted[i] == _T('\r') && formatted[i + 1] == _T('\n')) {\r
       /* This is the last CRLF. */\r
-      if (i >= dnlen - 2) break;\r
+      if (i >= formattedlen - 2) break;\r
 \r
       /*\r
         Strip at the start of the block or if the next characters are\r
         CRLF too.\r
       */\r
-      if (! i || (dn[i + 2] == _T('\r') && dn[i + 3] == _T('\n'))) {\r
-        for (j = i + 2; j < dnlen; j++) dn[j - 2] = dn[j];\r
-        dn[dnlen--] = _T('\0');\r
-        dn[dnlen--] = _T('\0');\r
+      if (! i || (formatted[i + 2] == _T('\r') && formatted[i + 3] == _T('\n'))) {\r
+        for (j = i + 2; j < formattedlen; j++) formatted[j - 2] = formatted[j];\r
+        formatted[formattedlen--] = _T('\0');\r
+        formatted[formattedlen--] = _T('\0');\r
         i--;\r
         --*newlen;\r
       }\r
@@ -467,19 +487,166 @@ int unformat_double_null(TCHAR *dn, unsigned long dnlen, TCHAR **unformatted, un
   /* 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
+  *dn = (TCHAR *) HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, *newlen * sizeof(TCHAR));\r
+  if (! *dn) return 1;\r
 \r
-  for (i = 0, j = 0; i < dnlen; i++) {\r
-    if (dn[i] == _T('\r')) continue;\r
-    if (dn[i] == _T('\n')) (*unformatted)[j] = _T('\0');\r
-    else (*unformatted)[j] = dn[i];\r
+  for (i = 0, j = 0; i < formattedlen; i++) {\r
+    if (formatted[i] == _T('\r')) continue;\r
+    if (formatted[i] == _T('\n')) (*dn)[j] = _T('\0');\r
+    else (*dn)[j] = formatted[i];\r
     j++;\r
   }\r
 \r
   return 0;\r
 }\r
 \r
+/* Copy a block. */\r
+int copy_double_null(TCHAR *dn, unsigned long dnlen, TCHAR **newdn) {\r
+  if (! newdn) return 1;\r
+\r
+  *newdn = 0;\r
+  if (! dn) return 0;\r
+\r
+  *newdn = (TCHAR *) HeapAlloc(GetProcessHeap(), 0, dnlen * sizeof(TCHAR));\r
+  if (! *newdn) {\r
+    log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, _T("dn"), _T("copy_double_null()"), 0);\r
+    return 2;\r
+  }\r
+\r
+  memmove(*newdn, dn, dnlen * sizeof(TCHAR));\r
+  return 0;\r
+}\r
+\r
+/*\r
+  Create a new block with all the strings of the first block plus a new string.\r
+  The new string may be specified as <key> <delimiter> <value> and the keylen\r
+  gives the offset into the string to compare against existing entries.\r
+  If the key is already present its value will be overwritten in place.\r
+  If the key is blank or empty the new block will still be allocated and have\r
+  non-zero length.\r
+*/\r
+int append_to_double_null(TCHAR *dn, unsigned long dnlen, TCHAR **newdn, unsigned long *newlen, TCHAR *append, size_t keylen, bool case_sensitive) {\r
+  if (! append || ! append[0]) return copy_double_null(dn, dnlen, newdn);\r
+  size_t appendlen = _tcslen(append);\r
+  int (*fn)(const TCHAR *, const TCHAR *, size_t) = (case_sensitive) ? _tcsncmp : _tcsnicmp;\r
+\r
+  /* Identify the key, if any, or treat the whole string as the key. */\r
+  TCHAR *key = 0;\r
+  if (! keylen || keylen > appendlen) keylen = appendlen;\r
+  key = (TCHAR *) HeapAlloc(GetProcessHeap(), 0, (keylen + 1) * sizeof(TCHAR));\r
+  if (! key) {\r
+    log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, _T("key"), _T("append_to_double_null()"), 0);\r
+    return 1;\r
+  }\r
+  memmove(key, append, keylen * sizeof(TCHAR));\r
+  key[keylen] = _T('\0');\r
+\r
+  /* Find the length of the block not including any existing key. */\r
+  size_t len = 0;\r
+  TCHAR *s;\r
+  for (s = dn; *s; s++) {\r
+    if (fn(s, key, keylen)) len += _tcslen(s) + 1;\r
+    for ( ; *s; s++);\r
+  }\r
+\r
+  /* Account for new entry. */\r
+  len += _tcslen(append) + 1;\r
+\r
+  /* Account for trailing NULL. */\r
+  len++;\r
+\r
+  /* Allocate a new block. */\r
+  *newdn = (TCHAR *) HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, len * sizeof(TCHAR));\r
+  if (! *newdn) {\r
+    log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, _T("newdn"), _T("append_to_double_null()"), 0);\r
+    HeapFree(GetProcessHeap(), 0, key);\r
+    return 2;\r
+  }\r
+\r
+  /* Copy existing entries.*/\r
+  *newlen = (unsigned long) len;\r
+  TCHAR *t = *newdn;\r
+  TCHAR *u;\r
+  bool replaced = false;\r
+  for (s = dn; *s; s++) {\r
+    if (fn(s, key, keylen)) u = s;\r
+    else {\r
+      u = append;\r
+      replaced = true;\r
+    }\r
+    len = _tcslen(u) + 1;\r
+    memmove(t, u, len * sizeof(TCHAR));\r
+    t += len;\r
+    for ( ; *s; s++);\r
+  }\r
+\r
+  /* Add the entry if it wasn't already replaced.  The buffer was zeroed. */\r
+  if (! replaced) memmove(t, append, _tcslen(append) * sizeof(TCHAR));\r
+\r
+  HeapFree(GetProcessHeap(), 0, key);\r
+  return 0;\r
+}\r
+\r
+/*\r
+  Create a new block with all the string of the first block minus the given\r
+  string.\r
+  The keylen parameter gives the offset into the string to compare against\r
+  existing entries.  If a substring of existing value matches the string to\r
+  the given length it will be removed.\r
+  If the last entry is removed the new block will still be allocated and\r
+  have non-zero length.\r
+*/\r
+int remove_from_double_null(TCHAR *dn, unsigned long dnlen, TCHAR **newdn, unsigned long *newlen, TCHAR *remove, size_t keylen, bool case_sensitive) {\r
+  if (! remove || !remove[0]) return copy_double_null(dn, dnlen, newdn);\r
+  size_t removelen = _tcslen(remove);\r
+  int (*fn)(const TCHAR *, const TCHAR *, size_t) = (case_sensitive) ? _tcsncmp : _tcsnicmp;\r
+\r
+  /* Identify the key, if any, or treat the whole string as the key. */\r
+  TCHAR *key = 0;\r
+  if (! keylen || keylen > removelen) keylen = removelen;\r
+  key = (TCHAR *) HeapAlloc(GetProcessHeap(), 0, (keylen + 1) * sizeof(TCHAR));\r
+  if (! key) {\r
+    log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, _T("key"), _T("remove_from_double_null()"), 0);\r
+    return 1;\r
+  }\r
+  memmove(key, remove, keylen * sizeof(TCHAR));\r
+  key[keylen] = _T('\0');\r
+\r
+  /* Find the length of the block not including any existing key. */\r
+  size_t len = 0;\r
+  TCHAR *s;\r
+  for (s = dn; *s; s++) {\r
+    if (fn(s, key, keylen)) len += _tcslen(s) + 1;\r
+    for ( ; *s; s++);\r
+  }\r
+\r
+  /* Account for trailing NULL. */\r
+  if (++len < 2) len = 2;\r
+\r
+  /* Allocate a new block. */\r
+  *newdn = (TCHAR *) HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, len * sizeof(TCHAR));\r
+  if (! *newdn) {\r
+    log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, _T("newdn"), _T("remove_from_double_null()"), 0);\r
+    HeapFree(GetProcessHeap(), 0, key);\r
+    return 2;\r
+  }\r
+\r
+  /* Copy existing entries.*/\r
+  *newlen = (unsigned long) len;\r
+  TCHAR *t = *newdn;\r
+  for (s = dn; *s; s++) {\r
+    if (fn(s, key, keylen)) {\r
+      len = _tcslen(s) + 1;\r
+      memmove(t, s, len * sizeof(TCHAR));\r
+      t += len;\r
+    }\r
+    for ( ; *s; s++);\r
+  }\r
+\r
+  HeapFree(GetProcessHeap(), 0, key);\r
+  return 0;\r
+}\r
+\r
 void override_milliseconds(TCHAR *service_name, HKEY key, TCHAR *value, unsigned long *buffer, unsigned long default_value, unsigned long event) {\r
   unsigned long type = REG_DWORD;\r
   unsigned long buflen = sizeof(unsigned long);\r
@@ -492,7 +659,7 @@ void override_milliseconds(TCHAR *service_name, HKEY key, TCHAR *value, unsigned
         _sntprintf_s(milliseconds, _countof(milliseconds), _TRUNCATE, _T("%lu"), default_value);\r
         log_event(EVENTLOG_WARNING_TYPE, event, service_name, value, milliseconds, 0);\r
       }\r
-      else log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_QUERYVALUE_FAILED, value, error_string(GetLastError()), 0);\r
+      else log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_QUERYVALUE_FAILED, value, error_string(ret), 0);\r
     }\r
   }\r
   else ok = true;\r
@@ -500,6 +667,7 @@ void override_milliseconds(TCHAR *service_name, HKEY key, TCHAR *value, unsigned
   if (! ok) *buffer = default_value;\r
 }\r
 \r
+/* Open the key of the service itself Services\<service_name>. */\r
 HKEY open_service_registry(const TCHAR *service_name, REGSAM sam, bool must_exist) {\r
   /* Get registry */\r
   TCHAR registry[KEY_LENGTH];\r
@@ -511,6 +679,7 @@ HKEY open_service_registry(const TCHAR *service_name, REGSAM sam, bool must_exis
   return open_registry_key(registry, sam, must_exist);\r
 }\r
 \r
+/* Open a subkey of the service Services\<service_name>\<sub>. */\r
 long open_registry(const TCHAR *service_name, const TCHAR *sub, REGSAM sam, HKEY *key, bool must_exist) {\r
   /* Get registry */\r
   TCHAR registry[KEY_LENGTH];\r
@@ -703,7 +872,7 @@ int get_parameters(nssm_service_t *service, STARTUPINFO *si) {
       if (type != REG_DWORD) {\r
         log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_BOGUS_STOP_METHOD_SKIP, service->name, NSSM_REG_STOP_METHOD_SKIP, NSSM, 0);\r
       }\r
-      else log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_QUERYVALUE_FAILED, NSSM_REG_STOP_METHOD_SKIP, error_string(GetLastError()), 0);\r
+      else log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_QUERYVALUE_FAILED, NSSM_REG_STOP_METHOD_SKIP, error_string(ret), 0);\r
     }\r
   }\r
   else stop_ok = true;\r