Application to store templates in database. Fixes ietf-tools#908

 - Legacy-Id: 5077

Author: emiliosanchez

ietf/dbtemplate/__init__.py

@@ -0,0 +1,10 @@
+from django import forms
+
+from ietf.dbtemplate.models import DBTemplate
+
+
+class DBTemplateForm(forms.ModelForm):
+
+    class Meta:
+        model = DBTemplate
+        fields = ('content', )

ietf/dbtemplate/forms.py

@@ -0,0 +1,45 @@
+from django.db import models
+
+from ietf.group.models import Group
+
+
+TEMPLATE_TYPES = (
+    ('plain', 'Plain'),
+    ('rst', 'reStructuredText'),
+    ('django', 'Django'),
+    )
+
+
+class DBTemplate(models.Model):
+    path = models.CharField(
+        max_length=255,
+        unique=True,
+        blank=False,
+        null=False,
+        )
+    title = models.CharField(
+        max_length=255,
+        blank=False,
+        null=False,
+        )
+    help_text = models.TextField(
+        blank=True,
+        null=True,
+        )
+    template_type = models.CharField(
+        max_length=10,
+        choices=TEMPLATE_TYPES,
+        default='rst',
+        )
+    content = models.TextField(
+        blank=False,
+        null=False,
+        )
+    group = models.ForeignKey(
+        Group,
+        blank=True,
+        null=True,
+        )
+
+    def __unicode__(self):
+        return self.title

ietf/dbtemplate/migrations/0001_initial.py

@@ -0,0 +1 @@
+%(html_body)s

ietf/dbtemplate/migrations/__init__.py

@@ -0,0 +1,79 @@
+import os
+import string
+from docutils.core import publish_string
+
+from django.template import Template as DjangoTemplate, TemplateDoesNotExist, TemplateEncodingError
+from django.template.loader import BaseLoader
+from django.utils.encoding import smart_unicode
+
+from ietf.dbtemplate.models import DBTemplate
+
+
+BASE_DIR = os.path.dirname(os.path.abspath(__file__))
+RST_TEMPLATE = os.path.join(BASE_DIR, 'resources/rst.txt')
+
+
+class Template(object):
+
+    def __init__(self, template_string, origin=None, name='<Unknown Template>'):
+        try:
+            template_string = smart_unicode(template_string)
+        except UnicodeDecodeError:
+            raise TemplateEncodingError("Templates can only be constructed from unicode or UTF-8 strings.")
+        self.template_string = string.Template(template_string)
+        self.name = name
+
+    def render(self, context):
+        raise NotImplemented
+
+
+class PlainTemplate(Template):
+
+    def render(self, context):
+        context_dict = {}
+        for d in context.dicts:
+            context_dict.update(d)
+        return self.template_string.safe_substitute(context_dict)
+
+
+class RSTTemplate(PlainTemplate):
+
+    def render(self, context):
+        interpolated_string = super(RSTTemplate, self).render(context)
+        return publish_string(source=interpolated_string,
+                              writer_name='html',
+                              settings_overrides={
+                                  'input_encoding': 'unicode',
+                                  'output_encoding': 'unicode',
+                                  'embed_stylesheet': False,
+                                  'xml_declaration': False,
+                                  'template': RST_TEMPLATE,
+                              })
+
+
+class Loader(BaseLoader):
+
+    def load_template_source(self, template_name, template_dirs=None):
+        try:
+            template = DBTemplate.objects.get(path=template_name)
+            if template.template_type == 'rst':
+                return (RSTTemplate(template.content), template)
+            elif template.template_type == 'django':
+                return (DjangoTemplate(template.content), template)
+            return (PlainTemplate(template.content), template)
+        except DBTemplate.DoesNotExist:
+            raise TemplateDoesNotExist(template_name)
+
+
+_loader = Loader()
+
+
+def load_template_source(template_name, template_dirs=None):
+    # For backwards compatibility
+    import warnings
+    warnings.warn(
+        "'ietf.dbtemplate.template.load_template_source' is deprecated; use 'ietf.dbtemplate.template.Loader' instead.",
+        PendingDeprecationWarning
+    )
+    return _loader.load_template_source(template_name, template_dirs)
+load_template_source.is_usable = True

ietf/dbtemplate/models.py

@@ -0,0 +1,37 @@
+{% extends "base.html" %}
+
+{% block content %}
+<h1>Template: {{ template }}</h1>
+
+<h2>Meta information</h2>
+<dl>
+  <dt>Title</dt>
+  <dd>{{ template.title }}</dt>
+  <dt>Group</dt>
+  <dd>{{ template.group }}</dd>
+  <dt>Template type</dt>
+  <dd>{{ template.get_template_type_display }}
+  {% ifequal template.template_type "rst" %}
+  <p>This template uses the syntax of reStructuredText. Get a quick reference at <a href="http://docutils.sourceforge.net/docs/user/rst/quickref.html">http://docutils.sourceforge.net/docs/user/rst/quickref.html</a>.</p>
+  <p>You can do variable interpolation with $varialbe if the template allows any variable.</p>
+  {% endifequal %}
+  {% ifequal template.template_type "django" %}
+  <p>This template uses the syntax of the default django template framework. Get more info at <a href="https://docs.djangoproject.com/en/dev/topics/templates/">https://docs.djangoproject.com/en/dev/topics/templates/</a>.</p>
+  <p>You can do variable interpolation with the current django markup &#123;&#123;variable&#125;&#125; if the template allows any variable.</p>
+  {% endifequal %}
+  {% ifequal template.template_type "plain" %}
+  <p>This template uses plain text, so no markup is used. You can do variable interpolation with $variable if the template allows any variable.</p>
+  {% endifequal %}
+  </dd>
+  {% if template.help_text %}
+  <dt>Extra info about this template</dt>
+  <dd>{{ template.help_text }}</dd>
+  {% endif %}
+</dl>
+
+<h2>Edit template content</h2>
+<form action="" method="post">
+{{ form.as_p }}
+<input type="submit" value="Submit changes" />
+</form>
+{% endblock content %}

ietf/dbtemplate/resources/rst.txt

@@ -0,0 +1,15 @@
+{% extends "base.html" %}
+
+{% block content %}
+<h1>Defined templates for group {{ group }}</h1>
+
+{% if template_list %}
+<ul>
+{% for template in template_list %}
+  <li><a href="{% url template_edit group.acronym template.id %}">{{ template }}</a></li>
+{% endfor %}
+</ul>
+{% else %}
+  <p>There are no templates defined for this group.</p>
+{% endif %}
+{% endblock content %}

ietf/dbtemplate/template.py

@@ -0,0 +1,7 @@
+from django.conf.urls.defaults import patterns, url
+
+
+urlpatterns = patterns('ietf.dbtemplate.views',
+    url(r'^(?P<acronym>[\w.@+-]+)/$', 'template_list', name='template_list'),
+    url(r'^(?P<acronym>[\w.@+-]+)/(?P<template_id>[\d]+)/$', 'template_edit', name='template_edit'),
+)