64a85e19e7
When loading a Mako template from a Django template, the file encoding of the Mako template was left unspecified. In some cases, this would cause the Mako template to be interpreted as an ASCII template, resulting in blowups if the template was encoded in UTF-8 (e.g., lms/templates/footer.html). Now, both the input and output encodings are specified as UTF-8.
86 lines
3.0 KiB
Python
86 lines
3.0 KiB
Python
import logging
|
|
|
|
from django.conf import settings
|
|
from django.template.base import TemplateDoesNotExist
|
|
from django.template.loader import make_origin, get_template_from_string
|
|
from django.template.loaders.filesystem import Loader as FilesystemLoader
|
|
from django.template.loaders.app_directories import Loader as AppDirectoriesLoader
|
|
|
|
from mitxmako.template import Template
|
|
import mitxmako.middleware
|
|
|
|
import tempdir
|
|
|
|
log = logging.getLogger(__name__)
|
|
|
|
|
|
class MakoLoader(object):
|
|
"""
|
|
This is a Django loader object which will load the template as a
|
|
Mako template if the first line is "## mako". It is based off BaseLoader
|
|
in django.template.loader.
|
|
"""
|
|
|
|
is_usable = False
|
|
|
|
def __init__(self, base_loader):
|
|
# base_loader is an instance of a BaseLoader subclass
|
|
self.base_loader = base_loader
|
|
|
|
module_directory = getattr(settings, 'MAKO_MODULE_DIR', None)
|
|
|
|
if module_directory is None:
|
|
log.warning("For more caching of mako templates, set the MAKO_MODULE_DIR in settings!")
|
|
module_directory = tempdir.mkdtemp_clean()
|
|
|
|
self.module_directory = module_directory
|
|
|
|
|
|
def __call__(self, template_name, template_dirs=None):
|
|
return self.load_template(template_name, template_dirs)
|
|
|
|
def load_template(self, template_name, template_dirs=None):
|
|
source, file_path = self.load_template_source(template_name, template_dirs)
|
|
|
|
if source.startswith("## mako\n"):
|
|
# This is a mako template
|
|
template = Template(filename=file_path,
|
|
module_directory=self.module_directory,
|
|
input_encoding='utf-8',
|
|
output_encoding='utf-8',
|
|
uri=template_name)
|
|
return template, None
|
|
else:
|
|
# This is a regular template
|
|
origin = make_origin(file_path, self.load_template_source, template_name, template_dirs)
|
|
try:
|
|
template = get_template_from_string(source, origin, template_name)
|
|
return template, None
|
|
except TemplateDoesNotExist:
|
|
# If compiling the template we found raises TemplateDoesNotExist, back off to
|
|
# returning the source and display name for the template we were asked to load.
|
|
# This allows for correct identification (later) of the actual template that does
|
|
# not exist.
|
|
return source, file_path
|
|
|
|
def load_template_source(self, template_name, template_dirs=None):
|
|
# Just having this makes the template load as an instance, instead of a class.
|
|
return self.base_loader.load_template_source(template_name, template_dirs)
|
|
|
|
def reset(self):
|
|
self.base_loader.reset()
|
|
|
|
|
|
class MakoFilesystemLoader(MakoLoader):
|
|
is_usable = True
|
|
|
|
def __init__(self):
|
|
MakoLoader.__init__(self, FilesystemLoader())
|
|
|
|
|
|
class MakoAppDirectoriesLoader(MakoLoader):
|
|
is_usable = True
|
|
|
|
def __init__(self):
|
|
MakoLoader.__init__(self, AppDirectoriesLoader())
|