view sat_pubsub/schema.py @ 430:5a0ada3b61ca

Full-Text Search implementation: /!\ pgsql schema needs to be updated /!\ /!\ Minimal PostgreSQL required version is now 12 /!\ A new options is available to specify main language of a node. By default a `generic` language is used (which uses the `simple` configuration in PostgreSQL). When a node owner changes the language, the index is rebuilt accordingly. It is possible to have item specific language for multilingual nodes (but for the moment the search is done with node language, so the results won't be good). If an item language is explicitely set in `item_languages`, the FTS configuration won't be affected by node FTS language setting. Search is parsed with `websearch_to_tsquery` for now, but this parser doesn't handle prefix matching, so it may be replaced in the future. SetConfiguration now only updates the modified values, this avoid triggering the FTS re-indexing on each config change. `_checkNodeExists` is not called anymore as we can check if a row has been modified to see if the node exists, this avoid a useless query. Item storing has been slighly improved with a useless SELECT and condition removed. To avoid 2 schema updates in a row, the `sat_pubsub_update_5_6.sql` file also prepares the implementation of XEP-0346 by updating nodes with a schema and creating the suitable template nodes.
author Goffi <goffi@goffi.org>
date Fri, 11 Dec 2020 17:18:52 +0100
parents ccb2a22ea0fc
children
line wrap: on
line source

#!/usr/bin/env python3
#-*- coding: utf-8 -*-
#
# Copyright (c) 2015 Jérôme Poisson


# 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/>.

# ---

# This module implements node schema

from twisted.words.protocols.jabber import jid
from twisted.words.xish import domish
from wokkel import disco, iwokkel
from wokkel.iwokkel import IPubSubService
from wokkel.subprotocols import XMPPHandler, IQHandlerMixin
from wokkel import data_form, pubsub
from zope.interface import implementer
from sat_pubsub import const

QUERY_SCHEMA = "/pubsub[@xmlns='" + const.NS_SCHEMA + "']"


@implementer(iwokkel.IDisco)
class SchemaHandler(XMPPHandler, IQHandlerMixin):
    iqHandlers = {"/iq[@type='get']" + QUERY_SCHEMA: 'onSchemaGet',
                  "/iq[@type='set']" + QUERY_SCHEMA: 'onSchemaSet'}

    def __init__(self):
        super(SchemaHandler, self).__init__()
        self.pubsub_service = None

    def connectionInitialized(self):
        for handler in self.parent.handlers:
            if IPubSubService.providedBy(handler):
                self.pubsub_service = handler
                break
        self.backend = self.parent.parent.getServiceNamed('backend')
        self.xmlstream.addObserver("/iq[@type='get' or @type='set']" + QUERY_SCHEMA, self.handleRequest)

    def _getNodeSchemaCb(self, x_elt, nodeIdentifier):
        schema_elt = domish.Element((const.NS_SCHEMA, 'schema'))
        schema_elt['node'] = nodeIdentifier
        if x_elt is not None:
            assert x_elt.uri == 'jabber:x:data'
            schema_elt.addChild(x_elt)
        return schema_elt

    def onSchemaGet(self, iq_elt):
        try:
            schema_elt = next(iq_elt.pubsub.elements(const.NS_SCHEMA, 'schema'))
            nodeIdentifier = schema_elt['node']
        except StopIteration:
            raise pubsub.BadRequest(text='missing schema element')
        except KeyError:
            raise pubsub.BadRequest(text='missing node')
        pep = iq_elt.delegated
        recipient = jid.JID(iq_elt['to'])
        d = self.backend.getNodeSchema(nodeIdentifier,
                                       pep,
                                       recipient)
        d.addCallback(self._getNodeSchemaCb, nodeIdentifier)
        return d.addErrback(self.pubsub_service.resource._mapErrors)

    def onSchemaSet(self, iq_elt):
        try:
            schema_elt = next(iq_elt.pubsub.elements(const.NS_SCHEMA, 'schema'))
            nodeIdentifier = schema_elt['node']
        except StopIteration:
            raise pubsub.BadRequest(text='missing schema element')
        except KeyError:
            raise pubsub.BadRequest(text='missing node')
        requestor = jid.JID(iq_elt['from'])
        pep = iq_elt.delegated
        recipient = jid.JID(iq_elt['to'])
        try:
            x_elt = next(schema_elt.elements(data_form.NS_X_DATA, 'x'))
        except StopIteration:
            # no schema form has been found
            x_elt = None
        d = self.backend.setNodeSchema(nodeIdentifier,
                                       x_elt,
                                       requestor,
                                       pep,
                                       recipient)
        return d.addErrback(self.pubsub_service.resource._mapErrors)

    def getDiscoInfo(self, requestor, service, nodeIdentifier=''):
        return [disco.DiscoFeature(const.NS_SCHEMA)]

    def getDiscoItems(self, requestor, service, nodeIdentifier=''):
        return []