libervia-backend: sat/plugins/plugin_xep

comparison sat/plugins/plugin_xep_0050.py @ 3028:ab2696e34d29

Python 3 port: /!\ this is a huge commit /!\ starting from this commit, SàT is needs Python 3.6+ /!\ SàT maybe be instable or some feature may not work anymore, this will improve with time This patch port backend, bridge and frontends to Python 3. Roughly this has been done this way: - 2to3 tools has been applied (with python 3.7) - all references to python2 have been replaced with python3 (notably shebangs) - fixed files not handled by 2to3 (notably the shell script) - several manual fixes - fixed issues reported by Python 3 that where not handled in Python 2 - replaced "async" with "async_" when needed (it's a reserved word from Python 3.7) - replaced zope's "implements" with @implementer decorator - temporary hack to handle data pickled in database, as str or bytes may be returned, to be checked later - fixed hash comparison for password - removed some code which is not needed anymore with Python 3 - deactivated some code which needs to be checked (notably certificate validation) - tested with jp, fixed reported issues until some basic commands worked - ported Primitivus (after porting dependencies like urwid satext) - more manual fixes

author	Goffi <goffi@goffi.org>
date	Tue, 13 Aug 2019 19:08:41 +0200
parents	a8c2d8b3453f
children	9d0df638c8b4

comparison

equal deleted inserted replaced

-:ff5bcb12ae60
+:ab2696e34d29
-#!/usr/bin/env python2
+#!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 # SAT plugin for Ad-Hoc Commands (XEP-0050)
 # Copyright (C) 2009-2019 Jérôme Poisson (goffi@goffi.org)
 from sat.core import exceptions
 from sat.memory.memory import Sessions
 from uuid import uuid4
 from sat.tools import xml_tools
-from zope.interface import implements
+from zope.interface import implementer
 try:
 from twisted.words.protocols.xmlstream import XMPPHandler
 except ImportError:
 from wokkel.subprotocols import XMPPHandler
 C.PI_MODES: C.PLUG_MODE_BOTH,
 C.PI_TYPE: "XEP",
 C.PI_PROTOCOLS: ["XEP-0050"],
 C.PI_MAIN: "XEP_0050",
 C.PI_HANDLER: "yes",
-C.PI_DESCRIPTION: _(u"""Implementation of Ad-Hoc Commands"""),
+C.PI_DESCRIPTION: _("""Implementation of Ad-Hoc Commands"""),
 }
 class AdHocError(Exception):
 def __init__(self, error_const):
 """
 assert error_const in XEP_0050.ERROR
 self.callback_error = error_const
+@implementer(iwokkel.IDisco)
 class AdHocCommand(XMPPHandler):
-implements(iwokkel.IDisco)
 def __init__(self, callback, label, node, features, timeout,
 allowed_jids, allowed_groups, allowed_magics, forbidden_jids,
 forbidden_groups):
 XMPPHandler.__init__(self)
 allowed = set(self.allowed_jids)
 for group in self.allowed_groups:
 try:
 allowed.update(self.client.roster.getJidsFromGroup(group))
 except exceptions.UnknownGroupError:
-log.warning(_(u"The groups [{group}] is unknown for profile [{profile}])")
+log.warning(_("The groups [{group}] is unknown for profile [{profile}])")
 .format(group=group, profile=self.client.profile))
 if requestor.userhostJID() in allowed:
 return True
 return False
 @param request: original request (domish.Element)
 """
 xmpp_condition, cmd_condition = error_constant
 iq_elt = jabber.error.StanzaError(xmpp_condition).toResponse(request)
 if cmd_condition:
-error_elt = iq_elt.elements(None, "error").next()
+error_elt = next(iq_elt.elements(None, "error"))
 error_elt.addElement(cmd_condition, NS_COMMANDS)
 self.client.send(iq_elt)
 del self.sessions[session_id]
 def onRequest(self, command_elt, requestor, action, session_id):
 "adHocRun",
 ".plugin",
 in_sign="sss",
 out_sign="s",
 method=self._run,
-async=True,
+async_=True,
 )
 host.bridge.addMethod(
 "adHocList",
 ".plugin",
 in_sign="ss",
 out_sign="s",
 method=self._listUI,
-async=True,
+async_=True,
 )
 self.__requesting_id = host.registerCallback(
 self._requestingEntity, with_data=True
 )
 host.importMenu(
 (D_("Service"), D_("Commands")),
 self._commandsMenu,
 security_limit=2,
 help_string=D_("Execute ad-hoc commands"),
 )
-host.registerNamespace(u'commands', NS_COMMANDS)
+host.registerNamespace('commands', NS_COMMANDS)
 def getHandler(self, client):
 return XEP_0050_handler(self)
 def profileConnected(self, client):
 d = iq_elt.send()
 return d
 def getCommandElt(self, iq_elt):
 try:
-return iq_elt.elements(NS_COMMANDS, "command").next()
+return next(iq_elt.elements(NS_COMMANDS, "command"))
 except StopIteration:
-raise exceptions.NotFound(_(u"Missing command element"))
+raise exceptions.NotFound(_("Missing command element"))
 def adHocError(self, error_type):
 """Shortcut to raise an AdHocError
 @param error_type(unicode): one of XEP_0050.ERROR
 return C.XMLUI_DATA_LVL_ERROR
 elif type_ == "warn":
 return C.XMLUI_DATA_LVL_WARNING
 else:
 if type_ != "info":
-log.warning(_(u"Invalid note type [%s], using info") % type_)
+log.warning(_("Invalid note type [%s], using info") % type_)
 return C.XMLUI_DATA_LVL_INFO
 def _mergeNotes(self, notes):
 """Merge notes with level prefix (e.g. "ERROR: the message")
 lvl_map = {
 C.XMLUI_DATA_LVL_INFO: "",
 C.XMLUI_DATA_LVL_WARNING: "%s: " % _("WARNING"),
 C.XMLUI_DATA_LVL_ERROR: "%s: " % _("ERROR"),
 }
-return [u"%s%s" % (lvl_map[lvl], msg) for lvl, msg in notes]
+return ["%s%s" % (lvl_map[lvl], msg) for lvl, msg in notes]
 def _commandsAnswer2XMLUI(self, iq_elt, session_id, session_data):
 """Convert command answer to an ui for frontend
 @param iq_elt: command result
 notes = []
 for note_elt in command_elt.elements(NS_COMMANDS, "note"):
 notes.append(
 (
 self._getDataLvl(note_elt.getAttribute("type", "info")),
-unicode(note_elt),
+str(note_elt),
 )
 )
 for data_elt in command_elt.elements(data_form.NS_X_DATA, "x"):
 if data_elt["type"] in ("form", "result"):
 break
 dlg_level = notes[0][0] if len(notes) == 1 else C.XMLUI_DATA_LVL_INFO
 return xml_tools.XMLUI(
 C.XMLUI_DIALOG,
 dialog_opt={
 C.XMLUI_DATA_TYPE: C.XMLUI_DIALOG_NOTE,
-C.XMLUI_DATA_MESS: u"\n".join(self._mergeNotes(notes)),
+C.XMLUI_DATA_MESS: "\n".join(self._mergeNotes(notes)),
 C.XMLUI_DATA_LVL: dlg_level,
 },
 session_id=session_id,
 )
 if len(actions) == 1:
 # it's our first request, we ask the desired new status
 status = XEP_0050.STATUS.EXECUTING
 form = data_form.Form("form", title=_("status selection"))
 show_options = [
-data_form.Option(name, label) for name, label in SHOWS.items()
+data_form.Option(name, label) for name, label in list(SHOWS.items())
 ]
 field = data_form.Field(
 "list-single", "show", options=show_options, required=True
 )
 form.addField(field)
 note = None
 elif len(actions) == 2:
 # we should have the answer here
 try:
-x_elt = command_elt.elements(data_form.NS_X_DATA, "x").next()
+x_elt = next(command_elt.elements(data_form.NS_X_DATA, "x"))
 answer_form = data_form.Form.fromElement(x_elt)
 show = answer_form["show"]
 except (KeyError, StopIteration):
 self.adHocError(XEP_0050.ERROR.BAD_PAYLOAD)
 if show not in SHOWS:
 self.host.setPresence(show=show, profile_key=client.profile)
 # job done, we can end the session
 status = XEP_0050.STATUS.COMPLETED
 payload = None
-note = (self.NOTE.INFO, _(u"Status updated"))
+note = (self.NOTE.INFO, _("Status updated"))
 else:
 self.adHocError(XEP_0050.ERROR.INTERNAL)
 return (payload, status, None, note)
 commands[node] = ad_hoc_command
 def onCmdRequest(self, request, client):
 request.handled = True
 requestor = jid.JID(request["from"])
-command_elt = request.elements(NS_COMMANDS, "command").next()
+command_elt = next(request.elements(NS_COMMANDS, "command"))
 action = command_elt.getAttribute("action", self.ACTION.EXECUTE)
 node = command_elt.getAttribute("node")
 if not node:
-client.sendError(request, u"bad-request")
+client.sendError(request, "bad-request")
 return
 sessionid = command_elt.getAttribute("sessionid")
 commands = client._XEP_0050_commands
 try:
 command = commands[node]
 except KeyError:
-client.sendError(request, u"item-not-found")
+client.sendError(request, "item-not-found")
 return
 command.onRequest(command_elt, requestor, action, sessionid)
+@implementer(iwokkel.IDisco)
 class XEP_0050_handler(XMPPHandler):
-implements(iwokkel.IDisco)
 def __init__(self, plugin_parent):
 self.plugin_parent = plugin_parent
 @property
 def getDiscoItems(self, requestor, target, nodeIdentifier=""):
 ret = []
 if nodeIdentifier == NS_COMMANDS:
 commands = self.client._XEP_0050_commands
-for command in commands.values():
+for command in list(commands.values()):
 if command.isAuthorised(requestor):
 ret.append(
 disco.DiscoItem(self.parent.jid, command.node, command.getName())
 )  # TODO: manage name language
 return ret

Mercurial > libervia-backend

comparison sat/plugins/plugin_xep_0050.py @ 3028:ab2696e34d29