Added Service_GetStatus call - addressed issues mentioned in the previous request

CHANGELOG.md

@@ -1,6 +1,7 @@
 ###  1.5 (Next Release)
 
   * **Features**:
+    * Added `Service_GetStatus` - (https://github.com/dblock/msiext/pull/8)
   * **Bugs**: 
   * **Misc**:
     * [#5] (https://github.com/dblock/msiext/pull/5) - Fixed WiX UI extension screens: texts, icons, margins, spacing - [@romanws](https://github.com/romanws).

src/Common/Service/ServiceInstance.cpp

@@ -134,6 +134,27 @@ DWORD ServiceInstance::GetServiceState() const
     return status.dwCurrentState;
 }
 
+static std::wstring serviceStateToString(DWORD dwCurrentState)
+{
+	const wchar_t* st = L"Unknown";
+
+	switch (dwCurrentState) {
+		case SERVICE_STOPPED:          st = L"Stopped";  break;
+		case SERVICE_START_PENDING:    st = L"Starting"; break;
+		case SERVICE_STOP_PENDING:     st = L"Stopping"; break;
+		case SERVICE_RUNNING:          st = L"Running";  break;
+		case SERVICE_CONTINUE_PENDING: st = L"Resuming"; break;
+		case SERVICE_PAUSE_PENDING:    st = L"Pausing";  break;
+		case SERVICE_PAUSED:           st = L"Paused";   break;
+	}
+	return st;
+}
+
+std::wstring ServiceInstance::GetServiceStateString()
+{
+	return serviceStateToString( GetServiceState() );
+}
+
 bool ServiceInstance::Wait(DWORD timeout) const
 {
     DWORD slept = 0;

src/Common/Service/ServiceInstance.h

@@ -42,6 +42,8 @@ namespace AppSecInc
             void Continue();
             //! return the service state
             DWORD GetServiceState() const;
+            //! return string presentation of the service state
+            std::wstring GetServiceStateString();
             //! returns true if the service is started
             bool IsStarted() const { return (GetServiceState() == SERVICE_RUNNING); }
             //! returns true if the service is stopped

src/Common/Service/ServiceInstanceUnitTests.cpp

@@ -40,6 +40,16 @@ void ServiceInstanceUnitTests::testGetServiceProcessStatus()
     CPPUNIT_ASSERT(0 != status.dwProcessId);
 }
 
+void ServiceInstanceUnitTests::testGetServiceStateString()
+{
+    ServiceManager scm;
+    scm.Open();
+    ServiceInstance instance;
+    instance.Open(scm, L"W32Time");
+    std::wstring state = instance.GetServiceStateString();
+    CPPUNIT_ASSERT( L"Running" == state );
+}
+
 void ServiceInstanceUnitTests::testControl()
 {
     ServiceManager scm;

src/Common/Service/ServiceInstanceUnitTests.h

@@ -13,6 +13,7 @@ namespace AppSecInc
 				CPPUNIT_TEST( testCreateDelete );
                 CPPUNIT_TEST( testOpenClose );
                 CPPUNIT_TEST( testGetServiceProcessStatus );
+                CPPUNIT_TEST( testGetServiceStateString );
                 CPPUNIT_TEST( testControl );
 				CPPUNIT_TEST( testGetConfig );
 				CPPUNIT_TEST( testGetDescription );
@@ -23,6 +24,7 @@ namespace AppSecInc
                 void testOpenClose();
                 void testControl();
                 void testGetServiceProcessStatus();
+                void testGetServiceStateString();
 				void testGetConfig();
 				void testGetDescription();
 			};

src/CustomActions/SystemTools/ServiceImpl.cpp

@@ -171,3 +171,27 @@ CA_API UINT __stdcall Service_Exists(MSIHANDLE hInstall)
 	MSI_EXCEPTION_HANDLER_EPILOG;
     return ERROR_SUCCESS;
 }
+
+
+CA_API UINT __stdcall Service_GetStatus(MSIHANDLE hInstall)
+{
+	MSI_EXCEPTION_HANDLER_PROLOG;
+	MsiInstall msiInstall(hInstall);
+
+	std::wstring service_name = msiInstall.GetProperty(L"SERVICE_STATUS_SERVICE_NAME");
+	if (service_name.empty()) {
+		service_name = msiInstall.GetProperty(L"SERVICE_NAME");
+	}
+
+	AppSecInc::Service::ServiceManager scm;
+	scm.Open(SC_MANAGER_CONNECT|STANDARD_RIGHTS_READ);
+	AppSecInc::Service::ServiceInstance service;
+	service.Open( scm, service_name );
+	std::wstring state = service.GetServiceStateString();
+
+	msiInstall.SetProperty(L"SERVICE_STATUS", state);
+
+	MSI_EXCEPTION_HANDLER_EPILOG;
+	return ERROR_SUCCESS;
+}
+

src/CustomActions/SystemTools/ServiceImpl.h

@@ -100,3 +100,13 @@ CA_API UINT __stdcall Service_GetConfig(MSIHANDLE hInstall);
 \return SERVICE_EXISTS set to "1" if service exists, "0" otherwise
 */
 CA_API UINT __stdcall Service_Exists(MSIHANDLE hInstall);
+
+/*! 
+
+\brief Get status of a service
+\param SERVICE_STATUS_SERVICE_NAME service name
+\param SERVICE_NAME alternative property for service name, used when SERVICE_STATUS_SERVICE_NAME is not set
+\return SERVICE_STATUS set to one of: Stopped, Starting, Stopping, Running, Resuming, Pausing, Paused depending on the current service state. Fails if service does not exist; SERVICE_STATUS is unchanged in this case.
+*/
+CA_API UINT __stdcall Service_GetStatus(MSIHANDLE hInstall);
+

src/CustomActions/SystemTools/ServiceImplUnitTests.cpp

@@ -21,6 +21,7 @@ void ServiceImplUnitTests::Test_EntryPoints()
 	CPPUNIT_ASSERT(NULL != GetProcAddress(h, "Service_Delete"));
 	CPPUNIT_ASSERT(NULL != GetProcAddress(h, "Service_GetConfig"));
 	CPPUNIT_ASSERT(NULL != GetProcAddress(h, "Service_Exists"));
+	CPPUNIT_ASSERT(NULL != GetProcAddress(h, "Service_GetStatus"));
 	::FreeLibrary(h);
 }
 
@@ -218,3 +219,37 @@ void ServiceImplUnitTests::Test_Service_Exists()
 	CPPUNIT_ASSERT(ERROR_SUCCESS == hInstall.ExecuteCA(L"SystemTools.dll", L"Service_Exists"));
 	CPPUNIT_ASSERT(L"0" == msiInstall.GetProperty(L"SERVICE_EXISTS"));
 }
+
+void ServiceImplUnitTests::Test_Service_GetStatus()
+{
+	AppSecInc::Msi::MsiShim hInstall;
+	MsiInstall msiInstall(hInstall);
+
+	msiInstall.SetProperty(L"SERVICE_STATUS_SERVICE_NAME", L"W32Time");
+	CPPUNIT_ASSERT(ERROR_SUCCESS == hInstall.ExecuteCA(L"SystemTools.dll", L"Service_GetStatus"));
+	CPPUNIT_ASSERT(L"Running" == msiInstall.GetProperty(L"SERVICE_STATUS"));
+
+	msiInstall.SetProperty(L"SERVICE_STATUS_SERVICE_NAME", L"Wecsvc");
+	CPPUNIT_ASSERT(ERROR_SUCCESS == hInstall.ExecuteCA(L"SystemTools.dll", L"Service_GetStatus"));
+	CPPUNIT_ASSERT(L"Stopped" == msiInstall.GetProperty(L"SERVICE_STATUS"));
+
+	msiInstall.SetProperty(L"SERVICE_STATUS_SERVICE_NAME", AppSecInc::Com::GenerateGUIDStringW());
+	CPPUNIT_ASSERT(ERROR_SUCCESS != hInstall.ExecuteCA(L"SystemTools.dll", L"Service_GetStatus"));
+	// SERVICE_STATUS should remain unchanged
+	CPPUNIT_ASSERT(L"Stopped" == msiInstall.GetProperty(L"SERVICE_STATUS"));
+}
+
+void ServiceImplUnitTests::Test_Service_GetStatus_Accepts_SERVICE_NAME()
+{
+	AppSecInc::Msi::MsiShim hInstall;
+	MsiInstall msiInstall(hInstall);
+
+	msiInstall.SetProperty(L"SERVICE_NAME", L"W32Time");
+	CPPUNIT_ASSERT(ERROR_SUCCESS == hInstall.ExecuteCA(L"SystemTools.dll", L"Service_GetStatus"));
+	CPPUNIT_ASSERT(L"Running" == msiInstall.GetProperty(L"SERVICE_STATUS"));
+
+	// more specific name should override generic one:
+	msiInstall.SetProperty(L"SERVICE_STATUS_SERVICE_NAME", L"Wecsvc");
+	CPPUNIT_ASSERT(ERROR_SUCCESS == hInstall.ExecuteCA(L"SystemTools.dll", L"Service_GetStatus"));
+	CPPUNIT_ASSERT(L"Stopped" == msiInstall.GetProperty(L"SERVICE_STATUS"));
+}

src/CustomActions/SystemTools/ServiceImplUnitTests.h

@@ -18,6 +18,8 @@ namespace AppSecInc
 				CPPUNIT_TEST( Test_Service_Delete );
 				CPPUNIT_TEST( Test_Service_GetConfig );
 				CPPUNIT_TEST( Test_Service_Exists );
+				CPPUNIT_TEST( Test_Service_GetStatus );
+				CPPUNIT_TEST( Test_Service_GetStatus_Accepts_SERVICE_NAME );
 				CPPUNIT_TEST_SUITE_END();
 			private:
 				std::wstring service_name;
@@ -33,6 +35,8 @@ namespace AppSecInc
                 void Test_Service_Control();
 				void Test_Service_GetConfig();
 				void Test_Service_Exists();
+				void Test_Service_GetStatus();
+				void Test_Service_GetStatus_Accepts_SERVICE_NAME();
 			};
 		}
 	}

src/CustomActions/SystemTools/SystemTools.def

@@ -35,6 +35,7 @@ EXPORTS
 	Service_ChangeDescription
 	Service_GetConfig
 	Service_Exists
+	Service_GetStatus
 	TemplateFiles_Immediate
 	TemplateFiles_Deferred
 	Registry_CopyBranch