plugin account: first draft of automatic SàT/Prosody account creation (basis coming from Libervia)

src/plugins/plugin_misc_account.py

@@ -0,0 +1,185 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+"""
+SAT plugin for parrot mode (experimental)
+Copyright (C) 2009, 2010, 2011, 2012  Jérôme Poisson (goffi@goffi.org)
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+"""
+
+from logging import debug, info, warning, error
+from sat.core import exceptions
+from twisted.internet import reactor, defer, protocol
+from os.path import join, dirname
+from twisted.python.procutils import which
+
+PLUGIN_INFO = {
+"name": "Account Plugin",
+"import_name": "MISC-ACCOUNT",
+"type": "MISC",
+"protocols": [],
+"dependencies": [],
+"main": "MiscAccount",
+"handler": "no",
+"description": _(u"""SàT account creation""")
+}
+
+#You need do adapt the following consts to your server
+_REG_EMAIL_FROM = "NOREPLY@libervia.org"
+_REG_EMAIL_SERVER = "localhost"
+_REG_ADMIN_EMAIL = "goffi@goffi.org"
+_NEW_ACCOUNT_SERVER = "localhost"
+_NEW_ACCOUNT_DOMAIN = "necton3.int"
+_NEW_ACCOUNT_RESOURCE = "libervia"
+_PROSODY_PATH = None #prosody path (where prosodyctl will be executed from), or None to automaticaly find it
+_PROSODYCTL = "prosodyctl"
+
+RESERVED = ['libervia']
+
+class ProsodyRegisterProtocol(protocol.ProcessProtocol):
+    """ Try to register an account with prosody """
+    
+    def __init__(self, password, deferred = None):
+        self.password = password
+        self.deferred = deferred
+        self.data = ''
+    
+    def connectionMade(self):
+        self.transport.write("%s\n%s" % ((self.password.encode('utf-8'),)*2))
+        self.transport.closeStdin()
+
+
+    def outReceived(self, data):
+        self.data += data
+    
+    def errReceived(self, data):
+        self.err += data
+    
+    def processEnded(self, reason):
+        if (reason.value.exitCode == 0):
+            info(_('Prosody registration success'))
+            self.deferred.callback(None)
+        else:
+            error(_(u"Can't register Prosody account (error code: %(code)d): %(message)s") % {'code': reason.value.exitCode, 'message': self.data})
+            self.deferred.errback("INTERNAL")
+
+
+class MiscAccount():
+    """Account plugin: create a SàT + Prosody account, used by Libervia"""
+    #XXX: This plugin is a Q&D one used for the demo. Something more generic (and not
+    #     only focused on Prosody) is planed
+    _prosody_path = _PROSODY_PATH or ''
+
+    def __init__(self, host):
+        info(_(u"Plugin Account initialization"))
+        self.host = host
+        host.bridge.addMethod("registerSatAccount", ".plugin", in_sign='sss', out_sign='', method=self._registerAccount, async = True)
+        if not self._prosody_path:
+            paths = which(_PROSODYCTL)
+            if not paths:
+                error(_("Can't find %s") % (_PROSODYCTL,))
+            else:
+                self._prosody_path = dirname(paths[0])
+                info(_('Prosody path found: %s') % (self._prosody_path,))
+
+    def _registerAccount(self, email, password, profile):
+        
+        """
+        #Password Generation
+        #_charset = [chr(i) for i in range(0x21,0x7F)] #XXX: this charset seems to have some issues with openfire
+        _charset = [chr(i) for i in range(0x30,0x3A) + range(0x41,0x5B) + range (0x61,0x7B)]
+        import random
+        random.seed()
+        password = ''.join([random.choice(_charset) for i in range(15)])
+        """
+        if not email or not password or not profile:
+            raise exceptions.DataError
+
+        if profile.lower() in RESERVED:
+            return defer.fail('CONFLICT')
+
+        d = self.host.memory.asyncCreateProfile(profile)
+        d.addCallback(self._profileRegistered, email, password, profile)
+        return d
+
+    def _profileRegistered(self, result, email, password, profile):
+        
+        #FIXME: values must be in a config file instead of hardcoded
+        self.host.memory.setParam("JabberID", "%s@%s/%s" % (profile, _NEW_ACCOUNT_DOMAIN, _NEW_ACCOUNT_RESOURCE), "Connection", profile) 
+        self.host.memory.setParam("Server", _NEW_ACCOUNT_SERVER, "Connection", profile)
+        self.host.memory.setParam("Password", password, "Connection", profile)
+        #and the account
+       
+        #XXX: we use "prosodyctl adduser" because "register" doesn't check conflict
+        #     and just change the password if the account already exists
+        d = defer.Deferred()
+        prosody_reg = ProsodyRegisterProtocol(password, d)
+        prosody_exe = join (self._prosody_path, _PROSODYCTL)
+        reactor.spawnProcess(prosody_reg, prosody_exe, [prosody_exe, 'adduser', "%s@%s" % (profile, _NEW_ACCOUNT_DOMAIN)], path=self._prosody_path)
+
+        d.addCallback(self._accountCreated)
+        return d
+
+    def _accountCreated(self, result):
+        print "_accountCreated"
+           
+        #action_id = self.sat_host.bridge.registerNewAccount(login, password, email, _NEW_ACCOUNT_DOMAIN, 5222)
+        #self.sat_host.action_handler.waitForId(self._postAccountCreation, action_id, profile)
+
+        ##time to send the email
+
+        #_email_host = _REG_EMAIL_SERVER
+        #_email_from = _REG_EMAIL_FROM
+
+        #def email_ok(ignore):
+        #    print ("Account creation email sent to %s" % email)
+
+        #def email_ko(ignore):
+        #    #TODO: return error code to user
+        #    error ("Failed to send email to %s" % email)
+        #
+        #body = (u"""Welcome to Libervia, a Salut à Toi project part
+        #
+        #/!\\ WARNING, THIS IS ONLY A TECHNICAL DEMO, DON'T USE THIS ACCOUNT FOR ANY SERIOUS PURPOSE /!\\
+        #
+        #Here are your connection informations:
+        #login: %(login)s
+        #password: %(password)s
+        #
+        #Your Jabber ID (JID) is: %(jid)s
+        #
+        #Any feedback welcome
+        #
+        #Cheers
+        #Goffi""" % { 'login': login, 'password': password, 'jid':"%s@%s" % (login, _NEW_ACCOUNT_DOMAIN) }).encode('utf-8')
+        #msg = MIMEText(body, 'plain', 'UTF-8')
+        #msg['Subject'] = 'Libervia account created'
+        #msg['From'] = _email_from
+        #msg['To'] = email
+
+        #d = sendmail(_email_host, _email_from, email, msg.as_string())
+        #d.addCallbacks(email_ok, email_ko)
+
+        ##email to the administrator
+
+        #body = (u"""New account created: %(login)s [%(email)s]""" % { 'login': login, 'email': email }).encode('utf-8')
+        #msg = MIMEText(body, 'plain', 'UTF-8')
+        #msg['Subject'] = 'Libervia new account created'
+        #msg['From'] = _email_from
+        #msg['To'] = _REG_ADMIN_EMAIL
+
+        #d = sendmail(_email_host, _email_from, _REG_ADMIN_EMAIL, msg.as_string())
+        #d.addCallbacks(email_ok, email_ko)
+        #return "REGISTRATION"