ethyca-fides 2.69.1b1__py2.py3-none-any.whl → 2.69.1rc0__py2.py3-none-any.whl

fides/api/service/privacy_request/dsr_package/dsr_report_builder.py

@@ -1,18 +1,34 @@
+import copy
 import json
 import os
 import time as time_module
 import zipfile
-from collections import defaultdict
 from io import BytesIO
 from pathlib import Path
-from typing import TYPE_CHECKING, Any, Optional
+from typing import Any, Optional
 
 import jinja2
 from jinja2 import Environment, FileSystemLoader
 from loguru import logger
-
-from fides.api.schemas.policy import ActionType
+from sqlalchemy.orm import object_session
+
+from fides.api.models.privacy_request import PrivacyRequest
+from fides.api.service.privacy_request.dsr_package.dsr_data_preprocessor import (
+    DSRDataPreprocessor,
+)
+from fides.api.service.privacy_request.dsr_package.utils import map_privacy_request
+from fides.api.service.storage.util import (
+    _get_datasets_from_dsr_data,
+    create_attachment_info_dict,
+    format_attachment_size,
+    generate_attachment_url_from_storage_path,
+    is_attachment_field,
+    process_attachment_naming,
+    process_attachments_contextually,
+    resolve_directory_from_context,
+)
 from fides.api.util.storage_util import StorageJSONEncoder, format_size
+from fides.config import CONFIG
 
 DSR_DIRECTORY = Path(__file__).parent.resolve()
 
@@ -20,12 +36,9 @@ TEXT_COLOR = "#4A5568"
 HEADER_COLOR = "#FAFAFA"
 BORDER_COLOR = "#E2E8F0"
 
-if TYPE_CHECKING:
-    from fides.api.models.privacy_request import PrivacyRequest  # pragma: no cover
-
 
 # pylint: disable=too-many-instance-attributes
-class DsrReportBuilder:
+class DSRReportBuilder:
     """
     Manages populating HTML templates from the given data and adding the generated
     pages to a zip file in a way that the pages can be navigated between.
@@ -37,7 +50,7 @@ class DsrReportBuilder:
     - data/dataset_name/collection_name/item_index.html: the detail page for the item
     - attachments/index.html: the index page for the attachments
 
-    Args:
+        Args:
         privacy_request: the privacy request object
         dsr_data: the DSR data
     """
@@ -46,6 +59,7 @@ class DsrReportBuilder:
         self,
         privacy_request: "PrivacyRequest",
         dsr_data: dict[str, Any],
+        enable_streaming: bool = False,
     ):
         """
         Initializes the DSR report builder.
@@ -54,7 +68,6 @@ class DsrReportBuilder:
         jinja2.filters.FILTERS["pretty_print"] = lambda value, indent=4: json.dumps(
             value, indent=indent, cls=StorageJSONEncoder
         )
-
         # Initialize instance zip file variables
         self.baos = BytesIO()
 
@@ -70,15 +83,38 @@ class DsrReportBuilder:
             "text_color": TEXT_COLOR,
             "header_color": HEADER_COLOR,
             "border_color": BORDER_COLOR,
+            "download_link_ttl_days": self._get_download_link_ttl_days(),
+            "enable_streaming": enable_streaming,
         }
         self.main_links: dict[str, Any] = {}  # used to track the generated pages
 
+        # Process the DSR data for redaction
+        db = object_session(privacy_request)
+        if db is not None:
+            processor = DSRDataPreprocessor(db)
+            processed_dsr_data = processor.process_dsr_data(dsr_data)
+        else:
+            # Fallback if no database session available
+            processed_dsr_data = dsr_data
+
         # report data to populate the templates
-        self.request_data = _map_privacy_request(privacy_request)
-        self.dsr_data = dsr_data
+        self.request_data = map_privacy_request(privacy_request)
+        self.dsr_data = processed_dsr_data
+        self.enable_streaming = enable_streaming
+
+        # Track used filenames per dataset to prevent conflicts within the same dataset
+        # Maps dataset_name -> set of used filenames
+        self.used_filenames_per_dataset: dict[str, set[str]] = {}
 
-        # Track used filenames across all attachments
-        self.used_filenames: set[str] = set()
+        # Track attachments by their unique identifier to prevent duplicate processing
+        # Maps (download_url, file_name) -> unique_filename
+        self.processed_attachments: dict[tuple[str, str], str] = {}
+        # Track which attachments were processed as dataset attachments (not top-level)
+        self.dataset_processed_attachments: set[tuple[str, str]] = set()
+
+    def _get_download_link_ttl_days(self) -> int:
+        """Get the download link TTL in days from the security configuration."""
+        return int(CONFIG.security.subject_request_download_link_ttl_seconds / 86400)
 
     def _populate_template(
         self,
@@ -125,10 +161,6 @@ class DsrReportBuilder:
         """
         Generates a page for each collection in the dataset and an index page for the dataset.
         Tracks the generated links to build a root level index after each collection has been processed.
-
-        Args:
-            dataset_name: the name of the dataset to add
-            collections: the collections to add to the dataset
         """
         # track links to collection indexes
         collection_links = {}
@@ -148,34 +180,12 @@ class DsrReportBuilder:
             ),
         )
 
-    def _get_unique_filename(self, filename: str) -> str:
-        """
-        Generates a unique filename by appending a counter if the file already exists.
-        Now tracks filenames across all directories to ensure global uniqueness.
-
-        Args:
-            filename: The original filename
-
-        Returns:
-            A unique filename that won't conflict with existing files
-        """
-        base_name, extension = os.path.splitext(filename)
-        counter = 1
-        unique_filename = filename
-
-        # Check if file exists in used_filenames set
-        while unique_filename in self.used_filenames:
-            unique_filename = f"{base_name}_{counter}{extension}"
-            counter += 1
-
-        # Add the new filename to the set
-        self.used_filenames.add(unique_filename)
-        return unique_filename
-
+    # pylint: disable=too-many-branches
     def _write_attachment_content(
         self,
         attachments: list[dict[str, Any]],
         directory: str,
+        dataset_name: str = "attachments",
     ) -> dict[str, dict[str, str]]:
         """
         Processes attachments and returns a dictionary mapping filenames to their download URLs and sizes.
@@ -194,51 +204,150 @@ class DsrReportBuilder:
             if not isinstance(attachment, dict):
                 continue
 
-            file_name = attachment.get("file_name")
-            if not file_name:
-                logger.warning("Skipping attachment with no file name")
+            # Get or create the used_filenames set for this dataset
+            if dataset_name not in self.used_filenames_per_dataset:
+                self.used_filenames_per_dataset[dataset_name] = set()
+            used_filenames = self.used_filenames_per_dataset[dataset_name]
+
+            # Process attachment naming using shared utility
+            result = process_attachment_naming(
+                attachment, used_filenames, self.processed_attachments, dataset_name
+            )
+
+            if result is None:  # Skip if processing failed
                 continue
 
+            unique_filename, attachment_key = result
+            # Track that this attachment was processed as a dataset attachment
+            self.dataset_processed_attachments.add(attachment_key)
+
+            # Format file size using shared utility
+            file_size = format_attachment_size(attachment.get("file_size"))
+
+            # Determine the actual directory for this attachment based on its context
+            actual_directory = resolve_directory_from_context(attachment, directory)
+
+            # Generate attachment URL using shared utility with actual storage path
             download_url = attachment.get("download_url")
             if not download_url:
-                logger.warning("Skipping attachment with no download URL")
                 continue
 
-            file_size = attachment.get("file_size")
-            if isinstance(file_size, (int, float)):
-                file_size = format_size(float(file_size))
-            else:
-                file_size = "Unknown"
+            attachment_url = generate_attachment_url_from_storage_path(
+                download_url,
+                unique_filename,
+                actual_directory,  # This is the base_path where the file will be stored
+                actual_directory,  # This is the HTML template directory
+                self.enable_streaming,
+            )
 
-            # Get a unique filename to prevent duplicates
-            unique_filename = self._get_unique_filename(file_name)
+            # Create attachment info dictionary using shared utility
+            file_name = attachment.get("file_name")
+            if not file_name:
+                continue
 
-            # Add to processed attachments
-            processed_attachments.append(
-                (unique_filename, {"url": download_url, "size": file_size})
+            attachment_info = create_attachment_info_dict(
+                attachment_url, file_size, file_name
             )
 
+            processed_attachments.append((unique_filename, attachment_info))
+
         # Convert list of tuples to dictionary
         return dict(processed_attachments)
 
+    def _get_processed_attachments_list(
+        self, data: dict[str, Any]
+    ) -> list[dict[str, Any]]:
+        """Get all processed attachments using shared contextual logic.
+
+        Args:
+            data: The DSR data dictionary
+
+        Returns:
+            List of processed attachment dictionaries
+        """
+        # Create temporary sets for compatibility with the shared function
+        used_filenames_data = set()
+        used_filenames_attachments = set()
+
+        # Populate the temporary sets from our per-dataset tracking
+        for dataset_name, filenames in self.used_filenames_per_dataset.items():
+            if dataset_name == "attachments":
+                used_filenames_attachments.update(filenames)
+            else:
+                used_filenames_data.update(filenames)
+
+        processed_attachments_list = process_attachments_contextually(
+            data,
+            used_filenames_data,
+            used_filenames_attachments,
+            self.processed_attachments,
+            enable_streaming=self.enable_streaming,
+        )
+
+        # Trust the contextual processing completely - it already correctly determines
+        # context based on the attachment's location in the DSR data structure
+        filtered_list = processed_attachments_list
+
+        return filtered_list
+
+    def _generate_attachment_url_from_index(
+        self, context: dict[str, Any], unique_filename: str
+    ) -> str:
+        """Generate the correct URL from attachments/index.html to an attachment file.
+
+        Args:
+            context: The attachment context information
+            unique_filename: The unique filename of the attachment
+
+        Returns:
+            The relative URL from attachments/index.html to the attachment file
+        """
+        if context.get("type") == "top_level":
+            # Top-level attachments are in the same directory as the index
+            return unique_filename
+        if context.get("type") in ["direct", "nested"]:
+            # Dataset attachments are in data/dataset/collection/attachments/
+            # From attachments/index.html, we need to go to ../data/dataset/collection/attachments/filename
+            dataset = context.get("dataset", "unknown")
+            collection = context.get("collection", "unknown")
+            return f"../data/{dataset}/{collection}/attachments/{unique_filename}"
+        # Fallback for other cases - return just the filename
+        return unique_filename
+
+    def _create_attachment_info_with_corrected_url(
+        self, attachment_info: dict[str, str], correct_url: str
+    ) -> dict[str, str]:
+        """Create attachment info with corrected URL.
+
+        Args:
+            attachment_info: The original attachment info
+            correct_url: The corrected URL
+
+        Returns:
+            New attachment info with corrected URL and safe_url
+        """
+        corrected_attachment_info = attachment_info.copy()
+        corrected_attachment_info["url"] = correct_url
+        corrected_attachment_info["safe_url"] = correct_url
+        return corrected_attachment_info
+
     def _add_collection(
-        self, rows: list[dict[str, Any]], dataset_name: str, collection_name: str
+        self,
+        rows: list[dict[str, Any]],
+        dataset_name: str,
+        collection_name: str,
     ) -> None:
         """
         Adds a collection to the zip file.
-
-        Args:
-            rows: the rows to add to the collection
-            dataset_name: the name of the dataset to add the collection to
-            collection_name: the name of the collection to add
         """
         items_content = []
 
-        for index, collection_item in enumerate(rows, 1):
-            # Create a copy of the item data to avoid modifying the original
-            item_data = collection_item.copy()
+        for item_index, collection_item in enumerate(rows, 1):
+            # Create a deep copy of the item data to avoid modifying the original DSR data
+            # This ensures the comprehensive attachments index can access unmodified attachments
+            item_data = copy.deepcopy(collection_item)
 
-            # Process any attachments in the item
+            # Process any attachments in the item - First check for direct attachments key
             if "attachments" in item_data and isinstance(
                 item_data["attachments"], list
             ):
@@ -246,15 +355,40 @@ class DsrReportBuilder:
                 attachment_links = self._write_attachment_content(
                     item_data["attachments"],
                     f"data/{dataset_name}/{collection_name}",
+                    dataset_name,
                 )
                 # Add the attachment URLs to the item data
                 item_data["attachments"] = attachment_links
-
-            # Add item content to the list
+            else:
+                # Check for nested attachment fields (ManualTask format)
+                attachment_fields_found = []
+                for field_name, field_value in item_data.items():
+                    if isinstance(field_value, list) and field_value:
+                        # Check if this field contains attachment-like data
+                        first_item = field_value[0]
+                        if isinstance(first_item, dict) and all(
+                            key in first_item
+                            for key in ["file_name", "download_url", "file_size"]
+                        ):
+                            attachment_fields_found.append(field_name)
+
+                            # Process attachments and get their URLs
+                            attachment_links = self._write_attachment_content(
+                                field_value,
+                                f"data/{dataset_name}/{collection_name}",
+                                dataset_name,
+                            )
+
+                            # Replace the field value with processed attachment links
+                            item_data[field_name] = attachment_links
+
+            # Add item content to the list with item heading
+            # Field names are already redacted in the processed data
+            item_heading = f"{collection_name} (item #{item_index})"
             items_content.append(
                 {
-                    "index": index,
-                    "heading": f"{collection_name} (item #{index})",
+                    "index": item_index,
+                    "heading": item_heading,
                     "data": item_data,
                 }
             )
@@ -294,34 +428,67 @@ class DsrReportBuilder:
             ),
         )
 
-    def _get_datasets_from_dsr_data(self) -> dict[str, Any]:
+    def _add_comprehensive_attachments_index(self) -> None:
         """
-        Returns the datasets from the DSR data.
+        Creates a comprehensive attachments index that includes ALL attachments
+        from all datasets and top-level attachments, with links pointing to their
+        actual storage locations.
         """
-        # pre-process data to split the dataset:collection keys
-        datasets: dict[str, Any] = defaultdict(lambda: defaultdict(list))
-        for key, rows in self.dsr_data.items():
-
-            # we handle attachments separately
-            if key == "attachments":
+        # Get all processed attachments using shared logic on original DSR data
+        processed_attachments_list = self._get_processed_attachments_list(self.dsr_data)
+
+        # Create a comprehensive attachment links dictionary with deduplication
+        all_attachment_links = {}
+        seen_attachment_keys = set()
+
+        for processed_attachment in processed_attachments_list:
+            unique_filename = processed_attachment["unique_filename"]
+            attachment_info = processed_attachment["attachment_info"]
+            context = processed_attachment["context"]
+            attachment = processed_attachment["attachment"]
+
+            # Create a unique key based on download_url to avoid duplicates
+            attachment_key = attachment.get("download_url")
+            if attachment_key in seen_attachment_keys:
                 continue
+            seen_attachment_keys.add(attachment_key)
 
-            parts = key.split(":", 1)
-            if len(parts) > 1:
-                dataset_name, collection_name = parts
+            # Generate the correct URL based on streaming settings
+            if self.enable_streaming:
+                # For streaming mode, use local attachment references
+                correct_url = self._generate_attachment_url_from_index(
+                    context, unique_filename
+                )
+            else:
+                # For non-streaming mode, use original download URLs
+                correct_url = attachment.get("download_url", unique_filename)
+
+            # Create a descriptive key that includes the source location
+            if context.get("type") == "top_level":
+                key = f"Top-level: {unique_filename}"
+            elif context.get("type") in ["direct", "nested"]:
+                dataset = context.get("dataset", "unknown")
+                collection = context.get("collection", "unknown")
+                key = f"{dataset}/{collection}: {unique_filename}"
             else:
-                for row in rows:
-                    if "system_name" in row:
-                        dataset_name = row["system_name"]
-                        collection_name = parts[0]
-                        break
-                else:
-                    dataset_name = "manual"
-                    collection_name = parts[0]
+                key = unique_filename
 
-            datasets[dataset_name][collection_name].extend(rows)
+            # Create new attachment info with the correct URL
+            corrected_attachment_info = self._create_attachment_info_with_corrected_url(
+                attachment_info, correct_url
+            )
+            all_attachment_links[key] = corrected_attachment_info
 
-        return datasets
+        # Generate comprehensive attachments index page
+        self._add_file(
+            "attachments/index.html",
+            self._populate_template(
+                "templates/attachments_index.html",
+                "All Attachments",
+                "All files attached to this privacy request",
+                all_attachment_links,
+            ),
+        )
 
     def generate(self) -> BytesIO:
         """
@@ -343,7 +510,7 @@ class DsrReportBuilder:
             )
 
             # pre-process data to split the dataset:collection keys
-            datasets: dict[str, Any] = self._get_datasets_from_dsr_data()
+            datasets: dict[str, Any] = _get_datasets_from_dsr_data(self.dsr_data)
 
             # Sort datasets alphabetically, excluding special cases
             regular_datasets = [
@@ -358,12 +525,35 @@ class DsrReportBuilder:
             # Add Additional Data if it exists
             if "dataset" in datasets:
                 self._add_dataset("dataset", datasets["dataset"])
+                # Use a more friendly name for the link but keep the dataset name for the path
                 self.main_links["Additional Data"] = "data/dataset/index.html"
 
-            # Add Additional Attachments last if it exists
-            if "attachments" in self.dsr_data:
-                self._add_attachments(self.dsr_data["attachments"])
-                self.main_links["Additional Attachments"] = "attachments/index.html"
+            # Add comprehensive attachments index that includes ALL attachments
+            # Check if there are any attachments at all (top-level or in datasets)
+            has_top_level_attachments = (
+                "attachments" in self.dsr_data and self.dsr_data["attachments"]
+            )
+            has_dataset_attachments = any(
+                any(
+                    "attachments" in item
+                    or any(
+                        is_attachment_field(field_value)
+                        for field_value in item.values()
+                        if isinstance(field_value, list)
+                    )
+                    for item in collection_items
+                    if isinstance(item, dict)
+                )
+                for collection in datasets.values()
+                if isinstance(collection, dict)
+                for collection_items in collection.values()
+                if isinstance(collection_items, list)
+            )
+            has_attachments = has_top_level_attachments or has_dataset_attachments
+
+            if has_attachments:
+                self._add_comprehensive_attachments_index()
+                self.main_links["All Attachments"] = "attachments/index.html"
 
             # create the main index once all the datasets have been added
             self._add_file(
@@ -387,27 +577,3 @@ class DsrReportBuilder:
             "DSR report generation complete."
         )
         return self.baos
-
-
-def _map_privacy_request(privacy_request: "PrivacyRequest") -> dict[str, Any]:
-    """Creates a map with a subset of values from the privacy request"""
-    request_data: dict[str, Any] = {}
-    request_data["id"] = privacy_request.id
-
-    action_type: Optional[ActionType] = privacy_request.policy.get_action_type()
-    if action_type:
-        request_data["type"] = action_type.value
-
-    request_data["identity"] = {
-        key: value
-        for key, value in privacy_request.get_persisted_identity()
-        .labeled_dict(include_default_labels=True)
-        .items()
-        if value["value"] is not None
-    }
-
-    if privacy_request.requested_at:
-        request_data["requested_at"] = privacy_request.requested_at.strftime(
-            "%m/%d/%Y %H:%M %Z"
-        )
-    return request_data

fides/api/service/privacy_request/dsr_package/templates/attachments_index.html

@@ -14,7 +14,9 @@
                </a>
             </div>
             <h1>Attachments</h1>
-            <p class="expiration-notice">Note: All download links will expire in 7 days.</p>
+            {% if not enable_streaming %}
+            <p class="expiration-notice">Note: All download links will expire in {{ download_link_ttl_days }} days.</p>
+            {% endif %}
             <div class="table table-hover">
                <div class="table-row">
                   <div class="table-cell" style="text-align: left;">File Name</div>
@@ -22,7 +24,7 @@
                </div>
                {% for name, info in data.items() %}
                <a href="{{ info.url }}" class="table-row" target="_blank">
-                  <div class="table-cell" style="text-align: left;">{{ name }}</div>
+                  <div class="table-cell" style="text-align: left;">{% if enable_streaming %}{{ name }}{% else %}{{ info.original_name }}{% endif %}</div>
                   <div class="table-cell" style="text-align: left;">{{ info.size }}</div>
                </a>
                {% endfor %}

fides/api/service/privacy_request/dsr_package/templates/collection_index.html

@@ -35,7 +35,9 @@
                         {% endif %}
 
                         {% if _is_attachment_block %}
-                           <p class="expiration-notice">Note: All download links will expire in 7 days.</p>
+                           {% if not enable_streaming %}
+                           <p class="expiration-notice">Note: All download links will expire in {{ download_link_ttl_days }} days.</p>
+                           {% endif %}
                            <div class="table table-hover">
                               <div class="table-row">
                                  <div class="table-cell" style="text-align: left;">File Name</div>

fides/api/service/privacy_request/dsr_package/templates/dataset_index.html

@@ -27,4 +27,4 @@
          </div>
       </div>
    </body>
-</html>
+</html>