- -
-+ +
+This is an automated message to let you know that the following tasks - assigned to you within PRS are currently overdue:
-This is an automatically-generated email - please do not reply.
" - msg = EmailMultiAlternatives(subject, text_content, from_email, to_email) - msg.attach_alternative(html_content, "text/html") - # Email should fail gracefully - ie no Exception raised on failure. - msg.send(fail_silently=True) - - return True - - -def wfs_getfeature(type_name, crs="EPSG:4326", cql_filter=None, max_features=50): - """A utility function to perform a GetFeature request on a WFS endpoint - and return results as GeoJSON. - """ - url = env("GEOSERVER_URL", None) - auth = (env("GEOSERVER_SSO_USER", None), env("GEOSERVER_SSO_PASS", None)) - params = { - "service": "WFS", - "version": "1.1.0", - "typeName": type_name, - "request": "getFeature", - "outputFormat": "json", - "SRSName": f"urn:x-ogc:def:crs:{crs}", - "maxFeatures": max_features, - } - if cql_filter: - params["cql_filter"] = cql_filter - resp = requests.get(url, auth=auth, params=params) - try: - resp.raise_for_status() - except: - # On exception, return an empty dict. - return {} - - return resp.json() - - -def query_caddy(q): - """Utility function to proxy queries to the Caddy geocoder service.""" - url = env("GEOCODER_URL", None) - auth = (env("GEOSERVER_SSO_USER", None), env("GEOSERVER_SSO_PASS", None)) - params = {"q": q} - resp = requests.get(url, auth=auth, params=params) - try: - resp.raise_for_status() - except: - # On exception, return an empty list. - return [] - - return resp.json() - - -def get_previous_pages(page_num, count=5): - """Convenience function to take a Paginator page object and return the previous `count` - page numbers, to a minimum of 1. - """ - prev_page_numbers = [] - - if page_num and page_num.has_previous(): - for i in range(page_num.previous_page_number(), page_num.previous_page_number() - count, -1): - if i >= 1: - prev_page_numbers.append(i) - - prev_page_numbers.reverse() - return prev_page_numbers - - -def get_next_pages(page_num, count=5): - """Convenience function to take a Paginator page object and return the next `count` - page numbers, to a maximum of the paginator page count. - """ - next_page_numbers = [] - - if page_num and page_num.has_next(): - for i in range(page_num.next_page_number(), page_num.next_page_number() + count): - if i <= page_num.paginator.num_pages: - next_page_numbers.append(i) - - return next_page_numbers +import json +import re +from datetime import date, datetime + +import requests +from dbca_utils.utils import env +from django.apps import apps +from django.conf import settings +from django.contrib import admin +from django.core.mail import EmailMultiAlternatives +from django.db.models import Q +from django.db.models.base import ModelBase +from django.utils.encoding import smart_str +from django.utils.safestring import mark_safe +from reversion.models import Version +from unidecode import unidecode + + +def is_model_or_string(model): + """This function checks if we passed in a Model, or the name of a model as + a case-insensitive string. The string may also be plural to some extent + (i.e. ending with "s"). If we passed in a string, return the named Model + instead using get_model(). + + Example:: + + from referral.util import is_model_or_string + is_model_or_string('region') + is_model_or_string(Region) + + >>> from referral.models import Region + >>> from django.db.models.base import ModelBase + >>> from referral.util import is_model_or_string + >>> isinstance(is_model_or_string('region'), ModelBase) + True + >>> isinstance(is_model_or_string(Region), ModelBase) + True + """ + if not isinstance(model, ModelBase): + # Hack: if the last character is "s", remove it before calling get_model + x = len(model) - 1 + if model[x] == "s": + model = model[0:x] + try: + model = apps.get_model("referral", model) + except LookupError: + model = None + return model + + +def smart_truncate(content, length=100, suffix="....(more)"): + """Small function to truncate a string in a sensible way, sourced from: + http://stackoverflow.com/questions/250357/smart-truncate-in-python + """ + content = smart_str(content) + if len(content) <= length: + return content + else: + return " ".join(content[: length + 1].split(" ")[0:-1]) + suffix + + +def dewordify_text(txt): + """Function to strip some of the crufty HTML that results from copy-pasting + MS Word documents/HTML emails into the RTF text fields in this application. + Should always return a unicode string. + + Source: + http://stackoverflow.com/questions/1175540/iterative-find-replace-from-a-list-of-tuples-in-python + """ + REPLACEMENTS = { + " ": " ", + "<": "<", + ">": ">", + ' class="MsoNormal"': "", + '': "", + "": "", + "": "", + } + + def replacer(m): + return REPLACEMENTS[m.group(0)] + + if txt: + # Whatever string encoding is passed in, + # use unidecode to replace non-ASCII characters. + txt = unidecode(txt) # Replaces odd characters. + r = re.compile("|".join(REPLACEMENTS.keys())) + r = r.sub(replacer, txt) + return r + else: + return "" + + +def breadcrumbs_li(links): + """Returns HTML: an unordered list of URLs (no surroundingThis is an automated message to let you know that the following tasks + assigned to you within PRS are currently overdue:
+This is an automatically-generated email - please do not reply.
" + msg = EmailMultiAlternatives(subject, text_content, from_email, to_email) + msg.attach_alternative(html_content, "text/html") + # Email should fail gracefully - ie no Exception raised on failure. + msg.send(fail_silently=True) + + return True + + +def wfs_getfeature(type_name, crs="EPSG:4326", cql_filter=None, max_features=50): + """A utility function to perform a GetFeature request on a WFS endpoint + and return results as GeoJSON. + """ + url = env("GEOSERVER_URL", None) + auth = (env("GEOSERVER_SSO_USER", None), env("GEOSERVER_SSO_PASS", None)) + params = { + "service": "WFS", + "version": "1.1.0", + "typeName": type_name, + "request": "getFeature", + "outputFormat": "json", + "SRSName": f"urn:x-ogc:def:crs:{crs}", + "maxFeatures": max_features, + } + if cql_filter: + params["cql_filter"] = cql_filter + resp = requests.get(url, auth=auth, params=params) + try: + resp.raise_for_status() + response = resp.json() + except: + # On exception, return an empty dict. + return {} + + return response + + +def query_caddy(q): + """Utility function to proxy queries to the Caddy geocoder service.""" + url = env("GEOCODER_URL", None) + auth = (env("GEOSERVER_SSO_USER", None), env("GEOSERVER_SSO_PASS", None)) + params = {"q": q} + resp = requests.get(url, auth=auth, params=params) + try: + resp.raise_for_status() + response = resp.json() + except: + # On exception, return an empty list. + return [] + + return response + + +def get_previous_pages(page_num, count=5): + """Convenience function to take a Paginator page object and return the previous `count` + page numbers, to a minimum of 1. + """ + prev_page_numbers = [] + + if page_num and page_num.has_previous(): + for i in range(page_num.previous_page_number(), page_num.previous_page_number() - count, -1): + if i >= 1: + prev_page_numbers.append(i) + + prev_page_numbers.reverse() + return prev_page_numbers + + +def get_next_pages(page_num, count=5): + """Convenience function to take a Paginator page object and return the next `count` + page numbers, to a maximum of the paginator page count. + """ + next_page_numbers = [] + + if page_num and page_num.has_next(): + for i in range(page_num.next_page_number(), page_num.next_page_number() + count): + if i <= page_num.paginator.num_pages: + next_page_numbers.append(i) + + return next_page_numbers diff --git a/prs2/referral/views.py b/prs2/referral/views.py index a3ab4951..96c7d695 100644 --- a/prs2/referral/views.py +++ b/prs2/referral/views.py @@ -10,8 +10,6 @@ from django.contrib.auth.mixins import LoginRequiredMixin from django.contrib.auth.models import Group from django.contrib.gis.geos import GEOSGeometry, MultiPolygon -from django.core.cache import cache -from django.core.cache.utils import make_template_fragment_key from django.core.mail import EmailMultiAlternatives from django.core.paginator import Paginator from django.core.serializers import serialize @@ -713,11 +711,6 @@ def form_valid(self, form): if not messages.get_messages(self.request): messages.success(self.request, "{} has been created.".format(self.object)) - # Invalidate any cached referral detail fragment. - if settings.REDIS_CACHE_HOST: - key = make_template_fragment_key("referral_detail", [self.object.referral.pk]) - cache.delete(key) - redirect_url = redirect_url if redirect_url else self.get_success_url() return HttpResponseRedirect(redirect_url) @@ -1020,11 +1013,6 @@ def post(self, request, *args, **kwargs): messages.success(request, "{} location(s) created.".format(len(forms))) - # Invalidate any cached referral detail fragment. - if settings.REDIS_CACHE_HOST: - key = make_template_fragment_key("referral_detail", [ref.pk]) - cache.delete(key) - # Test for intersecting locations. intersecting_locations = self.polygon_intersects(locations) if intersecting_locations: @@ -1169,11 +1157,6 @@ def post(self, request, *args, **kargs): rec.order_date = date.today() rec.save() - # Invalidate the cached referral detail fragment. - if settings.REDIS_CACHE_HOST: - referral = rec.referral - key = make_template_fragment_key("referral_detail", [referral.pk]) - cache.delete(key) return JsonResponse( { @@ -1680,13 +1663,6 @@ def post(self, request, *args, **kwargs): ref1.remove_relationship(ref2) messages.success(request, "Referral relation removed") - # Invalidate the cached referral detail fragments. - if settings.REDIS_CACHE_HOST: - key = make_template_fragment_key("referral_detail", [ref1.pk]) - cache.delete(key) - key = make_template_fragment_key("referral_detail", [ref2.pk]) - cache.delete(key) - return redirect(ref1.get_absolute_url()) @@ -1741,11 +1717,6 @@ def post(self, request, *args, **kwargs): if request.POST.get("cancel"): return HttpResponseRedirect(reverse("prs_object_detail", kwargs={"pk": obj.pk, "model": "conditions"})) - # Invalidate any cached referral detail fragment. - if settings.REDIS_CACHE_HOST: - key = make_template_fragment_key("referral_detail", [obj.referral.pk]) - cache.delete(key) - return super().post(request, *args, **kwargs) def form_valid(self, form): diff --git a/prs2/referral/views_base.py b/prs2/referral/views_base.py index 155f33c6..00dea5c7 100644 --- a/prs2/referral/views_base.py +++ b/prs2/referral/views_base.py @@ -1,45 +1,24 @@ +import json +import logging + from django.conf import settings from django.contrib import messages from django.contrib.admin import site from django.contrib.auth.mixins import LoginRequiredMixin -from django.core.cache import cache -from django.core.cache.utils import make_template_fragment_key from django.core.serializers import serialize from django.db.models import F -from django.urls import reverse -from django.http import ( - HttpResponse, - HttpResponseBadRequest, - HttpResponseRedirect, - Http404, -) +from django.http import Http404, HttpResponse, HttpResponseBadRequest, HttpResponseRedirect from django.shortcuts import redirect from django.template.defaultfilters import slugify +from django.urls import reverse from django.utils.decorators import method_decorator from django.views.decorators.csrf import csrf_exempt -from django.views.generic import ( - View, - ListView, - DetailView, - CreateView, - UpdateView, - DeleteView, -) -import json -import logging +from django.views.generic import CreateView, DeleteView, DetailView, ListView, UpdateView, View +from referral.forms import FORMS_MAP +from referral.utils import breadcrumbs_li, get_next_pages, get_previous_pages, get_query, is_model_or_string, prs_user from reversion.models import Version from taggit.models import Tag -from referral.forms import FORMS_MAP -from referral.utils import ( - is_model_or_string, - breadcrumbs_li, - get_query, - prs_user, - get_previous_pages, - get_next_pages, -) - logger = logging.getLogger("prs") @@ -47,6 +26,7 @@ class PrsObjectList(LoginRequiredMixin, ListView): """A general-purpose view class to use for listing and searching PRS objects. Extend this class to customise the view for each model type. """ + paginate_by = 20 template_name = "referral/prs_object_list.html" @@ -60,8 +40,7 @@ def dispatch(self, request, *args, **kwargs): return super().dispatch(request, *args, **kwargs) def get_queryset(self): - """Define the queryset of objects to return. - """ + """Define the queryset of objects to return.""" qs = super().get_queryset() # By default, filter out "inactive" objects. if "effective_to" in [f.name for f in self.model._meta.get_fields()]: @@ -105,6 +84,7 @@ class to customise the 'create' view for each model type. Note that most PRS objects are associated with Referral models, thus they use the ``ReferralChildObjectCreate`` view instead. """ + template_name = "referral/change_form.html" def dispatch(self, request, *args, **kwargs): @@ -112,9 +92,7 @@ def dispatch(self, request, *args, **kwargs): messages.warning( request, """You do not have permission to edit data. - Please contact the application owner(s): {}""".format( - ", ".join([i[0] for i in settings.MANAGERS]) - ), + Please contact the application owner(s): {}""".format(", ".join([i[0] for i in settings.MANAGERS])), ) return HttpResponseRedirect(reverse("site_home")) @@ -130,9 +108,7 @@ def get_context_data(self, **kwargs): model_type = m.verbose_name.capitalize() context["model_type"] = model_type context["title"] = "CREATE {}".format(self.model._meta.object_name.upper()) - context["page_title"] = " | ".join( - [settings.APPLICATION_ACRONYM, "Create " + model_type] - ) + context["page_title"] = " | ".join([settings.APPLICATION_ACRONYM, "Create " + model_type]) context["page_heading"] = "CREATE " + model_type.upper() model_list_url = reverse( "prs_object_list", @@ -180,19 +156,6 @@ def form_valid(self, form): self.object.save() messages.success(self.request, "{0} has been created.".format(self.object)) - # Find the referral associated with this object (may be the object itself) - # and invalidate any cached detail fragment. - if settings.REDIS_CACHE_HOST: - if self.object._meta.model_name == "referral": - referral = self.object - elif hasattr(self.object, "referral"): - referral = self.object.referral - else: - referral = None - if referral: - key = make_template_fragment_key("referral_detail", [referral.pk]) - cache.delete(key) - return HttpResponseRedirect(self.get_success_url()) def get_success_url(self): @@ -206,8 +169,8 @@ def get_success_url(self): class PrsObjectDetail(LoginRequiredMixin, DetailView): - """A general-purpose view class to use for displaying a single PRS object. - """ + """A general-purpose view class to use for displaying a single PRS object.""" + template_name = "referral/prs_object_detail.html" def dispatch(self, request, *args, **kwargs): @@ -217,7 +180,7 @@ def dispatch(self, request, *args, **kwargs): return super().dispatch(request, *args, **kwargs) def get_context_data(self, **kwargs): - from referral.models import Task, Record, Note, Location + from referral.models import Location, Note, Record, Task context = super().get_context_data(**kwargs) context["object_type"] = self.model._meta.verbose_name @@ -287,9 +250,7 @@ def get_context_data(self, **kwargs): if self.model == Location: # Add child locations serialised as GeoJSON (if geometry exists). if obj: - context["geojson_locations"] = serialize( - "geojson", [obj], geometry_field="poly", srid=4283 - ) + context["geojson_locations"] = serialize("geojson", [obj], geometry_field="poly", srid=4283) return context @@ -298,6 +259,7 @@ class PrsObjectUpdate(LoginRequiredMixin, UpdateView): using a form. Extend this class to customise the view for each model type. """ + template_name = "referral/change_form.html" def dispatch(self, request, *args, **kwargs): @@ -305,9 +267,7 @@ def dispatch(self, request, *args, **kwargs): messages.warning( request, """You do not have permission to edit data. - Please contact the application owner(s): {}""".format( - ", ".join([i[0] for i in settings.MANAGERS]) - ), + Please contact the application owner(s): {}""".format(", ".join([i[0] for i in settings.MANAGERS])), ) return HttpResponseRedirect(reverse("site_home")) @@ -326,9 +286,7 @@ def get_context_data(self, **kwargs): context = super().get_context_data(**kwargs) obj = self.get_object() context["title"] = "UPDATE {}".format(obj._meta.object_name).upper() - context["page_title"] = "PRS | {} | {} | Update".format( - obj._meta.verbose_name_plural.capitalize(), obj.pk - ) + context["page_title"] = "PRS | {} | {} | Update".format(obj._meta.verbose_name_plural.capitalize(), obj.pk) context["page_heading"] = "UPDATE " + obj._meta.verbose_name.upper() # Create a breadcrumb trail: Home[URL] > Model[URL] > ID > History context["breadcrumb_trail"] = breadcrumbs_li( @@ -358,21 +316,7 @@ def post(self, request, *args, **kwargs): def form_valid(self, form): self.object = form.save() - - # Find the referral associated with this object (may be the object itself) - # and invalidate any cached detail fragment. - if settings.REDIS_CACHE_HOST: - if self.object._meta.model_name == 'referral': - referral = self.object - else: - referral = self.object.referral - if referral: - key = make_template_fragment_key('referral_detail', [referral.pk]) - cache.delete(key) - - messages.success( - self.request, "{0} has been updated.".format(self.get_object()) - ) + messages.success(self.request, "{0} has been updated.".format(self.get_object())) return HttpResponseRedirect(self.get_success_url()) @@ -381,6 +325,7 @@ class PrsObjectHistory(PrsObjectDetail): history of a PRS object. Extend this class to customise the view for each model type. """ + template_name = "referral/prs_object_history.html" def dispatch(self, request, *args, **kwargs): @@ -393,12 +338,8 @@ def get_context_data(self, **kwargs): context = super().get_context_data(**kwargs) obj = self.get_object() context["title"] = "CHANGE HISTORY: {}".format(obj) - context["page_title"] = " | ".join( - [settings.APPLICATION_ACRONYM, self.get_object().__str__(), "History"] - ) - context["page_heading"] = ( - self.model._meta.verbose_name.upper() + " CHANGE HISTORY" - ) + context["page_title"] = " | ".join([settings.APPLICATION_ACRONYM, self.get_object().__str__(), "History"]) + context["page_heading"] = self.model._meta.verbose_name.upper() + " CHANGE HISTORY" # Create a breadcrumb trail: Home[URL] > Model[URL] > ID > History context["breadcrumb_trail"] = breadcrumbs_li( [ @@ -425,6 +366,7 @@ class PrsObjectDelete(LoginRequiredMixin, DeleteView): """A general-purpose view for confirming the deletion of a PRS object. Extend this class to customise the view for each model type. """ + template_name = "referral/prs_object_delete.html" def dispatch(self, request, *args, **kwargs): @@ -432,9 +374,7 @@ def dispatch(self, request, *args, **kwargs): messages.warning( request, """You do not have permission to edit data. - Please contact the application owner(s): {}""".format( - ", ".join([i[0] for i in settings.MANAGERS]) - ), + Please contact the application owner(s): {}""".format(", ".join([i[0] for i in settings.MANAGERS])), ) return HttpResponseRedirect(reverse("site_home")) @@ -498,17 +438,6 @@ def form_valid(self, form): else: success_url = self.get_success_url() - # Find the referral associated with this object (may be the object itself) - # and invalidate any cached detail fragment. - if settings.REDIS_CACHE_HOST: - if obj._meta.model_name == "referral": - referral = obj - else: - referral = obj.referral - if referral: - key = make_template_fragment_key("referral_detail", [referral.pk]) - cache.delete(key) - messages.success(self.request, f"{obj} has been deleted.") return HttpResponseRedirect(success_url) @@ -521,6 +450,7 @@ class PrsObjectTag(LoginRequiredMixin, View): Default to adding the tag, unless the ``delete`` query param is also passed in. """ + http_method_names = ["post"] model = None pk_url_kwarg = "pk" @@ -532,10 +462,7 @@ def dispatch(self, request, *args, **kwargs): self.model = is_model_or_string(kwargs["model"]) # is_model_or_string() returns None if the model doesn't exist. if not self.model: - raise AttributeError( - "Object tag view {} must be called with an " - "model.".format(self.__class__.__name__) - ) + raise AttributeError("Object tag view {} must be called with an " "model.".format(self.__class__.__name__)) return super().dispatch(request, *args, **kwargs) def get_queryset(self): @@ -550,22 +477,16 @@ def get_object(self, queryset=None): queryset = queryset.filter(pk=pk) else: raise AttributeError( - "Object tag view {} must be called with an " - "object pk.".format(self.__class__.__name__) + "Object tag view {} must be called with an " "object pk.".format(self.__class__.__name__) ) try: obj = queryset.get() except queryset.model.DoesNotExist: - raise Http404( - "No {} found matching the query".format( - queryset.model._meta.verbose_name_plural - ) - ) + raise Http404("No {} found matching the query".format(queryset.model._meta.verbose_name_plural)) return obj def post(self, request, *args, **kwargs): - """Handles POST requests, and adds or remove a tag on an object. - """ + """Handles POST requests, and adds or remove a tag on an object.""" obj = self.get_object() tag = request.POST.get("tag", None) if not tag: diff --git a/prs2/settings.py b/prs2/settings.py index f7197eda..cd0a3d15 100644 --- a/prs2/settings.py +++ b/prs2/settings.py @@ -176,7 +176,7 @@ } } API_RESPONSE_CACHE_SECONDS = env("API_RESPONSE_CACHE_SECONDS", 60) -CACHE_MIDDLEWARE_SECONDS = env("CACHE_MIDDLEWARE_SECONDS", 60) +CACHE_MIDDLEWARE_SECONDS = env("CACHE_MIDDLEWARE_SECONDS", 0) # Email settings EMAIL_HOST = env("EMAIL_HOST", "email.host") diff --git a/pyproject.toml b/pyproject.toml index dfad5e11..df9c8dd0 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "prs" -version = "2.5.58" +version = "2.5.59" description = "Planning Referral System corporate application" authors = ["Ashley Felton