poezio/src/logger.py

# Copyright 2010-2011 Florent Le Coz <louiz@louiz.org>
#
# This file is part of Poezio.
#
# Poezio is free software: you can redistribute it and/or modify
# it under the terms of the zlib license. See the COPYING file.

from os import environ, makedirs
import os
from datetime import datetime
from config import config
from xhtml import clean_text

import logging

log = logging.getLogger(__name__)

DATA_HOME = config.get('log_dir', '') or os.path.join(environ.get('XDG_DATA_HOME') or os.path.join(environ.get('HOME'), '.local', 'share'), 'poezio')
DATA_HOME = os.path.expanduser(DATA_HOME)

class Logger(object):
    """
    Appends things to files. Error/information/warning logs
    and also log the conversations to logfiles
    """
    def __init__(self):
        self.logfile = config.get('logfile', 'logs')
        self.roster_logfile = None
        # a dict of 'groupchatname': file-object (opened)
        self.fds = dict()

    def __del__(self):
        for opened_file in self.fds.values():
            if opened_file:
                try:
                    opened_file.close()
                except: # Can't close? too bad
                    pass

    def reload_all(self):
        """Close and reload all the file handles (on SIGHUP)"""
        for opened_file in self.fds.values():
            if opened_file:
                opened_file.close()
        log.debug('All log file handles closed')
        for room in self.fds:
            self.fds[room] = self.check_and_create_log_dir(room)
            log.debug('Log handle for %s re-created', room)

    def check_and_create_log_dir(self, room):
        """
        Check that the directory where we want to log the messages
        exists. if not, create it
        """
        if config.get_by_tabname('use_log', 'false', room) == 'false':
            return
        directory = os.path.join(DATA_HOME, 'logs')
        try:
            makedirs(directory, exist_ok=True)
        except OSError:
            import traceback
            log.debug('Cannot create log directory "%s":\n%s', directory, traceback.format_exc())
        try:
            fd = open(os.path.join(directory, room), 'a')
            self.fds[room] = fd
            return fd
        except IOError:
            import traceback
            log.debug('Cannot open logfile %s:\n%s', room, traceback.format_exc())
            return

    def get_logs(self, jid, nb=10):
        """
        Get the log history for the given jid
        """
        if config.get_by_tabname('load_log', 10, jid) <= 0:
            return

        if nb <= 0:
            return
        directory = os.path.join(DATA_HOME, 'logs')
        try:
            fd = open(os.path.join(directory, jid), 'r')
        except:
            return
        if not fd:
            return

        pos = fd.seek(0, 2)
        reads = fd.readlines()
        while len(reads) < nb + 1:
            if pos == 0:
                break
            pos -= 100
            if pos < 0:
                pos = 0
            fd.seek(pos)
            try:
                reads = fd.readlines()
            except UnicodeDecodeError:
                pass
        fd.close()
        logs = reads[-nb:]
        return logs

    def log_message(self, jid, nick, msg, date=None, typ=1):
        """
        log the message in the appropriate jid's file
        type: 1 = Message
              2 = Status/whatever
        """
        jid = str(jid).replace('/', '\\')
        if config.get_by_tabname('use_log', 'false', jid) != 'true':
            return True
        if jid in self.fds.keys():
            fd = self.fds[jid]
        else:
            fd = self.check_and_create_log_dir(jid)
        if not fd:
            return True
        try:
            msg = clean_text(msg)
            if date is None:
                str_time = datetime.now().strftime('%Y%m%dT%H%M%SZ')
            else:
                str_time = date.strftime('%Y%m%dT%H%M%SZ')
            if typ == 1:
                prefix = 'MR'
            else:
                prefix = 'MI'
            lines = msg.count('\n')
            lines = str(lines).zfill(3)
            if nick:
                nick = '<' + nick + '>'
                fd.write(' '.join((prefix, str_time, lines, nick, msg, '\n')))
            else:
                fd.write(' '.join((prefix, str_time, lines, msg, '\n')))
        except:
            return False
        else:
            try:
                fd.flush()          # TODO do something better here?
            except:
                return False
        return True

    def log_roster_change(self, jid, message):
        """
        Log a roster change
        """
        if config.get_by_tabname('use_log', 'false', jid) != 'true':
            return True
        if not self.roster_logfile:
            try:
                self.roster_logfile = open(os.path.join(DATA_HOME, 'logs', 'roster.log'), 'a')
            except IOError:
                return False
        try:
            str_time = datetime.now().strftime('%Y%m%dT%H%M%SZ')
            message = clean_text(message)
            lines = str(message.count('\n')).zfill(3)
            self.roster_logfile.write('MI %s %s %s %s\n' % (str_time, lines, jid, message))
            self.roster_logfile.flush()
        except:
            return False
        return True

logger = Logger()