slixmpp/plugins/xep_0077/register.py

   1 """
   2     Slixmpp: The Slick XMPP Library
   3     Copyright (C) 2012 Nathanael C. Fritz, Lance J.T. Stout
   4     This file is part of Slixmpp.
   5
   6     See the file LICENSE for copying permission.
   7 """
   8
   9 import logging
  10 import ssl
  11
  12 from slixmpp.stanza import StreamFeatures, Iq
  13 from slixmpp.xmlstream import register_stanza_plugin, JID
  14 from slixmpp.plugins import BasePlugin
  15 from slixmpp.plugins.xep_0077 import stanza, Register, RegisterFeature
  16
  17
  18 log = logging.getLogger(__name__)
  19
  20
  21 class XEP_0077(BasePlugin):
  22
  23     """
  24     XEP-0077: In-Band Registration
  25     """
  26
  27     name = 'xep_0077'
  28     description = 'XEP-0077: In-Band Registration'
  29     dependencies = set(['xep_0004', 'xep_0066'])
  30     stanza = stanza
  31     default_config = {
  32         'create_account': True,
  33         'force_registration': False,
  34         'order': 50
  35     }
  36
  37     def plugin_init(self):
  38         register_stanza_plugin(StreamFeatures, RegisterFeature)
  39         register_stanza_plugin(Iq, Register)
  40
  41         if not self.xmpp.is_component:
  42             self.xmpp.register_feature('register',
  43                 self._handle_register_feature,
  44                 restart=False,
  45                 order=self.order)
  46
  47         register_stanza_plugin(Register, self.xmpp['xep_0004'].stanza.Form)
  48         register_stanza_plugin(Register, self.xmpp['xep_0066'].stanza.OOB)
  49
  50         self.xmpp.add_event_handler('connected', self._force_registration)
  51
  52     def plugin_end(self):
  53         if not self.xmpp.is_component:
  54             self.xmpp.unregister_feature('register', self.order)
  55
  56     def _force_registration(self, event):
  57         if self.force_registration:
  58             self.xmpp.add_filter('in', self._force_stream_feature)
  59
  60     def _force_stream_feature(self, stanza):
  61         if isinstance(stanza, StreamFeatures):
  62             if self.xmpp.use_tls or self.xmpp.use_ssl:
  63                 if 'starttls' not in self.xmpp.features:
  64                     return stanza
  65                 elif not isinstance(self.xmpp.socket, ssl.SSLSocket):
  66                     return stanza
  67             if 'mechanisms' not in self.xmpp.features:
  68                 log.debug('Forced adding in-band registration stream feature')
  69                 stanza.enable('register')
  70                 self.xmpp.del_filter('in', self._force_stream_feature)
  71         return stanza
  72
  73     def _handle_register_feature(self, features):
  74         if 'mechanisms' in self.xmpp.features:
  75             # We have already logged in with an account
  76             return False
  77
  78         if self.create_account and self.xmpp.event_handled('register'):
  79             form = self.get_registration()
  80             self.xmpp.event('register', form, direct=True)
  81             return True
  82         return False
  83
  84     def get_registration(self, jid=None, ifrom=None, block=True,
  85                          timeout=None, callback=None):
  86         iq = self.xmpp.Iq()
  87         iq['type'] = 'get'
  88         iq['to'] = jid
  89         iq['from'] = ifrom
  90         iq.enable('register')
  91         return iq.send(block=block, timeout=timeout,
  92                        callback=callback, now=True)
  93
  94     def cancel_registration(self, jid=None, ifrom=None, block=True,
  95                             timeout=None, callback=None):
  96         iq = self.xmpp.Iq()
  97         iq['type'] = 'set'
  98         iq['to'] = jid
  99         iq['from'] = ifrom
 100         iq['register']['remove'] = True
 101         return iq.send(block=block, timeout=timeout, callback=callback)
 102
 103     def change_password(self, password, jid=None, ifrom=None, block=True,
 104                         timeout=None, callback=None):
 105         iq = self.xmpp.Iq()
 106         iq['type'] = 'set'
 107         iq['to'] = jid
 108         iq['from'] = ifrom
 109         if self.xmpp.is_component:
 110             ifrom = JID(ifrom)
 111             iq['register']['username'] = ifrom.user
 112         else:
 113             iq['register']['username'] = self.xmpp.boundjid.user
 114         iq['register']['password'] = password
 115         return iq.send(block=block, timeout=timeout, callback=callback)