libervia-backend: plugins/plugin_xep

annotate plugins/plugin_xep_0100.py @ 98:dd556233a1b1

Tarot Plugin: Garde Sans and Garde Contre are now managed

author	Goffi <goffi@goffi.org>
date	Thu, 03 Jun 2010 17:43:49 +0930
parents	86f1f7f6d332
children	94011f553cd0

rev	line source
25 53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways Goffi <goffi@goffi.org> parents: diff changeset	1 #!/usr/bin/python
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways Goffi <goffi@goffi.org> parents: diff changeset	2 # -- coding: utf-8 --
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways Goffi <goffi@goffi.org> parents: diff changeset	3
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways Goffi <goffi@goffi.org> parents: diff changeset	4 """
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways Goffi <goffi@goffi.org> parents: diff changeset	5 SAT plugin for managing gateways (xep-0100)
57 a5b5fb5fc9fd updated README and copyright note Goffi <goffi@goffi.org> parents: 48 diff changeset	6 Copyright (C) 2009, 2010 Jérôme Poisson (goffi@goffi.org)
25 53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways Goffi <goffi@goffi.org> parents: diff changeset	7
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways Goffi <goffi@goffi.org> parents: diff changeset	8 This program is free software: you can redistribute it and/or modify
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways Goffi <goffi@goffi.org> parents: diff changeset	9 it under the terms of the GNU General Public License as published by
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways Goffi <goffi@goffi.org> parents: diff changeset	10 the Free Software Foundation, either version 3 of the License, or
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways Goffi <goffi@goffi.org> parents: diff changeset	11 (at your option) any later version.
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways Goffi <goffi@goffi.org> parents: diff changeset	12
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways Goffi <goffi@goffi.org> parents: diff changeset	13 This program is distributed in the hope that it will be useful,
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways Goffi <goffi@goffi.org> parents: diff changeset	14 but WITHOUT ANY WARRANTY; without even the implied warranty of
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways Goffi <goffi@goffi.org> parents: diff changeset	15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways Goffi <goffi@goffi.org> parents: diff changeset	16 GNU General Public License for more details.
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways Goffi <goffi@goffi.org> parents: diff changeset	17
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways Goffi <goffi@goffi.org> parents: diff changeset	18 You should have received a copy of the GNU General Public License
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways Goffi <goffi@goffi.org> parents: diff changeset	19 along with this program. If not, see <http://www.gnu.org/licenses/>.
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways Goffi <goffi@goffi.org> parents: diff changeset	20 """
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways Goffi <goffi@goffi.org> parents: diff changeset	21
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways Goffi <goffi@goffi.org> parents: diff changeset	22 from logging import debug, info, error
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways Goffi <goffi@goffi.org> parents: diff changeset	23 from twisted.internet import protocol
64 d46f849664aa SàT: multi-profile, plugins updated Goffi <goffi@goffi.org> parents: 57 diff changeset	24 from twisted.words.protocols.jabber import client, jid
39 2e3411a6baad Wix: external server management in gateways manager, SàT: bug fixes in gateway management Goffi <goffi@goffi.org> parents: 37 diff changeset	25 from twisted.words.protocols.jabber import error as jab_error
25 53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways Goffi <goffi@goffi.org> parents: diff changeset	26 import pdb
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways Goffi <goffi@goffi.org> parents: diff changeset	27
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways Goffi <goffi@goffi.org> parents: diff changeset	28 from wokkel import disco, iwokkel
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways Goffi <goffi@goffi.org> parents: diff changeset	29
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways Goffi <goffi@goffi.org> parents: diff changeset	30 PLUGIN_INFO = {
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways Goffi <goffi@goffi.org> parents: diff changeset	31 "name": "Gateways Plugin",
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways Goffi <goffi@goffi.org> parents: diff changeset	32 "import_name": "XEP_0100",
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways Goffi <goffi@goffi.org> parents: diff changeset	33 "type": "XEP",
48 4392f1fdb064 plugins improvement Goffi <goffi@goffi.org> parents: 42 diff changeset	34 "protocols": ["XEP-0100"],
37 a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 30 diff changeset	35 "dependencies": ["XEP_0077"],
25 53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways Goffi <goffi@goffi.org> parents: diff changeset	36 "main": "XEP_0100",
69 86f1f7f6d332 i18n first draft Goffi <goffi@goffi.org> parents: 65 diff changeset	37 "description": _("""Implementation of Gateways protocol""")
25 53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways Goffi <goffi@goffi.org> parents: diff changeset	38 }
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways Goffi <goffi@goffi.org> parents: diff changeset	39
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways Goffi <goffi@goffi.org> parents: diff changeset	40 class XEP_0100():
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways Goffi <goffi@goffi.org> parents: diff changeset	41
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways Goffi <goffi@goffi.org> parents: diff changeset	42 def __init__(self, host):
69 86f1f7f6d332 i18n first draft Goffi <goffi@goffi.org> parents: 65 diff changeset	43 info(_("Gateways plugin initialization"))
25 53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways Goffi <goffi@goffi.org> parents: diff changeset	44 self.host = host
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways Goffi <goffi@goffi.org> parents: diff changeset	45 self.__gateways = {} #dict used to construct the answer to findGateways. Key = target jid
65 d35c5edab53f SàT: multi-profile: memory & dbus bridge's methods profile management Goffi <goffi@goffi.org> parents: 64 diff changeset	46 host.bridge.addMethod("findGateways", ".communication", in_sign='ss', out_sign='s', method=self.findGateways)
37 a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 30 diff changeset	47 host.bridge.addMethod("gatewayRegister", ".request", in_sign='ssa(ss)', out_sign='s', method=self.gatewayRegister)
39 2e3411a6baad Wix: external server management in gateways manager, SàT: bug fixes in gateway management Goffi <goffi@goffi.org> parents: 37 diff changeset	48
2e3411a6baad Wix: external server management in gateways manager, SàT: bug fixes in gateway management Goffi <goffi@goffi.org> parents: 37 diff changeset	49 def __inc_handled_items(self, request_id):
2e3411a6baad Wix: external server management in gateways manager, SàT: bug fixes in gateway management Goffi <goffi@goffi.org> parents: 37 diff changeset	50 self.__gateways[request_id]['__handled_items']+=1
2e3411a6baad Wix: external server management in gateways manager, SàT: bug fixes in gateway management Goffi <goffi@goffi.org> parents: 37 diff changeset	51
2e3411a6baad Wix: external server management in gateways manager, SàT: bug fixes in gateway management Goffi <goffi@goffi.org> parents: 37 diff changeset	52 if self.__gateways[request_id]['__total_items'] == self.__gateways[request_id]['__handled_items']:
69 86f1f7f6d332 i18n first draft Goffi <goffi@goffi.org> parents: 65 diff changeset	53 debug (_("All items checked for id [%s]") % str(request_id))
39 2e3411a6baad Wix: external server management in gateways manager, SàT: bug fixes in gateway management Goffi <goffi@goffi.org> parents: 37 diff changeset	54
2e3411a6baad Wix: external server management in gateways manager, SàT: bug fixes in gateway management Goffi <goffi@goffi.org> parents: 37 diff changeset	55 del self.__gateways[request_id]['__total_items']
2e3411a6baad Wix: external server management in gateways manager, SàT: bug fixes in gateway management Goffi <goffi@goffi.org> parents: 37 diff changeset	56 del self.__gateways[request_id]['__handled_items']
2e3411a6baad Wix: external server management in gateways manager, SàT: bug fixes in gateway management Goffi <goffi@goffi.org> parents: 37 diff changeset	57 self.host.actionResultExt(request_id,"DICT_DICT",self.__gateways[request_id])
2e3411a6baad Wix: external server management in gateways manager, SàT: bug fixes in gateway management Goffi <goffi@goffi.org> parents: 37 diff changeset	58
25 53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways Goffi <goffi@goffi.org> parents: diff changeset	59 def discoInfo(self, disco, entity, request_id):
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways Goffi <goffi@goffi.org> parents: diff changeset	60 """Find disco infos about entity, to check if it is a gateway"""
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways Goffi <goffi@goffi.org> parents: diff changeset	61
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways Goffi <goffi@goffi.org> parents: diff changeset	62 for identity in disco.identities:
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways Goffi <goffi@goffi.org> parents: diff changeset	63 if identity[0] == 'gateway':
69 86f1f7f6d332 i18n first draft Goffi <goffi@goffi.org> parents: 65 diff changeset	64 print (_("Found gateway (%(jid)s): %(identity)s") % {'jid':entity.full(), 'identity':disco.identities[identity]})
25 53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways Goffi <goffi@goffi.org> parents: diff changeset	65 self.__gateways[request_id][entity.full()] = {
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways Goffi <goffi@goffi.org> parents: diff changeset	66 'name':disco.identities[identity],
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways Goffi <goffi@goffi.org> parents: diff changeset	67 'type':identity[1]
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways Goffi <goffi@goffi.org> parents: diff changeset	68 }
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways Goffi <goffi@goffi.org> parents: diff changeset	69
39 2e3411a6baad Wix: external server management in gateways manager, SàT: bug fixes in gateway management Goffi <goffi@goffi.org> parents: 37 diff changeset	70 self.__inc_handled_items(request_id)
2e3411a6baad Wix: external server management in gateways manager, SàT: bug fixes in gateway management Goffi <goffi@goffi.org> parents: 37 diff changeset	71
2e3411a6baad Wix: external server management in gateways manager, SàT: bug fixes in gateway management Goffi <goffi@goffi.org> parents: 37 diff changeset	72 def discoInfoErr(self, failure, entity, request_id):
2e3411a6baad Wix: external server management in gateways manager, SàT: bug fixes in gateway management Goffi <goffi@goffi.org> parents: 37 diff changeset	73 """Something is going wrong with disco"""
2e3411a6baad Wix: external server management in gateways manager, SàT: bug fixes in gateway management Goffi <goffi@goffi.org> parents: 37 diff changeset	74 failure.trap(jab_error.StanzaError)
69 86f1f7f6d332 i18n first draft Goffi <goffi@goffi.org> parents: 65 diff changeset	75 error(_("Error when discovering [%(jid)s]: %(condition)s") % {'jid':entity.full(), 'condition':failure.value.condition})
39 2e3411a6baad Wix: external server management in gateways manager, SàT: bug fixes in gateway management Goffi <goffi@goffi.org> parents: 37 diff changeset	76 self.__inc_handled_items(request_id)
2e3411a6baad Wix: external server management in gateways manager, SàT: bug fixes in gateway management Goffi <goffi@goffi.org> parents: 37 diff changeset	77
25 53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways Goffi <goffi@goffi.org> parents: diff changeset	78
64 d46f849664aa SàT: multi-profile, plugins updated Goffi <goffi@goffi.org> parents: 57 diff changeset	79 def discoItems(self, disco, request_id, target, client):
25 53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways Goffi <goffi@goffi.org> parents: diff changeset	80 """Look for items with disco protocol, and ask infos for each one"""
42 874de3020e1c Initial VCard (XEP-0054) support + misc fixes Goffi <goffi@goffi.org> parents: 39 diff changeset	81 #FIXME: target is used as we can't find the original iq node (parent is None)
874de3020e1c Initial VCard (XEP-0054) support + misc fixes Goffi <goffi@goffi.org> parents: 39 diff changeset	82 # an other way would avoid this useless parameter (is there a way with wokkel ?)
25 53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways Goffi <goffi@goffi.org> parents: diff changeset	83 if len(disco._items) == 0:
69 86f1f7f6d332 i18n first draft Goffi <goffi@goffi.org> parents: 65 diff changeset	84 debug (_("No gateway found"))
25 53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways Goffi <goffi@goffi.org> parents: diff changeset	85 self.host.actionResultExt(request_id,"DICT_DICT",{})
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways Goffi <goffi@goffi.org> parents: diff changeset	86 return
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways Goffi <goffi@goffi.org> parents: diff changeset	87
42 874de3020e1c Initial VCard (XEP-0054) support + misc fixes Goffi <goffi@goffi.org> parents: 39 diff changeset	88 self.__gateways[request_id] = {'__total_items':len(disco._items), '__handled_items':0, '__private__':{'target':target.full()}}
25 53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways Goffi <goffi@goffi.org> parents: diff changeset	89 for item in disco._items:
69 86f1f7f6d332 i18n first draft Goffi <goffi@goffi.org> parents: 65 diff changeset	90 debug (_("item found: %s"), item.name)
64 d46f849664aa SàT: multi-profile, plugins updated Goffi <goffi@goffi.org> parents: 57 diff changeset	91 client.disco.requestInfo(item.entity).addCallback(self.discoInfo, entity=item.entity, request_id=request_id)
d46f849664aa SàT: multi-profile, plugins updated Goffi <goffi@goffi.org> parents: 57 diff changeset	92 client.disco.requestInfo(item.entity).addErrback(self.discoInfoErr, entity=item.entity, request_id=request_id)
25 53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways Goffi <goffi@goffi.org> parents: diff changeset	93
37 a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 30 diff changeset	94 def registrationSuccessful(self, target):
a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 30 diff changeset	95 """Called when in_band registration is ok, we must now follow the rest of procedure"""
69 86f1f7f6d332 i18n first draft Goffi <goffi@goffi.org> parents: 65 diff changeset	96 debug (_("Registration successful, doing the rest"))
37 a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 30 diff changeset	97 self.host.addContact(target)
a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 30 diff changeset	98 self.host.setPresence(target)
a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 30 diff changeset	99
a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 30 diff changeset	100 def gatewayRegister(self, action, target, fields):
a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 30 diff changeset	101 """Register gateway using in-band registration, then log-in to gateway"""
a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 30 diff changeset	102 if action == 'SUBMIT':
a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 30 diff changeset	103 self.host.plugins["XEP_0077"].addTrigger(target, self.registrationSuccessful)
a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 30 diff changeset	104 return self.host.plugins["XEP_0077"].in_band_submit(action, target, fields)
a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 30 diff changeset	105
64 d46f849664aa SàT: multi-profile, plugins updated Goffi <goffi@goffi.org> parents: 57 diff changeset	106 def findGateways(self, target, profile_key='@DEFAULT@'):
25 53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways Goffi <goffi@goffi.org> parents: diff changeset	107 """Find gateways in the target JID, using discovery protocol
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways Goffi <goffi@goffi.org> parents: diff changeset	108 Return an id used for retrieving the list of gateways
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways Goffi <goffi@goffi.org> parents: diff changeset	109 """
64 d46f849664aa SàT: multi-profile, plugins updated Goffi <goffi@goffi.org> parents: 57 diff changeset	110 client = self.host.getClient(profile_key)
d46f849664aa SàT: multi-profile, plugins updated Goffi <goffi@goffi.org> parents: 57 diff changeset	111 assert(client)
42 874de3020e1c Initial VCard (XEP-0054) support + misc fixes Goffi <goffi@goffi.org> parents: 39 diff changeset	112 to_jid = jid.JID(target)
69 86f1f7f6d332 i18n first draft Goffi <goffi@goffi.org> parents: 65 diff changeset	113 debug (_("find gateways (target = %s)") % to_jid.full())
25 53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways Goffi <goffi@goffi.org> parents: diff changeset	114 request_id = self.host.get_next_id()
64 d46f849664aa SàT: multi-profile, plugins updated Goffi <goffi@goffi.org> parents: 57 diff changeset	115 client.disco.requestItems(to_jid).addCallback(self.discoItems, request_id=request_id, target = to_jid, client = client)
25 53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways Goffi <goffi@goffi.org> parents: diff changeset	116 return request_id

Mercurial > libervia-backend

annotate plugins/plugin_xep_0100.py @ 98:dd556233a1b1