|
| 1 | +from django.conf import settings |
| 2 | +from django.contrib import messages |
| 3 | +from django.http import HttpRequest, HttpResponse |
| 4 | +from django.utils.safestring import mark_safe |
| 5 | +from django.utils.translation import gettext_lazy as _ |
| 6 | + |
| 7 | + |
| 8 | +class ProductAnnouncementManager: |
| 9 | + """Base class for centralized helper methods""" |
| 10 | + |
| 11 | + base_try_free = "Try today for free" |
| 12 | + base_contact_us = "email us at" |
| 13 | + base_email_address = "hello@defectdojo.com" |
| 14 | + ui_try_free = f'<b><a href="https://cloud.defectdojo.com/accounts/onboarding/plg_step_1" target="_blank">{base_try_free}</a></b>' |
| 15 | + ui_contact_us = f'{base_contact_us} <b><a href="mailto:{base_email_address}">{base_email_address}</a></b>' |
| 16 | + ui_outreach = f"{ui_try_free} or {ui_contact_us}." |
| 17 | + api_outreach = f"{base_try_free} or {base_contact_us} {base_email_address}" |
| 18 | + |
| 19 | + def __init__( |
| 20 | + self, |
| 21 | + *args: list, |
| 22 | + request: HttpRequest = None, |
| 23 | + response: HttpResponse = None, |
| 24 | + response_data: dict = {}, |
| 25 | + **kwargs: dict, |
| 26 | + ) -> None: |
| 27 | + """Skip all this if the CREATE_CLOUD_BANNER is not set""" |
| 28 | + if not settings.CREATE_CLOUD_BANNER: |
| 29 | + return |
| 30 | + # Fill in the vars if the were supplied correctly |
| 31 | + if request is not None and isinstance(request, HttpRequest): |
| 32 | + self._add_django_message( |
| 33 | + request=request, |
| 34 | + message=mark_safe(f"{self.base_message} {self.ui_outreach}"), |
| 35 | + ) |
| 36 | + elif response is not None and isinstance(response, HttpResponse): |
| 37 | + response.data = self._add_api_response_key( |
| 38 | + message=f"{self.base_message} {self.api_outreach}", data=response.data |
| 39 | + ) |
| 40 | + elif response_data != {} and isinstance(response_data, dict): |
| 41 | + response_data = self._add_api_response_key( |
| 42 | + message=f"{self.base_message} {self.api_outreach}", data=response_data |
| 43 | + ) |
| 44 | + else: |
| 45 | + msg = "At least one of request, response, or response_data must be supplied" |
| 46 | + raise ValueError(msg) |
| 47 | + |
| 48 | + def _add_django_message(self, request: HttpRequest, message: str) -> None: |
| 49 | + """Add a message to the UI""" |
| 50 | + messages.add_message( |
| 51 | + request=request, |
| 52 | + level=messages.INFO, |
| 53 | + message=_(message), |
| 54 | + extra_tags="alert-info", |
| 55 | + ) |
| 56 | + |
| 57 | + def _add_api_response_key(self, message: str, data: dict) -> dict: |
| 58 | + """Update the response data in place""" |
| 59 | + if (feature_list := data.get("pro")) is not None and isinstance( |
| 60 | + feature_list, |
| 61 | + list, |
| 62 | + ): |
| 63 | + data["pro"] = [*feature_list, _(message)] |
| 64 | + else: |
| 65 | + data["pro"] = [_(message)] |
| 66 | + return data |
| 67 | + |
| 68 | + |
| 69 | +class ErrorPageProductAnnouncement(ProductAnnouncementManager): |
| 70 | + def __init__( |
| 71 | + self, |
| 72 | + *args: list, |
| 73 | + request: HttpRequest = None, |
| 74 | + response: HttpResponse = None, |
| 75 | + response_data: dict = {}, |
| 76 | + **kwargs: dict, |
| 77 | + ) -> None: |
| 78 | + self.base_message = "Pro comes with support." |
| 79 | + super().__init__( |
| 80 | + *args, |
| 81 | + request=request, |
| 82 | + response=response, |
| 83 | + response_data=response_data, |
| 84 | + **kwargs, |
| 85 | + ) |
| 86 | + |
| 87 | + |
| 88 | +class LargeScanSizeProductAnnouncement(ProductAnnouncementManager): |
| 89 | + def __init__( |
| 90 | + self, |
| 91 | + *args: list, |
| 92 | + request: HttpRequest = None, |
| 93 | + response: HttpResponse = None, |
| 94 | + response_data: dict = {}, |
| 95 | + duration: float = 0.0, # seconds |
| 96 | + **kwargs: dict, |
| 97 | + ) -> None: |
| 98 | + self.trigger_threshold = 60.0 |
| 99 | + minute_duration = round(duration / 60.0) |
| 100 | + self.base_message = f"Your import took about {minute_duration} minute(s). Did you know Pro has async imports?" |
| 101 | + if duration > self.trigger_threshold: |
| 102 | + super().__init__( |
| 103 | + *args, |
| 104 | + request=request, |
| 105 | + response=response, |
| 106 | + response_data=response_data, |
| 107 | + **kwargs, |
| 108 | + ) |
| 109 | + |
| 110 | + |
| 111 | +class LongRunningRequestProductAnnouncement(ProductAnnouncementManager): |
| 112 | + def __init__( |
| 113 | + self, |
| 114 | + *args: list, |
| 115 | + request: HttpRequest = None, |
| 116 | + response: HttpResponse = None, |
| 117 | + response_data: dict = {}, |
| 118 | + duration: float = 0.0, # seconds |
| 119 | + **kwargs: dict, |
| 120 | + ) -> None: |
| 121 | + self.trigger_threshold = 15.0 |
| 122 | + self.base_message = "Did you know, Pro has a new UI and is performance tested up to 22M findings?" |
| 123 | + if duration > self.trigger_threshold: |
| 124 | + super().__init__( |
| 125 | + *args, |
| 126 | + request=request, |
| 127 | + response=response, |
| 128 | + response_data=response_data, |
| 129 | + **kwargs, |
| 130 | + ) |
| 131 | + |
| 132 | + |
| 133 | +class ScanTypeProductAnnouncement(ProductAnnouncementManager): |
| 134 | + supported_scan_types = [ |
| 135 | + "Snyk Scan", |
| 136 | + "Semgrep JSON Report", |
| 137 | + "Burp Enterprise Scan", |
| 138 | + "AWS Security Hub Scan", |
| 139 | + "Probely Scan", # No OS support here |
| 140 | + "Checkmarx One Scan", |
| 141 | + "Tenable Scan", |
| 142 | + "SonarQube Scan", |
| 143 | + "Dependency Track Finding Packaging Format (FPF) Export", |
| 144 | + "Wiz Scan", |
| 145 | + ] |
| 146 | + |
| 147 | + def __init__( |
| 148 | + self, |
| 149 | + *args: list, |
| 150 | + request: HttpRequest = None, |
| 151 | + response: HttpResponse = None, |
| 152 | + response_data: dict = {}, |
| 153 | + scan_type: str = None, |
| 154 | + **kwargs: dict, |
| 155 | + ) -> None: |
| 156 | + self.base_message = ( |
| 157 | + f"Did you know, Pro has an automated no-code connector for {scan_type}?" |
| 158 | + ) |
| 159 | + if scan_type in self.supported_scan_types: |
| 160 | + super().__init__( |
| 161 | + *args, |
| 162 | + request=request, |
| 163 | + response=response, |
| 164 | + response_data=response_data, |
| 165 | + **kwargs, |
| 166 | + ) |
0 commit comments