view src/plugins/plugin_xep_0049.py @ 1005:b4af31a8a4f2

core (logs): added formatting, name filter and outputs management: - formatting is inspired from, and use when possible, standard logging. "message", "levelname", and "name" are the only format managed, depending on backend more can be managed (standard backend formats are specified in official python logging doc) - name filter use regular expressions. It's possible to log only plugins with SAT_LOG_LOGGER="^sat.plugins". To log only XEPs 96 & 65, we can use SAT_LOG_LOGGER='(xep_0095|xep_0065)' - output management use a particular syntax: - output handler are name with "//", so far there are "//default" (most of time stderr), "//memory" and "//file" - options can be specified in parenthesis, e.g. "//memory(50)" mean a 50 lines memory buffer (50 is the current default, so that's equivalent to "//memory") - several handlers can be specified: "//file(/tmp/sat.log)//default" will use the default logging + a the /tmp/sat.log file - if there is only one handler, it use the file handler: "/tmp/sat.log" is the same as "//file(/tmp/sat.log)" - not finished, need more work for twisted and basic backends
author Goffi <goffi@goffi.org>
date Mon, 05 May 2014 18:58:34 +0200
parents 301b342c697a
children 069ad98b360d
line wrap: on
line source

#!/usr/bin/python
# -*- coding: utf-8 -*-

# SAT plugin for managing xep-0049
# Copyright (C) 2009, 2010, 2011, 2012, 2013, 2014 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 sat.core.i18n import _
from sat.core.log import getLogger
log = getLogger(__name__)
from wokkel import compat
from twisted.words.xish import domish



PLUGIN_INFO = {
    "name": "XEP-0049 Plugin",
    "import_name": "XEP-0049",
    "type": "XEP",
    "protocols": ["XEP-0049"],
    "dependencies": [],
    "main": "XEP_0049",
    "handler": "no",
    "description": _("""Implementation of private XML storage""")
}


class XEP_0049(object):
    NS_PRIVATE = 'jabber:iq:private'

    def __init__(self, host):
        log.info(_("Plugin XEP-0049 initialization"))
        self.host = host

    def privateXMLStore(self, element, profile_key):
        """Store private data
        @param element: domish.Element to store (must have a namespace)
        @param profile_key: %(doc_profile_key)s

        """
        assert isinstance(element, domish.Element)
        client = self.host.getClient(profile_key)
        # XXX: feature announcement in disco#info is not mandatory in XEP-0049, so we have to try to use private XML, and react according to the answer
        iq_elt = compat.IQ(client.xmlstream)
        query_elt = iq_elt.addElement('query', XEP_0049.NS_PRIVATE)
        query_elt.addChild(element)
        return iq_elt.send()

    def privateXMLGet(self, node_name, namespace, profile_key):
        """Store private data
        @param node_name: name of the node to get
        @param namespace: namespace of the node to get
        @param profile_key: %(doc_profile_key)s
        @return (domish.Element): a deferred which fire the stored data

        """
        client = self.host.getClient(profile_key)
        # XXX: see privateXMLStore note about feature checking
        iq_elt = compat.IQ(client.xmlstream, 'get')
        query_elt = iq_elt.addElement('query', XEP_0049.NS_PRIVATE)
        query_elt.addElement(node_name, namespace)
        def getCb(answer_iq_elt):
            answer_query_elt = answer_iq_elt.elements(XEP_0049.NS_PRIVATE, 'query').next()
            return answer_query_elt.firstChildElement()
        d = iq_elt.send()
        d.addCallback(getCb)
        return d