mirror of
https://github.com/correl/SleekXMPP.git
synced 2024-11-23 19:19:53 +00:00
Added new implementation for XEP-0086.
This commit is contained in:
Lance Stout
parent
6d45971411
commit
d94811d81d
6 changed files with 148 additions and 53 deletions
1
setup.py
1
setup.py
|
|
@ -52,6 +52,7 @@ packages = [ 'sleekxmpp',
|
|||
'sleekxmpp/plugins/xep_0050',
|
||||
'sleekxmpp/plugins/xep_0059',
|
||||
'sleekxmpp/plugins/xep_0085',
|
||||
'sleekxmpp/plugins/xep_0086',
|
||||
'sleekxmpp/plugins/xep_0092',
|
||||
'sleekxmpp/plugins/xep_0128',
|
||||
'sleekxmpp/plugins/xep_0199',
|
||||
|
|
|
|||
|
|
@ -1,49 +0,0 @@
|
|||
|
||||
from __future__ import with_statement
|
||||
from . import base
|
||||
import logging
|
||||
from xml.etree import cElementTree as ET
|
||||
import copy
|
||||
|
||||
class xep_0086(base.base_plugin):
|
||||
"""
|
||||
XEP-0086 Error Condition Mappings
|
||||
"""
|
||||
|
||||
def plugin_init(self):
|
||||
self.xep = '0086'
|
||||
self.description = 'Error Condition Mappings'
|
||||
self.error_map = {
|
||||
'bad-request':('modify','400'),
|
||||
'conflict':('cancel','409'),
|
||||
'feature-not-implemented':('cancel','501'),
|
||||
'forbidden':('auth','403'),
|
||||
'gone':('modify','302'),
|
||||
'internal-server-error':('wait','500'),
|
||||
'item-not-found':('cancel','404'),
|
||||
'jid-malformed':('modify','400'),
|
||||
'not-acceptable':('modify','406'),
|
||||
'not-allowed':('cancel','405'),
|
||||
'not-authorized':('auth','401'),
|
||||
'payment-required':('auth','402'),
|
||||
'recipient-unavailable':('wait','404'),
|
||||
'redirect':('modify','302'),
|
||||
'registration-required':('auth','407'),
|
||||
'remote-server-not-found':('cancel','404'),
|
||||
'remote-server-timeout':('wait','504'),
|
||||
'resource-constraint':('wait','500'),
|
||||
'service-unavailable':('cancel','503'),
|
||||
'subscription-required':('auth','407'),
|
||||
'undefined-condition':(None,'500'),
|
||||
'unexpected-request':('wait','400')
|
||||
}
|
||||
|
||||
|
||||
def makeError(self, condition, cdata=None, errorType=None, text=None, customElem=None):
|
||||
conditionElem = self.xmpp.makeStanzaErrorCondition(condition, cdata)
|
||||
if errorType is None:
|
||||
error = self.xmpp.makeStanzaError(conditionElem, self.error_map[condition][0], self.error_map[condition][1], text, customElem)
|
||||
else:
|
||||
error = self.xmpp.makeStanzaError(conditionElem, errorType, self.error_map[condition][1], text, customElem)
|
||||
error.append(conditionElem)
|
||||
return error
|
||||
10
sleekxmpp/plugins/xep_0086/__init__.py
Normal file
10
sleekxmpp/plugins/xep_0086/__init__.py
Normal file
|
|
@ -0,0 +1,10 @@
|
|||
"""
|
||||
SleekXMPP: The Sleek XMPP Library
|
||||
Copyright (C) 2011 Nathanael C. Fritz, Lance J.T. Stout
|
||||
This file is part of SleekXMPP.
|
||||
|
||||
See the file LICENSE for copying permission.
|
||||
"""
|
||||
|
||||
from sleekxmpp.plugins.xep_0086.stanza import LegacyError
|
||||
from sleekxmpp.plugins.xep_0086.legacy_error import xep_0086
|
||||
42
sleekxmpp/plugins/xep_0086/legacy_error.py
Normal file
42
sleekxmpp/plugins/xep_0086/legacy_error.py
Normal file
|
|
@ -0,0 +1,42 @@
|
|||
"""
|
||||
SleekXMPP: The Sleek XMPP Library
|
||||
Copyright (C) 2011 Nathanael C. Fritz, Lance J.T. Stout
|
||||
This file is part of SleekXMPP.
|
||||
|
||||
See the file LICENSE for copying permission.
|
||||
"""
|
||||
|
||||
from sleekxmpp.stanza import Error
|
||||
from sleekxmpp.xmlstream import register_stanza_plugin
|
||||
from sleekxmpp.plugins.base import base_plugin
|
||||
from sleekxmpp.plugins.xep_0086 import stanza, LegacyError
|
||||
|
||||
|
||||
class xep_0086(base_plugin):
|
||||
|
||||
"""
|
||||
XEP-0086: Error Condition Mappings
|
||||
|
||||
Older XMPP implementations used code based error messages, similar
|
||||
to HTTP response codes. Since then, error condition elements have
|
||||
been introduced. XEP-0086 provides a mapping between the new
|
||||
condition elements and a combination of error types and the older
|
||||
response codes.
|
||||
|
||||
Also see <http://xmpp.org/extensions/xep-0086.html>.
|
||||
|
||||
Configuration Values:
|
||||
override -- Indicates if applying legacy error codes should
|
||||
be done automatically. Defaults to True.
|
||||
If False, then inserting legacy error codes can
|
||||
be done using:
|
||||
iq['error']['legacy']['condition'] = ...
|
||||
"""
|
||||
|
||||
def plugin_init(self):
|
||||
self.xep = '0086'
|
||||
self.description = 'Error Condition Mappings'
|
||||
self.stanza = stanza
|
||||
|
||||
register_stanza_plugin(Error, LegacyError,
|
||||
overrides=self.config.get('override', True))
|
||||
91
sleekxmpp/plugins/xep_0086/stanza.py
Normal file
91
sleekxmpp/plugins/xep_0086/stanza.py
Normal file
|
|
@ -0,0 +1,91 @@
|
|||
"""
|
||||
SleekXMPP: The Sleek XMPP Library
|
||||
Copyright (C) 2011 Nathanael C. Fritz, Lance J.T. Stout
|
||||
This file is part of SleekXMPP.
|
||||
|
||||
See the file LICENSE for copying permission.
|
||||
"""
|
||||
|
||||
from sleekxmpp.stanza import Error
|
||||
from sleekxmpp.xmlstream import ElementBase, ET, register_stanza_plugin
|
||||
|
||||
|
||||
class LegacyError(ElementBase):
|
||||
|
||||
"""
|
||||
Older XMPP implementations used code based error messages, similar
|
||||
to HTTP response codes. Since then, error condition elements have
|
||||
been introduced. XEP-0086 provides a mapping between the new
|
||||
condition elements and a combination of error types and the older
|
||||
response codes.
|
||||
|
||||
Also see <http://xmpp.org/extensions/xep-0086.html>.
|
||||
|
||||
Example legacy error stanzas:
|
||||
<error xmlns="jabber:client" code="501" type="cancel">
|
||||
<feature-not-implemented
|
||||
xmlns="urn:ietf:params:xml:ns:xmpp-stanzas" />
|
||||
</error>
|
||||
|
||||
<error code="402" type="auth">
|
||||
<payment-required
|
||||
xmlns="urn:ietf:params:xml:ns:xmpp-stanzas" />
|
||||
</error>
|
||||
|
||||
Attributes:
|
||||
error_map -- A map of error conditions to error types and
|
||||
code values.
|
||||
Methods:
|
||||
setup -- Overrides ElementBase.setup
|
||||
set_condition -- Remap the type and code interfaces when a
|
||||
condition is set.
|
||||
"""
|
||||
|
||||
name = 'legacy'
|
||||
namespace = Error.namespace
|
||||
plugin_attrib = name
|
||||
interfaces = set(('condition',))
|
||||
overrides = ['set_condition']
|
||||
|
||||
error_map = {'bad-request': ('modify','400'),
|
||||
'conflict': ('cancel','409'),
|
||||
'feature-not-implemented': ('cancel','501'),
|
||||
'forbidden': ('auth','403'),
|
||||
'gone': ('modify','302'),
|
||||
'internal-server-error': ('wait','500'),
|
||||
'item-not-found': ('cancel','404'),
|
||||
'jid-malformed': ('modify','400'),
|
||||
'not-acceptable': ('modify','406'),
|
||||
'not-allowed': ('cancel','405'),
|
||||
'not-authorized': ('auth','401'),
|
||||
'payment-required': ('auth','402'),
|
||||
'recipient-unavailable': ('wait','404'),
|
||||
'redirect': ('modify','302'),
|
||||
'registration-required': ('auth','407'),
|
||||
'remote-server-not-found': ('cancel','404'),
|
||||
'remote-server-timeout': ('wait','504'),
|
||||
'resource-constraint': ('wait','500'),
|
||||
'service-unavailable': ('cancel','503'),
|
||||
'subscription-required': ('auth','407'),
|
||||
'undefined-condition': (None,'500'),
|
||||
'unexpected-request': ('wait','400')}
|
||||
|
||||
def setup(self, xml):
|
||||
"""Don't create XML for the plugin."""
|
||||
self.xml = ET.Element('')
|
||||
|
||||
def set_condition(self, value):
|
||||
"""
|
||||
Set the error type and code based on the given error
|
||||
condition value.
|
||||
|
||||
Arguments:
|
||||
value -- The new error condition.
|
||||
"""
|
||||
self.parent().set_condition(value)
|
||||
|
||||
error_data = self.error_map.get(value, None)
|
||||
if error_data is not None:
|
||||
if error_data[0] is not None:
|
||||
self.parent()['type'] = error_data[0]
|
||||
self.parent()['code'] = error_data[1]
|
||||
|
|
@ -37,7 +37,7 @@ class TestStreamExceptions(SleekTest):
|
|||
|
||||
self.send("""
|
||||
<message type="error">
|
||||
<error type="cancel">
|
||||
<error type="cancel" code="501">
|
||||
<feature-not-implemented
|
||||
xmlns="urn:ietf:params:xml:ns:xmpp-stanzas" />
|
||||
<text xmlns="urn:ietf:params:xml:ns:xmpp-stanzas">
|
||||
|
|
@ -73,7 +73,7 @@ class TestStreamExceptions(SleekTest):
|
|||
self.send("""
|
||||
<iq type="error" id="0">
|
||||
<query xmlns="test" />
|
||||
<error type="cancel">
|
||||
<error type="cancel" code="501">
|
||||
<feature-not-implemented
|
||||
xmlns="urn:ietf:params:xml:ns:xmpp-stanzas" />
|
||||
<text xmlns="urn:ietf:params:xml:ns:xmpp-stanzas">
|
||||
|
|
@ -103,7 +103,7 @@ class TestStreamExceptions(SleekTest):
|
|||
|
||||
self.send("""
|
||||
<message type="error">
|
||||
<error type="cancel">
|
||||
<error type="cancel" code="501">
|
||||
<feature-not-implemented
|
||||
xmlns="urn:ietf:params:xml:ns:xmpp-stanzas" />
|
||||
<text xmlns="urn:ietf:params:xml:ns:xmpp-stanzas">
|
||||
|
|
@ -137,7 +137,7 @@ class TestStreamExceptions(SleekTest):
|
|||
|
||||
self.send("""
|
||||
<message type="error">
|
||||
<error type="cancel">
|
||||
<error type="cancel" code="500">
|
||||
<undefined-condition
|
||||
xmlns="urn:ietf:params:xml:ns:xmpp-stanzas" />
|
||||
<text xmlns="urn:ietf:params:xml:ns:xmpp-stanzas">
|
||||
|
|
|
|||
Loading…
Reference in a new issue