entities.py

# -*- coding: utf-8 -*-
# copyright 2016 LOGILAB S.A. (Paris, FRANCE), all rights reserved.
# contact http://www.logilab.fr -- mailto:contact@logilab.fr
#
# This program is free software: you can redistribute it and/or modify it under
# the terms of the GNU Lesser General Public License as published by the Free
# Software Foundation, either version 2.1 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 Lesser General Public License for more
# details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.

"""cubicweb-elasticsearch entity's classes"""
from cubicweb import view
from cubicweb.predicates import is_instance

from cubicweb.appobject import AppObject

from cubes.elasticsearch import es


class EsRegistry(AppObject):
    __registry__ = 'es'


class Indexer(EsRegistry):
    __regid__ = 'indexer'
    settings = {
        'analysis': {
            'analyzer': {
                'default': {'filter': ['standard',
                                       'my_ascii_folding',
                                       'lowercase',
                                       'french_snowball'],
                            'tokenizer': 'standard'}
            },
            'filter': {'my_ascii_folding': {'preserve_original': True,
                                            'type': 'asciifolding'},
                       'french_snowball': {'type': 'snowball',
                                           'language': 'French'}}
        },
    }

    def get_connection(self):
        config = self._cw.vreg.config
        return es.get_connection(config, self.settings)


class IFullTextIndexSerializable(view.EntityAdapter):
    """Adapter to serialize an entity to a bare python structure that may be
    directly serialized to e.g. JSON.
    """

    __regid__ = 'IFullTextIndexSerializable'
    __select__ = is_instance('Any')

    def serialize(self, complete=False):
        entity = self.entity
        if complete:
            entity.complete()
        data = {
            'cw_etype': entity.cw_etype,
            'eid': entity.eid,
            'cwuri': entity.cwuri,
        }
        data.update(entity.cw_attr_cache)
        self.update_parent_info(data, entity)
        # TODO take a look at what's in entity.cw_relation_cache
        return data

    def update_parent_info(self, data, entity):
        """this is where a client cube would feed the 'parent' index

            data['parent'] = entity.related('entry_of', 'subject').get_entity(0, 0)
        """
        pass