cr-connect-workflow/crc/services/jinja_service.py

from docxtpl import DocxTemplate, Listing, InlineImage
from jinja2 import Environment, DictLoader

from docx.shared import Inches
from io import BytesIO

import copy


class JinjaService:
    """Service for Jinja2 templates.

Includes the ability to embed templates inside templates, using task.data.

-- In task.data
name = "Dan"
my_template = "Hi {{name}}, This is a jinja template too!"

-- In Element Documentation
Please Introduce yourself.
{% include 'my_template' %}
Cool Right?

-- Produces
Please Introduce yourself.
Hi Dan, This is a jinja template too!
Cool Right?
"""

    @staticmethod
    def get_content(input_template, data):
        templates = data
        templates['main_template'] = input_template
        jinja2_env = Environment(loader=DictLoader(templates))

        # We just make a call here and let any errors percolate up to the calling method
        template = jinja2_env.get_template('main_template')
        return template.render(**data)

    @staticmethod
    def get_word_document_content(binary_stream, task_data, image_file_data=None):
        doc = DocxTemplate(binary_stream)
        doc_context = copy.deepcopy(task_data)
        doc_context = JinjaService().rich_text_update(doc_context)
        # doc_context = JinjaService().append_images(doc, doc_context, image_file_data)
        jinja2_env = Environment(autoescape=True)
        return doc.render(doc_context, jinja2_env)

    def rich_text_update(self, context):
        """This is a bit of a hack.  If we find that /n characters exist in the data, we want
        these to come out in the final document without requiring someone to predict it in the
        template.  Ideally we would use the 'RichText' feature of the python-docx library, but
        that requires we both escape it here, and in the Docx template.  There is a thing called
        a 'listing' in python-docx library that only requires we use it on the way in, and the
        template doesn't have to think about it.  So running with that for now."""
        # loop through the content, identify anything that has a newline character in it, and
        # wrap that sucker in a 'listing' function.
        if isinstance(context, dict):
            for k, v in context.items():
                context[k] = self.rich_text_update(v)
        elif isinstance(context, list):
            for i in range(len(context)):
                context[i] = self.rich_text_update(context[i])
        elif isinstance(context, str) and '\n' in context:
            return Listing(context)
        return context

    def append_images(self, template, context, image_file_data):
        context['images'] = {}
        if image_file_data is not None:
            for file_data_model in image_file_data:
                fm = file_data_model.file_model
                if fm is not None:
                    context['images'][fm.id] = {
                        'name': fm.name,
                        'url': '/v1.0/file/%s/data' % fm.id,
                        'image': self.make_image(file_data_model, template)
                    }

        return context

    @staticmethod
    def make_image(file_data_model, template):
        return InlineImage(template, BytesIO(file_data_model.data), width=Inches(6.5))