add more docstrings
[logparse.git] / logparse / parsers / smbd.py
index 1bf06bdaac0d940cc51a44255f6c7ff3682cc367..963c8e6213fddf6cc13139c3029a49547c483f13 100644 (file)
@@ -8,72 +8,75 @@
 import re
 import glob
 
-from ..formatting import *
-from ..util import readlog, resolve
-from .. import config
+from logparse.formatting import *
+from logparse.util import readlog, resolve
+from logparse import config
+from logparse.load_parsers import Parser
 
-import logging
-logger = logging.getLogger(__name__)
+class Smbd(Parser):
 
-def parse_log():
-    output = ''
-    logger.debug("Starting smbd section")
-    output += opentag('div', 1, 'smbd', 'section')
-    files = glob.glob(config.prefs['logs']['smb'] + "/log.*[!\.gz][!\.old]")    # find list of logfiles
-    # for f in files:
+    def __init__(self):
+        super().__init__()
+        self.name = "smbd"
+        self.info = "Get login statistics for a samba server."
 
-        # file_mod_time = os.stat(f).st_mtime
+    def parse_log(self):
+        logger.debug("Starting smbd section")
+        section = Section("smbd")
+        files = glob.glob(config.prefs.get("logs", "smbd") + "/log.*[!\.gz][!\.old]")    # find list of logfiles
+        # for f in files:
 
-        # Time in seconds since epoch for time, in which logfile can be unmodified.
-        # should_time = time.time() - (30 * 60)
+            # file_mod_time = os.stat(f).st_mtime
 
-        # Time in minutes since last modification of file
-        # last_time = (time.time() - file_mod_time)
-        # logger.debug(last_time)
+            # Time in seconds since epoch for time, in which logfile can be unmodified.
+            # should_time = time.time() - (30 * 60)
 
-        # if (file_mod_time - should_time) < args.time:
-            # print "CRITICAL: {} last modified {:.2f} minutes. Threshold set to 30 minutes".format(last_time, file, last_time)
-        # else:
+            # Time in minutes since last modification of file
+            # last_time = (time.time() - file_mod_time)
+            # logger.debug(last_time)
 
-        # if (datetime.timedelta(datetime.datetime.now() - datetime.fromtimestamp(os.path.getmtime(f))).days > 7):
-            # files.remove(f)
-    logger.debug("Found log files " + str(files))
-    n_auths = 0         # total number of logins from all users
-    sigma_auths = []    # contains users
+            # if (file_mod_time - should_time) < args.time:
+                # print "CRITICAL: {} last modified {:.2f} minutes. Threshold set to 30 minutes".format(last_time, file, last_time)
+            # else:
 
-    for file in files:  # one log file for each client
+            # if (datetime.timedelta(datetime.datetime.now() - datetime.fromtimestamp(os.path.getmtime(f))).days > 7):
+                # files.remove(f)
+        logger.debug("Found log files " + str(files))
+        n_auths = 0         # total number of logins from all users
+        sigma_auths = []    # contains users
 
-        logger.debug("Looking at file " + file)
+        for file in files:  # one log file for each client
 
-        # find the machine (ip or hostname) that this file represents
-        ip = re.search('log\.(.*)', file).group(1)    # get ip or hostname from file path (/var/log/samba/log.host)
-        host = resolve(ip, fqdn=config.prefs['smbd']['resolve-domains'])
-        if (host == ip and (config.prefs['smbd']['resolve-domains'] or config.prefs['resolve-domains']) != 'ip'):    # if ip has disappeared, fall back to a hostname from logfile
-            newhost = re.findall('.*\]\@\[(.*)\]', readlog(file))
-            if (len(set(newhost)) == 1):    # all hosts in one file should be the same
-                host = newhost[0].lower()
+            logger.debug("Looking at file " + file)
 
-        # count number of logins from each user-host pair
-        matches = re.findall('.*(?:authentication for user \[|connect to service .* initially as user )(\S*)(?:\] .*succeeded| \()', readlog(file))
-        for match in matches:
-            userhost = match + "@" + host
-            sigma_auths.append(userhost)
-            # exists = [i for i, item in enumerate(sigma_auths) if re.search(userhost, item[0])]
-            # if (exists == []):
-            #     sigma_auths.append([userhost, 1])
-            # else:
-            #     sigma_auths[exists[0]][1] += 1
-            n_auths += 1
-    output += writetitle("samba")
-    subtitle = plural("login", n_auths) + " from"
-    if (len(sigma_auths) == 1):             # if only one user, do not display no of logins for this user
-        subtitle += ' ' + sigma_auths[0][0]
-        output += writedata(subtitle)
-    else:       # multiple users
-        sigma_auths = orderbyfreq(sigma_auths)
-        sigma_auths = truncl(sigma_auths, config.prefs['maxlist'])
-        logger.debug("Found {0} samba logins".format(str(n_auths)))
-        output += writedata(subtitle, sigma_auths)
-    output += closetag('div', 1)
-    logger.info("Finished smbd section")
-    return output
+            # find the machine (ip or hostname) that this file represents
+            ip = re.search('log\.(.*)', file).group(1)    # get ip or hostname from file path (/var/log/samba/log.host)
+            host = resolve(ip, fqdn=config.prefs.get("smbd", "smbd-resolve-domains"))
+            if host == ip and (config.prefs.get("smbd", "smbd-resolve-domains") != "ip" or config.prefs.get("logparse", "resolve-domains") != "ip"):    # if ip has disappeared, fall back to a hostname from logfile
+                newhost = re.findall('.*\]\@\[(.*)\]', readlog(file))
+                if (len(set(newhost)) == 1):    # all hosts in one file should be the same
+                    host = newhost[0].lower()
+
+            # count number of logins from each user-host pair
+            matches = re.findall('.*(?:authentication for user \[|connect to service .* initially as user )(\S*)(?:\] .*succeeded| \()', readlog(file))
+            for match in matches:
+                userhost = match + "@" + host
+                sigma_auths.append(userhost)
+                # exists = [i for i, item in enumerate(sigma_auths) if re.search(userhost, item[0])]
+                # if (exists == []):
+                #     sigma_auths.append([userhost, 1])
+                # else:
+                #     sigma_auths[exists[0]][1] += 1
+                n_auths += 1
+        auth_data = Data(subtitle=plural("login", n_auths) + " from")
+        if (len(sigma_auths) == 1):             # if only one user, do not display no of logins for this user
+            auth_data.subtitle += ' ' + sigma_auths[0][0]
+            section.append_data(auth_data)
+        else:       # multiple users
+            auth_data.items = sigma_auths
+            auth_data.orderbyfreq()
+            auth_data.truncl(config.prefs.getint("logparse", "maxlist"))
+            logger.debug("Found {0} samba logins".format(str(n_auths)))
+        section.append_data(auth_data)
+        logger.info("Finished smbd section")
+        return section