rer.solrpush 1.3.4__py3-none-any.whl

rer/solrpush/permissions.zcml

@@ -0,0 +1,18 @@
+<configure
+  xmlns="http://namespaces.zope.org/zope"
+  xmlns:zcml="http://namespaces.zope.org/zcml"
+  i18n_domain="plone">
+
+  <configure zcml:condition="installed AccessControl.security">
+    <permission
+      id="rer.solrpush.editElevate"
+      title="rer.solrpush: Edit Elevate"
+      />
+    <permission
+      id="rer.solrpush.editSettings"
+      title="rer.solrpush: Edit Settings"
+      />
+
+  </configure>
+
+</configure>

rer/solrpush/profiles/default/actions.xml

@@ -0,0 +1,21 @@
+<?xml version="1.0"?>
+<object name="portal_actions" meta_type="Plone Actions Tool"
+   xmlns:i18n="http://xml.zope.org/namespaces/i18n">
+ <object name="user" meta_type="CMF Action Category" purge="False">
+  <object name="solr-elevate"
+          meta_type="CMF Action"
+          i18n:domain="rer.solrpush"
+          insert-before="logout">
+   <property name="title" i18n:translate="">Elevate configuration</property>
+   <property name="description" i18n:translate=""></property>
+   <property
+      name="url_expr">string:${portal_url}/@@elevate-settings</property>
+   <property name="icon_expr"></property>
+   <property name="available_expr">python:member is not None</property>
+   <property name="permissions">
+      <element value="rer.solrpush: Edit Elevate"/>
+   </property>
+   <property name="visible">True</property>
+  </object>
+ </object>
+</object>

rer/solrpush/profiles/default/browserlayer.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<layers>
+  <layer
+      name="rer.solrpush"
+      interface="rer.solrpush.interfaces.IRerSolrpushLayer"
+      />
+</layers>

rer/solrpush/profiles/default/catalog.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0"?>
+<object name="portal_catalog">
+  <!--<column value="my_meta_column"/>-->
+</object>

rer/solrpush/profiles/default/controlpanel.xml

@@ -0,0 +1,31 @@
+<?xml version="1.0"?>
+<object
+    name="portal_controlpanel"
+    xmlns:i18n="http://xml.zope.org/namespaces/i18n"
+    i18n:domain="rer.bandisolr">
+
+    <configlet
+        title="Configurazione RER SolrPush"
+        action_id="solrpush.configuration"
+        appId="solrpush"
+        category="Products"
+        condition_expr=""
+        url_expr="string:${portal_url}/@@solrpush-settings"
+        icon_expr=""
+        visible="True"
+        i18n:attributes="title">
+            <permission>rer.solrpush: Edit Settings</permission>
+    </configlet>
+    <configlet
+        title="Configurazione Elevate"
+        action_id="solrpush.elevate"
+        appId="solrpush-elevate"
+        category="Products"
+        condition_expr=""
+        url_expr="string:${portal_url}/@@elevate-settings"
+        icon_expr=""
+        visible="True"
+        i18n:attributes="title">
+            <permission>rer.solrpush: Edit Elevate</permission>
+    </configlet>
+</object>

rer/solrpush/profiles/default/metadata.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<metadata>
+  <version>2000</version>
+  <dependencies>
+    <dependency>profile-collective.z3cform.jsonwidget:default</dependency>
+    <dependency>profile-plone.restapi:default</dependency>
+  </dependencies>
+</metadata>

rer/solrpush/profiles/default/registry/bundle.xml

@@ -0,0 +1,25 @@
+<?xml version="1.0"?>
+<registry xmlns:i18n="http://xml.zope.org/namespaces/i18n"
+          i18n:domain="rer.solrpush">
+
+  <!-- RESOURCE -->
+  <records prefix="plone.resources/rer-solrpush-css"
+           interface='Products.CMFPlone.interfaces.IResourceRegistry'>
+     <value key="css">
+       <element>++plone++rer.solrpush/styles.css</element>
+     </value>
+  </records>
+
+  <!-- BUNDLE -->
+  <records prefix="plone.bundles/rer-solrpush-css-bundle"
+           interface='Products.CMFPlone.interfaces.IBundleRegistry'>
+    <value key="enabled">True</value>
+    <value key="resources" purge="false">
+      <element>rer-solrpush-css</element>
+    </value>
+    <value key="csscompilation">++plone++rer.solrpush/styles.css</value>
+    <value key="last_compilation">2020-11-17 00:00:00</value>
+    <value key="compile">True</value>
+    <value key="depends">plone</value>
+  </records>
+</registry>

rer/solrpush/profiles/default/registry/criteria.xml

@@ -0,0 +1,55 @@
+<?xml version="1.0"?>
+<registry xmlns:i18n="http://xml.zope.org/namespaces/i18n"
+          i18n:domain="rer.solrpush">
+
+  <records interface="plone.app.querystring.interfaces.IQueryField"
+            prefix="plone.app.querystring.field.searchWithSolr">
+    <value key="title" i18n:translate="">Search with Solr</value>
+    <value key="description"
+           i18n:translate="Select if perform search with SOLR or with Plone (local) catalog.">
+    </value>
+    <value key="enabled">True</value>
+    <value key="sortable">False</value>
+    <value key="operations">
+        <element>plone.app.querystring.operation.boolean.isTrue</element>
+        <element>plone.app.querystring.operation.boolean.isFalse</element>
+    </value>
+    <value key="group" i18n:translate="">SOLR</value>
+  </records>
+  <records interface="plone.app.querystring.interfaces.IQueryField"
+             prefix="plone.app.querystring.field.solr_sites">
+        <value key="title" i18n:translate="">Sites</value>
+        <value key="description" i18n:translate="">A list of (SOLR indexed) sites where search items.</value>
+        <value key="enabled">True</value>
+        <value key="sortable">False</value>
+        <value key="operations">
+            <element>plone.app.querystring.operation.selection.any</element>
+        </value>
+        <value key="vocabulary">rer.solrpush.vocabularies.AvailableSites</value>
+       <value key="group" i18n:translate="">SOLR</value>
+  </records>
+  <records interface="plone.app.querystring.interfaces.IQueryField"
+             prefix="plone.app.querystring.field.solr_subjects">
+        <value key="title" i18n:translate="">Keywords in SOLR</value>
+        <value key="description" i18n:translate="">A complete list of keywords stored in SOLR.</value>
+        <value key="enabled">True</value>
+        <value key="sortable">False</value>
+        <value key="operations">
+            <element>plone.app.querystring.operation.selection.any</element>
+        </value>
+        <value key="vocabulary">rer.solrpush.vocabularies.AvailableSubjects</value>
+       <value key="group" i18n:translate="">SOLR</value>
+  </records>
+  <records interface="plone.app.querystring.interfaces.IQueryField"
+             prefix="plone.app.querystring.field.solr_portal_types">
+        <value key="title" i18n:translate="">Portal types in SOLR</value>
+        <value key="description" i18n:translate="">A complete list of portal_types stored in SOLR.</value>
+        <value key="enabled">True</value>
+        <value key="sortable">False</value>
+        <value key="operations">
+            <element>plone.app.querystring.operation.selection.any</element>
+        </value>
+        <value key="vocabulary">rer.solrpush.vocabularies.AvailablePortalTypes</value>
+       <value key="group" i18n:translate="">SOLR</value>
+  </records>
+</registry>

rer/solrpush/profiles/default/registry/settings.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0"?>
+<registry xmlns:i18n="http://xml.zope.org/namespaces/i18n"
+          i18n:domain="rer.solrpush">
+  <records interface="rer.solrpush.interfaces.settings.IRerSolrpushSettings" />
+  <records interface="rer.solrpush.interfaces.IElevateSettings" />
+</registry>

rer/solrpush/profiles/default/rolemap.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0"?>
+<rolemap>
+  <permissions>
+    <permission name="rer.solrpush: Edit Elevate" acquire="True">
+      <role name="Manager" />
+      <role name="Site Administrator" />
+    </permission>
+    <permission name="rer.solrpush: Edit Settings" acquire="True">
+      <role name="Manager" />
+      <role name="Site Administrator" />
+    </permission>
+  </permissions>
+</rolemap>

rer/solrpush/profiles/default/types/Document.xml

@@ -0,0 +1,12 @@
+<?xml version="1.0"?>
+<object
+    name="Document"
+    meta_type="Dexterity FTI"
+    i18n:domain="plone"
+    xmlns:i18n="http://xml.zope.org/namespaces/i18n">
+
+  <property name="behaviors" purge="false">
+    <element value="rer.solrpush.behaviors.solr_fields.ISolrFields" />
+  </property>
+
+</object>

rer/solrpush/profiles/to_1100/componentregistry.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0"?>
+<componentregistry>
+  <utilities>
+    <utility 
+        interface="rer.solrpush.interfaces.ISolrIndexQueueProcessor"
+        name="solrpush.utility"
+        remove="True" />
+  </utilities>
+</componentregistry>

rer/solrpush/profiles/to_1100/metadata.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<metadata>
+  <dependencies>
+  </dependencies>
+</metadata>

rer/solrpush/profiles/to_1300/controlpanel.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0"?>
+<object
+    name="portal_controlpanel"
+    xmlns:i18n="http://xml.zope.org/namespaces/i18n"
+    i18n:domain="rer.bandisolr">
+
+    <configlet
+        title="Configurazione Elevate"
+        action_id="solrpush.elevate"
+        appId="solrpush-elevate"
+        remove="True">
+    </configlet>
+</object>

rer/solrpush/profiles/to_1300/registry.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0"?>
+<registry xmlns:i18n="http://xml.zope.org/namespaces/i18n"
+          i18n:domain="rer.solrpush">
+  <records interface="rer.solrpush.interfaces.IElevateSettings" remove="True"/>
+</registry>

rer/solrpush/profiles/uninstall/browserlayer.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<layers>
+  <layer
+      name="rer.solrpush"
+      remove="true"
+      />
+</layers>

rer/solrpush/profiles/uninstall/controlpanel.xml

@@ -0,0 +1,21 @@
+<?xml version="1.0"?>
+<object
+    name="portal_controlpanel"
+    xmlns:i18n="http://xml.zope.org/namespaces/i18n"
+    i18n:domain="rer.solrpush">
+
+    <configlet
+        title="Configurazione RER SolrPush"
+        action_id="solrpush.configuration"
+        appId="solrpush"
+        category="SOLR"
+        remove="True">
+    </configlet>
+    <configlet
+        title="Configurazione Elevate"
+        action_id="solrpush.elevate"
+        appId="solrpush-elevate"
+        category="SOLR"
+        remove="True">
+    </configlet>
+</object>

rer/solrpush/profiles/uninstall/registry.xml

@@ -0,0 +1,17 @@
+<?xml version="1.0"?>
+<registry>
+  <!-- -*- extra stuff goes here -*- -->
+  <records interface="rer.solrpush.interfaces.settings.IRerSolrpushSettings" remove="True"/>
+  <records interface="rer.solrpush.interfaces.IElevateSettings" remove="True"/>
+
+  <!-- RESOURCE -->
+  <records prefix="plone.resources/rer-solrpush-css"
+           interface='Products.CMFPlone.interfaces.IResourceRegistry' remove="True">
+  </records>
+
+  <!-- BUNDLE -->
+  <records prefix="plone.bundles/rer-solrpush-css-bundle"
+           interface='Products.CMFPlone.interfaces.IBundleRegistry' remove="True">
+  </records>
+
+</registry>

rer/solrpush/restapi/configure.zcml

@@ -0,0 +1,8 @@
+<configure
+    xmlns="http://namespaces.zope.org/zope"
+    xmlns:plone="http://namespaces.plone.org/plone">
+
+  <include package="plone.restapi" file="configure.zcml"/>
+  <include package=".services" />
+
+</configure>

rer/solrpush/restapi/services/configure.zcml

@@ -0,0 +1,8 @@
+<configure
+    xmlns="http://namespaces.zope.org/zope"
+    xmlns:plone="http://namespaces.plone.org/plone">
+
+  <include package=".elevate_schema" />
+  <include package=".solr_search" />
+
+</configure>

rer/solrpush/restapi/services/elevate_schema/configure.zcml

@@ -0,0 +1,14 @@
+<configure
+    xmlns="http://namespaces.zope.org/zope"
+    xmlns:plone="http://namespaces.plone.org/plone">
+
+  <plone:service
+    method="GET"
+    for="zope.interface.Interface"
+    factory=".get.ElevateSchemaGet"
+    name="@elevate-schema"
+    permission="zope2.View"
+    layer="rer.solrpush.interfaces.IRerSolrpushLayer"
+    />
+
+</configure>

rer/solrpush/restapi/services/elevate_schema/get.py

@@ -0,0 +1,12 @@
+# -*- coding: utf-8 -*-
+from plone.restapi.services import Service
+from rer.solrpush.utils.solr_common import get_setting
+from rer.solrpush.interfaces import IElevateSettings
+
+import json
+
+
+class ElevateSchemaGet(Service):
+    def reply(self):
+        data = get_setting(field="elevate_schema", interface=IElevateSettings)
+        return json.loads(data)

rer/solrpush/restapi/services/solr_search/batch.py

@@ -0,0 +1,129 @@
+# -*- coding: utf-8 -*-
+from plone.restapi.deserializer import json_body
+from six.moves.urllib.parse import parse_qsl
+from six.moves.urllib.parse import urlencode
+
+
+DEFAULT_BATCH_SIZE = 25
+
+
+class SolrHypermediaBatch(object):
+    def __init__(self, request, results):
+        self.request = request
+
+        self.b_start = int(
+            json_body(self.request).get("b_start", False)
+        ) or int(self.request.form.get("b_start", 0))
+        self.b_size = int(json_body(self.request).get("b_size", False)) or int(
+            self.request.form.get("b_size", DEFAULT_BATCH_SIZE)
+        )
+
+        self.hits = getattr(results, "hits", 0)
+
+    @property
+    def canonical_url(self):
+        """Return the canonical URL to the batched collection-like resource,
+        preserving query string params, but stripping all batching related
+        params from it.
+        """
+        url = self.request["ACTUAL_URL"]
+        qs_params = parse_qsl(self.request["QUERY_STRING"])
+
+        # Remove any batching / sorting related parameters.
+        # Also take care to preserve list-like query string params.
+        for key, value in qs_params[:]:
+            if key in (
+                "b_size",
+                "b_start",
+                "sort_on",
+                "sort_order",
+                "sort_limit",
+            ):
+                qs_params.remove((key, value))
+
+        qs = urlencode(qs_params)
+
+        if qs_params:
+            url = "?".join((url, qs))
+        return url
+
+    @property
+    def current_batch_url(self):
+        url = self.request["ACTUAL_URL"]
+        qs = self.request["QUERY_STRING"]
+        if qs:
+            url = "?".join((url, qs))
+        return url
+
+    @property
+    def links(self):
+        """Get a dictionary with batching links.
+        """
+        # Don't provide batching links if resultset isn't batched
+        if self.hits <= self.b_size:
+            return None
+
+        links = {}
+
+        last = self._last_page()
+        next = self._next_page()
+        prev = self._prev_page()
+
+        links["@id"] = self.current_batch_url
+        links["first"] = self._url_for_batch(0)
+        links["last"] = self._url_for_batch(last)
+
+        if next:
+            links["next"] = self._url_for_batch(next)
+
+        if prev:
+            links["prev"] = self._url_for_batch(prev)
+
+        return links
+
+    def _url_for_batch(self, pagenumber):
+        """Return a new Batch object for the given pagenumber.
+        """
+        new_start = pagenumber * self.b_size
+        return self._url_with_params(params={"b_start": new_start})
+
+    def _last_page(self):
+        page = self.hits / self.b_size
+        if self.hits % self.b_size == 0:
+            return page - 1
+        return page
+
+    def _next_page(self):
+        curr_page = self.b_start / self.b_size
+        if curr_page == self._last_page():
+            return None
+        return curr_page + 1
+
+    def _prev_page(self):
+        curr_page = self.b_start / self.b_size
+        if curr_page == 0:
+            return None
+        return curr_page - 1
+
+    def _url_with_params(self, params):
+        """Build an URL based on the actual URL of the current request URL
+        and add or update some query string parameters in it.
+        """
+        url = self.request["ACTUAL_URL"]
+        qs_params = parse_qsl(
+            self.request["QUERY_STRING"], keep_blank_values=1
+        )
+
+        # Take care to preserve list-like query string arguments (same QS
+        # param repeated multiple times). In other words, don't turn the
+        # result of parse_qsl into a dict!
+
+        # Drop params to be updated, then prepend new params in order
+        qs_params = [x for x in qs_params if x[0] not in list(params)]
+        qs_params = sorted(params.items()) + qs_params
+
+        qs = urlencode(qs_params)
+
+        if qs_params:
+            url = "?".join((url, qs))
+        return url

rer/solrpush/restapi/services/solr_search/configure.zcml

@@ -0,0 +1,14 @@
+<configure
+    xmlns="http://namespaces.zope.org/zope"
+    xmlns:plone="http://namespaces.plone.org/plone">
+
+  <plone:service
+    method="GET"
+    for="zope.interface.Interface"
+    factory=".get.SearchGet"
+    name="@solr-search"
+    permission="zope2.View"
+    layer="rer.solrpush.interfaces.IRerSolrpushLayer"
+    />
+
+</configure>

rer/solrpush/restapi/services/solr_search/get.py

@@ -0,0 +1,25 @@
+# -*- coding: utf-8 -*-
+from plone.restapi.search.utils import unflatten_dotted_dict
+from plone.restapi.services import Service
+from rer.solrpush.restapi.services.solr_search.solr_search_handler import (
+    SolrSearchHandler,
+)
+from plone.restapi.search.handler import SearchHandler
+from rer.solrpush.interfaces.settings import IRerSolrpushSettings
+from plone import api
+
+
+class SearchGet(Service):
+    def reply(self):
+        query = self.request.form.copy()
+        query = unflatten_dotted_dict(query)
+        handler = SearchHandler
+        try:
+            search_enabled = api.portal.get_registry_record(
+                "search_enabled", interface=IRerSolrpushSettings
+            )
+        except Exception:
+            return handler(self.context, self.request).search(query)
+        if search_enabled:
+            handler = SolrSearchHandler
+        return handler(self.context, self.request).search(query)

rer/solrpush/restapi/services/solr_search/solr_search_handler.py

@@ -0,0 +1,86 @@
+# -*- coding: utf-8 -*-
+from copy import deepcopy
+from Products.CMFCore.utils import getToolByName
+from plone.restapi.search.handler import SearchHandler as BaseHandler
+from rer.solrpush.utils import search as solr_search
+from rer.solrpush.restapi.services.solr_search.batch import SolrHypermediaBatch
+from plone.restapi.deserializer import boolean_value
+
+DEFAULT_METADATA_FIELDS = set(
+    ["@id", "@type", "description", "review_state", "title"]
+)
+FIELD_ACCESSORS = {
+    "@id": "getURL",
+    "@type": "PortalType",
+    "description": "Description",
+    "title": "Title",
+}
+
+NON_METADATA_ATTRIBUTES = set(["getPath", "getURL"])
+
+BLACKLISTED_ATTRIBUTES = set(["getDataOrigin", "getObject", "getUserData"])
+
+
+class SolrSearchHandler(BaseHandler):
+    """Executes a solr search based on a query dict, and returns
+    JSON compatible results.
+    """
+
+    def __init__(self, context, request):
+        self.context = context
+        self.request = request
+        self.catalog = getToolByName(self.context, "portal_catalog")
+
+    def search(self, query=None):
+        if query is None:
+            solr_query = {}
+        else:
+            solr_query = deepcopy(query)
+        fl = self.get_fields_list(solr_query)
+        facets = boolean_value(solr_query.get("facets", False))
+        facet_fields = solr_query.get("facet_fields", [])
+        query_params = {"fl": fl}
+        if facets:
+            query_params["facets"] = facets
+            if facet_fields:
+                query_params["facet_fields"] = facet_fields
+                del solr_query["facet_fields"]
+            if "facets" in solr_query:
+                del solr_query["facets"]
+        query_params["query"] = solr_query
+        return self.serialize_results(solr_search(**query_params))
+
+    def get_fields_list(self, query):
+        if "fullobjects" in query:
+            del query["fullobjects"]
+            return []
+        fields = []
+        for field in self.metadata_fields(query):
+            if field.startswith("_") or field in BLACKLISTED_ATTRIBUTES:
+                continue
+            fields.append(field)
+        return fields
+
+    def metadata_fields(self, query):
+        additional_metadata_fields = query.get("metadata_fields", [])
+        if not isinstance(additional_metadata_fields, list):
+            additional_metadata_fields = [additional_metadata_fields]
+        additional_metadata_fields = set(additional_metadata_fields)
+        if additional_metadata_fields:
+            del query["metadata_fields"]
+        return DEFAULT_METADATA_FIELDS | additional_metadata_fields
+
+    def serialize_results(self, solr_results):
+        batch = SolrHypermediaBatch(self.request, solr_results)
+        results = {}
+        results["@id"] = batch.canonical_url
+        results["items_total"] = solr_results.hits
+        if solr_results.facets:
+            results["facets"] = solr_results.facets.get("facet_fields", {})
+        links = batch.links
+        if links:
+            results["batching"] = links
+
+        results["items"] = solr_results.docs
+
+        return results

rer/solrpush/setuphandlers.py

@@ -0,0 +1,20 @@
+# -*- coding: utf-8 -*-
+from Products.CMFPlone.interfaces import INonInstallable
+from zope.interface import implementer
+
+
+@implementer(INonInstallable)
+class HiddenProfiles(object):
+    def getNonInstallableProfiles(self):
+        """Hide uninstall profile from site-creation and quickinstaller."""
+        return ["rer.solrpush:uninstall", "rer.solrpush:1100"]
+
+
+def post_install(context):
+    """Post install script"""
+    # Do something at the end of the installation of this package.
+
+
+def uninstall(context):
+    """Uninstall script"""
+    # Do something at the end of the uninstallation of this package.