libervia-backend: plugins/plugin_xep

annotate plugins/plugin_xep_0077.py @ 57:a5b5fb5fc9fd

updated README and copyright note - fixed images path in README - added year 2010 in all copyright notes

author	Goffi <goffi@goffi.org>
date	Sun, 10 Jan 2010 17:51:56 +1100
parents	4392f1fdb064
children	d46f849664aa

rev	line source
30 d6b613764dd7 new plugin for xep 0077 (In-Band registration): first draft Goffi <goffi@goffi.org> parents: diff changeset	1 #!/usr/bin/python
d6b613764dd7 new plugin for xep 0077 (In-Band registration): first draft Goffi <goffi@goffi.org> parents: diff changeset	2 # -- coding: utf-8 --
d6b613764dd7 new plugin for xep 0077 (In-Band registration): first draft Goffi <goffi@goffi.org> parents: diff changeset	3
d6b613764dd7 new plugin for xep 0077 (In-Band registration): first draft Goffi <goffi@goffi.org> parents: diff changeset	4 """
d6b613764dd7 new plugin for xep 0077 (In-Band registration): first draft Goffi <goffi@goffi.org> parents: diff changeset	5 SAT plugin for managing xep-0077
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)
30 d6b613764dd7 new plugin for xep 0077 (In-Band registration): first draft Goffi <goffi@goffi.org> parents: diff changeset	7
d6b613764dd7 new plugin for xep 0077 (In-Band registration): first draft Goffi <goffi@goffi.org> parents: diff changeset	8 This program is free software: you can redistribute it and/or modify
d6b613764dd7 new plugin for xep 0077 (In-Band registration): first draft Goffi <goffi@goffi.org> parents: diff changeset	9 it under the terms of the GNU General Public License as published by
d6b613764dd7 new plugin for xep 0077 (In-Band registration): first draft Goffi <goffi@goffi.org> parents: diff changeset	10 the Free Software Foundation, either version 3 of the License, or
d6b613764dd7 new plugin for xep 0077 (In-Band registration): first draft Goffi <goffi@goffi.org> parents: diff changeset	11 (at your option) any later version.
d6b613764dd7 new plugin for xep 0077 (In-Band registration): first draft Goffi <goffi@goffi.org> parents: diff changeset	12
d6b613764dd7 new plugin for xep 0077 (In-Band registration): first draft Goffi <goffi@goffi.org> parents: diff changeset	13 This program is distributed in the hope that it will be useful,
d6b613764dd7 new plugin for xep 0077 (In-Band registration): first draft Goffi <goffi@goffi.org> parents: diff changeset	14 but WITHOUT ANY WARRANTY; without even the implied warranty of
d6b613764dd7 new plugin for xep 0077 (In-Band registration): first draft Goffi <goffi@goffi.org> parents: diff changeset	15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
d6b613764dd7 new plugin for xep 0077 (In-Band registration): first draft Goffi <goffi@goffi.org> parents: diff changeset	16 GNU General Public License for more details.
d6b613764dd7 new plugin for xep 0077 (In-Band registration): first draft Goffi <goffi@goffi.org> parents: diff changeset	17
d6b613764dd7 new plugin for xep 0077 (In-Band registration): first draft Goffi <goffi@goffi.org> parents: diff changeset	18 You should have received a copy of the GNU General Public License
d6b613764dd7 new plugin for xep 0077 (In-Band registration): first draft Goffi <goffi@goffi.org> parents: diff changeset	19 along with this program. If not, see <http://www.gnu.org/licenses/>.
d6b613764dd7 new plugin for xep 0077 (In-Band registration): first draft Goffi <goffi@goffi.org> parents: diff changeset	20 """
d6b613764dd7 new plugin for xep 0077 (In-Band registration): first draft Goffi <goffi@goffi.org> parents: diff changeset	21
d6b613764dd7 new plugin for xep 0077 (In-Band registration): first draft Goffi <goffi@goffi.org> parents: diff changeset	22 from logging import debug, info, error
39 2e3411a6baad Wix: external server management in gateways manager, SàT: bug fixes in gateway management Goffi <goffi@goffi.org> parents: 37 diff changeset	23 from twisted.words.protocols.jabber import client, jid, xmlstream
2e3411a6baad Wix: external server management in gateways manager, SàT: bug fixes in gateway management Goffi <goffi@goffi.org> parents: 37 diff changeset	24 from twisted.words.protocols.jabber import error as jab_error
30 d6b613764dd7 new plugin for xep 0077 (In-Band registration): first draft Goffi <goffi@goffi.org> parents: diff changeset	25 from twisted.words.protocols.jabber.xmlstream import IQ
d6b613764dd7 new plugin for xep 0077 (In-Band registration): first draft Goffi <goffi@goffi.org> parents: diff changeset	26 from twisted.internet import reactor
33 b9bb5d8e0cc7 In-band-registration: data form 2 xml conversion Goffi <goffi@goffi.org> parents: 30 diff changeset	27 from tools.xml_tools import XMLTools
30 d6b613764dd7 new plugin for xep 0077 (In-Band registration): first draft Goffi <goffi@goffi.org> parents: diff changeset	28 import pdb
d6b613764dd7 new plugin for xep 0077 (In-Band registration): first draft Goffi <goffi@goffi.org> parents: diff changeset	29
33 b9bb5d8e0cc7 In-band-registration: data form 2 xml conversion Goffi <goffi@goffi.org> parents: 30 diff changeset	30 from wokkel import data_form
b9bb5d8e0cc7 In-band-registration: data form 2 xml conversion Goffi <goffi@goffi.org> parents: 30 diff changeset	31
30 d6b613764dd7 new plugin for xep 0077 (In-Band registration): first draft Goffi <goffi@goffi.org> parents: diff changeset	32 NS_REG = 'jabber:iq:register'
d6b613764dd7 new plugin for xep 0077 (In-Band registration): first draft Goffi <goffi@goffi.org> parents: diff changeset	33
d6b613764dd7 new plugin for xep 0077 (In-Band registration): first draft Goffi <goffi@goffi.org> parents: diff changeset	34 PLUGIN_INFO = {
d6b613764dd7 new plugin for xep 0077 (In-Band registration): first draft Goffi <goffi@goffi.org> parents: diff changeset	35 "name": "XEP 0077 Plugin",
d6b613764dd7 new plugin for xep 0077 (In-Band registration): first draft Goffi <goffi@goffi.org> parents: diff changeset	36 "import_name": "XEP_0077",
d6b613764dd7 new plugin for xep 0077 (In-Band registration): first draft Goffi <goffi@goffi.org> parents: diff changeset	37 "type": "XEP",
48 4392f1fdb064 plugins improvement Goffi <goffi@goffi.org> parents: 40 diff changeset	38 "protocols": ["XEP-0077"],
30 d6b613764dd7 new plugin for xep 0077 (In-Band registration): first draft Goffi <goffi@goffi.org> parents: diff changeset	39 "dependencies": [],
d6b613764dd7 new plugin for xep 0077 (In-Band registration): first draft Goffi <goffi@goffi.org> parents: diff changeset	40 "main": "XEP_0077",
36 6491b7956c80 wix: Form submitting, first draft Goffi <goffi@goffi.org> parents: 35 diff changeset	41 "description": """Implementation of in-band registration"""
30 d6b613764dd7 new plugin for xep 0077 (In-Band registration): first draft Goffi <goffi@goffi.org> parents: diff changeset	42 }
d6b613764dd7 new plugin for xep 0077 (In-Band registration): first draft Goffi <goffi@goffi.org> parents: diff changeset	43
d6b613764dd7 new plugin for xep 0077 (In-Band registration): first draft Goffi <goffi@goffi.org> parents: diff changeset	44 class XEP_0077():
37 a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 36 diff changeset	45
30 d6b613764dd7 new plugin for xep 0077 (In-Band registration): first draft Goffi <goffi@goffi.org> parents: diff changeset	46 def __init__(self, host):
d6b613764dd7 new plugin for xep 0077 (In-Band registration): first draft Goffi <goffi@goffi.org> parents: diff changeset	47 info("Plugin XEP_0077 initialization")
d6b613764dd7 new plugin for xep 0077 (In-Band registration): first draft Goffi <goffi@goffi.org> parents: diff changeset	48 self.host = host
37 a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 36 diff changeset	49 self.triggers = {} #used by other protocol (e.g. XEP-0100) to finish registration. key = target_jid
30 d6b613764dd7 new plugin for xep 0077 (In-Band registration): first draft Goffi <goffi@goffi.org> parents: diff changeset	50 host.bridge.addMethod("in_band_register", ".communication", in_sign='s', out_sign='s', method=self.in_band_register)
37 a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 36 diff changeset	51 host.bridge.addMethod("in_band_submit", ".request", in_sign='sa(ss)', out_sign='s', method=self.in_band_submit)
30 d6b613764dd7 new plugin for xep 0077 (In-Band registration): first draft Goffi <goffi@goffi.org> parents: diff changeset	52
37 a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 36 diff changeset	53 def addTrigger(self, target, cb):
a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 36 diff changeset	54 """Add a callback which is called when registration to target is successful"""
a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 36 diff changeset	55 self.triggers[target] = cb
a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 36 diff changeset	56
30 d6b613764dd7 new plugin for xep 0077 (In-Band registration): first draft Goffi <goffi@goffi.org> parents: diff changeset	57 def reg_ok(self, answer):
d6b613764dd7 new plugin for xep 0077 (In-Band registration): first draft Goffi <goffi@goffi.org> parents: diff changeset	58 """Called after the first get IQ"""
39 2e3411a6baad Wix: external server management in gateways manager, SàT: bug fixes in gateway management Goffi <goffi@goffi.org> parents: 37 diff changeset	59 try:
2e3411a6baad Wix: external server management in gateways manager, SàT: bug fixes in gateway management Goffi <goffi@goffi.org> parents: 37 diff changeset	60 x_elem = filter (lambda x:x.name == "x", answer.firstChildElement().elements())[0] #We only want the "x" element (data form)
2e3411a6baad Wix: external server management in gateways manager, SàT: bug fixes in gateway management Goffi <goffi@goffi.org> parents: 37 diff changeset	61 except IndexError:
2e3411a6baad Wix: external server management in gateways manager, SàT: bug fixes in gateway management Goffi <goffi@goffi.org> parents: 37 diff changeset	62 info("No data form found")
2e3411a6baad Wix: external server management in gateways manager, SàT: bug fixes in gateway management Goffi <goffi@goffi.org> parents: 37 diff changeset	63 #TODO: manage registration without data form
2e3411a6baad Wix: external server management in gateways manager, SàT: bug fixes in gateway management Goffi <goffi@goffi.org> parents: 37 diff changeset	64 answer_data = {}
2e3411a6baad Wix: external server management in gateways manager, SàT: bug fixes in gateway management Goffi <goffi@goffi.org> parents: 37 diff changeset	65 answer_data={"reason": "unmanaged", "message":"This gateway can't be managed by SàT, sorry :("}
2e3411a6baad Wix: external server management in gateways manager, SàT: bug fixes in gateway management Goffi <goffi@goffi.org> parents: 37 diff changeset	66 answer_type = "ERROR"
2e3411a6baad Wix: external server management in gateways manager, SàT: bug fixes in gateway management Goffi <goffi@goffi.org> parents: 37 diff changeset	67 self.host.bridge.actionResult(answer_type, answer['id'], answer_data)
2e3411a6baad Wix: external server management in gateways manager, SàT: bug fixes in gateway management Goffi <goffi@goffi.org> parents: 37 diff changeset	68 return
2e3411a6baad Wix: external server management in gateways manager, SàT: bug fixes in gateway management Goffi <goffi@goffi.org> parents: 37 diff changeset	69
2e3411a6baad Wix: external server management in gateways manager, SàT: bug fixes in gateway management Goffi <goffi@goffi.org> parents: 37 diff changeset	70 form = data_form.Form.fromElement(x_elem)
33 b9bb5d8e0cc7 In-band-registration: data form 2 xml conversion Goffi <goffi@goffi.org> parents: 30 diff changeset	71 xml_data = XMLTools.dataForm2xml(form)
36 6491b7956c80 wix: Form submitting, first draft Goffi <goffi@goffi.org> parents: 35 diff changeset	72 self.host.bridge.actionResult("FORM", answer['id'], {"target":answer["from"], "type":"registration", "xml":xml_data})
30 d6b613764dd7 new plugin for xep 0077 (In-Band registration): first draft Goffi <goffi@goffi.org> parents: diff changeset	73
d6b613764dd7 new plugin for xep 0077 (In-Band registration): first draft Goffi <goffi@goffi.org> parents: diff changeset	74 def reg_err(self, failure):
d6b613764dd7 new plugin for xep 0077 (In-Band registration): first draft Goffi <goffi@goffi.org> parents: diff changeset	75 """Called when something is wrong with registration"""
d6b613764dd7 new plugin for xep 0077 (In-Band registration): first draft Goffi <goffi@goffi.org> parents: diff changeset	76 info ("Registration failure: %s" % str(failure.value))
d6b613764dd7 new plugin for xep 0077 (In-Band registration): first draft Goffi <goffi@goffi.org> parents: diff changeset	77 answer_data = {}
d6b613764dd7 new plugin for xep 0077 (In-Band registration): first draft Goffi <goffi@goffi.org> parents: diff changeset	78 answer_data['reason'] = 'unknown'
d6b613764dd7 new plugin for xep 0077 (In-Band registration): first draft Goffi <goffi@goffi.org> parents: diff changeset	79 answer_data={"message":"%s [code: %s]" % (failure.value.condition, failure.value.code)}
d6b613764dd7 new plugin for xep 0077 (In-Band registration): first draft Goffi <goffi@goffi.org> parents: diff changeset	80 answer_type = "ERROR"
d6b613764dd7 new plugin for xep 0077 (In-Band registration): first draft Goffi <goffi@goffi.org> parents: diff changeset	81 self.host.bridge.actionResult(answer_type, failure.value.stanza['id'], answer_data)
d6b613764dd7 new plugin for xep 0077 (In-Band registration): first draft Goffi <goffi@goffi.org> parents: diff changeset	82
37 a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 36 diff changeset	83 def unregistrationAnswer(self, answer):
a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 36 diff changeset	84 debug ("registration answer: %s" % answer.toXml())
a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 36 diff changeset	85 answer_type = "SUCCESS"
a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 36 diff changeset	86 answer_data={"message":"Your are now unregistred"}
a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 36 diff changeset	87 self.host.bridge.actionResult(answer_type, answer['id'], answer_data)
a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 36 diff changeset	88
a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 36 diff changeset	89 def unregistrationFailure(self, failure):
a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 36 diff changeset	90 info ("Unregistration failure: %s" % str(failure.value))
a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 36 diff changeset	91 answer_type = "ERROR"
a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 36 diff changeset	92 answer_data = {}
a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 36 diff changeset	93 answer_data['reason'] = 'unknown'
a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 36 diff changeset	94 answer_data={"message":"Unregistration failed: %s" % failure.value.condition}
a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 36 diff changeset	95 self.host.bridge.actionResult(answer_type, failure.value.stanza['id'], answer_data)
a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 36 diff changeset	96
a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 36 diff changeset	97 def registrationAnswer(self, answer):
a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 36 diff changeset	98 debug ("registration answer: %s" % answer.toXml())
a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 36 diff changeset	99 answer_type = "SUCCESS"
a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 36 diff changeset	100 answer_data={"message":"Registration successfull"}
a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 36 diff changeset	101 self.host.bridge.actionResult(answer_type, answer['id'], answer_data)
a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 36 diff changeset	102 if self.triggers.has_key(answer["from"]):
a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 36 diff changeset	103 self.triggers[answer["from"]](answer["from"])
a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 36 diff changeset	104 del self.triggers[answer["from"]]
a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 36 diff changeset	105
a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 36 diff changeset	106 def registrationFailure(self, failure):
a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 36 diff changeset	107 info ("Registration failure: %s" % str(failure.value))
a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 36 diff changeset	108 print failure.value.stanza.toXml()
a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 36 diff changeset	109 answer_type = "ERROR"
a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 36 diff changeset	110 answer_data = {}
a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 36 diff changeset	111 if failure.value.condition == 'conflict':
a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 36 diff changeset	112 answer_data['reason'] = 'conflict'
a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 36 diff changeset	113 answer_data={"message":"Username already exists, please choose an other one"}
a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 36 diff changeset	114 else:
a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 36 diff changeset	115 answer_data['reason'] = 'unknown'
a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 36 diff changeset	116 answer_data={"message":"Registration failed"}
a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 36 diff changeset	117 self.host.bridge.actionResult(answer_type, failure.value.stanza['id'], answer_data)
a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 36 diff changeset	118 if self.triggers.has_key(answer["from"]):
a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 36 diff changeset	119 del self.triggers[answer["from"]]
a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 36 diff changeset	120
a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 36 diff changeset	121 def in_band_submit(self, action, target, fields):
a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 36 diff changeset	122 """Submit a form for registration, using data_form"""
a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 36 diff changeset	123 id, deferred = self.host.submitForm(action, target, fields)
a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 36 diff changeset	124 if action == 'CANCEL':
a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 36 diff changeset	125 deferred.addCallbacks(self.unregistrationAnswer, self.unregistrationFailure)
a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 36 diff changeset	126 else:
a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 36 diff changeset	127 deferred.addCallbacks(self.registrationAnswer, self.registrationFailure)
a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 36 diff changeset	128 return id
a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 36 diff changeset	129
30 d6b613764dd7 new plugin for xep 0077 (In-Band registration): first draft Goffi <goffi@goffi.org> parents: diff changeset	130 def in_band_register(self, target):
d6b613764dd7 new plugin for xep 0077 (In-Band registration): first draft Goffi <goffi@goffi.org> parents: diff changeset	131 """register to a target JID"""
d6b613764dd7 new plugin for xep 0077 (In-Band registration): first draft Goffi <goffi@goffi.org> parents: diff changeset	132 to_jid = jid.JID(target)
40 6f0699ba0329 plugin XEP-0077: minor log fix Goffi <goffi@goffi.org> parents: 39 diff changeset	133 debug("Asking registration for [%s]" % to_jid.full())
30 d6b613764dd7 new plugin for xep 0077 (In-Band registration): first draft Goffi <goffi@goffi.org> parents: diff changeset	134 reg_request=IQ(self.host.xmlstream,'get')
d6b613764dd7 new plugin for xep 0077 (In-Band registration): first draft Goffi <goffi@goffi.org> parents: diff changeset	135 reg_request["from"]=self.host.me.full()
d6b613764dd7 new plugin for xep 0077 (In-Band registration): first draft Goffi <goffi@goffi.org> parents: diff changeset	136 reg_request["to"] = to_jid.full()
d6b613764dd7 new plugin for xep 0077 (In-Band registration): first draft Goffi <goffi@goffi.org> parents: diff changeset	137 query=reg_request.addElement('query', NS_REG)
d6b613764dd7 new plugin for xep 0077 (In-Band registration): first draft Goffi <goffi@goffi.org> parents: diff changeset	138 reg_request.send(to_jid.full()).addCallbacks(self.reg_ok, self.reg_err)
d6b613764dd7 new plugin for xep 0077 (In-Band registration): first draft Goffi <goffi@goffi.org> parents: diff changeset	139 return reg_request["id"]

Mercurial > libervia-backend

annotate plugins/plugin_xep_0077.py @ 57:a5b5fb5fc9fd