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.
vico93 · Jan 1, 2014 · 048ecc8 · 048ecc8
1 parent 9cf66b8
commit 048ecc8
Show file tree

Hide file tree

Showing 4 changed files with 91 additions and 10 deletions.
diff --git a/README.txt b/README.txt
@@ -63,11 +63,14 @@ Since version 2.22, NSSM can manage existing services.
 
 Usage
 -----
-In the usage notes below, arguments to the program may be written in angle 
-brackets and/or square brackets.  <string> means you must insert the 
-appropriate string and [<string>] means the string is optional.  See the 
+In the usage notes below, arguments to the program may be written in angle
+brackets and/or square brackets.  <string> means you must insert the
+appropriate string and [<string>] means the string is optional.  See the
 examples below...
 
+Note that everywhere <servicename> appears you may substitute the
+service's display name.
+
 
 Installation using the GUI
 --------------------------

diff --git a/messages.mc b/messages.mc
diff --git a/service.cpp b/service.cpp
@@ -37,6 +37,85 @@ SC_HANDLE open_service_manager() {
   return ret;
 }
 
+/* Open a service by name or display name. */
+SC_HANDLE open_service(SC_HANDLE services, TCHAR *service_name, TCHAR *canonical_name, unsigned long canonical_namelen) {
+  SC_HANDLE service_handle = OpenService(services, service_name, SERVICE_ALL_ACCESS);
+  if (service_handle) {
+    if (canonical_name && canonical_name != service_name) {
+      if (_sntprintf_s(canonical_name, canonical_namelen, _TRUNCATE, _T("%s"), service_name) < 0) {
+        print_message(stderr, NSSM_MESSAGE_OUT_OF_MEMORY, _T("canonical_name"), _T("open_service()"));
+        return 0;
+      }
+    }
+    return service_handle;
+  }
+
+  unsigned long error = GetLastError();
+  if (error != ERROR_SERVICE_DOES_NOT_EXIST) {
+    print_message(stderr, NSSM_MESSAGE_OPENSERVICE_FAILED, error_string(GetLastError()));
+    return 0;
+  }
+
+  /* We can't look for a display name because there's no buffer to store it. */
+  if (! canonical_name) {
+    print_message(stderr, NSSM_MESSAGE_OPENSERVICE_FAILED, error_string(GetLastError()));
+    return 0;
+  }
+
+  unsigned long bufsize, required, count, i;
+  unsigned long resume = 0;
+  EnumServicesStatus(services, SERVICE_DRIVER | SERVICE_FILE_SYSTEM_DRIVER | SERVICE_KERNEL_DRIVER | SERVICE_WIN32, SERVICE_STATE_ALL, 0, 0, &required, &count, &resume);
+  error = GetLastError();
+  if (error != ERROR_MORE_DATA) {
+    print_message(stderr, NSSM_MESSAGE_ENUMSERVICESSTATUS_FAILED, error_string(GetLastError()));
+    return 0;
+  }
+
+  ENUM_SERVICE_STATUS *status = (ENUM_SERVICE_STATUS *) HeapAlloc(GetProcessHeap(), 0, required);
+  if (! status) {
+    print_message(stderr, NSSM_MESSAGE_OUT_OF_MEMORY, _T("ENUM_SERVICE_STATUS"), _T("open_service()"));
+    return 0;
+  }
+
+  bufsize = required;
+  while (true) {
+    /*
+      EnumServicesStatus() returns:
+      1 when it retrieved data and there's no more data to come.
+      0 and sets last error to ERROR_MORE_DATA when it retrieved data and
+        there's more data to come.
+      0 and sets last error to something else on error.
+    */
+    int ret = EnumServicesStatus(services, SERVICE_DRIVER | SERVICE_FILE_SYSTEM_DRIVER | SERVICE_KERNEL_DRIVER | SERVICE_WIN32, SERVICE_STATE_ALL, status, bufsize, &required, &count, &resume);
+    if (! ret) {
+      error = GetLastError();
+      if (error != ERROR_MORE_DATA) {
+        HeapFree(GetProcessHeap(), 0, status);
+        print_message(stderr, NSSM_MESSAGE_ENUMSERVICESSTATUS_FAILED, error_string(GetLastError()));
+        return 0;
+      }
+    }
+
+    for (i = 0; i < count; i++) {
+      if (str_equiv(status[i].lpDisplayName, service_name)) {
+        if (_sntprintf_s(canonical_name, canonical_namelen, _TRUNCATE, _T("%s"), status[i].lpServiceName) < 0) {
+          HeapFree(GetProcessHeap(), 0, status);
+          print_message(stderr, NSSM_MESSAGE_OUT_OF_MEMORY, _T("canonical_name"), _T("open_service()"));
+          return 0;
+        }
+
+        HeapFree(GetProcessHeap(), 0, status);
+        return open_service(services, canonical_name, 0, 0);
+      }
+    }
+
+    if (ret) break;
+  }
+
+  /* Recurse so we can get an error message. */
+  return open_service(services, service_name, 0, 0);
+}
+
 QUERY_SERVICE_CONFIG *query_service_config(const TCHAR *service_name, SC_HANDLE service_handle) {
   QUERY_SERVICE_CONFIG *qsc;
   unsigned long bufsize;
@@ -491,10 +570,9 @@ int pre_edit_service(int argc, TCHAR **argv) {
   }
 
   /* Try to open the service */
-  service->handle = OpenService(services, service->name, SC_MANAGER_ALL_ACCESS);
+  service->handle = open_service(services, service->name, service->name, _countof(service->name));
   if (! service->handle) {
     CloseServiceHandle(services);
-    print_message(stderr, NSSM_MESSAGE_OPENSERVICE_FAILED);
     return 3;
   }
 
@@ -806,16 +884,16 @@ int edit_service(nssm_service_t *service, bool editing) {
 int control_service(unsigned long control, int argc, TCHAR **argv) {
   if (argc < 1) return usage(1);
   TCHAR *service_name = argv[0];
+  TCHAR canonical_name[SERVICE_NAME_LENGTH];
 
   SC_HANDLE services = open_service_manager();
   if (! services) {
     print_message(stderr, NSSM_MESSAGE_OPEN_SERVICE_MANAGER_FAILED);
     return 2;
   }
 
-  SC_HANDLE service_handle = OpenService(services, service_name, SC_MANAGER_ALL_ACCESS);
+  SC_HANDLE service_handle = open_service(services, service_name, canonical_name, _countof(canonical_name));
   if (! service_handle) {
-    print_message(stderr, NSSM_MESSAGE_OPENSERVICE_FAILED);
     CloseServiceHandle(services);
     return 3;
   }
@@ -861,7 +939,7 @@ int control_service(unsigned long control, int argc, TCHAR **argv) {
       return 0;
     }
     else {
-      _ftprintf(stderr, _T("%s: %s\n"), service_name, error_string(error));
+      _ftprintf(stderr, _T("%s: %s\n"), canonical_name, error_string(error));
       return 1;
     }
   }
@@ -894,9 +972,8 @@ int remove_service(nssm_service_t *service) {
   }
 
   /* Try to open the service */
-  service->handle = OpenService(services, service->name, SC_MANAGER_ALL_ACCESS);
+  service->handle = open_service(services, service->name, service->name, _countof(service->name));
   if (! service->handle) {
-    print_message(stderr, NSSM_MESSAGE_OPENSERVICE_FAILED);
     CloseServiceHandle(services);
     return 3;
   }

diff --git a/service.h b/service.h
@@ -96,6 +96,7 @@ nssm_service_t *alloc_nssm_service();
 void set_nssm_service_defaults(nssm_service_t *);
 void cleanup_nssm_service(nssm_service_t *);
 SC_HANDLE open_service_manager();
+SC_HANDLE open_service(SC_HANDLE, TCHAR *, TCHAR *, unsigned long);
 QUERY_SERVICE_CONFIG *query_service_config(const TCHAR *, SC_HANDLE);
 int set_service_description(const TCHAR *, SC_HANDLE, TCHAR *);
 int get_service_description(const TCHAR *, SC_HANDLE, unsigned long, TCHAR *);