igs-slm 0.1.4b0__py3-none-any.whl → 0.1.5b1__py3-none-any.whl

slm/settings/templates.py

@@ -1,29 +1,35 @@
 from jinja2 import select_autoescape
 
-TEMPLATES = [
-    {
-        "BACKEND": "django.template.backends.django.DjangoTemplates",
-        "APP_DIRS": True,
-        "OPTIONS": {
-            "context_processors": [
-                "django.template.context_processors.debug",
-                "django.template.context_processors.request",
-                "django.contrib.auth.context_processors.auth",
-                "django.contrib.messages.context_processors.messages",
-            ],
-            "builtins": ["slm.templatetags.slm"],
+from slm.settings import set_default
+
+set_default(
+    "TEMPLATES",
+    [
+        {
+            "BACKEND": "django.template.backends.django.DjangoTemplates",
+            "APP_DIRS": True,
+            "OPTIONS": {
+                "context_processors": [
+                    "slm.context.globals",
+                    "django.template.context_processors.debug",
+                    "django.template.context_processors.request",
+                    "django.contrib.auth.context_processors.auth",
+                    "django.contrib.messages.context_processors.messages",
+                ],
+                "builtins": ["slm.templatetags.slm"],
+            },
         },
-    },
-    {
-        "BACKEND": "django.template.backends.jinja2.Jinja2",
-        "APP_DIRS": True,
-        "OPTIONS": {
-            "autoescape": select_autoescape(
-                disabled_extensions=("log",),
-                default_for_string=True,
-                default=True,
-            ),
-            "environment": "slm.templatetags.jinja2.compat",
+        {
+            "BACKEND": "django.template.backends.jinja2.Jinja2",
+            "APP_DIRS": True,
+            "OPTIONS": {
+                "autoescape": select_autoescape(
+                    disabled_extensions=("log",),
+                    default_for_string=True,
+                    default=True,
+                ),
+                "environment": "slm.templatetags.jinja2.compat",
+            },
         },
-    },
-]
+    ],
+)

slm/settings/uploads.py

@@ -1,8 +1,36 @@
-from slm.settings import get_setting, set_default
+from slm.settings import env as settings_environment
+from slm.settings import get_setting, set_default, slm_path_mk_dirs_must_exist
 
-MEDIA_URL = "/media/"
-set_default("MEDIA_ROOT", get_setting("SITE_DIR") / "media")
+env = settings_environment()
+
+set_default("MEDIA_URL", "/media/")
+
+DEBUG = get_setting("DEBUG", False)
+
+MEDIA_ROOT = env(
+    "MEDIA_ROOT",
+    slm_path_mk_dirs_must_exist,
+    default=get_setting("MEDIA_ROOT", get_setting("BASE_DIR") / "media"),
+)
+
+FILE_UPLOAD_MAX_MEMORY_SIZE = env(
+    "FILE_UPLOAD_MAX_MEMORY_SIZE",
+    int,
+    default=get_setting("FILE_UPLOAD_MAX_MEMORY_SIZE", 2621440),
+)
 
 # set RWX for Owner and Group for any uploaded files
-FILE_UPLOAD_PERMISSIONS = 0o770
-FILE_UPLOAD_DIRECTORY_PERMISSIONS = 0o770
+FILE_UPLOAD_PERMISSIONS = env(
+    "FILE_UPLOAD_PERMISSIONS",
+    int,
+    default=get_setting("FILE_UPLOAD_PERMISSIONS", 0o664 if DEBUG else 0o660),
+)
+FILE_UPLOAD_DIRECTORY_PERMISSIONS = env(
+    "FILE_UPLOAD_DIRECTORY_PERMISSIONS",
+    int,
+    default=get_setting("FILE_UPLOAD_DIRECTORY_PERMISSIONS", 0o775 if DEBUG else 0o770),
+)
+
+FILE_UPLOAD_TEMP_DIR = env(
+    "FILE_UPLOAD_TEMP_DIR", str, default=get_setting("FILE_UPLOAD_TEMP_DIR", None)
+)

slm/settings/urls.py

@@ -38,16 +38,6 @@ APIS dictionary. For example the slm.map app extends the public API like so:
         }
     }
 
-Other third party apps may be included at customizable mount points by
-providing a settings.SLM_URL_MOUNTS list. For example to include your app at
-the myapp path you might do this:
-
-.. code-block: python
-
-    SLM_URL_MOUNTS = [
-        ('myapp/', 'myapp.urls')
-    ]
-
 """
 
 from importlib import import_module
@@ -80,7 +70,11 @@ def bring_in_urls(urlpatterns):
 
     for app in reversed(settings.INSTALLED_APPS):
         try:
-            url_module = import_module(f"{app}.urls")
+            url_module_str = f"{app}.urls"
+            url_module = import_module(url_module_str)
+            slm_include = getattr(url_module, "SLM_INCLUDE", False)
+            if not slm_include:
+                continue
             api = getattr(url_module, "APIS", None)
             if api:
                 for api, endpoints in api.items():
@@ -95,6 +89,7 @@ def bring_in_urls(urlpatterns):
                                 endpoint[0] if len(endpoint) < 3 else endpoint[2]
                             ),
                         )
+            urlpatterns.insert(0, path("", include(url_module_str)))
 
         except ImportError:
             if app in {"slm", "slm.map", "network_map", "igs_ext"}:
@@ -117,7 +112,7 @@ urlpatterns = [
     path("", include("slm.urls")),
 ]
 
-if getattr(settings, "DJANGO_DEBUG_TOOLBAR", False):
+if getattr(settings, "SLM_DEBUG_TOOLBAR", False):
     urlpatterns.append(path("__debug__/", include("debug_toolbar.urls")))
 
 # allows us to use static files like images

slm/settings/validation.py

@@ -11,6 +11,7 @@ The format of SLM_DATA_VALIDATORS is
 }
 """
 
+from slm.settings import set_default
 from slm.validators import (
     ActiveEquipmentValidator,
     ARPValidator,
@@ -24,173 +25,172 @@ from slm.validators import (
 
 # toggling this off will prevent any validation configured to block edit saves
 # from doing so - instead flags will be issued.
-SLM_VALIDATION_BYPASS_BLOCK = False
+set_default("SLM_VALIDATION_BYPASS_BLOCK", False)
 
 # do not allow a log to be published without these sections
-SLM_REQUIRED_SECTIONS_TO_PUBLISH = [
-    "siteform",
-    "siteidentification",
-    "sitelocation",
-    "sitereceiver",
-    "siteantenna",
-    # 'sitesurveyedlocalties',
-    # 'sitefrequencystandard',
-    # 'sitecollocation',
-    # 'sitehumiditysensor',
-    # 'sitepressuresensor',
-    # 'sitetemperaturesensor',
-    # 'sitewatervaporradiometer',
-    # 'siteotherinstrumentation',
-    # 'siteradiointerferences',
-    # 'sitemultipathsources',
-    # 'sitesignalobstructions',
-    # 'sitelocalepisodiceffects',
-    "siteoperationalcontact",
-    # 'siteresponsibleagency',
-    # 'sitemoreinformation'
-]
+set_default(
+    "SLM_REQUIRED_SECTIONS_TO_PUBLISH",
+    [
+        "siteform",
+        "siteidentification",
+        "sitelocation",
+        "sitereceiver",
+        "siteantenna",
+        # 'sitesurveyedlocalties',
+        # 'sitefrequencystandard',
+        # 'sitecollocation',
+        # 'sitehumiditysensor',
+        # 'sitepressuresensor',
+        # 'sitetemperaturesensor',
+        # 'sitewatervaporradiometer',
+        # 'siteotherinstrumentation',
+        # 'siteradiointerferences',
+        # 'sitemultipathsources',
+        # 'sitesignalobstructions',
+        # 'sitelocalepisodiceffects',
+        "siteoperationalcontact",
+        # 'siteresponsibleagency',
+        # 'sitemoreinformation'
+    ],
+)
 
 # the model field to validator map
-SLM_DATA_VALIDATORS = {
-    "slm.SiteIdentification": {
-        "site_name": [FieldRequired()],
-        "fracture_spacing": [FieldRequired(desired=True), EnumValidator()],
-        "iers_domes_number": [FieldRequired()],
-        "date_installed": [FieldRequired()],
-    },
-    "slm.SiteLocation": {
-        "city": [FieldRequired()],
-        "country": [FieldRequired(), EnumValidator()],
-        "tectonic": [EnumValidator()],
-        "xyz": [FieldRequired()],
-        "llh": [FieldRequired()],
-    },
-    "slm.SiteReceiver": {
-        "receiver_type": [VerifiedEquipmentValidator(), ActiveEquipmentValidator()],
-        "satellite_system": [NonEmptyValidator()],
-        "serial_number": [FieldRequired()],
-        "firmware": [FieldRequired()],
-        "installed": [FieldRequired(), TimeRangeValidator(end_field="removed")],
-        "removed": [
-            TimeRangeValidator(start_field="installed"),
-            TimeRangeBookendValidator(),
-        ],
-    },
-    "slm.SiteAntenna": {
-        "antenna_type": [VerifiedEquipmentValidator(), ActiveEquipmentValidator()],
-        "radome_type": [VerifiedEquipmentValidator(), ActiveEquipmentValidator()],
-        "serial_number": [FieldRequired()],
-        "reference_point": [FieldRequired(), ARPValidator(), EnumValidator()],
-        "installed": [FieldRequired(), TimeRangeValidator(end_field="removed")],
-        "removed": [
-            TimeRangeValidator(start_field="installed"),
-            TimeRangeBookendValidator(),
-        ],
-        "marker_une": [FieldRequired(allow_legacy_nulls=True)],
-        "alignment": [FieldRequired(allow_legacy_nulls=True)],
-    },
-    "slm.SiteSurveyedLocalTies": {
-        "name": [FieldRequired()],
-        "measured": [FieldRequired(allow_legacy_nulls=True)],
-        "diff_xyz": [FieldRequired(allow_legacy_nulls=True)],
-    },
-    "slm.SiteFrequencyStandard": {
-        "standard_type": [FieldRequired(), EnumValidator()],
-        "effective_start": [
-            FieldRequired(),
-            TimeRangeValidator(end_field="effective_end"),
-        ],
-        "effective_end": [TimeRangeValidator(start_field="effective_start")],
-    },
-    "slm.SiteCollocation": {
-        "instrument_type": [FieldRequired()],
-        "status": [FieldRequired(allow_legacy_nulls=True), EnumValidator()],
-        "effective_start": [
-            FieldRequired(),
-            TimeRangeValidator(end_field="effective_end"),
-        ],
-        "effective_end": [TimeRangeValidator(start_field="effective_start")],
-    },
-    "slm.SiteHumiditySensor": {
-        "model": [FieldRequired()],
-        "manufacturer": [FieldRequired()],
-        "height_diff": [FieldRequired(allow_legacy_nulls=True)],
-        "effective_start": [TimeRangeValidator(end_field="effective_end")],
-        "effective_end": [TimeRangeValidator(start_field="effective_start")],
-        "aspiration": [FieldRequired(allow_legacy_nulls=True), EnumValidator()],
-    },
-    "slm.SitePressureSensor": {
-        "model": [FieldRequired()],
-        "manufacturer": [FieldRequired()],
-        "height_diff": [FieldRequired(allow_legacy_nulls=True)],
-        "effective_start": [TimeRangeValidator(end_field="effective_end")],
-        "effective_end": [TimeRangeValidator(start_field="effective_start")],
-    },
-    "slm.SiteTemperatureSensor": {
-        "model": [FieldRequired()],
-        "manufacturer": [FieldRequired()],
-        "height_diff": [FieldRequired(allow_legacy_nulls=True)],
-        "effective_start": [TimeRangeValidator(end_field="effective_end")],
-        "effective_end": [TimeRangeValidator(start_field="effective_start")],
-        "aspiration": [FieldRequired(allow_legacy_nulls=True), EnumValidator()],
+set_default(
+    "SLM_DATA_VALIDATORS",
+    {
+        "slm.SiteIdentification": {
+            "site_name": [FieldRequired()],
+            "fracture_spacing": [FieldRequired(desired=True), EnumValidator()],
+            "iers_domes_number": [FieldRequired()],
+            "date_installed": [FieldRequired()],
+        },
+        "slm.SiteLocation": {
+            "city": [FieldRequired()],
+            "country": [FieldRequired(), EnumValidator()],
+            "tectonic": [EnumValidator()],
+            "xyz": [FieldRequired()],
+            "llh": [FieldRequired()],
+        },
+        "slm.SiteReceiver": {
+            "receiver_type": [VerifiedEquipmentValidator(), ActiveEquipmentValidator()],
+            "satellite_system": [NonEmptyValidator()],
+            "serial_number": [FieldRequired()],
+            "firmware": [FieldRequired()],
+            "installed": [FieldRequired(), TimeRangeValidator(end_field="removed")],
+            "removed": [
+                TimeRangeValidator(start_field="installed"),
+                TimeRangeBookendValidator(),
+            ],
+        },
+        "slm.SiteAntenna": {
+            "antenna_type": [VerifiedEquipmentValidator(), ActiveEquipmentValidator()],
+            "radome_type": [VerifiedEquipmentValidator(), ActiveEquipmentValidator()],
+            "serial_number": [FieldRequired()],
+            "reference_point": [FieldRequired(), ARPValidator(), EnumValidator()],
+            "installed": [FieldRequired(), TimeRangeValidator(end_field="removed")],
+            "removed": [
+                TimeRangeValidator(start_field="installed"),
+                TimeRangeBookendValidator(),
+            ],
+            "marker_une": [FieldRequired(allow_legacy_nulls=True)],
+            "alignment": [FieldRequired(allow_legacy_nulls=True)],
+        },
+        "slm.SiteSurveyedLocalTies": {
+            "name": [FieldRequired()],
+            "measured": [FieldRequired(allow_legacy_nulls=True)],
+            "diff_xyz": [FieldRequired(allow_legacy_nulls=True)],
+        },
+        "slm.SiteFrequencyStandard": {
+            "standard_type": [FieldRequired(), EnumValidator()],
+            "effective_start": [
+                FieldRequired(),
+                TimeRangeValidator(end_field="effective_end"),
+            ],
+            "effective_end": [TimeRangeValidator(start_field="effective_start")],
+        },
+        "slm.SiteCollocation": {
+            "instrument_type": [FieldRequired()],
+            "status": [FieldRequired(allow_legacy_nulls=True), EnumValidator()],
+            "effective_start": [
+                FieldRequired(),
+                TimeRangeValidator(end_field="effective_end"),
+            ],
+            "effective_end": [TimeRangeValidator(start_field="effective_start")],
+        },
+        "slm.SiteHumiditySensor": {
+            "model": [FieldRequired()],
+            "manufacturer": [FieldRequired()],
+            "height_diff": [FieldRequired(allow_legacy_nulls=True)],
+            "effective_start": [TimeRangeValidator(end_field="effective_end")],
+            "effective_end": [TimeRangeValidator(start_field="effective_start")],
+            "aspiration": [FieldRequired(allow_legacy_nulls=True), EnumValidator()],
+        },
+        "slm.SitePressureSensor": {
+            "model": [FieldRequired()],
+            "manufacturer": [FieldRequired()],
+            "height_diff": [FieldRequired(allow_legacy_nulls=True)],
+            "effective_start": [TimeRangeValidator(end_field="effective_end")],
+            "effective_end": [TimeRangeValidator(start_field="effective_start")],
+        },
+        "slm.SiteTemperatureSensor": {
+            "model": [FieldRequired()],
+            "manufacturer": [FieldRequired()],
+            "height_diff": [FieldRequired(allow_legacy_nulls=True)],
+            "effective_start": [TimeRangeValidator(end_field="effective_end")],
+            "effective_end": [TimeRangeValidator(start_field="effective_start")],
+            "aspiration": [FieldRequired(allow_legacy_nulls=True), EnumValidator()],
+        },
+        "slm.SiteWaterVaporRadiometer": {
+            "model": [FieldRequired()],
+            "manufacturer": [FieldRequired()],
+            "distance_to_antenna": [FieldRequired(allow_legacy_nulls=True)],
+            "height_diff": [FieldRequired(allow_legacy_nulls=True)],
+            "effective_start": [TimeRangeValidator(end_field="effective_end")],
+            "effective_end": [TimeRangeValidator(start_field="effective_start")],
+        },
+        "slm.SiteOtherInstrumentation": {"instrumentation": [FieldRequired()]},
+        "slm.SiteRadioInterferences": {
+            "interferences": [FieldRequired(allow_legacy_nulls=True)],
+            "effective_start": [
+                FieldRequired(),
+                TimeRangeValidator(end_field="effective_end"),
+            ],
+            "effective_end": [TimeRangeValidator(start_field="effective_start")],
+        },
+        "slm.SiteMultiPathSources": {
+            "sources": [FieldRequired(allow_legacy_nulls=True)],
+            "effective_start": [
+                FieldRequired(),
+                TimeRangeValidator(end_field="effective_end"),
+            ],
+            "effective_end": [TimeRangeValidator(start_field="effective_start")],
+        },
+        "slm.SiteSignalObstructions": {
+            "obstructions": [FieldRequired(allow_legacy_nulls=True)],
+            "effective_start": [
+                FieldRequired(),
+                TimeRangeValidator(end_field="effective_end"),
+            ],
+            "effective_end": [TimeRangeValidator(start_field="effective_start")],
+        },
+        "slm.SiteLocalEpisodicEffects": {
+            "event": [FieldRequired(allow_legacy_nulls=True)],
+            "effective_start": [
+                FieldRequired(),
+                TimeRangeValidator(end_field="effective_end"),
+            ],
+            "effective_end": [TimeRangeValidator(start_field="effective_start")],
+        },
+        "slm.SiteOperationalContact": {
+            "agency": [FieldRequired()],
+            "preferred_abbreviation": [FieldRequired()],
+            "primary_name": [FieldRequired()],
+            "primary_phone1": [FieldRequired(desired=True)],
+            "primary_email": [FieldRequired(allow_legacy_nulls=True)],
+        },
+        "slm.SiteMoreInformation": {
+            "primary": [FieldRequired()],
+            "secondary": [FieldRequired()],
+        },
     },
-    "slm.SiteWaterVaporRadiometer": {
-        "model": [FieldRequired()],
-        "manufacturer": [FieldRequired()],
-        "distance_to_antenna": [FieldRequired(allow_legacy_nulls=True)],
-        "height_diff": [FieldRequired(allow_legacy_nulls=True)],
-        "effective_start": [TimeRangeValidator(end_field="effective_end")],
-        "effective_end": [TimeRangeValidator(start_field="effective_start")],
-    },
-    "slm.SiteOtherInstrumentation": {"instrumentation": [FieldRequired()]},
-    "slm.SiteRadioInterferences": {
-        "interferences": [FieldRequired(allow_legacy_nulls=True)],
-        "effective_start": [
-            FieldRequired(),
-            TimeRangeValidator(end_field="effective_end"),
-        ],
-        "effective_end": [TimeRangeValidator(start_field="effective_start")],
-    },
-    "slm.SiteMultiPathSources": {
-        "sources": [FieldRequired(allow_legacy_nulls=True)],
-        "effective_start": [
-            FieldRequired(),
-            TimeRangeValidator(end_field="effective_end"),
-        ],
-        "effective_end": [TimeRangeValidator(start_field="effective_start")],
-    },
-    "slm.SiteSignalObstructions": {
-        "obstructions": [FieldRequired(allow_legacy_nulls=True)],
-        "effective_start": [
-            FieldRequired(),
-            TimeRangeValidator(end_field="effective_end"),
-        ],
-        "effective_end": [TimeRangeValidator(start_field="effective_start")],
-    },
-    "slm.SiteLocalEpisodicEffects": {
-        "event": [FieldRequired(allow_legacy_nulls=True)],
-        "effective_start": [
-            FieldRequired(),
-            TimeRangeValidator(end_field="effective_end"),
-        ],
-        "effective_end": [TimeRangeValidator(start_field="effective_start")],
-    },
-    "slm.SiteOperationalContact": {
-        "agency": [FieldRequired()],
-        "preferred_abbreviation": [FieldRequired()],
-        "primary_name": [FieldRequired()],
-        "primary_phone1": [FieldRequired(desired=True)],
-        "primary_email": [FieldRequired(allow_legacy_nulls=True)],
-    },
-    "slm.SiteResponsibleAgency": {
-        "agency": [FieldRequired()],
-        "preferred_abbreviation": [FieldRequired()],
-        "primary_name": [FieldRequired()],
-        "primary_phone1": [FieldRequired(desired=True)],
-        "primary_email": [FieldRequired(allow_legacy_nulls=True)],
-    },
-    "slm.SiteMoreInformation": {
-        "primary": [FieldRequired()],
-        "secondary": [FieldRequired()],
-    },
-}
+)

slm/signals.py

@@ -1,6 +1,6 @@
 """
 All SLM specific signals sent by the system are defined here. These signals
-mostly include events relating to the site log edit/moderate/publish lifecycle.
+mostly include events relating to the site log edit/moderate/publish life cycle.
 
 All signals contain a request object that holds the request that initiated the
 event. This object is provided mostly for logging purposes and is not
@@ -51,6 +51,7 @@ The published timestamp will have increased.
 :param site: The Site object.
 :param previous_status: The previous status
 :param new_status: The new status
+:param reverted: If true this status change was the result of a reversion
 :param kwargs: Misc other key word arguments
 """
 site_status_changed = Signal()
@@ -156,7 +157,7 @@ site_file_published = Signal()
 
 
 """
-Sent when a moderator unpublishes a site file upload - could be an attachment
+Sent when a moderator retracts a site file upload - could be an attachment
 or an image.
 
 :param sender: The sending object (unreliable).