feat: add ckanext.vip_portal.free_access_by_default config option

Author: smotornyuk

README.md

@@ -46,6 +46,13 @@ ckanext.vip_portal.free_anonymous_access = true
 # (optional, default: true).
 ckanext.vip_portal.free_authenticated_access = false
 
+# Unless endpoint is blocked by one of IVipAccess implementations,
+# it can be accessed by anyone. Use it in combination with IVipAccess
+# interface if you want to leave the portal generally open and
+# block only certain endpoints
+# (optional, default: false).
+ckanext.vip_portal.free_access_by_default = true
+
 # Allow anonymous access to login pages
 # (optional, default: true).
 ckanext.vip_portal.allow_login = false

ckanext/vip_portal/config.py

@@ -15,6 +15,9 @@
 CONFIG_FREE_USER = "ckanext.vip_portal.free_authenticated_access"
 DEFAULT_FREE_USER = True
 
+CONFIG_FREE_UNDEFINED = "ckanext.vip_portal.free_access_by_default"
+DEFAULT_FREE_UNDEFINED = False
+
 CONFIG_ALLOW_LOGIN = "ckanext.vip_portal.allow_login"
 DEFAULT_ALLOW_LOGIN = True
 
@@ -71,6 +74,13 @@ def free_authenticated_access() -> bool:
         tk.config.get(CONFIG_FREE_USER, DEFAULT_FREE_USER)
     )
 
+
+def free_access_by_default() -> bool:
+    return tk.asbool(
+        tk.config.get(CONFIG_FREE_UNDEFINED, DEFAULT_FREE_UNDEFINED)
+    )
+
+
 def allowed_endpoints() -> list[tuple[str, Any]]:
     endpoints: list[tuple[str, Any]] = essential_endpoints.copy()
 

ckanext/vip_portal/interfaces.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 import enum
-from typing import Optional
+from typing import Optional, Union
 from flask import Response
 from ckan.plugins import Interface
 
@@ -14,7 +14,7 @@ class Access(enum.Enum):
 
 class IVipPortal(Interface):
     def check_vip_access_for_endpoint(
-            self, endpoint: tuple[str, str], user: Optional[str]
+            self, endpoint: Union[tuple[str, str], tuple[None, None]], user: Optional[str]
     ) -> Access:
         return Access.unknown
 

ckanext/vip_portal/utils.py

@@ -1,13 +1,13 @@
 from __future__ import annotations
-from typing import Optional
+from typing import Optional, Union
 
 import ckan.plugins.toolkit as tk
 from ckan.plugins import PluginImplementations
 
 from . import config, interfaces
 
 
-def is_free_endpoint(endpoint: tuple[str, str], user: Optional[str]) -> bool:
+def is_free_endpoint(endpoint: Union[tuple[str, str], tuple[None, None]], user: Optional[str]) -> bool:
     for p in PluginImplementations(interfaces.IVipPortal):
         access = p.check_vip_access_for_endpoint(endpoint, user)
 
@@ -17,7 +17,7 @@ def is_free_endpoint(endpoint: tuple[str, str], user: Optional[str]) -> bool:
         if access is interfaces.Access.forbidden:
             return False
 
-    return False
+    return config.free_access_by_default()
 
 
 def is_free_path(path: str, user: Optional[str]) -> bool:

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = ckanext-vip-portal
-version = 0.1.1
+version = 0.1.2
 description =
 long_description = file: README.md
 long_description_content_type = text/markdown