root/trunk/jjigw/component.py

#!/usr/bin/python -u
#
#  Jajcus' Jabber to IRC Gateway
#  Copyright (C) 2004  Jacek Konieczny <jajcus@jajcus.net>
#
#  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.,
#  59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.


import signal
import threading
import string
import logging

import pyxmpp.jabberd.component
from pyxmpp.presence import Presence
from pyxmpp.message import Message
from pyxmpp.streambase import StreamError,FatalStreamError
from pyxmpp.jid import JID
from pyxmpp.jabber.muccore import MUC_ADMIN_NS,MUC_NS
from pyxmpp.jabber.muccore import MucPresence,MucIq,MucAdminQuery
from pyxmpp.jabber.disco import DiscoItems,DiscoItem,DiscoInfo,DiscoIdentity

from ircsession import IRCSession
from spidentd import SPIdentD

class Component(pyxmpp.jabberd.component.Component):
    def __init__(self,config,profile=False):
        pyxmpp.jabberd.component.Component.__init__(self,config.jid,
                config.connect.secret,config.connect.host,config.connect.port,
                disco_name="JJIGW IRC gateway", disco_category="conference",disco_type="irc")
        self.__logger=logging.getLogger("jjigw.Component")
        self.profile=profile
        self.shutdown=0
        signal.signal(signal.SIGINT,self.signal_handler)
        signal.signal(signal.SIGPIPE,self.signal_handler)
        signal.signal(signal.SIGHUP,self.signal_handler)
        signal.signal(signal.SIGTERM,self.signal_handler)
        self.irc_sessions={}
        self.config=config
        if config.spidentd:
            self.ident_handler=SPIdentD(self,config.spidentd)
        else:
            self.ident_handler=None
        self.disco_info.add_identity("JJIGW IRC gateway", "conference", "text") # MUC compliance
        self.disco_info.add_identity("JJIGW IRC gateway", "gateway", "x-irc") # non-conference gateway services

    def get_session(self,user_jid,component_jid):
        return self.irc_sessions.get((user_jid.as_unicode(),component_jid.domain))

    def register_session(self,sess):
        user_jid=sess.jid
        component_jid=sess.network.jid
        self.__logger.debug("Registering session: %r on %r for %r" % (sess,component_jid,user_jid))
        self.irc_sessions[user_jid.as_unicode(),component_jid.domain]=sess

    def unregister_session(self,sess):
        user_jid=sess.jid
        component_jid=sess.network.jid
        self.__logger.debug("Unregistering session: %r on %r for %r" % (sess,component_jid,user_jid))
        try:
            del self.irc_sessions[user_jid.as_unicode(),component_jid.domain]
        except KeyError:
            self.__logger.debug("Session not found!")

    def signal_handler(self,signum,frame):
        self.__logger.debug("Signal %i received, shutting down..." % (signum,))
        self.shutdown=1

    def run(self,timeout):
        self.connect()
        try:
            while (not self.shutdown and self.stream
                    and not self.stream.eof and self.stream.socket is not None):
                try:
                    self.stream.loop_iter(timeout)
                except (KeyboardInterrupt,SystemExit,FatalStreamError,StreamError):
                    raise
                except:
                    self.__logger.exception("Exception cought:")
        finally:
            if self.shutdown:
                for sess in self.irc_sessions.values():
                    sess.disconnect("JJIGW shutdown")
            threads=threading.enumerate()
            for th in threads:
                try:
                    th.join(10*timeout)
                except:
                    pass
            for th in threads:
                try:
                    th.join(timeout)
                except:
                    pass
            self.disconnect()
            self.__logger.debug("Exitting normally")

    def send(self,stanza):
        self.get_stream().send(stanza)

    def stream_state_changed(self,state,arg):
        print "*** State changed: %s %r ***" % (state,arg)

    def authenticated(self):
        pyxmpp.jabberd.component.Component.authenticated(self)
        self.stream.set_iq_get_handler("query","jabber:iq:version",self.get_version)
        self.stream.set_iq_get_handler("query","jabber:iq:register",self.get_register)
        self.stream.set_iq_set_handler("query","jabber:iq:register",self.set_register)
        self.stream.set_iq_set_handler("query",MUC_ADMIN_NS,self.set_muc_admin)
        self.stream.set_presence_handler("available",self.presence_available)
        self.stream.set_presence_handler("unavailable",self.presence_unavailable)
        self.stream.set_presence_handler("subscribe",self.presence_control)
        self.stream.set_message_handler("groupchat",self.groupchat_message)
        self.stream.set_message_handler("normal",self.message)

    def set_muc_admin(self,iq):
        to=iq.get_to()
        fr=iq.get_from()
        if not to.node:
            self.__logger.debug("admin request sent to JID without a node")
            iq=iq.make_error_response("feature-not-implemented")
            self.stream.send(iq)
            return 1
        if to.resource or not (to.node[0] in "#+!" or to.node.startswith(",amp,")):
            self.__logger.debug("admin request sent not to a channel")
            iq=iq.make_error_response("not-acceptable")
            self.stream.send(iq)
            return 1

        iq=MucIq(iq)
        sess=self.get_session(fr,to)
        if not sess:
            self.__logger.debug("User session not found")
            iq=iq.make_error_response("recipient-unavailable")
            self.stream.send(iq)
            return 1

        channel=sess.get_channel(to)
        if not channel:
            self.__logger.debug("Channel not found")
            iq=iq.make_error_response("recipient-unavailable")
            self.stream.send(iq)
            return 1

        query=iq.get_muc_child()
        if not isinstance(query,MucAdminQuery):
            self.__logger.debug("Bad query content")
            iq=iq.make_error_response("bad-request")
            self.stream.send(iq)
            return 1

        items=query.get_items()
        if not items:
            self.__logger.debug("No items in query")
            iq=iq.make_error_response("bad-request")
            self.stream.send(iq)
            return 1
        item=items[0]
        if item.role=="none":
            channel.kick_user(item.nick,item.reason,iq)
        elif item.role=="visitor":
            channel.devoice_user(item.nick,iq)
        elif item.role=="participant":
            channel.voice_user(item.nick,iq)
        elif item.role=="moderator":
            channel.op_user(item.nick,iq)
        else:
            self.__logger.debug("Unknown admin action")
            iq=iq.make_error_response("feature-not-implemented")
            self.stream.send(iq)
            return 1

    def get_version(self,iq):
        iq=iq.make_result_response()
        q=iq.new_query("jabber:iq:version")
        q.newTextChild(q.ns(),"name","Jajcus' Jabber-IRC Gateway")
        q.newTextChild(q.ns(),"version","0.2.2")
        self.stream.send(iq)
        return 1

    def get_register(self,iq):
        to=iq.get_to()
        if to and to!=self.jid:
            iq=iq.make_error_response("feature-not-implemented")
            self.stream.send(iq)
            return 1
        iq=iq.make_result_response()
        q=iq.new_query("jabber:iq:register")
        q.newTextChild(q.ns(),"instructions","Enter anything below.")
        q.newChild(q.ns(),"username",None)
        q.newChild(q.ns(),"password",None)
        self.stream.send(iq)
        return 1

    def set_register(self,iq):
        to=iq.get_to()
        if to and to!=self.jid:
            iq=iq.make_error_response("feature-not-implemented")
            self.stream.send(iq)
            return 1
        remove=iq.xpath_eval("r:query/r:remove",{"r":"jabber:iq:register"})
        if remove:
            m=Message(from_jid=iq.get_to(),to_jid=iq.get_from(),stanza_type="chat",
                    body=u"Unregistered")
            self.stream.send(m)
            p=Presence(from_jid=iq.get_to(),to_jid=iq.get_from(),stanza_type="unsubscribe")
            self.stream.send(p)
            p=Presence(from_jid=iq.get_to(),to_jid=iq.get_from(),stanza_type="unsubscribed")
            self.stream.send(p)
            return 1
        username=iq.xpath_eval("r:query/r:username",{"r":"jabber:iq:register"})
        if username:
            username=username[0].getContent()
        else:
            username=u""
        password=iq.xpath_eval("r:query/r:password",{"r":"jabber:iq:register"})
        if password:
            password=password[0].getContent()
        else:
            password=u""
        m=Message(from_jid=iq.get_to(),to_jid=iq.get_from(),stanza_type="chat",
                body=u"Registered with username '%s' and password '%s'"
                " (both ignored)" % (username,password))
        self.stream.send(m)
        p=Presence(from_jid=iq.get_to(),to_jid=iq.get_from(),stanza_type="subscribe")
        self.stream.send(p)
        iq=iq.make_result_response()
        self.stream.send(iq)
        return 1

    def message(self,stanza):
        to=stanza.get_to()
        fr=stanza.get_from()
        typ=stanza.get_type()
        if typ not in (None,"chat"):
            typ=None
        sess=self.get_session(fr,to)
        if not to.node:
            if sess:
                m=Message(to_jid=fr,from_jid=to,body="Connected to: %s" % (sess.server,),stanza_type=typ)
            else:
                m=Message(to_jid=fr,from_jid=to,body="Not connected",stanza_type=typ)
            return 1
        if not to.resource and (to.node[0] in "#+!" or to.node.startswith(",amp,")):
            self.groupchat_message(stanza)
        if sess:
            sess.message_to_user(stanza)
        else:
            m=stanza.make_error_response("recipient-unavailable")
            self.send(m)
        return 1

    def groupchat_message(self,stanza):
        to=stanza.get_to()
        if not to.node:
            self.__logger.debug("No node in groupchat message target")
            return 0
        if to.node[0] not in "#+!" and not to.node.startswith(",amp,"):
            self.__logger.debug("Groupchat message target is not a channel")
            return self.message(stanza)
        if to.resource:
            self.__logger.debug("Groupchat message target is not bare JID")
            return 0
        fr=stanza.get_from()
        sess=self.get_session(fr,to)
        if sess:
            sess.message_to_channel(stanza)
        else:
            m=stanza.make_error_response("recipient-unavailable")
            self.send(m)
        return 1

    def presence_available(self,stanza):
        nick = None
        to = stanza.get_to()
        fr = stanza.get_from()
        status = stanza.get_status()
        show = stanza.get_show()
        if not status:
            if not show:
                status = "Unknown"
            else:
                status = show
        if to.node and not to.resource:
            p=stanza.make_error_response("bad-request")
            self.send(p)
            return 1
        sess=self.get_session(fr,to)
        if sess:
            if to.node and not sess.check_nick(to.resource):
                p=stanza.make_error_response("conflict")
                self.send(p)
                return 1
            if show in ("away", "xa", "dnd"):
                sess.set_away(status)
            else:
                sess.set_back()
        else:
            nick=to.resource
            if not nick:
                nick=fr.node
            try:
                sess=IRCSession(self,self.config,to,fr,nick)
            except ValueError,e:
                print `e`
                e=stanza.make_error_response("bad-request")
                self.send(e)
                return
            self.register_session(sess)
        if to.node:
            sess.join(MucPresence(stanza))
        else:
            sess.login(stanza)
        return 1

    def presence_unavailable(self,stanza):
        to=stanza.get_to()
        fr=stanza.get_from()
        status=stanza.get_status()
        sess=self.get_session(fr,to)
        if sess:
            if to.node:
                disconnected=sess.leave(stanza)
            else:
                disconnected=sess.logout(stanza)
            if disconnected:
                self.unregister_session(sess)
        return 1

    def presence_control(self,stanza):
        p=stanza.make_accept_response()
        self.stream.send(p)
        return 1

    def register_connection(self,conninfo):
        if self.ident_handler:
            self.ident_handler.register_connection(conninfo)

    def unregister_connection(self,conninfo):
        if self.ident_handler:
            self.ident_handler.unregister_connection(conninfo)

    def disco_get_info(self,node,iq):
        to=iq.get_to()
        try:
            network=self.config.get_network(to)
        except KeyError:
            return iq.make_error_response("recipient-unavailable")
        if to.node is None and to.resource is None:
            di=DiscoInfo()
            if node is None:
                di.add_feature("jabber:iq:version")
                di.add_feature("jabber:iq:register")
                di.add_feature(MUC_NS)
                if network.name:
                    name=network.name
                else:
                    name="IRC gateway"
                DiscoIdentity(di,name,"conference","irc")
                DiscoIdentity(di,name,"conference","text")
                DiscoIdentity(di,name,"gateway","x-irc")
            return di
        elif len(to.node)>1 and to.node[0] in u"&#+!" and to.resource is None:
            di=DiscoInfo()
            di.add_feature(MUC_NS)
            if network.name:
                name="%s channel on %s IRC network" % (to.node,network.name)
            else:
                name="%s IRC channel" % (to.node,)
            DiscoIdentity(di, name, "conference", "text")
            DiscoIdentity(di, name, "conference", "irc")
            return di
        return iq.make_error_response("feature-not-implemented")

    def disco_get_items(self,node,iq):
        to=iq.get_to()
        fr=iq.get_from()
        try:
            network=self.config.get_network(to)
        except KeyError:
            return iq.make_error_response("recipient-unavailable")
        if to.node is not None or to.resource is not None:
            return iq.make_error_response("feature-not-implemented")
        if not node:
            di=DiscoItems()
            print "Requester: %r Admins: %r" % (fr,self.config.admins)
            if fr in self.config.admins or fr.bare() in self.config.admins:
                DiscoItem(di,to,"admin","Administrator tree")
            if network.channels: 
                for c in network.channels.values():
                    if not c.browseable:
                        continue
                    desc = c.description
                    if not c.description:
                        desc = "%s IRC channel on %s IRC network" % (c.name,network.name)
                    jid = JID(c.name,to,None);
                    DiscoItem(di,jid,None,desc);
            return di
        if node=="admin" or node.startswith("admin."):
            if fr not in self.config.admins and fr.bare() not in self.config.admins:
                return iq.make_error_response("forbidden")
        else:
            return iq.make_error_response("item-not-found")
        node=node.split(".")
        if node==["admin"]:
            di=DiscoItems()
            DiscoItem(di,to,"admin.sessions","Sessions (jid nick)")
            return di
        if node==["admin","sessions"]:
            di=DiscoItems()
            for sess in self.irc_sessions.values():
                if not sess.network==network:
                    continue
                DiscoItem(di,to,"admin.sessions.%s" % (id(sess),),
                        u"%r %r" % (sess.jid.as_unicode(),sess.nick))
            return di
        if len(node)>2 and node[:2]==["admin","sessions"]:
            try:
                sessid=int(node[2])
            except ValueError:
                return iq.make_error_response("item-not-found")
            sess=None
            for s in self.irc_sessions.values():
                if id(s)==sessid:
                    sess=s
                    break
            if sess is None:
                return iq.make_error_response("item-not-found")
            if len(node)==3:
                di=DiscoItems()
                DiscoItem(di,sess.jid,None,"Owner")
                DiscoItem(di,to,string.join(node+["used_for"],"."),"Used for")
                DiscoItem(di,to,string.join(node+["users"],"."),"Known IRC users")
                DiscoItem(di,to,string.join(node+["channels"],"."),"Active channels")
                return di
            if len(node)==4 and node[3]=="used_for":
                di=DiscoItems()
                for j in sess.used_for:
                    DiscoItem(di,j,None,j.as_unicode())
                return di
            if len(node)==4 and node[3]=="users":
                di=DiscoItems()
                for u in sess.users.values():
                    DiscoItem(di,to,string.join(node+[str(id(u))],"."),`u.nick`)
                return di
            if len(node)==4 and node[3]=="channels":
                di=DiscoItems()
                for ch in sess.channels.values():
                    DiscoItem(di,to,string.join(node+[str(id(ch))],"."),`ch.name`)
                return di

        return iq.make_error_response("item-not-found")

# vi: sts=4 et sw=4