Logo Search packages:      
Sourcecode: sushi version File versions  Download package

com.py

# coding: UTF-8
"""
Copyright (c) 2008 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 re
import gobject

import dbus
from dbus.mainloop.glib import DBusGMainLoop
from gettext import gettext as _
from types import NoneType

from tekka.typecheck import types


"""
The com module caches the nick,
provides a persistent interface to maki,
provides methods to connect / disconnect
maki and to send messages.
"""


00049 class NoSushiError (BaseException):
      pass


00053 class SushiWrapper (gobject.GObject):

      """ Wraps a DBus Interface to maki so if there's
            no connection, an error signal is emitted and
            can be catched by the GUI.

            Access to the underlying gobject methods is
            possible by prefixing an "g_":
            g_emit(), g_connect, ...

            The only methods available directly from
            this class are all methods beginning with an "_"
            and the "connected" property.
            All other getattr calls will be forwarded
            to the intern sushi interface.
      """


      @types (sushi_interface = (dbus.Interface, NoneType))
      def __init__(self, sushi_interface):
            gobject.GObject.__init__(self)

            self.connected = False
            self.remote = False

            self._set_interface(sushi_interface)


      @types(v = bool)
      def _set_remote(self, v):
            self._remote = v


      @types (connected = bool)
      def _set_connected(self, connected):
            if connected:
                  self.g_emit("maki-connected")
            else:
                  self.g_emit("maki-disconnected")

            self.__recent_reconnect = True
            self._connected = connected


      @types (interface = (dbus.Interface, NoneType))
      def _set_interface(self, interface):
            self._sushi = interface
            self._set_connected(interface != None)


      @types (title = basestring, msg = basestring)
      def _emit_error(self, title, msg):
            self.g_emit("sushi-error", title, msg)


00108       def __getattribute__(self, attr):

            """ attributes prefixed with g_ will be resolved
                  by GObject's getattribute with the g_ striped.

                  attributes prefixed with _ will be resolved
                  as they are for SushiWrapper.

                  all other attributes are forwarded to self._sushi
            """

            def dummy(*args, **kwargs):
                  """ called if no connection is active """

                  if self.__recent_reconnect:
                        self.__recent_reconnect = False

                        sushi._emit_error(
                              _("tekka could not connect to maki."),
                              _("Please check whether maki is running."))

                  pass

            def errordummy(message):
                  """ called if a DBusError was catched """

                  def new(*args, **kwargs):
                        sushi._emit_error(
                              _("tekka could not connect to maki."),
                              _("Please check whether maki is running.\n"
                                "The following error occurred: %(error)s") % {
                                          "error": message })

                  return new

            gobject_attr = False

            if attr[:2] == "g_":
                  attr = attr[2:]
                  gobject_attr = True

            if (attr[0] == "_" or gobject_attr
            or attr in ("connected", "remote")):
                  # resolve it by gobject.__getattribute__. This function
                  # will call getattr as well if there is no matching
                  # method in the gobject hierarchy.
                  return gobject.GObject.__getattribute__(self, attr)
            else:
                  if not self._sushi:
                        # return a dummy which reports an error
                        return dummy
                  else:
                        try:
                              # try local methods
                              return self._sushi.__getattribute__(attr)
                        except AttributeError:
                              # try proxy methods
                              try:
                                    def attr_dummy(*args, **kwargs):
                                          """ wrapped call to dbus proxy attr """
                                          try:
                                                return self._sushi.__getattr__(attr)(
                                                                  *args,
                                                                  **kwargs)
                                          except dbus.DBusException as e:
                                                self._emit_error(
                                                      _("Communication error with maki."),
                                                      _("There was an error while executing "
                                                        "<b>'%s</b>' with DBus: \n<b>%s</b>\n"
                                                        "You should keep safe that maki is "
                                                        "running " % (attr, e)))

                                    return attr_dummy
                              except dbus.DBusException as e:
                                    # method not found, return dummy
                                    return errordummy(str(e))

            raise AttributeError(attr)


      # Properties
      remote = property(lambda s: s._remote, _set_remote)
      connected = property(lambda s: s._connected, _set_connected)


gobject.signal_new ("maki-connected", SushiWrapper,
      gobject.SIGNAL_ACTION, None, ())
gobject.signal_new ("maki-disconnected", SushiWrapper,
      gobject.SIGNAL_ACTION, None, ())
gobject.signal_new ("sushi-error", SushiWrapper,
      gobject.SIGNAL_ACTION, None, (str, str))


dbus_loop = DBusGMainLoop()
required_version = (1, 2, 0)
bus = None

sushi = SushiWrapper(None)

myNick = {}

_shutdown_callback = None
_nick_callback = None


def disable_sushi_on_fail(cmethod):
      """ decorator: disable sushi wrapper if connect fails """
      def new(*args, **kwargs):
            global sushi
            ret = cmethod(*args, **kwargs)
            if not ret:
                  sushi._set_interface(None)
            return ret
      return new


@disable_sushi_on_fail
def connect():
      """
      Connect to maki over DBus.
      Returns True if the connection attempt was succesful.
      If the attempt was successful, the sushi object's
      attribute "connected" is set to "True" and the object
      has more attributes through the dbus proxy so you
      can call dbus methods directly.
      """
      global sushi, _shutdown_callback, _nick_callback, bus

      bus_address = os.getenv("SUSHI_REMOTE_BUS_ADDRESS")

      def bus_remote_error(exception):
            sushi._emit_error(
                  _("tekka could not connect to maki."),
                  _("Please check whether maki is running.\n"
                  "The following error occurred: %(error)s") % {
                        "error": str(exception) })

      def connect_session_bus():
            global bus, dbus_loop
            try:
                  return dbus.SessionBus(mainloop=dbus_loop)
            except DBusException as e:
                  bus_remote_error(e)
                  return None

      if bus_address:
            try:
                  bus = dbus.connection.Connection(bus_address,
                              mainloop=dbus_loop)
            except dbus.DBusException as e:
                  bus_remote_error(e)
                  return False

      else:
            bus = connect_session_bus()

            if bus == None:
                  return False

      if type(bus) == dbus.connection.Connection:
            sushi.remote = True

      try:
            proxy = bus.get_object("de.ikkoku.sushi", "/de/ikkoku/sushi")
      except dbus.exceptions.DBusException as e:
            bus_remote_error(e)
            return False

      sushi._set_interface(dbus.Interface(proxy, "de.ikkoku.sushi"))

      version = tuple([int(v) for v in sushi.version()])

      if not version or version < required_version:
            version_string = ".".join([str(x) for x in required_version])

            sushi._emit_error(
                  _("tekka requires a newer maki version."),
                  _("Please update maki to at least version %(version)s.") % {
                              "version": version_string })

            sushi._set_interface(None)
            return False

      _shutdown_callback = sushi.connect_to_signal("shutdown", _shutdownSignal)
      _nick_callback = sushi.connect_to_signal("nick", _nickSignal)

      for server in sushi.servers():
            fetch_own_nick(server)

      return True


def disconnect():
      global sushi, _shutdown_callback, _nick_callback
      sushi._set_interface(None)

      if _shutdown_callback:
            _shutdown_callback.remove()

      if _nick_callback:
            _nick_callback.remove()


def parse_from (from_str):
      h = from_str.split("!", 2)

      if len(h) < 2:
            return (h[0],)

      t = h[1].split("@", 2)

      if len(t) < 2:
            return (h[0],)

      return (h[0], t[0], t[1])



def _shutdownSignal(time):
      disconnect()


def _nickSignal(time, server, from_str, new_nick):
      nick = parse_from(from_str)[0]

      if not nick or nick == get_own_nick(server):
            cache_own_nick(server, new_nick)



def sendMessage(server, channel, text):
      """ sends a PRIVMSG to channel @channel on server @server """
      text = re.sub('(^|\s)(_\S+_)(\s|$)', '\\1' + chr(31) + '\\2' + chr(31) + '\\3', text)
      text = re.sub('(^|\s)(\*\S+\*)(\s|$)', '\\1' + chr(2) + '\\2' + chr(2) + '\\3', text)

      sushi.message(server, channel, text)

# fetches the own nick for server @server from maki
def fetch_own_nick(server):
      from_str = sushi.user_from(server, "")
      nick = parse_from(from_str)[0]
      cache_own_nick(server, nick)

# caches the nick @nickname for server @server.
def cache_own_nick(server, nickname):
      myNick[server] = nickname

# returns the cached nick of server @server
def get_own_nick(server):
      if myNick.has_key(server):
            return myNick[server]
      return ""

Generated by  Doxygen 1.6.0   Back to index