gajim-plural/src/common/logger.py

## logger.py
##
## Gajim Team:
## - Yann Le Boulanger <asterix@lagaule.org>
## - Vincent Hanquez <tab@snarc.org>
## - Nikos Kouremenos <kourem@gmail.com>
##
##      Copyright (C) 2003-2005 Gajim Team
##
## 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; version 2 only.
##
## 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.
##

import os
import sys
import time
import stat

import common.gajim
from common import i18n
_ = i18n._
from common import helpers

LOGPATH = os.path.expanduser('~/.gajim/logs')
if os.name == 'nt':
	try:
		# Documents and Settings\[User Name]\Application Data\Gajim\logs
		LOGPATH = os.environ['appdata'] + '/Gajim/Logs'
	except KeyError:
		# win9x, ./logs
		LOGPATH = 'Logs'

class Logger:
	def __init__(self):
		dot_gajim = os.path.dirname(LOGPATH)
		if os.path.isfile(dot_gajim):
			print _('%s is file but it should be a directory') % dot_gajim
			print _('Gajim will now exit')
			sys.exit()
		elif os.path.isdir(dot_gajim):
			s = os.stat(dot_gajim)
			if s.st_mode & stat.S_IROTH: # others have read permission!
				os.chmod(dot_gajim, 0700) # rwx------

			if not os.path.exists(LOGPATH):
				print _('creating %s directory') % LOGPATH
				os.mkdir(LOGPATH, 0700)
			elif os.path.isfile(LOGPATH):
				print _('%s is file but it should be a directory') % LOGPATH
				print _('Gajim will now exit')
				sys.exit()
			elif os.path.isdir(LOGPATH):
					s = os.stat(LOGPATH)
					if s.st_mode & stat.S_IROTH: # others have read permission!
						os.chmod(LOGPATH, 0700) # rwx------
		else: # dot_gajim doesn't exist
			if dot_gajim: # is '' on win9x so avoid that
				print _('creating %s directory') % dot_gajim
				os.mkdir(dot_gajim, 0700)
			if not os.path.isdir(LOGPATH):
				print _('creating %s directory') % LOGPATH
				os.mkdir(LOGPATH, 0700)

	def write(self, kind, msg, jid, show = None, tim = None):
		if not tim:
			tim = time.time()
		else:
			tim = time.mktime(tim)

		if not msg:
			msg = ''

		msg = helpers.to_one_line(msg)
		if len(jid.split('/')) > 1:
			ji, nick = jid.split('/', 1)
		else:
			ji = jid
			nick = ''
		files = []
		if kind == 'status': # we save time:jid:show:msg
			if not show:
				show = 'online'
			if common.gajim.config.get('log_notif_in_user_file'):
				path_to_file = os.path.join(LOGPATH, ji)
				if os.path.isdir(path_to_file):
					jid = 'gcstatus'
					msg = show + ':' + msg
					show = nick
					files.append(ji + '/' + ji)
					if os.path.isfile(jid):
						files.append(jid)
				else:
					files.append(ji)
			if common.gajim.config.get('log_notif_in_sep_file'):
				files.append('notify.log')
		elif kind == 'incoming': # we save time:recv:message
			path_to_file = os.path.join(LOGPATH, ji)
			if os.path.isdir(path_to_file):
				files.append(jid)
			else:
				files.append(ji)
			jid = 'recv'
			show = msg
			msg = ''
		elif kind == 'outgoing': # we save time:sent:message
			path_to_file = os.path.join(LOGPATH, ji)
			if os.path.isdir(path_to_file):
				files.append(jid)
			else:
				files.append(ji)
			jid = 'sent'
			show = msg
			msg = ''
		elif kind == 'gc': # we save time:gc:nick:message
			# create the folder if needed
			ji_fn = os.path.join(LOGPATH, ji)
			if os.path.isfile(ji_fn):
				os.remove(ji_fn)
			if not os.path.isdir(ji_fn):
				os.mkdir(ji_fn, 0700)
			files.append(ji + '/' + ji)
			jid = 'gc'
			show = nick
		# convert to utf8 before writing to file if needed
		if isinstance(tim, unicode):
			tim = tim.encode('utf-8')
		if isinstance(jid, unicode):
			jid = jid.encode('utf-8')
		if isinstance(show, unicode):
			show = show.encode('utf-8')
		if msg and isinstance(msg, unicode):
			msg = msg.encode('utf-8')
		for f in files:
			path_to_file = os.path.join(LOGPATH, f)
			if os.path.isdir(path_to_file):
				return
			# this does it rw-r-r by default but is in a dir with 700 so it's ok
			fil = open(path_to_file, 'a')
			fil.write('%s:%s:%s' % (tim, jid, show))
			if msg:
				fil.write(':' + msg)
			fil.write('\n')
			fil.close()

	def __get_path_to_file(self, fjid):
		jid = fjid.split('/')[0]
		path_to_file = os.path.join(LOGPATH, jid)
		if os.path.isdir(path_to_file):
			if fjid == jid: # we want to read the gc history
				path_to_file = os.path.join(LOGPATH, jid + '/' + jid)
			else: #we want to read pm history
				path_to_file = os.path.join(LOGPATH, fjid)
		return path_to_file

	def get_no_of_lines(self, fjid):
		'''return total number of lines in a log file
		return 0 if log file does not exist'''
		path_to_file = self.__get_path_to_file(fjid)
		if not os.path.isfile(path_to_file):
			return 0
		fil = open(path_to_file, 'r')
		no_of_lines = 0 # number of lines
		while fil.readline():
			no_of_lines += 1
		fil.close()
		return no_of_lines

	def read(self, fjid, begin_line, end_line):
		'''return number of lines read and the text in the lines
		return 0 and empty respectively if log file does not exist'''
		path_to_file = self.__get_path_to_file(fjid)
		if not os.path.isfile(path_to_file):
			return 0, []
		fil = open(path_to_file, 'r')
		no_of_lines = 0 # number of lines
		lines = []
		while (no_of_lines < begin_line and fil.readline()):
			no_of_lines += 1
		while no_of_lines < end_line:
			line = fil.readline().decode('utf-8')
			if line:
				line = helpers.from_one_line(line)
				lineSplited = line.split(':')
				if len(lineSplited) > 2:
					lines.append(lineSplited)
			no_of_lines += 1
		return no_of_lines, lines