Election Day: Allow application to be private.

TYPE: Feature
LINK: OGC-1678

src/onegov/election_day/models/principal.py

@@ -100,6 +100,7 @@ def __init__(
         custom_css: str | None = None,
         official_host: str | None = None,
         segmented_notifications: bool = False,
+        private: bool = False,
         **kwargs: 'Never'
     ):
         assert all((id_, domain, domains_election, domains_vote, entities))
@@ -137,6 +138,7 @@ def __init__(
         self.custom_css = custom_css
         self.official_host = official_host
         self.segmented_notifications = segmented_notifications
+        self.private = private
 
     @classmethod
     def from_yaml(cls, yaml_source: '_ReadStream') -> 'Canton | Municipality':

src/onegov/election_day/security.py

@@ -0,0 +1,51 @@
+
+from onegov.core.security import Private
+from onegov.core.security import Public
+from onegov.core.security.permissions import Intent
+from onegov.core.security.rules import has_permission_logged_in
+from onegov.core.security.rules import has_permission_not_logged_in
+from onegov.election_day import ElectionDayApp
+
+from typing import TYPE_CHECKING
+if TYPE_CHECKING:
+    from morepath.authentication import Identity
+
+
+class MaybePublic(Intent):
+    """ The general public is allowed to do this, if not otherwise defined
+    in the principal. """
+
+
+@ElectionDayApp.permission_rule(
+    model=object,
+    permission=MaybePublic,
+    identity=None
+)
+def has_permission_maybe_public_not_logged_in(
+    app: ElectionDayApp,
+    identity: None,
+    model: object,
+    permission: object
+) -> bool:
+
+    if getattr(app.principal, 'private', False):
+        return has_permission_not_logged_in(app, identity, model, Private)
+
+    return has_permission_not_logged_in(app, identity, model, Public)
+
+
+@ElectionDayApp.permission_rule(
+    model=object,
+    permission=MaybePublic
+)
+def has_permission_maybe_public_logged_in(
+    app: ElectionDayApp,
+    identity: 'Identity',
+    model: object,
+    permission: MaybePublic
+) -> bool:
+
+    if getattr(app.principal, 'private', False):
+        return has_permission_logged_in(app, identity, model, Private)
+
+    return has_permission_logged_in(app, identity, model, Public)

src/onegov/election_day/views/archive.py

@@ -1,4 +1,5 @@
-from onegov.core.security import Public
+from fs.errors import ResourceNotFound
+from morepath.request import Response
 from onegov.election_day import ElectionDayApp
 from onegov.election_day.collections import ArchivedResultCollection
 from onegov.election_day.collections import SearchableArchivedResultCollection
@@ -7,12 +8,11 @@
 from onegov.election_day.layouts import DefaultLayout
 from onegov.election_day.layouts.archive import ArchiveLayout
 from onegov.election_day.models import Principal
+from onegov.election_day.security import MaybePublic
 from onegov.election_day.utils import add_cors_header
 from onegov.election_day.utils import add_last_modified_header
 from onegov.election_day.utils import get_summaries
 from webob.exc import HTTPNotFound
-from fs.errors import ResourceNotFound
-from morepath.request import Response
 
 
 from typing import TYPE_CHECKING
@@ -25,7 +25,7 @@
 @ElectionDayApp.html(
     model=ArchivedResultCollection,
     template='archive.pt',
-    permission=Public
+    permission=MaybePublic
 )
 def view_archive(
     self: ArchivedResultCollection,
@@ -49,7 +49,7 @@ def view_archive(
 @ElectionDayApp.json(
     model=ArchivedResultCollection,
     name='json',
-    permission=Public
+    permission=MaybePublic
 )
 def view_archive_json(
     self: ArchivedResultCollection,
@@ -81,7 +81,7 @@ def add_headers(response: Response) -> None:
 @ElectionDayApp.html(
     model=Principal,
     template='archive.pt',
-    permission=Public
+    permission=MaybePublic
 )
 def view_principal(
     self: Principal,
@@ -106,7 +106,7 @@ def view_principal(
 @ElectionDayApp.json(
     model=Principal,
     name='json',
-    permission=Public
+    permission=MaybePublic
 )
 def view_principal_json(
     self: Principal,
@@ -151,7 +151,7 @@ def search_form(
     model=SearchableArchivedResultCollection,
     template='archive_search.pt',
     form=search_form,
-    permission=Public,
+    permission=MaybePublic,
 )
 def view_archive_search(
     self: SearchableArchivedResultCollection,
@@ -182,7 +182,8 @@ def view_archive_search(
 @ElectionDayApp.view(
     model=Principal,
     name='archive-download',
-    permission=Public)
+    permission=MaybePublic
+)
 def view_archive_download(
     self: Principal,
     request: 'ElectionDayRequest'

src/onegov/election_day/views/election/candidate_district.py

@@ -1,11 +1,11 @@
-from onegov.core.security import Public
 from onegov.election_day import _
 from onegov.election_day import ElectionDayApp
 from onegov.election_day.hidden_by_principal import \
     hide_candidate_district_map_percentages
 from onegov.election_day.layouts import ElectionLayout
 from onegov.election_day.models import Candidate
 from onegov.election_day.models import Election
+from onegov.election_day.security import MaybePublic
 from onegov.election_day.utils import add_last_modified_header
 
 
@@ -54,7 +54,7 @@ def ordering_completed(candidate: Candidate) -> tuple[bool, str, str]:
 @ElectionDayApp.json(
     model=Candidate,
     name='by-district',
-    permission=Public
+    permission=MaybePublic
 )
 def view_candidate_by_district(
     self: Candidate,
@@ -69,7 +69,7 @@ def view_candidate_by_district(
     model=Election,
     name='candidate-by-district',
     template='election/heatmap.pt',
-    permission=Public
+    permission=MaybePublic
 )
 def view_election_candidate_by_district(
     self: Election,
@@ -110,7 +110,7 @@ def view_election_candidate_by_district(
     model=Election,
     name='candidate-by-district-chart',
     template='embed.pt',
-    permission=Public
+    permission=MaybePublic
 )
 def view_election_candidate_by_district_chart(
     self: Election,

src/onegov/election_day/views/election/candidate_entity.py

@@ -1,11 +1,11 @@
-from onegov.core.security import Public
 from onegov.election_day import _
 from onegov.election_day import ElectionDayApp
 from onegov.election_day.hidden_by_principal import \
     hide_candidate_entity_map_percentages
 from onegov.election_day.layouts import ElectionLayout
 from onegov.election_day.models import Candidate
 from onegov.election_day.models import Election
+from onegov.election_day.security import MaybePublic
 from onegov.election_day.utils import add_last_modified_header
 
 
@@ -53,7 +53,7 @@ def ordering_completed(candidate: Candidate) -> tuple[bool, str, str]:
 @ElectionDayApp.json(
     model=Candidate,
     name='by-entity',
-    permission=Public
+    permission=MaybePublic
 )
 def view_candidate_by_entity(
     self: Candidate,
@@ -68,7 +68,7 @@ def view_candidate_by_entity(
     model=Election,
     name='candidate-by-entity',
     template='election/heatmap.pt',
-    permission=Public
+    permission=MaybePublic
 )
 def view_election_candidate_by_entity(
     self: Election,
@@ -109,7 +109,7 @@ def view_election_candidate_by_entity(
     model=Election,
     name='candidate-by-entity-chart',
     template='embed.pt',
-    permission=Public
+    permission=MaybePublic
 )
 def view_election_candidate_by_entity_chart(
     self: Election,

src/onegov/election_day/views/election/candidates.py

@@ -1,9 +1,9 @@
-from onegov.core.security import Public
 from onegov.election_day import _
 from onegov.election_day import ElectionDayApp
 from onegov.election_day.hidden_by_principal import hide_candidates_chart
 from onegov.election_day.layouts import ElectionLayout
 from onegov.election_day.models import Election
+from onegov.election_day.security import MaybePublic
 from onegov.election_day.utils import add_last_modified_header
 from onegov.election_day.utils import get_entity_filter
 from onegov.election_day.utils import get_parameter
@@ -29,7 +29,7 @@
 @ElectionDayApp.json(
     model=Election,
     name='candidates-data',
-    permission=Public
+    permission=MaybePublic
 )
 def view_election_candidates_data(
     self: Election,
@@ -62,7 +62,7 @@ def view_election_candidates_data(
     model=Election,
     name='candidates-chart',
     template='embed.pt',
-    permission=Public
+    permission=MaybePublic
 )
 def view_election_candidates_chart(
     self: Election,
@@ -90,7 +90,7 @@ def add_last_modified(response: 'Response') -> None:
     model=Election,
     name='candidates',
     template='election/candidates.pt',
-    permission=Public
+    permission=MaybePublic
 )
 def view_election_candidates(
     self: Election,
@@ -124,7 +124,7 @@ def view_election_candidates(
     model=Election,
     name='candidates-table',
     template='embed.pt',
-    permission=Public
+    permission=MaybePublic
 )
 def view_election_lists_table(
     self: Election,
@@ -153,7 +153,11 @@ def add_last_modified(response: 'Response') -> None:
     }
 
 
-@ElectionDayApp.svg_file(model=Election, name='candidates-svg')
+@ElectionDayApp.svg_file(
+    model=Election,
+    name='candidates-svg',
+    permission=MaybePublic
+)
 def view_election_candidates_svg(
     self: Election,
     request: 'ElectionDayRequest'

src/onegov/election_day/views/election/connections.py

@@ -1,9 +1,9 @@
-from onegov.core.security import Public
 from onegov.election_day import ElectionDayApp
 from onegov.election_day.hidden_by_principal import (
     hide_connections_chart)
 from onegov.election_day.layouts import ElectionLayout
 from onegov.election_day.models import Election
+from onegov.election_day.security import MaybePublic
 from onegov.election_day.utils import add_last_modified_header
 from onegov.election_day.utils.election import get_connection_results_api
 from onegov.election_day.utils.election import get_connections_data
@@ -28,7 +28,7 @@
 @ElectionDayApp.json(
     model=Election,
     name='connections-data',
-    permission=Public
+    permission=MaybePublic
 )
 def view_election_connections_data(
     self: Election,
@@ -46,7 +46,7 @@ def view_election_connections_data(
     model=Election,
     name='connections-chart',
     template='embed.pt',
-    permission=Public
+    permission=MaybePublic
 )
 def view_election_connections_chart(
     self: Election,
@@ -73,7 +73,7 @@ def add_last_modified(response: 'Response') -> None:
     model=Election,
     name='connections-table',
     template='embed.pt',
-    permission=Public
+    permission=MaybePublic
 )
 def view_election_connections_table(
     self: Election,
@@ -98,7 +98,7 @@ def add_last_modified(response: 'Response') -> None:
     model=Election,
     name='connections',
     template='election/connections.pt',
-    permission=Public
+    permission=MaybePublic
 )
 def view_election_connections(
     self: Election,
@@ -116,7 +116,11 @@ def view_election_connections(
     }
 
 
-@ElectionDayApp.svg_file(model=Election, name='connections-svg')
+@ElectionDayApp.svg_file(
+    model=Election,
+    name='connections-svg',
+    permission=MaybePublic
+)
 def view_election_connections_svg(
     self: Election,
     request: 'ElectionDayRequest'