main.py.in

#!/usr/bin/env python
# coding: UTF-8
"""
Copyright (c) 2009 Marian Tietz
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:

1. Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
"""

import os
import sys
import traceback

import glib
import gobject

try:
	import urwid
except ImportError, e:
	print >> sys.stderr, "Failed to import urwid: %s" % (e)
	print >> sys.stderr, "Do you have urwid installed?"
	sys.exit(1)

from urwid import MetaSignals

try:
	import gobject
except ImportError:
	print >> sys.stderr, "You need python-gobject installed."
	sys.exit(1)
import re

import logging
import locale

try:
	import gettext
	from gettext import gettext as _
except ImportError:
	print >> sys.stderr, "You need gettext installed."
	sys.exit(1)

import config
import messages
import commands
import connection
import signals
import tabs
import plugin_control

from typecheck import types

import extends
from extends import *
from input_history import InputHistory

from helper import tabcompletion

"""
 -------context-------
| --inner context---- |
|| HEADER            ||
||                   ||
|| BODY              ||
||                   ||
|| DIVIDER           ||
| ------------------- |
| FOOTER              |
 ---------------------

inner context = context.body
context.body.body = BODY
context.body.header = HEADER
context.body.footer = DIVIDER
context.footer = FOOTER

HEADER = Notice line (urwid.Text)
BODY = Extended ListBox
DIVIDER = Divider with information (urwid.Text)
FOOTER = Input line (Ext. Edit)
"""

NIGIRI_VERSION = "@SUSHI_VERSION@"

class MainWindow(object):

	__metaclass__ = MetaSignals
	signals = ["quit","keypress","tab_switched"]

	_palette = [
			('divider','black','dark cyan', 'standout'),
			('text','light gray', 'default'),
			('bold_text', 'light gray', 'default', 'bold'),
			("body", "text"),
			("footer", "text"),
			("header", "text"),
		]

	for type, bg in (
			("div_fg_", "dark cyan"),
			("", "default")):
		for name, color in (
				("red","dark red"),
				("blue", "dark blue"),
				("green", "dark green"),
				("yellow", "yellow"),
				("magenta", "dark magenta"),
				("gray", "light gray"),
				("white", "white"),
				("black", "black")):
			_palette.append( (type + name, color, bg) )


	def __init__(self):
		self.current_tab = None
		self.servers = []
		self.shortcut_pattern = re.compile(
			config.get("nigiri", "shortcut_pattern"))
		self.shall_quit = False

	def main(self):
		""" entry point to start UI """

		self.ui = urwid.raw_display.Screen ()
		self.ui.register_palette (self._palette)

		self.build_interface()

		self.update_divider()

		self.generic_input_history = InputHistory(
				text_callback = self.footer.get_edit_text)


		self.ui.run_wrapper(self.run)

	def run(self):
		""" setup input handler, invalidate handler to
			automatically redraw the interface if needed.

			connect to dbus, start mainloop.
		"""

		def input_cb(key):
			if self.shall_quit:
				raise urwid.ExitMainLoop
			self.keypress(self.size, key)

		self.size = self.ui.get_cols_rows()

		self.main_loop = urwid.MainLoop(
				self.context,
				screen=self.ui,
				handle_mouse=False,
				unhandled_input=input_cb,
				event_loop=urwid.GLibEventLoop()
			)

		connection.connect()

		def call_redraw(*x):
			self.draw_interface()
			invalidate.locked = False
			return True

		inv = urwid.canvas.CanvasCache.invalidate

		def invalidate (cls, *a, **k):
			inv(*a, **k)

			if not invalidate.locked:
				invalidate.locked = True
				self.main_loop.set_alarm_in(0, call_redraw)

		invalidate.locked = False
		urwid.canvas.CanvasCache.invalidate = classmethod(invalidate)

		try:
			self.main_loop.run()
		except KeyboardInterrupt:
			self.quit()

	def quit(self, exit=True):
		""" stops the ui, exits the application (if exit=True)
			After the UI is stopped, the config is written.
		"""
		urwid.emit_signal(self, "quit")

		config.write_config_file ()

		self.shall_quit = True

		if exit:
			sys.exit(0)

	def _create_widgets(self):
		""" create the UI widgets """
		self.header = urwid.Text("nigiri %s" % NIGIRI_VERSION)
		self.footer = extends.Edit.ExtendedEdit("> ")
		self.divider = urwid.Text("Initializing.")

		self.generic_output_walker = urwid.SimpleListWalker([])
		self.body = extends.ListBox.ExtendedListBox(
			self.generic_output_walker)

		urwid.connect_signal(self.body, "set_auto_scroll",
			self.handle_body_auto_scroll)

	def _setup_widgets(self):
		""" set coloring and attributes of the UI widgets
			created in _create_widgets
		"""
		self.header = urwid.AttrWrap (self.header, "divider")
		self.footer = urwid.AttrWrap (self.footer, "footer")
		self.divider = urwid.AttrWrap (self.divider, "divider")
		self.body = urwid.AttrWrap (self.body, "body")

		# apply config values
		if not config.get_bool ("nigiri", "wrap_input"):
			self.footer.set_wrap_mode ("clip")
		else:
			self.footer.set_wrap_mode ("space")

	def _setup_context(self):
		""" wrap a Frame called context around the widgets
			created in _create_widgets
		"""
		self.context = urwid.Frame (self.body, header = self.header,
				footer = self.divider)
		self.context = urwid.Frame (self.context, footer = self.footer)

		self.context.set_focus ("footer")

	def build_interface(self):
		""" call the widget methods to build the UI """
		self._create_widgets()
		self._setup_widgets()
		self._setup_context()

	def draw_interface(self):
		self.main_loop.draw_screen()

	def keypress(self, size, key):
		""" handle keypress events """

		urwid.emit_signal(self, "keypress", size, key)

		if key != "tab":
			tabcompletion.stopIteration()

		if key in ("page up","page down"):
			self.body.keypress (size, key)

		elif key == "window resize":
			self.size = self.ui.get_cols_rows()

		elif key == "enter":
			# Parse data or (if parse failed)
			# send it to the current world
			input = self.footer.get_edit_text()

			self.footer.set_edit_text(" "*len(input))
			self.footer.set_edit_text("")

			if not commands.parse (self, input):
				# no parsable command, send text
				if self.current_tab:
					commands.send_text(self.current_tab, input)

			if self.current_tab:
				history = self.current_tab.input_history
			else:
				history = self.generic_input_history

			history.add_entry (input)
			history.reset()

		elif key == "up":
			history = self.generic_input_history

			if self.current_tab:
				history = self.current_tab.input_history

			prev = history.get_previous()

			if prev == None:
				return

			self.footer.edit_pos = None
			self.footer.set_edit_text (prev)
			self.footer.set_edit_pos (len(prev))

		elif key == "down":
			history = self.generic_input_history

			if self.current_tab:
				history = self.current_tab.input_history

			next = history.get_next()

			if next == None:
				return

			self.footer.set_edit_text (next)
			self.footer.set_edit_pos (len(next))

		elif key == "ctrl p":
			self.switch_to_previous_tab()

		elif key == "ctrl n":
			self.switch_to_next_tab()

		elif self.shortcut_pattern.match(key):
			self.switch_to_tabid(int(key[-1]))

		elif key == "ctrl u":
			# clear the edit line
			self.footer.set_edit_text ("")
			self.footer.set_edit_pos (0)

		elif key == "ctrl w":
			# remove the text from cursor
			# position to previous space

			def ctrlw(et, ep):
				i = et[:ep].rfind(" ")
				if i == -1:
					et = et[ep:]
				else:
					et = et[:i+1] + et[ep:]
				return et

			# FIXME: fix position setting
			new = ctrlw(
				self.footer.get_edit_text(),
				self.footer.edit_pos)
			self.footer.set_edit_text(new)

		elif key == "tab":
			logging.debug("tab is pressed!")
			tabcompletion.complete(self.footer, self.footer.get_edit_text())

		else:
			self.context.keypress (size, key)

	def find_server(self, server_name):
		try:
			i = [n.name.lower()
				for n in self.servers].index(server_name.lower())
		except ValueError:
			return None
		else:
			return self.servers[i]

	def find_tab(self, parent_name, child_name = ""):
		try:
			i = [n.name.lower()
				for n in self.servers].index(parent_name.lower())
		except ValueError:
			return None
		else:
			if not child_name:
				return self.servers[i]
			else:
				try:
					j = [n.name.lower()
						for n in self.servers[i].children].index(
							child_name.lower())
				except ValueError:
					return None
				else:
					return self.servers[i].children[j]
		return None

	def add_server(self, server_tab):
		self.servers.append(server_tab)

		server_tab.support_chantypes = connection.sushi.support_chantypes(
			server_tab.name)

		urwid.connect_signal(server_tab, "remove",
			self.handle_server_remove)
		urwid.connect_signal(server_tab, "child_added",
			self.handle_channel_add)
		urwid.connect_signal(server_tab, "child_removed",
			self.handle_channel_remove)

		server_tab.input_history = InputHistory(
			text_callback = self.footer.get_edit_text)

		self.update_divider()

	def remove_server(self, server):
		try:
			i = self.servers.index(server)
		except ValueError:
			return
		else:
			del self.servers[i]
			self.update_divider()

	@types(id = int)
	def switch_to_tabid(self, id):
		""" Switch to the _visible_ number of the tab. """

		tablist = tabs.tree_to_list(self.servers)
		if not config.get_bool("nigiri","server_shortcuts"):
			tablist = [n for n in tablist if type(n) != tabs.Server]
		try:
			tab = tablist[id-1]
		except IndexError:
			return
		self.switch_to_tab(tab)

	def switch_to_tab(self, tab):
		""" switch to the given tab and emit tab_switched signal
			if switching is done
		"""

		if self.current_tab:
			# set readline and save typed text from input bar
			self.current_tab.set_readline()
			self.current_tab.input_text = self.footer.get_edit_text()

		self.current_tab = tab

		if not tab:
			self.body.switch_body(self.generic_output_walker)

		else:
			# Set body content to tab content
			self.body.switch_body(tab.output_walker)
			tab.reset_status()

			if type(tab) == tabs.Channel:
				self.header.set_text(tab.get_topic())
			else:
				self.header.set_text("")

			# Restore typed text in the input bar
			self.footer.set_edit_text(tab.input_text)
			self.footer.set_edit_pos(len(tab.input_text))

		if tab.auto_scroll:
			self.body.scroll_to_bottom()
		self.update_divider()

		urwid.emit_signal(self, "tab_switched", tab)

	def switch_to_next_tab (self):
		tablist = tabs.tree_to_list(self.servers)

		try:
			current_index = tablist.index (self.current_tab)
		except ValueError:
			if tablist:
				self.switch_to_tab(tablist[0])
			return

		if (current_index + 1) >= len (tablist):
			current_index = 0
		else:
			current_index += 1

		self.switch_to_tab (tablist[current_index])

	def switch_to_previous_tab (self):
		tablist = tabs.tree_to_list(self.servers)
		try:
			current_index = tablist.index(self.current_tab)
		except ValueError:
			if tablist:
				self.switch_to_tab(tablist[0])
			return

		self.switch_to_tab (tablist[current_index - 1])


	# TODO:  update_divider without color usage
	# TODO:: for people who can't see colors

	def nc_update_divider(self):
		pass

	def update_divider(self):
		"""
		0: [maki] green or red highlighted
		1: "Not connected." or tab id
		if no connection: abort here.
		2: tab name
		3: status of the tab (joined / connected)
		4: tab list with highlights
		"""
		markup = []
		tablist = tabs.tree_to_list(self.servers)

		try:
			tabid = tablist.index(self.current_tab)
		except ValueError:
			tabid = -1

		# [maki]
		markup.append(("divider", "["))
		if connection.sushi.connected:
			markup.append(("div_fg_blue","maki"))
		else:
			markup.append(("div_fg_red","maki"))
		markup.append(("divider", "] "))

		if not self.servers:
			markup.append(("divider", "Not connected to any server."))
			self.divider.set_text(markup)
			return

		else:
			# add <nick>@<server>:<current tab>
			temp = "%(nick)s@%(server)s:%(tab)s (%(id)s) "

			if self.current_tab:
				subdict = {
					"tab":str(self.current_tab),
					"nick":"",
					"server":"",
					"id":""
				}

				if type(self.current_tab) == tabs.Server:
					subdict["nick"] = self.current_tab.get_nick() or "-"
					subdict["server"] = str(self.current_tab)
				else:
					subdict["nick"] = self.current_tab.parent.get_nick() or "-"
					subdict["server"] = str(self.current_tab.parent.name)

				subdict["id"] = str(tabid+1)

				markup.append(("divider", temp % subdict))

			else:
				markup.append(("divider", "-@-:- "))

		# tab status (joined / connected)
		if self.current_tab:
			if type(self.current_tab) == tabs.Channel:
				# check if joined
				if not self.current_tab.connected:
					markup.append(("divider", "(not connected) "))
				elif not self.current_tab.joined:
					markup.append(("divider", "(not joined) "))
			else:
				# check if connected
				if not self.current_tab.connected:
					markup.append(("divider", "(not connected) "))

		# display tabnumbers which are active
		markup.append(("divider", "["))
		active_tabs = [tab for tab in tablist if tab.status and tab != self.current_tab]
		active_tabs_len = len(active_tabs)

		for i in range(active_tabs_len):

			tab = active_tabs[i]
			try:
				name = str(tablist.index(tab)+1)
			except ValueError:
				name = "UNAVAIL"
			color = "divider"

			if tab.has_status("actions") or tab.has_status("actions_own"):
				color = "div_fg_gray"

			if tab.has_status("messages") or tab.has_status("messages_own"):
				color = "div_fg_white"

			if tab.has_status("actions_highlight"):
				color = "div_fg_yellow"

			if tab.has_status("messages_highlight"):
				color = "div_fg_magenta"

			if tab.has_status("informative"):
				color = "div_fg_yellow"


			markup.append((color, name))

			if i+1 != active_tabs_len:
				markup.append(("divider", ","))

		markup.append(("divider", "]"))

		self.divider.set_text(markup)

	@types(text = (str, unicode, list))
	def print_text(self, text):
		"""
		print the given text in the _current_ window
		"""

		if self.current_tab:
			walker = self.current_tab.output_walker

		else:
			walker = self.generic_output_walker

		if text and text[-1] == "\n":
			text = text[:-1]

		walker.append (urwid.Text (text))

		self.body.scroll_to_bottom()

	# Signal handlers

	def handle_body_auto_scroll(self, switch):
		self.current_tab.auto_scroll = switch

	def handle_server_remove(self, server):
		self.remove_server(server)

	def handle_channel_add(self, server_tab, channel_tab):
		channel_tab.input_history = InputHistory(
			text_callback = self.footer.get_edit_text)
		self.update_divider()

	def handle_channel_remove(self, server_tab, channel_tab):
		if channel_tab == self.current_tab:
			self.switch_to_next_tab()

		if connection.sushi.connected and channel_tab.joined:
			connection.sushi.part(server_tab.name, channel_tab.name, "")

		self.update_divider()

	def handle_maki_disconnect(self):
		self.update_divider()



def except_hook(extype, exobj, extb, manual=False):
	if not manual:
		try:
			main_window.quit(exit=False)
		except NameError:
			pass

	message = _("An error occured:\n%(divider)s\n%(traceback)s\n"\
		"%(exception)s\n%(divider)s" % {
			"divider": 20*"-",
			"traceback": "".join(traceback.format_tb(extb)),
			"exception": extype.__name__+": "+str(exobj)
		})

	logging.error(message)

	if manual:
		messages.print_error(message)
	else:
		print >> sys.stderr, message


def setup_logging():
	""" set the path of the logfile to tekka.logfile config
		value and create it (including path) if needed.
		After that, add a logging handler for exceptions
		which reports exceptions catched by the logger
		to the tekka_excepthook. (DBus uses this)
	"""
	try:
		class ExceptionHandler(logging.Handler):
			""" handler for exceptions caught with logging.error.
				dump those exceptions to the exception handler.
			"""
			def emit(self, record):
				if record.exc_info:
					except_hook(*record.exc_info)

		logfile = config.get("nigiri","logfile")
		logdir = os.path.dirname(logfile)

		if not os.path.exists(logdir):
			os.makedirs(logdir)

		logging.basicConfig(filename=logfile, level=logging.DEBUG,
			filemode="w")

		logging.getLogger("").addHandler(ExceptionHandler())

	except BaseException, e:
		print >> sys.stderr, "Logging init error: %s" % (e)


if __name__ == "__main__":
	global main_window, stderr

	config.setup()

	setup_logging()

	# setup locale stuff
	try:
		locale.setlocale(locale.LC_ALL, "")
	except:
		pass

	gettext.bindtextdomain("nigiri", config.get("nigiri","locale_dir"))
	gettext.textdomain("nigiri")

	main_window = MainWindow()

	sys.excepthook = except_hook

	signals.setup(main_window)

	messages.setup(main_window)

	tabcompletion.setup(main_window)

	main_window.main()