OP#2859 : add API calendar display

Author: tkeriven

app/api/v1/user/ApiUserPreferences.py

@@ -71,6 +71,15 @@ def get(self) -> ResponseReturnValue:
         interface_api: InterfaceUserPreferences = g.inter
         return interface_api.get_user_folders()
 
+    @blp.arguments(sch.UserPreferencesFoldersPatch, example=sch.UserPreferencesFoldersPatch.example(), error_status_code=400)
+    @blp.response(200)
+    def patch(self, new_data: dict) -> ResponseReturnValue:
+        """
+        Update a single folder key's value in the user's folders structure
+        """
+        interface_api: InterfaceUserPreferences = g.inter
+        return interface_api.update_folder_value(new_data["resource"], new_data["id"], new_data["value"])
+
 
 # @blp.route("/<string:pref_type>")
 # class ApiUserPreferencesPart(MethodView):

app/api/v1/user/schema/userPreferences.py

@@ -1,4 +1,4 @@
-from marshmallow import Schema, fields
+from marshmallow import Schema, fields, validate
 
 from app.utils.api.ApiBaseResponse import ApiBaseResponse
 
@@ -86,4 +86,28 @@ def example(cls) -> dict:
                     "SOGO_U_LANGUAGE": "French",
                 }
             }
+        }
+
+class UserPreferencesFoldersPatch(Schema):
+    """
+    Schema of the body expected for PATCH /preferences/folders
+
+    Updates a single folder key's boolean value within the folders column (CALENDAR or ADDRESSBOOKS)
+    """
+    resource = fields.String(required=True, validate=validate.OneOf(["CALENDAR", "ADDRESSBOOKS"]))
+    id = fields.String(required=True)
+    value = fields.Boolean(required=True)
+
+    @classmethod
+    def example(cls) -> dict:
+        """
+        Example of data for the patch request
+
+        :return: Example data
+        :rtype: dict
+        """
+        return {
+            "resource": "CALENDAR",
+            "id": "3c4b0bc9-3aab-4243-abb2-75a5edc8c239",
+            "value": True
         }

app/interface/user/InterfaceUserPreferences.py

@@ -55,6 +55,26 @@ def get_user_folders(self) -> tuple[dict, int]:
 
         return create_api_base_response(folders)
 
+    def update_folder_value(self, resource: str, folder_id: str, value: bool) -> tuple[dict, int]:
+        """
+        Update a single folder key's boolean value in the user's folders structure (CALENDAR or ADDRESSBOOKS)
+
+        :param resource: Resource type - "CALENDAR" or "ADDRESSBOOKS"
+        :type resource: str
+        :param folder_id: Unique id of the folder to update
+        :type folder_id: str
+        :param value: New boolean value to set
+        :type value: bool
+        :return: Tuple containing response dict and HTTP status code
+        :rtype: tuple[dict, int]
+        """
+        try:
+            folders = self.module_user_profile.update_folder_value(self.user.uid, resource, folder_id, value)
+        except RequestException as ex:
+            return create_api_base_response(None, ex.error)
+
+        return create_api_base_response(folders)
+
     def get_partial_preferences(self, subparent:str) -> tuple[dict, int]:
         """Get partial user preferences for a specific subparent
 

app/module/user/ModuleUserProfile.py

@@ -283,6 +283,40 @@ def remove_folder_key(self, uid: str, folder_type: str, key: str, owner_key: str
 
         self._update_user_column(uid, tbl.COL_USER_FOLDERS.name, current_folders)
 
+    def update_folder_value(self, uid: str, resource: str, folder_id: str, value: bool) -> dict:
+        """
+        Update the boolean value of a single folder key within the folders column (CALENDAR or ADDRESSBOOKS).
+
+        Searches every owner-type sub-section (OWNER, SUBS, EXT, ...) of the given resource for folder_id
+        and updates the first match found; folder_id is expected to be unique across the whole structure.
+
+        :param uid: User unique identifier
+        :type uid: str
+        :param resource: Resource type - "CALENDAR" or "ADDRESSBOOKS"
+        :type resource: str
+        :param folder_id: Unique id of the folder to update
+        :type folder_id: str
+        :param value: New boolean value to set
+        :type value: bool
+        :return: The updated folders dictionary
+        :rtype: dict
+        :raises RequestException: If user profile not found or folder_id not found for this resource
+        :raises AggravatedException: If multiple user profiles found
+        """
+        logger_user_profile.debug("Updating folder value for uid: %s, resource: %s, id: %s, value: %s",
+                                  uid, resource, folder_id, value)
+
+        current_folders = self._get_user_column(uid, tbl.COL_USER_FOLDERS.name)
+
+        for section in current_folders.get(resource, {}).values():
+            if folder_id in section:
+                section[folder_id] = value
+                self._update_user_column(uid, tbl.COL_USER_FOLDERS.name, current_folders)
+                return current_folders
+
+        logger_user_profile.error("Folder key not found for uid: %s, resource: %s, id: %s", uid, resource, folder_id)
+        raise RequestException(err.ERROR_FOLDER_KEY_NOT_FOUND.m, err.ERROR_FOLDER_KEY_NOT_FOUND)
+
     def _get_user_column(self, uid: str, field_name: str) -> Any:
         """
         Generic method to get a specific field from user profile

app/utils/errors.py

@@ -181,6 +181,7 @@ def __init__(self, c:str, m:str, h:int = HTTPStatus.INTERNAL_SERVER_ERROR):
 
 #Preferences
 ERROR_PREF_UNKNOWN_SUB = E("S000340", "Subparent of User Settings does not exist", HTTPStatus.BAD_REQUEST)
+ERROR_FOLDER_KEY_NOT_FOUND = E("S000341", "Folder Key Not Found In Folders Preferences", HTTPStatus.NOT_FOUND)
 
 #Delegations
 ERROR_DELEGATION_NOT_FOUND = E("S000350", "Delegation Not Found", HTTPStatus.NOT_FOUND)

tests/test_calendar/test_ModuleCalendarEvent.py

@@ -119,13 +119,19 @@ def _require_event(uid, event_key):
 
     sources_mock.require_event.side_effect = _require_event
 
-    def _get_events(uid, start, end, search, calendar_key=None):
+    def _get_events(uid, start, end, search, calendar_key=None, subscribed_keys=None):
         if calendar_key is not None:
             source = sources.get(calendar_key)
             if source is None:
                 raise RequestException(error=err.ERROR_CALENDAR_NOT_FOUND)
+            if subscribed_keys is not None and calendar_key not in subscribed_keys:
+                return []
             return source.get_all_events(start, end, search)
-        return [e for s in sources.values() for e in s.get_all_events(start, end, search)]
+        return [
+            e for key, s in sources.items()
+            if subscribed_keys is None or key in subscribed_keys
+            for e in s.get_all_events(start, end, search)
+        ]
 
     sources_mock.get_all_events.side_effect = _get_events
     module._sources = sources_mock