Ticket #9666: future_ssi-1.diff

django/templatetags/future_ssi.py

@@ +1 @@
+from django.conf import settings
+from django.template import Library, Node, Template, TemplateSyntaxError
+from django.template.defaulttags import include_is_allowed
+
+
+register = Library()
+
+
+class SsiNode(Node):
+    def __init__(self, filepath, parsed):
+        self.filepath, self.parsed = filepath, parsed
+
+    def render(self, context):
+        filepath = self.filepath.resolve(context)
+        if not include_is_allowed(filepath):
+            if settings.DEBUG:
+                return "[Didn't have permission to include file]"
+            else:
+                return '' # Fail silently for invalid includes.
+        try:
+            fp = open(filepath, 'r')
+            output = fp.read()
+            fp.close()
+        except IOError:
+            output = ''
+        if self.parsed:
+            try:
+                t = Template(output, name=filepath)
+                return t.render(context)
+            except TemplateSyntaxError, e:
+                if settings.DEBUG:
+                    return "[Included template had syntax error: %s]" % e
+                else:
+                    return '' # Fail silently for invalid included templates.
+        return output
+
+
+def ssi(parser, token):
+    """
+    Outputs the contents of a given file into the page.
+
+    Like a simple "include" tag, the ``ssi`` tag includes the contents
+    of another file -- which must be specified using an absolute path --
+    in the current page::
+
+        {% ssi "/home/html/ljworld.com/includes/right_generic.html" %}
+
+    If the optional "parsed" parameter is given, the contents of the included
+    file are evaluated as template code, with the current context::
+
+        {% ssi "/home/html/ljworld.com/includes/right_generic.html" parsed %}
+    """
+    bits = token.contents.split()
+    parsed = False
+    if len(bits) not in (2, 3):
+        raise TemplateSyntaxError("'ssi' tag takes one argument: the path to"
+                                  " the file to be included")
+    if len(bits) == 3:
+        if bits[2] == 'parsed':
+            parsed = True
+        else:
+            raise TemplateSyntaxError("Second (optional) argument to %s tag"
+                                      " must be 'parsed'" % bits[0])
+    filepath = parser.compile_filter(bits[1])
+    return SsiNode(filepath, parsed)
+ssi = register.tag(ssi)

django/template/defaulttags.py

@@ -893 +893 @@
 
         {% ssi /home/html/ljworld.com/includes/right_generic.html parsed %}
     """
+
+    import warnings
+    warnings.warn('The old style ssi tag is being deprecated. '
+                  'You can start using the new style ssi (link to docs).',
+                  category=PendingDeprecationWarning)
+
     bits = token.contents.split()
     parsed = False
     if len(bits) not in (2, 3):

docs/ref/templates/builtins.txt

@@ -885 +885 @@
 
 See also: ``{% include %}``.
 
+.. versionchanged:: 1.3
+
+If you find yourself needing to use a context variable as the filepath, 
+you can now do that. To do so you must load a new ssi tag that overwrites
+the previous tag.
+
+For example::
+
+    {% load future_ssi %}
+    {% ssi path_to_file parsed %}
+
+Now if you have ``path_to_file`` defined in your template context
+it will use that value. Please note that old paths that are
+not context variables need to be quoted using the new ssi tag.
+
+For example::
+
+    {% url "/home/html/ljworld.com/includes/right_generic.html" parsed %}
+
+In version 1.3 the old ssi tag throws a ``PendingDeprecationWarning``,
+then is version 1.4 this will move to a ``DeprecationWarning`` and finally
+in version 1.5 the old tag will be removed and replaced by the new tag.
+
 .. templatetag:: templatetag
 
 templatetag