from datetime import datetime import json from django import forms from django.utils.safestring import mark_safe from django.utils.encoding import force_str from django.utils.formats import get_format from django.utils.translation import get_language from django.conf import settings from django.template.loader import render_to_string def cdn_media(): """ Returns the CDN locations for Tempus Dominus, included by default. """ css = { "all": ( "//cdnjs.cloudflare.com/ajax/libs/tempusdominus-bootstrap-4/" "5.39.0/css/tempusdominus-bootstrap-4.min.css", ) } if getattr(settings, "TEMPUS_DOMINUS_LOCALIZE", False): moment = "moment-with-locales" else: moment = "moment" js = ( ( "//cdnjs.cloudflare.com/ajax/libs/moment.js/2.22.2/" "{moment}.min.js".format(moment=moment) ), ( "//cdnjs.cloudflare.com/ajax/libs/tempusdominus-bootstrap-4/" "5.39.0/js/tempusdominus-bootstrap-4.min.js" ), ) return forms.Media(css=css, js=js) class TempusDominusMixin: """ The Tempus Dominus Mixin contains shared functionality for the three types of date pickers offered. """ def __init__(self, attrs=None, options=None, format=None): super().__init__() # Set default options to include a clock item, otherwise datetimepicker # shows no icon to switch into time mode self.js_options = { "format": self.get_js_format(), "icons": {"time": "fa fa-clock-o"}, } # If a dictionary of options is passed, combine it with our pre-set js_options. if isinstance(options, dict): self.js_options = {**self.js_options, **options} # save any additional attributes that the user defined in self self.attrs = attrs or {} self.format = format or None @property def media(self): if getattr(settings, "TEMPUS_DOMINUS_INCLUDE_ASSETS", True): return cdn_media() return forms.Media() def render(self, name, value, attrs=None, renderer=None): context = super().get_context(name, value, attrs) # self.attrs = user-defined attributes from __init__ # attrs = attributes added for rendering. # context['attrs'] contains a merge of self.attrs and attrs # NB If crispy forms is used, it will already contain # 'class': 'datepicker form-control' # for DatePicker widget all_attrs = context["widget"]["attrs"] all_attrs["id"] = all_attrs["id"].replace('-', '_') cls = all_attrs.get("class", "") if "form-control" not in cls: cls = "form-control " + cls # Add the attribute that makes datepicker popup close when focus is lost cls += " datetimepicker-input" all_attrs["class"] = cls # defaults for our widget attributes input_toggle = True icon_toggle = True input_group = True append = "" prepend = "" size = "" attr_html = "" for attr_key, attr_value in all_attrs.items(): if attr_key == "prepend": prepend = attr_value elif attr_key == "append": append = attr_value elif attr_key == "input_toggle": input_toggle = attr_value elif attr_key == "input_group": input_group = attr_value elif attr_key == "icon_toggle": icon_toggle = attr_value elif attr_key == "size": size = attr_value elif attr_key == "icon_toggle": icon_toggle = attr_value else: attr_html += ' {key}="{value}"'.format(key=attr_key, value=attr_value) options = {} options.update(self.js_options) if ( getattr(settings, "TEMPUS_DOMINUS_LOCALIZE", False) and "locale" not in self.js_options ): options["locale"] = get_language() if context["widget"]["value"] is not None: # Append an option to set the datepicker's value using a Javascript # moment object options.update(self.moment_option(value)) # picker_id below has to be changed to underscores, as hyphens are not # valid in JS function names. field_html = render_to_string( "tempus_dominus/widget.html", { "type": context["widget"]["type"], "picker_id": context["widget"]["attrs"]["id"].replace("-", "_"), "name": context["widget"]["name"], "attrs": mark_safe(attr_html), "js_options": mark_safe(json.dumps(options)), "prepend": prepend, "append": append, "icon_toggle": icon_toggle, "input_toggle": input_toggle, "input_group": input_group, "size": size, }, ) return mark_safe(force_str(field_html)) def moment_option(self, value): """ Returns an option dict to set the default date and/or time using a Javascript moment object. When a form is first instantiated, value is a date, time or datetime object, but after a form has been submitted with an error and re-rendered, value contains a formatted string that we need to parse back to a date, time or datetime object. """ if isinstance(value, str): if isinstance(self, DatePicker): formats = [self.format] if self.format else get_format( "DATE_INPUT_FORMATS" ) elif isinstance(self, TimePicker): formats = [self.format] if self.format else get_format( "TIME_INPUT_FORMATS" ) else: formats = [self.format] if self.format else get_format( "DATETIME_INPUT_FORMATS" ) for fmt in formats: try: value = datetime.strptime(value, fmt) if isinstance(self, TimePicker): # strptime returns a date; get the time from it. value = value.time() break except (ValueError, TypeError): continue else: return {} # Append an option to set the datepicker's value using iso formatted string iso_date = value.isoformat() # iso format for time requires a prepended T if isinstance(self, TimePicker): iso_date = "T" + iso_date return {"date": iso_date} def get_js_format(self): raise NotImplementedError class DatePicker(TempusDominusMixin, forms.widgets.DateInput): """ Widget for Tempus Dominus DatePicker. """ def get_js_format(self): if getattr(settings, "TEMPUS_DOMINUS_LOCALIZE", False): js_format = "L" else: js_format = getattr(settings, "TEMPUS_DOMINUS_DATE_FORMAT", "YYYY-MM-DD") return js_format class DateTimePicker(TempusDominusMixin, forms.widgets.DateTimeInput): """ Widget for Tempus Dominus DateTimePicker. """ def get_js_format(self): if getattr(settings, "TEMPUS_DOMINUS_LOCALIZE", False): js_format = "L LTS" else: js_format = getattr(settings, "TEMPUS_DOMINUS_DATETIME_FORMAT", "YYYY-MM-DD HH:mm:ss") return js_format class TimePicker(TempusDominusMixin, forms.widgets.TimeInput): """ Widget for Tempus Dominus TimePicker. """ def get_js_format(self): if getattr(settings, "TEMPUS_DOMINUS_LOCALIZE", False): js_format = "LTS" else: js_format = getattr(settings, "TEMPUS_DOMINUS_TIME_FORMAT", "HH:mm:ss") return js_format