
'''
File                : log.py 

Start Date        : 19980107 

Description        : Eddie Software Logfile stuff

$Id: log.py 892 2007-12-09 06:52:58Z chris $
'''

__version__ = '$Revision: 892 $'

__copyright__ = 'Copyright (c) Chris Miles 1998-2005'

__author__ = 'Chris Miles; Rod Telford'

__license__ = '''
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
'''


# Python imports
import time, os, threading

# Eddie imports
import utils

##
## Logfile & Log level (defaults)
##
logfile = "/var/log/eddie.log"
loglevel = 2
hostname = None                # normally overwritten during startup

adminemail = 'root'
adminlevel = 0
adminlog = []
admin_notify = 86400        # default send admin summaries once per day
admin_notify_time = 0        # track time till next notify

loglevel_min = 0
loglevel_max = 9

def log(text='', level=1):
    """log() - if (level <= loglevel), text is appended to logfile
          with date/time prepended (nothing is ever logged when loglevel is 0).
          If (level <= adminlevel) then store log in adminlog list (never store
          anything if adminlevel is 0).
    """

    if loglevel == 0 and adminlevel == 0:
        return 0                # not logged

    datetime = time.asctime(time.localtime(time.time()))
    threadname = threading.currentThread().getName()
    logtext = "%s (%s)[%d]:%s\n" % (datetime,threadname,level,text)

    logged = 0                        # flag if anything is logged

    if level > 0 and level <= loglevel:
        # log to logfile
        try:
            logf = open( logfile, 'a' )
            logf.write( logtext )
            logf.close()
            logged = logged + 1
        except IOError:
            # Cannot open logfile for writing - save this problem in adminlog
            logstr = "<Log>log() - Log warning - cannot write to logfile '%s'" % logfile
            print logstr
            datetime = time.asctime(time.localtime(time.time()))
            logtext = "%s [%d]:%s\n" % (datetime,3,logstr)
            adminlog.append( logtext )

    if adminlevel > 0 and level <= adminlevel:
        # log to adminlog
        adminlog.append(logtext)
        logged = logged + 1

    return logged                # 0=not logged, >0=logged


def sendadminlog( override=0 ):
    """sendadminlog() - send adminlog list to adminemail only if there
        is something in this list.
        If override==1 then admin_notify times are ignored.
    """

    global admin_notify_time
    global adminlog

    if override == 0:
        # if no admin_notify_time set, set one and return
        if admin_notify_time == 0:
            admin_notify_time = time.time() + admin_notify
            return
    
        # if time hasn't reached admin_notify_time then return
        if time.time() < admin_notify_time:
            return

    # time for notify - set new time and send the adminlog
    admin_notify_time = time.time() + admin_notify

    # if there isn't anything in adminlog don't bother
    if len(adminlog) == 0:
        return

    headers = 'To: %s\n' % adminemail
    headers = headers + 'Subject: [%s] Eddie Admin Messages\n' % hostname

    body = "Greetings Eddie Admin '%s', the following log messages are\n" % adminemail
    body = body + "being delivered to you for your perusal.  Enjoy.\n\n"
    body = body + "[Host:%s LogLevel=%d AdminLevel=%d AdminNotify=%s secs]\n" % (hostname,loglevel, adminlevel, admin_notify)
    body = body + "------------------------------------------------------------------------------\n"

    for i in adminlog:
        body = body + "%s" % (i)

    body = body + "------------------------------------------------------------------------------\n"
    r = utils.sendmail( headers, body )

    # clear adminlog
    adminlog = []


##
## END - log.py
##
