Mercurial > libervia-backend

annotate src/plugins/plugin_xep_0100.py @ 499:28f4ce741ae5

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
primitivus: fixed display for selected entity in contacts list + added indentation for status message
author Goffi <goffi@goffi.org>
date Tue, 04 Sep 2012 13:36:14 +0200
parents 2a072735e459
children 899bd6fc7580
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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)
459
cf005701624b copyleft date update
Goffi <goffi@goffi.org>
parents: 372
diff changeset
6 Copyright (C) 2009, 2010, 2011, 2012 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
480
2a072735e459 Licence modification: the full project is now under AGPL v3+ instead of GPL v3+
Goffi <goffi@goffi.org>
parents: 459
diff changeset
9 it under the terms of the GNU Affero General Public License as published by
25
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
480
2a072735e459 Licence modification: the full project is now under AGPL v3+ instead of GPL v3+
Goffi <goffi@goffi.org>
parents: 459
diff changeset
16 GNU Affero General Public License for more details.
25
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways
Goffi <goffi@goffi.org>
parents:
diff changeset
17
480
2a072735e459 Licence modification: the full project is now under AGPL v3+ instead of GPL v3+
Goffi <goffi@goffi.org>
parents: 459
diff changeset
18 You should have received a copy of the GNU Affero General Public License
25
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
174
fbae69247b15 Core: plugin 0100: added connection lost management for disco info
Goffi <goffi@goffi.org>
parents: 169
diff changeset
26 import twisted.internet.error
25
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways
Goffi <goffi@goffi.org>
parents:
diff changeset
27 import pdb
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways
Goffi <goffi@goffi.org>
parents:
diff changeset
28
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways
Goffi <goffi@goffi.org>
parents:
diff changeset
29 from wokkel import disco, iwokkel
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways
Goffi <goffi@goffi.org>
parents:
diff changeset
30
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways
Goffi <goffi@goffi.org>
parents:
diff changeset
31 PLUGIN_INFO = {
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways
Goffi <goffi@goffi.org>
parents:
diff changeset
32 "name": "Gateways Plugin",
291
7c79d4a8c9e6 plugins: fixed bad import names
Goffi <goffi@goffi.org>
parents: 228
diff changeset
33 "import_name": "XEP-0100",
25
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways
Goffi <goffi@goffi.org>
parents:
diff changeset
34 "type": "XEP",
48
4392f1fdb064 plugins improvement
Goffi <goffi@goffi.org>
parents: 42
diff changeset
35 "protocols": ["XEP-0100"],
291
7c79d4a8c9e6 plugins: fixed bad import names
Goffi <goffi@goffi.org>
parents: 228
diff changeset
36 "dependencies": ["XEP-0077"],
25
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways
Goffi <goffi@goffi.org>
parents:
diff changeset
37 "main": "XEP_0100",
69
86f1f7f6d332 i18n first draft
Goffi <goffi@goffi.org>
parents: 65
diff changeset
38 "description": _("""Implementation of Gateways protocol""")
25
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
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways
Goffi <goffi@goffi.org>
parents:
diff changeset
41 class XEP_0100():
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways
Goffi <goffi@goffi.org>
parents:
diff changeset
42
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways
Goffi <goffi@goffi.org>
parents:
diff changeset
43 def __init__(self, host):
69
86f1f7f6d332 i18n first draft
Goffi <goffi@goffi.org>
parents: 65
diff changeset
44 info(_("Gateways plugin initialization"))
25
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways
Goffi <goffi@goffi.org>
parents:
diff changeset
45 self.host = host
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways
Goffi <goffi@goffi.org>
parents:
diff changeset
46 self.__gateways = {} #dict used to construct the answer to findGateways. Key = target jid
372
f964dcec1611 core: plugins refactored according to bridge + updatedValue now use profile
Goffi <goffi@goffi.org>
parents: 291
diff changeset
47 host.bridge.addMethod("findGateways", ".plugin", in_sign='ss', out_sign='s', method=self.findGateways)
f964dcec1611 core: plugins refactored according to bridge + updatedValue now use profile
Goffi <goffi@goffi.org>
parents: 291
diff changeset
48 host.bridge.addMethod("gatewayRegister", ".plugin", in_sign='ssa(ss)s', 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
49
2e3411a6baad Wix: external server management in gateways manager, SàT: bug fixes in gateway management
Goffi <goffi@goffi.org>
parents: 37
diff changeset
50 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
51 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
52
2e3411a6baad Wix: external server management in gateways manager, SàT: bug fixes in gateway management
Goffi <goffi@goffi.org>
parents: 37
diff changeset
53 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
54 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
55
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]['__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
57 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
58 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
59
25
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways
Goffi <goffi@goffi.org>
parents:
diff changeset
60 def discoInfo(self, disco, entity, request_id):
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways
Goffi <goffi@goffi.org>
parents:
diff changeset
61 """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
62
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways
Goffi <goffi@goffi.org>
parents:
diff changeset
63 for identity in disco.identities:
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways
Goffi <goffi@goffi.org>
parents:
diff changeset
64 if identity[0] == 'gateway':
69
86f1f7f6d332 i18n first draft
Goffi <goffi@goffi.org>
parents: 65
diff changeset
65 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
66 self.__gateways[request_id][entity.full()] = {
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways
Goffi <goffi@goffi.org>
parents:
diff changeset
67 'name':disco.identities[identity],
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways
Goffi <goffi@goffi.org>
parents:
diff changeset
68 'type':identity[1]
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways
Goffi <goffi@goffi.org>
parents:
diff changeset
69 }
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways
Goffi <goffi@goffi.org>
parents:
diff changeset
70
39
2e3411a6baad Wix: external server management in gateways manager, SàT: bug fixes in gateway management
Goffi <goffi@goffi.org>
parents: 37
diff changeset
71 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
72
2e3411a6baad Wix: external server management in gateways manager, SàT: bug fixes in gateway management
Goffi <goffi@goffi.org>
parents: 37
diff changeset
73 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
74 """Something is going wrong with disco"""
174
fbae69247b15 Core: plugin 0100: added connection lost management for disco info
Goffi <goffi@goffi.org>
parents: 169
diff changeset
75 failure.trap(jab_error.StanzaError,twisted.internet.error.ConnectionLost)
fbae69247b15 Core: plugin 0100: added connection lost management for disco info
Goffi <goffi@goffi.org>
parents: 169
diff changeset
76 error(_("Error when discovering [%(jid)s]: %(error)s") % {'jid':entity.full(), 'error':failure.getErrorMessage()})
39
2e3411a6baad Wix: external server management in gateways manager, SàT: bug fixes in gateway management
Goffi <goffi@goffi.org>
parents: 37
diff changeset
77 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
78
25
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways
Goffi <goffi@goffi.org>
parents:
diff changeset
79
64
d46f849664aa SàT: multi-profile, plugins updated
Goffi <goffi@goffi.org>
parents: 57
diff changeset
80 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
81 """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
82 #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
83 # 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
84 if len(disco._items) == 0:
69
86f1f7f6d332 i18n first draft
Goffi <goffi@goffi.org>
parents: 65
diff changeset
85 debug (_("No gateway found"))
25
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways
Goffi <goffi@goffi.org>
parents:
diff changeset
86 self.host.actionResultExt(request_id,"DICT_DICT",{})
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways
Goffi <goffi@goffi.org>
parents:
diff changeset
87 return
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways
Goffi <goffi@goffi.org>
parents:
diff changeset
88
42
874de3020e1c Initial VCard (XEP-0054) support + misc fixes
Goffi <goffi@goffi.org>
parents: 39
diff changeset
89 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
90 for item in disco._items:
175
8537df794f74 Primitivus: gateways: current server is now shown in title
Goffi <goffi@goffi.org>
parents: 174
diff changeset
91 #TODO: need to set a timeout for theses requests
69
86f1f7f6d332 i18n first draft
Goffi <goffi@goffi.org>
parents: 65
diff changeset
92 debug (_("item found: %s"), item.name)
102
94011f553cd0 misc bugfixes
Goffi <goffi@goffi.org>
parents: 69
diff changeset
93 client.disco.requestInfo(item.entity).addCallback(self.discoInfo, entity=item.entity, request_id=request_id).addErrback(self.discoInfoErr, entity=item.entity, request_id=request_id)
94011f553cd0 misc bugfixes
Goffi <goffi@goffi.org>
parents: 69
diff changeset
94
94011f553cd0 misc bugfixes
Goffi <goffi@goffi.org>
parents: 69
diff changeset
95 def discoItemsErr(self, failure, request_id, target, client):
94011f553cd0 misc bugfixes
Goffi <goffi@goffi.org>
parents: 69
diff changeset
96 """Something is going wrong with disco"""
94011f553cd0 misc bugfixes
Goffi <goffi@goffi.org>
parents: 69
diff changeset
97 error(_("Error when discovering [%(target)s]: %(condition)s") % {'target':target.full(), 'condition':unicode(failure.value)})
94011f553cd0 misc bugfixes
Goffi <goffi@goffi.org>
parents: 69
diff changeset
98 message_data={"reason": "connection error", "message":_(u"Error while trying to discover %(target)s gateways: %(error_mess)s") % {'target':target.full(), 'error_mess':unicode(failure.value)}}
94011f553cd0 misc bugfixes
Goffi <goffi@goffi.org>
parents: 69
diff changeset
99 self.host.bridge.actionResult("ERROR", request_id, message_data)
94011f553cd0 misc bugfixes
Goffi <goffi@goffi.org>
parents: 69
diff changeset
100
25
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways
Goffi <goffi@goffi.org>
parents:
diff changeset
101
169
06985b6ad23a SàT: plugin 0077 & 0100: fixed profile management
Goffi <goffi@goffi.org>
parents: 102
diff changeset
102 def registrationSuccessful(self, target, profile):
37
a61beb21d16d Gateway registration, unregistration & edition
Goffi <goffi@goffi.org>
parents: 30
diff changeset
103 """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
104 debug (_("Registration successful, doing the rest"))
169
06985b6ad23a SàT: plugin 0077 & 0100: fixed profile management
Goffi <goffi@goffi.org>
parents: 102
diff changeset
105 self.host.addContact(target, profile)
06985b6ad23a SàT: plugin 0077 & 0100: fixed profile management
Goffi <goffi@goffi.org>
parents: 102
diff changeset
106 self.host.setPresence(target, profile)
37
a61beb21d16d Gateway registration, unregistration & edition
Goffi <goffi@goffi.org>
parents: 30
diff changeset
107
169
06985b6ad23a SàT: plugin 0077 & 0100: fixed profile management
Goffi <goffi@goffi.org>
parents: 102
diff changeset
108 def gatewayRegister(self, action, target, fields, profile_key='@DEFAULT@'):
37
a61beb21d16d Gateway registration, unregistration & edition
Goffi <goffi@goffi.org>
parents: 30
diff changeset
109 """Register gateway using in-band registration, then log-in to gateway"""
169
06985b6ad23a SàT: plugin 0077 & 0100: fixed profile management
Goffi <goffi@goffi.org>
parents: 102
diff changeset
110 profile = self.host.memory.getProfileName(profile_key)
06985b6ad23a SàT: plugin 0077 & 0100: fixed profile management
Goffi <goffi@goffi.org>
parents: 102
diff changeset
111 assert(profile) #FIXME: return an error here
37
a61beb21d16d Gateway registration, unregistration & edition
Goffi <goffi@goffi.org>
parents: 30
diff changeset
112 if action == 'SUBMIT':
291
7c79d4a8c9e6 plugins: fixed bad import names
Goffi <goffi@goffi.org>
parents: 228
diff changeset
113 self.host.plugins["XEP-0077"].addTrigger(target, self.registrationSuccessful, profile)
7c79d4a8c9e6 plugins: fixed bad import names
Goffi <goffi@goffi.org>
parents: 228
diff changeset
114 return self.host.plugins["XEP-0077"].in_band_submit(action, target, fields, profile)
37
a61beb21d16d Gateway registration, unregistration & edition
Goffi <goffi@goffi.org>
parents: 30
diff changeset
115
64
d46f849664aa SàT: multi-profile, plugins updated
Goffi <goffi@goffi.org>
parents: 57
diff changeset
116 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
117 """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
118 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
119 """
102
94011f553cd0 misc bugfixes
Goffi <goffi@goffi.org>
parents: 69
diff changeset
120 profile = self.host.memory.getProfileName(profile_key)
64
d46f849664aa SàT: multi-profile, plugins updated
Goffi <goffi@goffi.org>
parents: 57
diff changeset
121 client = self.host.getClient(profile_key)
d46f849664aa SàT: multi-profile, plugins updated
Goffi <goffi@goffi.org>
parents: 57
diff changeset
122 assert(client)
42
874de3020e1c Initial VCard (XEP-0054) support + misc fixes
Goffi <goffi@goffi.org>
parents: 39
diff changeset
123 to_jid = jid.JID(target)
102
94011f553cd0 misc bugfixes
Goffi <goffi@goffi.org>
parents: 69
diff changeset
124 debug (_("find gateways (target = %(target)s, profile = %(profile)s)") % {'target':to_jid.full(), 'profile':profile})
25
53e921c8a357 new plugin: gateways plugin, and first implementation of findGateways
Goffi <goffi@goffi.org>
parents:
diff changeset
125 request_id = self.host.get_next_id()
102
94011f553cd0 misc bugfixes
Goffi <goffi@goffi.org>
parents: 69
diff changeset
126 client.disco.requestItems(to_jid).addCallback(self.discoItems, request_id=request_id, target = to_jid, client = client).addErrback(self.discoItemsErr, 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
127 return request_id