"""
Module for manipulating WinNT, Win2k & WinXP services.
Requires the win32all package which can be retrieved
from => http://starship.python.net/crew/mhammond
"""
import sys, time
import win32api as wa, win32con as wc, win32service as ws
class WService:
"""
The WService Class is used for controlling WinNT, Win2k & WinXP like
services. Just pass the name of the service you wish to control to the
class instance and go from there. For example, if you want to control
the Workstation service try this:
import WService
workstation = WService.WService("Workstation")
workstation.start()
workstation.fetchstatus("running", 10)
workstation.stop()
workstation.fetchstatus("stopped")
Creating an instance of the WService class is done by passing the name of
the service as it appears in the Management Console or the short name as
it appears in the registry. Mixed case is ok.
cvs = WService.WService("CVS NT Service 1.11.1.2 (Build 41)")
or
cvs = WService.WService("cvs")
If needing remote service control try this:
cvs = WService.WService("cvs", r"\\CVS_SERVER")
or
cvs = WService.WService("cvs", "\\\\CVS_SERVER")
The WService Class supports these methods:
start: Starts service.
stop: Stops service.
restart: Stops and restarts service.
pause: Pauses service (Only if service supports feature).
resume: Resumes service that has been paused.
status: Queries current status of service.
fetchstatus: Continually queries service until requested status(STARTING, RUNNING,
STOPPING & STOPPED) is met or timeout value(in seconds) reached.
Default timeout value is infinite.
infotype: Queries service for process type. (Single, shared and/or
interactive process)
infoctrl: Queries control information about a running service.
i.e. Can it be paused, stopped, etc?
infostartup: Queries service Startup type. (Boot, System,
Automatic, Manual, Disabled)
setstartup Changes/sets Startup type. (Boot, System,
Automatic, Manual, Disabled)
getname: Gets the long and short service names used by Windows.
(Generally used for internal purposes)
"""
def __init__(self, service, machinename=None, dbname=None):
self.userv = service
self.scmhandle = ws.OpenSCManager(machinename, dbname, ws.SC_MANAGER_ALL_ACCESS)
self.sserv, self.lserv = self.getname()
if (self.sserv or self.lserv) == None: sys.exit()
self.handle = ws.OpenService(self.scmhandle, self.sserv, ws.SERVICE_ALL_ACCESS)
self.sccss = "SYSTEM\\CurrentControlSet\\Services\\"
def start(self):
ws.StartService(self.handle, None)
def stop(self):
self.stat = ws.ControlService(self.handle, ws.SERVICE_CONTROL_STOP)
def restart(self):
self.stop()
self.fetchstatus("STOPPED")
self.start()
def pause(self):
self.stat = ws.ControlService(self.handle, ws.SERVICE_CONTROL_PAUSE)
def resume(self):
self.stat = ws.ControlService(self.handle, ws.SERVICE_CONTROL_CONTINUE)
def status(self, prn = 0):
self.stat = ws.QueryServiceStatus(self.handle)
if self.stat[1]==ws.SERVICE_STOPPED:
if prn == 1:
print "The %s service is stopped." % self.lserv
else:
return "STOPPED"
elif self.stat[1]==ws.SERVICE_START_PENDING:
if prn == 1:
print "The %s service is starting." % self.lserv
else:
return "STARTING"
elif self.stat[1]==ws.SERVICE_STOP_PENDING:
if prn == 1:
print "The %s service is stopping." % self.lserv
else:
return "STOPPING"
elif self.stat[1]==ws.SERVICE_RUNNING:
if prn == 1:
print "The %s service is running." % self.lserv
else:
return "RUNNING"
def fetchstatus(self, fstatus, timeout=None):
self.fstatus = fstatus.upper()
if timeout != None:
timeout = int(timeout); timeout *= 2
def to(timeout):
time.sleep(.5)
if timeout != None:
if timeout > 1:
timeout -= 1; return timeout
else:
return "TO"
if self.fstatus == "STOPPED":
while 1:
self.stat = ws.QueryServiceStatus(self.handle)
if self.stat[1]==ws.SERVICE_STOPPED:
self.fstate = "STOPPED"; break
else:
timeout=to(timeout)
if timeout == "TO":
return "TIMEDOUT"; break
elif self.fstatus == "STOPPING":
while 1:
self.stat = ws.QueryServiceStatus(self.handle)
if self.stat[1]==ws.SERVICE_STOP_PENDING:
self.fstate = "STOPPING"; break
else:
timeout=to(timeout)
if timeout == "TO":
return "TIMEDOUT"; break
elif self.fstatus == "RUNNING":
while 1:
self.stat = ws.QueryServiceStatus(self.handle)
if self.stat[1]==ws.SERVICE_RUNNING:
self.fstate = "RUNNING"; break
else:
timeout=to(timeout)
if timeout == "TO":
return "TIMEDOUT"; break
elif self.fstatus == "STARTING":
while 1:
self.stat = ws.QueryServiceStatus(self.handle)
if self.stat[1]==ws.SERVICE_START_PENDING:
self.fstate = "STARTING"; break
else:
timeout=to(timeout)
if timeout == "TO":
return "TIMEDOUT"; break
def infotype(self):
self.stat = ws.QueryServiceStatus(self.handle)
if self.stat[0] and ws.SERVICE_WIN32_OWN_PROCESS:
print "The %s service runs in its own process." % self.lserv
if self.stat[0] and ws.SERVICE_WIN32_SHARE_PROCESS:
print "The %s service shares a process with other services." % self.lserv
if self.stat[0] and ws.SERVICE_INTERACTIVE_PROCESS:
print "The %s service can interact with the desktop." % self.lserv
def infoctrl(self):
self.stat = ws.QueryServiceStatus(self.handle)
if self.stat[2] and ws.SERVICE_ACCEPT_PAUSE_CONTINUE:
print "The %s service can be paused." % self.lserv
if self.stat[2] and ws.SERVICE_ACCEPT_STOP:
print "The %s service can be stopped." % self.lserv
if self.stat[2] and ws.SERVICE_ACCEPT_SHUTDOWN:
print "The %s service can be shutdown." % self.lserv
def infostartup(self):
self.isuphandle = wa.RegOpenKeyEx(wc.HKEY_LOCAL_MACHINE, self.sccss + self.sserv, 0, wc.KEY_READ)
self.isuptype = wa.RegQueryValueEx(self.isuphandle, "Start")[0]
wa.RegCloseKey(self.isuphandle)
if self.isuptype == 0:
return "boot"
elif self.isuptype == 1:
return "system"
elif self.isuptype == 2:
return "automatic"
elif self.isuptype == 3:
return "manual"
elif self.isuptype == 4:
return "disabled"
def setstartup(self, startuptype):
self.startuptype = startuptype.lower()
if self.startuptype == "boot":
self.suptype = 0
elif self.startuptype == "system":
self.suptype = 1
elif self.startuptype == "automatic":
self.suptype = 2
elif self.startuptype == "manual":
self.suptype = 3
elif self.startuptype == "disabled":
self.suptype = 4
self.snc = ws.SERVICE_NO_CHANGE
ws.ChangeServiceConfig(self.handle, self.snc, self.suptype, \
self.snc, None, None, 0, None, None, None, self.lserv)
def getname(self):
self.snames=ws.EnumServicesStatus(self.scmhandle)
for i in self.snames:
if i[0].lower() == self.userv.lower():
return i[0], i[1]; break
if i[1].lower() == self.userv.lower():
return i[0], i[1]; break
print "Error: The %s service doesn't seem to exist." % self.userv
return None, None
Diff to Previous Revision
--- revision 9 2010-09-27 11:20:00
+++ revision 10 2010-09-27 11:39:52
@@ -1,19 +1,18 @@
"""
-Module for manipulating WinNT, Win2k & WinXP services.
-Requires the win32all package which can be retrieved
+Module for manipulating WinNT, Win2k & WinXP services.
+Requires the win32all package which can be retrieved
from => http://starship.python.net/crew/mhammond
"""
-from sys import exit
-import time, win32api, win32con, win32service
-wa, wc, ws = win32api, win32con, win32service
+import sys, time
+import win32api as wa, win32con as wc, win32service as ws
class WService:
"""
The WService Class is used for controlling WinNT, Win2k & WinXP like
services. Just pass the name of the service you wish to control to the
- class instance and go from there. For example, if you want to control
+ class instance and go from there. For example, if you want to control
the Workstation service try this:
-
+
import WService
workstation = WService.WService("Workstation")
workstation.start()
@@ -24,17 +23,17 @@
Creating an instance of the WService class is done by passing the name of
the service as it appears in the Management Console or the short name as
it appears in the registry. Mixed case is ok.
- cvs = WService.WService("CVS NT Service 1.11.1.2 (Build 41)")
+ cvs = WService.WService("CVS NT Service 1.11.1.2 (Build 41)")
or
cvs = WService.WService("cvs")
If needing remote service control try this:
cvs = WService.WService("cvs", r"\\CVS_SERVER")
or
- cvs = WService.WService("cvs", "\\\\CVS_SERVER")
-
+ cvs = WService.WService("cvs", "\\\\CVS_SERVER")
+
The WService Class supports these methods:
-
+
start: Starts service.
stop: Stops service.
restart: Stops and restarts service.
@@ -43,30 +42,30 @@
status: Queries current status of service.
fetchstatus: Continually queries service until requested status(STARTING, RUNNING,
STOPPING & STOPPED) is met or timeout value(in seconds) reached.
- Default timeout value is infinite.
- infotype: Queries service for process type. (Single, shared and/or
+ Default timeout value is infinite.
+ infotype: Queries service for process type. (Single, shared and/or
interactive process)
infoctrl: Queries control information about a running service.
i.e. Can it be paused, stopped, etc?
- infostartup: Queries service Startup type. (Boot, System,
+ infostartup: Queries service Startup type. (Boot, System,
Automatic, Manual, Disabled)
- setstartup Changes/sets Startup type. (Boot, System,
- Automatic, Manual, Disabled)
+ setstartup Changes/sets Startup type. (Boot, System,
+ Automatic, Manual, Disabled)
getname: Gets the long and short service names used by Windows.
(Generally used for internal purposes)
- """
-
+ """
+
def __init__(self, service, machinename=None, dbname=None):
self.userv = service
self.scmhandle = ws.OpenSCManager(machinename, dbname, ws.SC_MANAGER_ALL_ACCESS)
self.sserv, self.lserv = self.getname()
- if (self.sserv or self.lserv) == None: exit()
+ if (self.sserv or self.lserv) == None: sys.exit()
self.handle = ws.OpenService(self.scmhandle, self.sserv, ws.SERVICE_ALL_ACCESS)
self.sccss = "SYSTEM\\CurrentControlSet\\Services\\"
-
+
def start(self):
ws.StartService(self.handle, None)
-
+
def stop(self):
self.stat = ws.ControlService(self.handle, ws.SERVICE_CONTROL_STOP)
@@ -74,36 +73,36 @@
self.stop()
self.fetchstatus("STOPPED")
self.start()
-
+
def pause(self):
self.stat = ws.ControlService(self.handle, ws.SERVICE_CONTROL_PAUSE)
-
+
def resume(self):
self.stat = ws.ControlService(self.handle, ws.SERVICE_CONTROL_CONTINUE)
-
+
def status(self, prn = 0):
self.stat = ws.QueryServiceStatus(self.handle)
if self.stat[1]==ws.SERVICE_STOPPED:
if prn == 1:
- print "The", self.lserv, "service is stopped."
+ print "The %s service is stopped." % self.lserv
else:
return "STOPPED"
elif self.stat[1]==ws.SERVICE_START_PENDING:
if prn == 1:
- print "The", self.lserv, "service is starting."
+ print "The %s service is starting." % self.lserv
else:
return "STARTING"
elif self.stat[1]==ws.SERVICE_STOP_PENDING:
if prn == 1:
- print "The", self.lserv, "service is stopping."
+ print "The %s service is stopping." % self.lserv
else:
return "STOPPING"
elif self.stat[1]==ws.SERVICE_RUNNING:
if prn == 1:
- print "The", self.lserv, "service is running."
+ print "The %s service is running." % self.lserv
else:
return "RUNNING"
-
+
def fetchstatus(self, fstatus, timeout=None):
self.fstatus = fstatus.upper()
if timeout != None:
@@ -114,7 +113,7 @@
if timeout > 1:
timeout -= 1; return timeout
else:
- return "TO"
+ return "TO"
if self.fstatus == "STOPPED":
while 1:
self.stat = ws.QueryServiceStatus(self.handle)
@@ -132,7 +131,7 @@
else:
timeout=to(timeout)
if timeout == "TO":
- return "TIMEDOUT"; break
+ return "TIMEDOUT"; break
elif self.fstatus == "RUNNING":
while 1:
self.stat = ws.QueryServiceStatus(self.handle)
@@ -141,7 +140,7 @@
else:
timeout=to(timeout)
if timeout == "TO":
- return "TIMEDOUT"; break
+ return "TIMEDOUT"; break
elif self.fstatus == "STARTING":
while 1:
self.stat = ws.QueryServiceStatus(self.handle)
@@ -151,24 +150,24 @@
timeout=to(timeout)
if timeout == "TO":
return "TIMEDOUT"; break
-
+
def infotype(self):
self.stat = ws.QueryServiceStatus(self.handle)
- if self.stat[0] & ws.SERVICE_WIN32_OWN_PROCESS:
- print "The", self.lserv, "service runs in its own process."
- if self.stat[0] & ws.SERVICE_WIN32_SHARE_PROCESS:
- print "The", self.lserv, "service shares a process with other services."
- if self.stat[0] & ws.SERVICE_INTERACTIVE_PROCESS:
- print "The", self.lserv, "service can interact with the desktop."
-
+ if self.stat[0] and ws.SERVICE_WIN32_OWN_PROCESS:
+ print "The %s service runs in its own process." % self.lserv
+ if self.stat[0] and ws.SERVICE_WIN32_SHARE_PROCESS:
+ print "The %s service shares a process with other services." % self.lserv
+ if self.stat[0] and ws.SERVICE_INTERACTIVE_PROCESS:
+ print "The %s service can interact with the desktop." % self.lserv
+
def infoctrl(self):
self.stat = ws.QueryServiceStatus(self.handle)
- if self.stat[2] & ws.SERVICE_ACCEPT_PAUSE_CONTINUE:
- print "The", self.lserv, "service can be paused."
- if self.stat[2] & ws.SERVICE_ACCEPT_STOP:
- print "The", self.lserv, "service can be stopped."
- if self.stat[2] & ws.SERVICE_ACCEPT_SHUTDOWN:
- print "The", self.lserv, "service can be shutdown."
+ if self.stat[2] and ws.SERVICE_ACCEPT_PAUSE_CONTINUE:
+ print "The %s service can be paused." % self.lserv
+ if self.stat[2] and ws.SERVICE_ACCEPT_STOP:
+ print "The %s service can be stopped." % self.lserv
+ if self.stat[2] and ws.SERVICE_ACCEPT_SHUTDOWN:
+ print "The %s service can be shutdown." % self.lserv
def infostartup(self):
self.isuphandle = wa.RegOpenKeyEx(wc.HKEY_LOCAL_MACHINE, self.sccss + self.sserv, 0, wc.KEY_READ)
@@ -184,7 +183,7 @@
return "manual"
elif self.isuptype == 4:
return "disabled"
-
+
def setstartup(self, startuptype):
self.startuptype = startuptype.lower()
if self.startuptype == "boot":
@@ -199,8 +198,8 @@
self.suptype = 4
self.snc = ws.SERVICE_NO_CHANGE
ws.ChangeServiceConfig(self.handle, self.snc, self.suptype, \
- self.snc, None, None, 0, None, None, None, self.lserv)
-
+ self.snc, None, None, 0, None, None, None, self.lserv)
+
def getname(self):
self.snames=ws.EnumServicesStatus(self.scmhandle)
for i in self.snames:
@@ -208,5 +207,5 @@
return i[0], i[1]; break
if i[1].lower() == self.userv.lower():
return i[0], i[1]; break
- print "Error: The", self.userv, "service doesn't seem to exist."
+ print "Error: The %s service doesn't seem to exist." % self.userv
return None, None
