Fix default landing page is not considered in clients listing (#2459)

* Fix clients default landing page is not working

* Cleanup

* Redirect client to client's default landing page if no landing page is set

* Redirect to client's default landing page in my_organization

* Remove unused import

* Changelog

* Flag utils.get_registry_record as deprecated

* Fix doctest

* Add client_landing_page into config variable

* Add upgrade decorator to import_registry function

Author: xispa

CHANGES.rst

@@ -4,6 +4,7 @@ Changelog
 2.5.0 (unreleased)
 ------------------
 
+- #2459 Fix default landing page is not considered in clients listing
 - #2456 Remove groups from user add form
 - #2455 Fix users/groups overview batch navigation styling
 - #2454 Fix analyses not filtered by selected WST services

src/bika/lims/browser/clientfolder.py

@@ -25,31 +25,26 @@
 from bika.lims.utils import check_permission
 from bika.lims.utils import get_email_link
 from bika.lims.utils import get_link
-from bika.lims.utils import get_registry_value
 from Products.CMFCore.permissions import ModifyPortalContent
 from senaite.app.listing import ListingView
 from senaite.core.catalog import CLIENT_CATALOG
+from senaite.core.config.registry import CLIENT_LANDING_PAGE
 from senaite.core.permissions import AddClient
 from senaite.core.permissions import ManageAnalysisRequests
+from senaite.core.registry import get_registry_record
 
 
 class ClientFolderContentsView(ListingView):
     """Listing view for all Clients
     """
 
-    _LANDING_PAGE_REGISTRY_KEY = "bika.lims.client.default_landing_page"
-    _DEFAULT_LANDING_PAGE = "analysisrequests"
-
     def __init__(self, context, request):
         super(ClientFolderContentsView, self).__init__(context, request)
 
         self.title = self.context.translate(_("Clients"))
         self.description = ""
         self.form_id = "list_clientsfolder"
         self.sort_on = "sortable_title"
-        # Landing page to be added to the link of each client from the list
-        self.landing_page = get_registry_value(
-            self._LANDING_PAGE_REGISTRY_KEY, self._DEFAULT_LANDING_PAGE)
 
         self.catalog = CLIENT_CATALOG
         self.contentFilter = {
@@ -127,6 +122,9 @@ def before_render(self):
         # Call `before_render` from the base class
         super(ClientFolderContentsView, self).before_render()
 
+        # Landing page to be added to the link of each client from the list
+        self.landing_page = get_registry_record(CLIENT_LANDING_PAGE)
+
         # Render the Add button if the user has the AddClient permission
         if check_permission(AddClient, self.context):
             self.context_actions[_("Add")] = {

src/bika/lims/browser/myorganization.py

@@ -20,6 +20,8 @@
 
 from bika.lims import api
 from bika.lims.browser import BrowserView
+from senaite.core.config.registry import CLIENT_LANDING_PAGE
+from senaite.core.registry import get_registry_record
 
 
 class MyOrganizationView(BrowserView):
@@ -28,11 +30,22 @@ class MyOrganizationView(BrowserView):
     """
 
     def __call__(self):
-        url = api.get_url(api.get_portal())
+
+        client = api.get_current_client()
+        if client:
+            # User belongs to a client, redirect to client's default view
+            view = get_registry_record(CLIENT_LANDING_PAGE)
+            url = "{}/{}".format(api.get_url(client), view)
+            return self.request.response.redirect(url)
+
         current_user = api.get_current_user()
         contact = api.get_user_contact(current_user)
         if contact:
+            # Redirect to the contact's container
             parent = api.get_parent(contact)
             url = api.get_url(parent)
+            return self.request.response.redirect(url)
 
+        # Not a contact, redirect to portal
+        url = api.get_url(api.get_portal())
         return self.request.response.redirect(url)

src/bika/lims/profiles/default/registry.xml

@@ -3,6 +3,7 @@
 <!-- Operation Definitions -->
 <registry xmlns:i18n="http://xml.zope.org/namespaces/i18n" i18n:domain="senaite.core">
 
+    <!-- Ported to 2.x: https://github.com/senaite/senaite.core/pull/2459 -->
     <record name="bika.lims.client.default_landing_page">
       <field type="plone.registry.field.Choice">
         <default>analysisrequests</default>

src/bika/lims/utils/__init__.py

@@ -754,8 +754,13 @@ def get_registry_value(key, default=None):
     :param default: default value if the key is not registered
     :return: value in the registry for the key passed in
     """
-    registry = queryUtility(IRegistry)
-    return registry.get(key, default)
+    # cannot use bika.lims.deprecated (circular dependencies)
+    import warnings
+    warnings.simplefilter("always", DeprecationWarning)
+    warn = "Deprecated: use senaite.core.api.get_registry_record instead"
+    warnings.warn(warn, category=DeprecationWarning, stacklevel=2)
+    warnings.simplefilter("default", DeprecationWarning)
+    return api.get_registry_record(key, default=default)
 
 
 def check_permission(permission, obj):

src/senaite/core/browser/frontpage/frontpage.py

@@ -24,6 +24,8 @@
 from plone import api as ploneapi
 from plone.protect.utils import addTokenToUrl
 from Products.Five.browser.pagetemplatefile import ViewPageTemplateFile
+from senaite.core.config.registry import CLIENT_LANDING_PAGE
+from senaite.core.registry import get_registry_record
 from zope.component import getAdapters
 
 
@@ -89,6 +91,13 @@ def __call__(self):
         if landingpage:
             return self.request.response.redirect(landingpage.absolute_url())
 
+        # Fourth precedence: Default landing page in client view
+        client = api.get_current_client()
+        if client:
+            view = get_registry_record(CLIENT_LANDING_PAGE)
+            url = "{}/{}".format(api.get_url(client), view)
+            return self.request.response.redirect(url)
+
         # Last precedence: Front Page
         return self.template()
 

src/senaite/core/config/registry.py

@@ -0,0 +1,21 @@
+# -*- coding: utf-8 -*-
+#
+# This file is part of SENAITE.CORE.
+#
+# SENAITE.CORE is free software: you can redistribute it and/or modify it under
+# the terms of the GNU General Public License as published by the Free Software
+# Foundation, version 2.
+#
+# 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 General Public License for more
+# details.
+#
+# You should have received a copy of the GNU General Public License along with
+# this program; if not, write to the Free Software Foundation, Inc., 51
+# Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+#
+# Copyright 2018-2023 by it's authors.
+# Some rights reserved, see README and LICENSE.
+
+CLIENT_LANDING_PAGE = "client_landing_page"

src/senaite/core/configure.zcml

@@ -31,6 +31,7 @@
   <include package=".subscribers" />
   <include package=".upgrade" />
   <include package=".utilities" />
+  <include package=".vocabularies" />
   <include package=".z3cform" />
 
   <!-- portal skins -->

src/senaite/core/profiles/default/metadata.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0"?>
 <metadata>
-  <version>2524</version>
+  <version>2525</version>
   <dependencies>
     <dependency>profile-Products.ATContentTypes:base</dependency>
     <dependency>profile-Products.CMFEditions:CMFEditions</dependency>

src/senaite/core/registry/schema.py

@@ -40,6 +40,7 @@ class IClientRegistry(ISenaiteRegistry):
         description=_("Settings for Clients"),
         fields=[
             "auto_create_client_group",
+            "client_landing_page",
         ],
     )
 
@@ -57,6 +58,22 @@ class IClientRegistry(ISenaiteRegistry):
         required=False,
     )
 
+    client_landing_page = schema.Choice(
+        title=_(
+            u"label_registry_client_landing_page",
+            default=u"Client landing page"
+        ),
+        description=_(
+            u"description_registry_client_landing_page",
+            default=u"Select the default landing page. This is used when a "
+                    u"Client user logs into the system, or when a client is "
+                    u"selected from the client folder listing"
+        ),
+        vocabulary="senaite.core.vocabularies.registry.client_landing_pages",
+        default="analysisrequests",
+        required=True,
+    )
+
 
 class ILabelRegistry(ISenaiteRegistry):
     """Label settings

src/senaite/core/upgrade/v02_05_000.py

@@ -37,9 +37,11 @@
 from senaite.core.catalog import SETUP_CATALOG
 from senaite.core.catalog import WORKSHEET_CATALOG
 from senaite.core.config import PROJECTNAME as product
+from senaite.core.config.registry import CLIENT_LANDING_PAGE
 from senaite.core.permissions import ManageBika
 from senaite.core.permissions import TransitionReceiveSample
 from senaite.core.registry import get_registry_record
+from senaite.core.registry import set_registry_record
 from senaite.core.setuphandlers import _run_import_step
 from senaite.core.setuphandlers import add_dexterity_items
 from senaite.core.setuphandlers import CATALOG_MAPPINGS
@@ -53,6 +55,8 @@
 from senaite.core.workflow import ANALYSIS_WORKFLOW
 from senaite.core.workflow import SAMPLE_WORKFLOW
 from zope.interface import alsoProvides
+from zope.schema.interfaces import IVocabularyFactory
+from zope.component import getUtility
 
 PORTAL_CATALOG = "portal_catalog"
 
@@ -262,6 +266,7 @@ def update_report_catalog(tool):
     logger.info("Update report catalog [DONE]")
 
 
+@upgradestep(product, version)
 def import_registry(tool):
     """Import registry step from profiles
     """
@@ -650,3 +655,26 @@ def purge_orphan_worksheets(tool):
         obj._p_deactivate()
 
     logger.info("Purging orphan Worksheet records from catalog [DONE]")
+
+
+def setup_client_landing_page(tool):
+    """Setup the registry record for the client's landing page
+    """
+    logger.info("Setup client's default landing page ...")
+
+    # import the client registry
+    import_registry(tool)
+
+    # look for the legacy registry record
+    key = "bika.lims.client.default_landing_page"
+    value = api.get_registry_record(key, default="")
+
+    # set the value to the new registry record
+    vocab_key = "senaite.core.vocabularies.registry.client_landing_pages"
+    vocab_factory = getUtility(IVocabularyFactory, vocab_key)
+    vocabulary = vocab_factory(api.get_portal())
+    values = [item.value for item in vocabulary]
+    if value in values:
+        set_registry_record(CLIENT_LANDING_PAGE, value)
+
+    logger.info("Setup client's default landing page [DONE]")

src/senaite/core/upgrade/v02_05_000.zcml

@@ -3,6 +3,14 @@
     xmlns:genericsetup="http://namespaces.zope.org/genericsetup"
     i18n_domain="senaite.core">
 
+  <genericsetup:upgradeStep
+      title="SENAITE.CORE 2.5.0: Setup client landing page"
+      description="Setup client landing page configuration"
+      source="2524"
+      destination="2525"
+      handler=".v02_05_000.setup_client_landing_page"
+      profile="senaite.core:default"/>
+
   <genericsetup:upgradeStep
       title="SENAITE.CORE 2.5.0: Un-catalog orphan worksheets"
       description="Un-catalog worksheets that were once removed"

src/senaite/core/vocabularies/__init__.py

@@ -0,0 +1,19 @@
+# -*- coding: utf-8 -*-
+#
+# This file is part of SENAITE.CORE.
+#
+# SENAITE.CORE is free software: you can redistribute it and/or modify it under
+# the terms of the GNU General Public License as published by the Free Software
+# Foundation, version 2.
+#
+# 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 General Public License for more
+# details.
+#
+# You should have received a copy of the GNU General Public License along with
+# this program; if not, write to the Free Software Foundation, Inc., 51
+# Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+#
+# Copyright 2018-2023 by it's authors.
+# Some rights reserved, see README and LICENSE.

src/senaite/core/vocabularies/configure.zcml

@@ -0,0 +1,9 @@
+<configure
+    xmlns="http://namespaces.zope.org/zope"
+    i18n_domain="senaite.core">
+
+  <utility
+      component=".registry.ClientLandingPagesVocabularyFactory"
+      name="senaite.core.vocabularies.registry.client_landing_pages" />
+
+</configure>

src/senaite/core/vocabularies/registry.py

@@ -0,0 +1,59 @@
+# -*- coding: utf-8 -*-
+#
+# This file is part of SENAITE.CORE.
+#
+# SENAITE.CORE is free software: you can redistribute it and/or modify it under
+# the terms of the GNU General Public License as published by the Free Software
+# Foundation, version 2.
+#
+# 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 General Public License for more
+# details.
+#
+# You should have received a copy of the GNU General Public License along with
+# this program; if not, write to the Free Software Foundation, Inc., 51
+# Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+#
+# Copyright 2018-2023 by it's authors.
+# Some rights reserved, see README and LICENSE.
+
+from zope.interface import implementer
+from zope.schema.interfaces import IVocabularyFactory
+from zope.schema.vocabulary import SimpleTerm
+from zope.schema.vocabulary import SimpleVocabulary
+from bika.lims import api
+
+
+@implementer(IVocabularyFactory)
+class ClientLandingPagesVocabulary(object):
+    """Vocabulary factory for Client landing pages
+    """
+
+    skip = ["edit", "manage_access", "auditlog", ]
+
+    def __call__(self, context):
+        pt = api.get_tool("portal_types")
+        type_info = pt.getTypeInfo("Client")
+        terms = []
+        for action in type_info.listActionInfos():
+            if not action.get("visible", True):
+                continue
+            if action.get("id") in self.skip:
+                continue
+            url = action.get("url")
+            if not url:
+                continue
+
+            # remove leading/trailing slashes
+            url = url.strip("/")
+
+            # create the vocab term
+            title = action.get("title")
+            term = SimpleTerm(url, url, title)
+            terms.append(term)
+
+        return SimpleVocabulary(terms)
+
+
+ClientLandingPagesVocabularyFactory = ClientLandingPagesVocabulary()