mirror of
https://github.com/jazzband/django-dbtemplates.git
synced 2026-03-16 22:20:28 +00:00
012fe061a8
* Add GitHub Actions test workflow. * Update version map. * Fix flake8 * Write coverage file. * Fix typo. * Add release workflow. * Removed Travis cruft and updated other files. * Update trove classifiers. * Black setup. * Remove unneeded twine check. * Extend changelog. * Fix six issue. * Update tox.ini Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> * Add 3.9. * Add base python Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
80 lines
2.9 KiB
Python
80 lines
2.9 KiB
Python
# -*- coding: utf-8 -*-
|
|
from dbtemplates.conf import settings
|
|
from dbtemplates.utils.cache import (add_template_to_cache,
|
|
remove_cached_template)
|
|
from dbtemplates.utils.template import get_template_source
|
|
from django.contrib.sites.managers import CurrentSiteManager
|
|
from django.contrib.sites.models import Site
|
|
from django.db import models
|
|
from django.db.models import signals
|
|
from django.template import TemplateDoesNotExist
|
|
from django.utils.translation import ugettext_lazy as _
|
|
from django.utils.timezone import now
|
|
|
|
|
|
class Template(models.Model):
|
|
"""
|
|
Defines a template model for use with the database template loader.
|
|
The field ``name`` is the equivalent to the filename of a static template.
|
|
"""
|
|
name = models.CharField(_('name'), max_length=100,
|
|
help_text=_("Example: 'flatpages/default.html'"))
|
|
content = models.TextField(_('content'), blank=True)
|
|
sites = models.ManyToManyField(Site, verbose_name=_(u'sites'),
|
|
blank=True)
|
|
creation_date = models.DateTimeField(_('creation date'),
|
|
default=now)
|
|
last_changed = models.DateTimeField(_('last changed'),
|
|
default=now)
|
|
|
|
objects = models.Manager()
|
|
on_site = CurrentSiteManager('sites')
|
|
|
|
class Meta:
|
|
db_table = 'django_template'
|
|
verbose_name = _('template')
|
|
verbose_name_plural = _('templates')
|
|
ordering = ('name',)
|
|
|
|
def __str__(self):
|
|
return self.name
|
|
|
|
def populate(self, name=None):
|
|
"""
|
|
Tries to find a template with the same name and populates
|
|
the content field if found.
|
|
"""
|
|
if name is None:
|
|
name = self.name
|
|
try:
|
|
source = get_template_source(name)
|
|
if source:
|
|
self.content = source
|
|
except TemplateDoesNotExist:
|
|
pass
|
|
|
|
def save(self, *args, **kwargs):
|
|
self.last_changed = now()
|
|
# If content is empty look for a template with the given name and
|
|
# populate the template instance with its content.
|
|
if settings.DBTEMPLATES_AUTO_POPULATE_CONTENT and not self.content:
|
|
self.populate()
|
|
super(Template, self).save(*args, **kwargs)
|
|
|
|
|
|
def add_default_site(instance, **kwargs):
|
|
"""
|
|
Called via Django's signals to cache the templates, if the template
|
|
in the database was added or changed, only if
|
|
DBTEMPLATES_ADD_DEFAULT_SITE setting is set.
|
|
"""
|
|
if not settings.DBTEMPLATES_ADD_DEFAULT_SITE:
|
|
return
|
|
current_site = Site.objects.get_current()
|
|
if current_site not in instance.sites.all():
|
|
instance.sites.add(current_site)
|
|
|
|
|
|
signals.post_save.connect(add_default_site, sender=Template)
|
|
signals.post_save.connect(add_template_to_cache, sender=Template)
|
|
signals.pre_delete.connect(remove_cached_template, sender=Template)
|