home *** CD-ROM | disk | FTP | other *** search
/ Chip 2004 July / CMCD0704.ISO / Software / Shareware / Comunicatii / jyte / jyte.exe / win32evtlogutil.py < prev    next >
Text File  |  2003-09-22  |  6KB  |  151 lines
  1. """Event Log Utilities - helper for win32evtlog.pyd
  2. """
  3.  
  4. import win32api, win32con, winerror, win32evtlog, string
  5.  
  6. error = win32api.error # The error the evtlog module raises.
  7.  
  8. langid = win32api.MAKELANGID(win32con.LANG_NEUTRAL, win32con.SUBLANG_NEUTRAL)
  9.  
  10. def AddSourceToRegistry(appName, msgDLL = None, eventLogType = "Application", eventLogFlags = None):
  11.   """Add a source of messages to the event log.
  12.  
  13.   Allows Python program to register a custom source of messages in the
  14.   registry.  You must also provide the DLL name that has the message table, so the
  15.   full message text appears in the event log.
  16.  
  17.   Note that the win32evtlog.pyd file has a number of string entries with just "%1"
  18.   built in, so many Python programs can simply use this DLL.  Disadvantages are that
  19.   you do not get language translation, and the full text is stored in the event log,
  20.   blowing the size of the log up.
  21.   """
  22.   
  23.   # When an application uses the RegisterEventSource or OpenEventLog
  24.   # function to get a handle of an event log, the event loggging service
  25.   # searches for the specified source name in the registry. You can add a
  26.   # new source name to the registry by opening a new registry subkey
  27.   # under the Application key and adding registry values to the new
  28.   # subkey. 
  29.  
  30.   if msgDLL is None:
  31.     msgDLL = win32evtlog.__file__
  32.  
  33.   # Create a new key for our application 
  34.   hkey = win32api.RegCreateKey(win32con.HKEY_LOCAL_MACHINE, \
  35.       "SYSTEM\\CurrentControlSet\\Services\\EventLog\\%s\\%s" % (eventLogType, appName))
  36.  
  37.   # Add the Event-ID message-file name to the subkey.
  38.   win32api.RegSetValueEx(hkey, 
  39.       "EventMessageFile",    # value name \
  40.       0,                     # reserved \
  41.       win32con.REG_EXPAND_SZ,# value type \
  42.       msgDLL)
  43.  
  44.   # Set the supported types flags and add it to the subkey.
  45.   if eventLogFlags is None:
  46.     eventLogFlags = win32evtlog.EVENTLOG_ERROR_TYPE | win32evtlog.EVENTLOG_WARNING_TYPE | win32evtlog.EVENTLOG_INFORMATION_TYPE
  47.   win32api.RegSetValueEx(hkey, # subkey handle \
  48.       "TypesSupported",        # value name \
  49.       0,                       # reserved \
  50.       win32con.REG_DWORD,      # value type \
  51.       eventLogFlags)
  52.   win32api.RegCloseKey(hkey)
  53.  
  54. def RemoveSourceFromRegistry(appName, eventLogType = "Application"):
  55.   """Removes a source of messages from the event log.
  56.   """
  57.   
  58.   # Delete our key 
  59.   try:
  60.     win32api.RegDeleteKey(win32con.HKEY_LOCAL_MACHINE, \
  61.                  "SYSTEM\\CurrentControlSet\\Services\\EventLog\\%s\\%s" % (eventLogType, appName))
  62.   except win32api.error, (hr, fn, desc):
  63.      if hr != winerror.ERROR_FILE_NOT_FOUND:
  64.        raise
  65.  
  66.  
  67. def ReportEvent(appName, eventID, eventCategory = 0, eventType=win32evtlog.EVENTLOG_ERROR_TYPE, strings = None, data = None, sid=None):
  68.   """Report an event for a previously added event source.
  69.   """
  70.     
  71.   # Get a handle to the Application event log 
  72.   hAppLog = win32evtlog.RegisterEventSource(None, appName)
  73.  
  74.   # Now report the event, which will add this event to the event log */
  75.   win32evtlog.ReportEvent(hAppLog, # event-log handle \
  76.       eventType,
  77.       eventCategory,
  78.       eventID,
  79.       sid,
  80.       strings,
  81.       data)
  82.  
  83.   win32evtlog.DeregisterEventSource(hAppLog);
  84.  
  85. def FormatMessage( eventLogRecord, logType="Application" ):
  86.     """Given a tuple from ReadEventLog, and optionally where the event
  87.     record came from, load the message, and process message inserts.
  88.  
  89.     Note that this function may raise win32api.error.  See also the
  90.     function SafeFormatMessage which will return None if the message can
  91.     not be processed.
  92.     """
  93.     
  94.     # From the event log source name, we know the name of the registry
  95.     # key to look under for the name of the message DLL that contains
  96.     # the messages we need to extract with FormatMessage. So first get
  97.     # the event log source name...
  98.     keyName = "SYSTEM\\CurrentControlSet\\Services\\EventLog\\%s\\%s" % (logType, eventLogRecord.SourceName)
  99.  
  100.     # Now open this key and get the EventMessageFile value, which is
  101.     # the name of the message DLL.
  102.     handle = win32api.RegOpenKey(win32con.HKEY_LOCAL_MACHINE, keyName)
  103.     try:
  104.         dllNames = win32api.RegQueryValueEx(handle, "EventMessageFile")[0].split(";")
  105.         # Win2k etc appear to allow multiple DLL names
  106.         data = None
  107.         for dllName in dllNames:
  108.             # Expand environment variable strings in the message DLL path name,
  109.             # in case any are there.
  110.             dllName = win32api.ExpandEnvironmentStrings(dllName)
  111.  
  112.             dllHandle = win32api.LoadLibraryEx(dllName, 0, win32con.DONT_RESOLVE_DLL_REFERENCES)
  113.             try:
  114.                 data = win32api.FormatMessageW(win32con.FORMAT_MESSAGE_FROM_HMODULE, 
  115.                         dllHandle, eventLogRecord.EventID, langid, eventLogRecord.StringInserts)
  116.             finally:
  117.                 win32api.FreeLibrary(dllHandle)
  118.             if data is not None:
  119.                 break
  120.     finally:
  121.         win32api.RegCloseKey(handle)
  122.     return data or u'' # Don't want "None" ever being returned.
  123.  
  124. def SafeFormatMessage( eventLogRecord, logType=None ):
  125.     """As for FormatMessage, except returns an error message if
  126.     the message can not be processed.
  127.     """
  128.     if logType is None: logType = "Application"
  129.     try:
  130.         return FormatMessage(eventLogRecord, logType)
  131.     except win32api.error:
  132.         if eventLogRecord.StringInserts is None:
  133.             desc = ""
  134.         else:
  135.             desc = u", ".join(eventLogRecord.StringInserts)
  136.         return u"<The description for Event ID ( %d ) in Source ( %r ) could not be found. It contains the following insertion string(s):%r.>" % (winerror.HRESULT_CODE(eventLogRecord.EventID), eventLogRecord.SourceName, desc)
  137.  
  138. def FeedEventLogRecords(feeder, machineName = None, logName = "Application", readFlags = None):
  139.     if readFlags is None:
  140.         readFlags = win32evtlog.EVENTLOG_BACKWARDS_READ|win32evtlog.EVENTLOG_SEQUENTIAL_READ
  141.  
  142.     h=win32evtlog.OpenEventLog(machineName, logName)
  143.     try:
  144.         while 1:
  145.             objects = win32evtlog.ReadEventLog(h, readFlags, 0)
  146.             if not objects:
  147.                 break
  148.             map(lambda item, feeder = feeder: apply(feeder, (item,)), objects)
  149.     finally:
  150.         win32evtlog.CloseEventLog(h)
  151.