Merge branch 'patch' of https://github.com/chenhouwu/django-conversejs into chenhouwu-patch

Conflicts:
	conversejs/utils.py

Author: seocam

conversejs/boshclient.py

@@ -14,7 +14,16 @@
 from urlparse import urlparse
 from xml.etree import ElementTree as ET
 
-from puresasl.client import SASLClient 
+from puresasl.client import SASLClient
+from .conf import get_conversejs_settings
+
+
+try:  # Python 2.7+
+    from logging import NullHandler
+except ImportError:
+    class NullHandler(logging.Handler):
+        def emit(self, record):
+            pass
 
 
 HTTPBIND_NS = 'http://jabber.org/protocol/httpbind'
@@ -44,23 +53,27 @@ def __init__(self, jid, password, bosh_service):
 
         self._connection = None
         self._sid = None
-        
+
         self.jid, self.to = jid.split('@')
         self.password = password
-        self.bosh_service = urlparse(bosh_service) 
-        
+        self.bosh_service = urlparse(bosh_service)
+
         self.rid = randint(0, 10000000)
         self.log.debug('Init RID: %s' % self.rid)
-        
+
         self.headers = {
             "Content-Type": "text/plain; charset=UTF-8",
             "Accept": "text/xml",
             "Accept-Encoding": "gzip, deflate"
         }
-        
+
         self.server_auth = []
-   
-    @property 
+
+        converse_settings = get_conversejs_settings()
+        xml_encoding_line = converse_settings['CONVERSEJS_XML_ENCODING_LINE']
+        self.xml_encoding_line = True if xml_encoding_line.lower() == 'true' else False
+
+    @property
     def connection(self):
         """Returns an stablished connection"""
 
@@ -74,9 +87,9 @@ def connection(self):
         elif self.bosh_service.scheme == 'https':
             Connection = httplib.HTTPSConnection
         else:
-            # TODO: raise proper exception 
+            # TODO: raise proper exception
             raise Exception('Invalid URL scheme %s' % self.bosh_service.scheme)
-        
+
         self._connection = Connection(self.bosh_service.netloc)
         self.log.debug('Connection initialized')
         # TODO add exceptions handler there (URL not found etc)
@@ -86,7 +99,7 @@ def connection(self):
     def close_connection(self):
         if not self._connection:
             self.log.debug('Trying to close connection before initializing it.')
-            return 
+            return
 
         self.log.debug('Closing connection')
         self.connection.close()
@@ -99,7 +112,7 @@ def get_body(self, sid_request=False):
         body.set('xmlns', HTTPBIND_NS)
 
         if sid_request:
-            body.set('xmlns:xmpp', BOSH_NS) 
+            body.set('xmlns:xmpp', BOSH_NS)
             body.set('wait', unicode(BOSH_WAIT))
             body.set('hold', unicode(BOSH_HOLD))
             body.set('content', BOSH_CONTENT)
@@ -112,15 +125,17 @@ def get_body(self, sid_request=False):
             body.set('to', self.to)
 
         if self._sid:
-            body.set('sid', self.sid) 
+            body.set('sid', self.sid)
 
         body.set('rid', str(self.rid))
 
         return body
 
     def send_request(self, xml_stanza):
-        if isinstance(xml_stanza, ET.Element):
-            xml_stanza = ET.tostring(xml_stanza, encoding='utf8', method='xml')
+        ElementType = getattr(ET, '_Element', ET.Element)
+        if isinstance(xml_stanza, ElementType):
+            xml_stanza = ET.tostring(xml_stanza) if not self.xml_encoding_line\
+                else ET.tostring(xml_stanza, encoding='utf8')
 
         self.log.debug('XML_STANZA: %s', xml_stanza)
         self.log.debug('Sending the request')
@@ -147,7 +162,7 @@ def send_request(self, xml_stanza):
     def sid(self):
         if self._sid:
             return self._sid
-        
+
         return self.request_sid()
 
     def request_sid(self):
@@ -160,44 +175,44 @@ def request_sid(self):
             return self._sid
 
         self.log.debug('Prepare to request BOSH session')
-        
+
         data = self.send_request(self.get_body(sid_request=True))
         if not data:
             return None
-      
+
 
         # This is XML. response_body contains the <body/> element of the
         # response.
         response_body = ET.fromstring(data)
-        
+
         # Get the remote Session ID
         self._sid = response_body.get('sid')
         self.log.debug('sid = %s' % self._sid)
-        
+
         # Get the longest time (s) that the XMPP server will wait before
         # responding to any request.
         self.server_wait = response_body.get('wait')
         self.log.debug('wait = %s' % self.server_wait)
-        
+
         # Get the authid
         self.authid = response_body.get('authid')
-        
+
         # Get the allowed authentication methods using xpath
-        search_for = '{{{}}}features/{{{}}}mechanisms/{{{}}}mechanism'.format(
+        search_for = '{{{0}}}features/{{{1}}}mechanisms/{{{2}}}mechanism'.format(
                                 JABBER_STREAMS_NS, XMPP_SASL_NS, XMPP_SASL_NS)
         self.log.debug('Looking for "%s" into response body', search_for)
         mechanisms = response_body.iterfind(search_for)
         self.server_auth = []
 
         for mechanism in mechanisms:
-            self.server_auth.append(mechanism.text) 
+            self.server_auth.append(mechanism.text)
             self.log.debug('New AUTH method: %s' % mechanism.text)
 
         if not self.server_auth:
             self.log.debug(('The server didn\'t send the allowed '
                             'authentication methods'))
             self._sid = None
-                    
+
         return self._sid
 
     def get_challenge(self, mechanism):
@@ -207,10 +222,10 @@ def get_challenge(self, mechanism):
         auth.set('mechanism', mechanism)
 
         resp_root = ET.fromstring(self.send_request(body))
-        challenge_node = resp_root.find('{{{}}}challenge'.format(XMPP_SASL_NS))
+        challenge_node = resp_root.find('{{{0}}}challenge'.format(XMPP_SASL_NS))
 
         if challenge_node is not None:
-            return challenge_node.text 
+            return challenge_node.text
 
         return None
 
@@ -222,16 +237,16 @@ def send_challenge_response(self, response_plain):
 
         # Create a response tag and add the response content on it
         #   using base64 encoding
-        response_node = ET.SubElement(body, 'response')  
+        response_node = ET.SubElement(body, 'response')
         response_node.set('xmlns', XMPP_SASL_NS)
         response_node.text = base64.b64encode(response_plain)
 
         # Send the challenge response to server
         resp_root = ET.fromstring(self.send_request(body))
 
         # Look for the success tag. If it's not present authentication
-        #   has failed 
-        success = resp_root.find('{{{}}}success'.format(XMPP_SASL_NS))
+        #   has failed
+        success = resp_root.find('{{{0}}}success'.format(XMPP_SASL_NS))
         if success is not None:
             return True
         return False
@@ -243,7 +258,7 @@ def authenticate_xmpp(self):
 
         self.log.debug('Prepare the XMPP authentication')
 
-        # Instantiate a sasl object 
+        # Instantiate a sasl object
         sasl = SASLClient(host=self.to,
                          service='xmpp',
                          username=self.jid,
@@ -254,7 +269,7 @@ def authenticate_xmpp(self):
 
         # Request challenge
         challenge = self.get_challenge(sasl.mechanism)
-        
+
         # Process challenge and generate response
         response = sasl.process(base64.b64decode(challenge))
 
@@ -266,7 +281,7 @@ def authenticate_xmpp(self):
         self.request_restart()
 
         self.bind_resource()
-        
+
         return True
 
     def bind_resource(self):
@@ -275,10 +290,10 @@ def bind_resource(self):
         iq = ET.SubElement(body, 'iq')
         iq.set('id', 'bind_1')
         iq.set('type', 'set')
-        iq.set('xmlns', JABBER_CLIENT_NS) 
+        iq.set('xmlns', JABBER_CLIENT_NS)
 
         bind = ET.SubElement(iq, 'bind')
-        bind.set('xmlns', XMPP_BIND_NS)    
+        bind.set('xmlns', XMPP_BIND_NS)
 
         self.send_request(body)
 
@@ -289,18 +304,18 @@ def request_restart(self):
         self.send_request(body)
 
     def get_credentials(self):
-        success = self.authenticate_xmpp()            
+        success = self.authenticate_xmpp()
         if not success:
             return None, None, None
 
-        return u'{}@{}'.format(self.jid, self.to), self.sid, self.rid 
-        
+        return u'{0}@{1}'.format(self.jid, self.to), self.sid, self.rid
+
 
 if __name__ == '__main__':
     import sys
 
     if len(sys.argv) != 4:
-        print 'usage: {} SERVICE_URL USERNAME PASSWORD'.format(sys.argv[0])
+        print 'usage: {0} SERVICE_URL USERNAME PASSWORD'.format(sys.argv[0])
         sys.exit(1)
 
     c = BOSHClient(sys.argv[2], sys.argv[3], sys.argv[1])

conversejs/conf.py

@@ -0,0 +1,25 @@
+from django.conf import settings
+
+
+def get_conversejs_settings():
+    converse_settings = {
+        'CONVERSEJS_AUTO_LIST_ROOMS': False,
+        'CONVERSEJS_AUTO_SUBSCRIBE': False,
+        'CONVERSEJS_BOSH_SERVICE_URL': 'https://bind.opkode.im',
+        'CONVERSEJS_HIDE_MUC_SERVER': False,
+        'CONVERSEJS_PREBIND': True,
+        'CONVERSEJS_SHOW_CONTROLBOX_BY_DEFAULT': False,
+        'CONVERSEJS_XHR_USER_SEARCH': False,
+        'CONVERSEJS_XML_ENCODING_LINE': True,
+        'CONVERSEJS_DEBUG': settings.DEBUG,
+    }
+
+    for key, value in converse_settings.items():
+        conf = getattr(settings, key, value)
+
+        if isinstance(conf, bool):
+            conf = unicode(conf).lower()
+
+        converse_settings[key] = conf
+
+    return converse_settings

conversejs/models.py

@@ -15,4 +15,4 @@ class XMPPAccount(models.Model):
     password = models.CharField(max_length=1024)
 
     def __unicode__(self):
-        return u'{}/{}'.format(self.user, self.jid)
+        return u'{0}/{1}'.format(self.user, self.jid)

conversejs/utils.py

@@ -1,35 +1,12 @@
 
 import uuid
 
-from django.conf import settings
+from .conf import get_conversejs_settings
 from .models import XMPPAccount
 from .boshclient import BOSHClient
 from .register import register_account
 
 
-def get_conversejs_settings():
-    converse_settings = {
-        'CONVERSEJS_AUTO_LIST_ROOMS': False,
-        'CONVERSEJS_AUTO_SUBSCRIBE': False,
-        'CONVERSEJS_BOSH_SERVICE_URL': 'https://bind.opkode.im',
-        'CONVERSEJS_HIDE_MUC_SERVER': False,
-        'CONVERSEJS_PREBIND': True,
-        'CONVERSEJS_SHOW_CONTROLBOX_BY_DEFAULT': False,
-        'CONVERSEJS_XHR_USER_SEARCH': False,
-        'CONVERSEJS_DEBUG': settings.DEBUG,
-    }
-
-    for key, value in converse_settings.items():
-        conf = getattr(settings, key, value)
-
-        if isinstance(conf, bool):
-            conf = unicode(conf).lower()
-
-        converse_settings[key] = conf
-
-    return converse_settings
-
-
 def get_conversejs_context(context, xmpp_login=False):
     context.update(get_conversejs_settings())
 
@@ -59,7 +36,7 @@ def get_conversejs_context(context, xmpp_login=False):
                                                   user=request.user)
 
     bosh = BOSHClient(xmpp_account.jid, xmpp_account.password,
-                      settings.CONVERSEJS_BOSH_SERVICE_URL)
+                      context['CONVERSEJS_BOSH_SERVICE_URL'])
     jid, sid, rid = bosh.get_credentials()
     context.update({'jid': jid, 'sid': sid, 'rid': rid})