igs-slm 0.1.0b0__py3-none-any.whl

slm/signals.py

@@ -0,0 +1,250 @@
+"""
+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.
+
+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
+guaranteed to be non-null.
+"""
+
+import sys
+
+from django.dispatch import Signal
+from django.utils.module_loading import import_string
+
+"""
+Signal sent when a new site is proposed.
+
+:param sender: The sending object (unreliable).
+:param site: The Site object. 
+:param user: The user that proposed the new site.
+:param timestamp: The time the request was received
+:param request: The Django request object that initiated the proposal.
+:param agencies: The Agencies identified by the requester as the 
+    responsible agencies.
+:param kwargs: Misc other key word arguments
+"""
+site_proposed = Signal()
+
+"""
+Sent when a site log is published, or when a section of a site log is
+published.
+
+:param sender: The sending object (unreliable).
+:param site: The Site object. 
+:param user: The user that published the site log.
+:param timestamp: The time the site log was published.
+:param request: The Django request object that initiated the publish.
+:param section: None if the entire site log was published, if an individual
+    section was published this will be the Section object instance.
+:param kwargs: Misc other key word arguments
+"""
+site_published = Signal()
+
+"""
+Sent when a site log is published, or when a section of a site log is
+published. Its possible that both the previous and new status states are
+Published. If this happens a site log was edited and published simultaneously.
+The published timestamp will have increased.
+
+:param sender: The sending object (unreliable).
+:param site: The Site object.
+:param previous_status: The previous status
+:param new_status: The new status
+:param kwargs: Misc other key word arguments
+"""
+site_status_changed = Signal()
+
+"""
+Sent when a site log section is edited.
+
+:param sender: The sending object (unreliable).
+:param site: The Site object. 
+:param user: The user that edited the site log section.
+:param timestamp: The time the site log section was edited.
+:param request: The Django request object that contained the edit.
+:param section: The section object that was edited.
+:param fields: The list of edited fields
+:param kwargs: Misc other key word arguments
+"""
+section_edited = Signal()
+
+"""
+Sent when a site log section is added.
+
+:param sender: The sending object (unreliable).
+:param site: The Site object. 
+:param user: The user that added the site log section.
+:param timestamp: The time the site log section was added.
+:param request: The Django request object that contained the add.
+:param section: The section object that was added.
+:param kwargs: Misc other key word arguments
+"""
+section_added = Signal()
+
+"""
+Sent when a site log section is deleted.
+
+:param sender: The sending object (unreliable).
+:param site: The Site object. 
+:param user: The user that deleted the site log section.
+:param timestamp: The time the site log section was deleted.
+:param request: The Django request object that contained the delete.
+:param section: The section object that was deleted.
+:param kwargs: Misc other key word arguments
+"""
+section_deleted = Signal()
+
+"""
+Sent when a site log section has fields flagged.
+
+:param sender: The sending object (unreliable).
+:param site: The Site object. 
+:param user: The user that added the flags or performed the action that caused
+ the flags to be added.
+:param timestamp: The time the site log section was flagged.
+:param request: The Django request object that added or triggered the flags.
+:param section: The section object concerned.
+:param fields: The list of fields that were flagged.
+:param kwargs: Misc other key word arguments
+"""
+fields_flagged = Signal()
+
+"""
+Sent when a site log section has fields flagged.
+
+:param sender: The sending object (unreliable).
+:param site: The Site object. 
+:param user: The user that removed the flags or performed the action that
+    caused the flags to be removed.
+:param timestamp: The time the site log section was flagged.
+:param request: The Django request object that removed or triggered the flags
+    to be cleared.
+:param section: The section object concerned.
+:param fields: The list of fields that were cleared of flags.
+:param clear: True if the section has no remaining flags - false otherwise.
+:param kwargs: Misc other key word arguments
+"""
+flags_cleared = Signal()
+
+"""
+Sent when a user uploads a site log.
+
+:param sender: The sending object (unreliable).
+:param site: The Site object. 
+:param user: The user that uploaded the site log.
+:param timestamp: The time the site log was uploaded.
+:param request: The Django request object that contained the upload.
+:param upload: The uploaded file (SiteFileUpload).
+:param kwargs: Misc other key word arguments
+"""
+site_file_uploaded = Signal()
+
+"""
+Sent when a moderator publishes a site file upload - could be an attachment or
+an image.
+
+:param sender: The sending object (unreliable).
+:param site: The Site object. 
+:param user: The user that published the file.
+:param timestamp: The time the file was published.
+:param request: The Django request object that contained the upload.
+:param upload: The uploaded file (SiteFileUpload).
+:param kwargs: Misc other key word arguments
+"""
+site_file_published = Signal()
+
+
+"""
+Sent when a moderator unpublishes a site file upload - could be an attachment
+or an image.
+
+:param sender: The sending object (unreliable).
+:param site: The Site object. 
+:param user: The user that unpublished the file.
+:param timestamp: The time the file was unpublished.
+:param request: The Django request object that contained the upload.
+:param upload: The uploaded file (SiteFileUpload).
+:param kwargs: Misc other key word arguments
+"""
+site_file_unpublished = Signal()
+
+
+"""
+Sent when a user deletes a site file upload through the API. The file must be
+a type other than a site log - could be an attachment or an image.
+
+:param sender: The sending object (unreliable).
+:param site: The Site object. 
+:param user: The user that deleted the file.
+:param timestamp: The time the file was deleted.
+:param request: The Django request object that contained the upload.
+:param upload: The uploaded file (SiteFileUpload).
+:param kwargs: Misc other key word arguments
+"""
+site_file_deleted = Signal()
+
+
+"""
+Sent when a user requests a site log be reviewed and published by moderators.
+
+:param sender: The sending object (unreliable).
+:param site: The site the reviews were requested for.
+:param detail: The user given reasons for requesting the update (if any).
+:param request: The Django request object that contained the request.
+:param kwargs: Misc other key word arguments
+"""
+review_requested = Signal()
+
+"""
+Sent when a moderator rejects edits requested for publish in a review request.
+
+:param sender: The sending object (unreliable).
+:param site: The site the updates were rejected for.
+:param detail: The user given reasons for rejecting the update (if any).
+:param request: The Django request object that contained the rejection.
+:param kwargs: Misc other key word arguments
+"""
+updates_rejected = Signal()
+
+"""
+Sent when an alert is issued.
+
+:param sender: The sending object (unreliable).
+:param alert: The alert object that was issued.
+:param kwargs: Misc other key word arguments
+"""
+alert_issued = Signal()
+
+"""
+Sent when an alert is cleared.
+
+:param sender: The sending object (unreliable).
+:param alert: The alert object that was issued.
+:param kwargs: Misc other key word arguments
+"""
+alert_cleared = Signal()
+
+
+_signal_names_ = {
+    value: f"slm.signals.{key}"
+    for key, value in sys._getframe().f_globals.items()
+    if isinstance(value, Signal)
+}
+
+
+def signal_name(signal):
+    """
+    Given a signal object - try to determine its name (import path). This is
+    not easy and prone to failure so don't use it for anything critical.
+    """
+    if not isinstance(signal, Signal):
+        return signal
+    name = _signal_names_.get(signal, None)
+    if name:
+        return name
+    return {
+        value: f"{signal.__module__}.{key}"
+        for key, value in vars(import_string(signal.__module__)).items()
+        if isinstance(value, Signal)
+    }.get(signal, str(signal))

slm/singleton.py

@@ -0,0 +1,49 @@
+from django.core.cache import cache
+from django.db import models
+
+
+class _Singleton(type):
+    _instances = {}
+
+    def __call__(cls, *args, **kwargs):
+        if cls not in cls._instances:
+            cls._instances[cls] = super(_Singleton, cls).__call__(*args, **kwargs)
+
+        return cls._instances[cls]
+
+    @classmethod
+    def is_instantiated(cls, typ):
+        return typ in cls._instances
+
+    @classmethod
+    def destroy(cls, typ):
+        if typ in cls._instances:
+            del cls._instances[typ]
+
+
+class Singleton(_Singleton("SingletonMeta", (object,), {})):
+    pass
+
+
+class SingletonModel(models.Model):
+    class Meta:
+        abstract = True
+
+    def delete(self, *args, **kwargs):
+        pass
+
+    def save(self, *args, **kwargs):
+        self.pk = 1
+        super(SingletonModel, self).save(*args, **kwargs)
+        self.set_cache()
+
+    @classmethod
+    def load(cls):
+        if cache.get(cls.__name__) is None:
+            obj, created = cls.objects.get_or_create(pk=1)
+            if not created:
+                obj.set_cache()
+        return cache.get(cls.__name__)
+
+    def set_cache(self):
+        cache.set(self.__class__.__name__, self)

slm/static/rest_framework/css/bootstrap-tweaks.css

@@ -0,0 +1,204 @@
+/*
+
+This CSS file contains some tweaks specific to the included Bootstrap theme.
+It's separate from `style.css` so that it can be easily overridden by replacing
+a single block in the template.
+
+*/
+
+.form-actions {
+  background: transparent;
+  border-top-color: transparent;
+  padding-top: 0;
+  text-align: right;
+}
+
+#generic-content-form textarea {
+  font-family:Consolas,Monaco,Lucida Console,Liberation Mono,DejaVu Sans Mono,Bitstream Vera Sans Mono,Courier New, monospace;
+  font-size: 80%;
+}
+
+.navbar-dark .navbar-brand {
+  color: #999999;
+}
+.navbar-inverse .navbar-brand:hover {
+  color: white;
+  text-decoration: none;
+}
+
+/* custom navigation styles */
+.navbar {
+  width: 100%;
+  position: fixed;
+  left: 0;
+  top: 0;
+}
+
+.navbar {
+  background: #2C2C2C;
+  color: white;
+  border: none;
+  border-top: 5px solid #A30000;
+  border-radius: 0px;
+}
+
+.navbar .nav li, .navbar .nav li a, .navbar .brand:hover {
+  color: white;
+}
+
+.nav-list > .active > a, .nav-list > .active > a:hover {
+  background: #2C2C2C;
+}
+
+.navbar .dropdown-menu li a, .navbar .dropdown-menu li {
+  color: #A30000;
+}
+
+.navbar .dropdown-menu li a:hover {
+  background: #EEEEEE;
+  color: #C20000;
+}
+
+ul.breadcrumb {
+  margin: 70px 0 0 0;
+}
+
+.breadcrumb li.active a {
+  color: #777;
+}
+
+.pagination>.disabled>a,
+.pagination>.disabled>a:hover,
+.pagination>.disabled>a:focus {
+  cursor: not-allowed;
+  pointer-events: none;
+}
+
+.pager>.disabled>a,
+.pager>.disabled>a:hover,
+.pager>.disabled>a:focus {
+  pointer-events: none;
+}
+
+.pager .next {
+  margin-left: 10px;
+}
+
+/*=== dabapps bootstrap styles ====*/
+
+html {
+  width:100%;
+  background: none;
+}
+
+/*body, .navbar .container-fluid {
+  max-width: 1150px;
+  margin: 0 auto;
+}*/
+
+body {
+  background: url("../img/grid.png") repeat-x;
+  background-attachment: fixed;
+}
+
+#content {
+  margin: 0;
+  padding-bottom: 60px;
+}
+
+/* sticky footer and footer */
+html, body {
+  height: 100%;
+}
+
+.wrapper {
+  position: relative;
+  top: 0;
+  left: 0;
+  padding-top: 60px;
+  margin: -60px 0;
+  min-height: 100%;
+}
+
+.form-switcher {
+  margin-bottom: 0;
+}
+
+.nav-tabs {
+  border: 0;
+}
+
+.nav-tabs > li {
+  float: right;
+}
+
+.nav-tabs li a {
+  margin-right: 0;
+}
+
+.nav-tabs > .active > a {
+  background: #F5F5F5;
+}
+
+.nav-tabs > .active > a:hover {
+  background: #F5F5F5;
+}
+
+.tabbable.first-tab-active .tab-content {
+  border-top-right-radius: 0;
+}
+
+footer {
+  position: absolute;
+  bottom: 0;
+  left: 0;
+  clear: both;
+  z-index: 10;
+  height: 60px;
+  width: 95%;
+  margin: 0 2.5%;
+}
+
+footer p {
+  text-align: center;
+  color: gray;
+  border-top: 1px solid #DDDDDD;
+  padding-top: 10px;
+}
+
+footer a {
+  color: gray !important;
+  font-weight: bold;
+}
+
+footer a:hover {
+  color: gray;
+}
+
+.page-header {
+  border-bottom: none;
+  padding-bottom: 0px;
+  margin: 0;
+}
+
+/* custom general page styles */
+.hero-unit h1, .hero-unit h2 {
+  color: #A30000;
+}
+
+body a {
+  color: #A30000;
+}
+
+body a:hover {
+  color: #c20000;
+}
+
+.request-info {
+  clear:both;
+}
+
+.modal-footer form {
+  margin-left: 5px;
+  margin-right: 5px;
+}