mirror of
https://github.com/paperless-ngx/paperless-ngx.git
synced 2025-09-12 21:35:40 -05:00
9e11e7fd05
--------- Co-authored-by: Trenton Holmes <797416+stumpylog@users.noreply.github.com> Co-authored-by: shamoon <4887959+shamoon@users.noreply.github.com>
107 lines
3.6 KiB
Python
107 lines
3.6 KiB
Python
import logging
|
|
from datetime import date
|
|
from datetime import datetime
|
|
from pathlib import Path
|
|
|
|
from django.utils.text import slugify as django_slugify
|
|
from jinja2 import StrictUndefined
|
|
from jinja2 import Template
|
|
from jinja2 import TemplateSyntaxError
|
|
from jinja2 import UndefinedError
|
|
from jinja2 import make_logging_undefined
|
|
from jinja2.sandbox import SecurityError
|
|
|
|
from documents.templating.environment import _template_environment
|
|
from documents.templating.filters import format_datetime
|
|
from documents.templating.filters import localize_date
|
|
|
|
logger = logging.getLogger("paperless.templating")
|
|
|
|
_LogStrictUndefined = make_logging_undefined(logger, StrictUndefined)
|
|
|
|
|
|
_template_environment.undefined = _LogStrictUndefined
|
|
|
|
_template_environment.filters["datetime"] = format_datetime
|
|
|
|
_template_environment.filters["slugify"] = django_slugify
|
|
|
|
_template_environment.filters["localize_date"] = localize_date
|
|
|
|
|
|
def parse_w_workflow_placeholders(
|
|
text: str,
|
|
correspondent_name: str,
|
|
doc_type_name: str,
|
|
owner_username: str,
|
|
local_added: datetime,
|
|
original_filename: str,
|
|
filename: str,
|
|
created: date | None = None,
|
|
doc_title: str | None = None,
|
|
doc_url: str | None = None,
|
|
) -> str:
|
|
"""
|
|
Available title placeholders for Workflows depend on what has already been assigned,
|
|
e.g. for pre-consumption triggers created will not have been parsed yet, but it will
|
|
for added / updated triggers
|
|
"""
|
|
|
|
formatting = {
|
|
"correspondent": correspondent_name,
|
|
"document_type": doc_type_name,
|
|
"added": local_added.isoformat(),
|
|
"added_year": local_added.strftime("%Y"),
|
|
"added_year_short": local_added.strftime("%y"),
|
|
"added_month": local_added.strftime("%m"),
|
|
"added_month_name": local_added.strftime("%B"),
|
|
"added_month_name_short": local_added.strftime("%b"),
|
|
"added_day": local_added.strftime("%d"),
|
|
"added_time": local_added.strftime("%H:%M"),
|
|
"owner_username": owner_username,
|
|
"original_filename": Path(original_filename).stem,
|
|
"filename": Path(filename).stem,
|
|
}
|
|
if created is not None:
|
|
formatting.update(
|
|
{
|
|
"created": created.isoformat(),
|
|
"created_year": created.strftime("%Y"),
|
|
"created_year_short": created.strftime("%y"),
|
|
"created_month": created.strftime("%m"),
|
|
"created_month_name": created.strftime("%B"),
|
|
"created_month_name_short": created.strftime("%b"),
|
|
"created_day": created.strftime("%d"),
|
|
"created_time": created.strftime("%H:%M"),
|
|
},
|
|
)
|
|
if doc_title is not None:
|
|
formatting.update({"doc_title": doc_title})
|
|
if doc_url is not None:
|
|
formatting.update({"doc_url": doc_url})
|
|
|
|
logger.debug(f"Jinja Template is : {text}")
|
|
try:
|
|
template = _template_environment.from_string(
|
|
text,
|
|
template_class=Template,
|
|
)
|
|
rendered_template = template.render(formatting)
|
|
|
|
# We're good!
|
|
return rendered_template
|
|
except UndefinedError as e:
|
|
# The undefined class logs this already for us
|
|
raise e
|
|
except TemplateSyntaxError as e:
|
|
logger.warning(f"Template syntax error in title generation: {e}")
|
|
except SecurityError as e:
|
|
logger.warning(f"Template attempted restricted operation: {e}")
|
|
except Exception as e:
|
|
logger.warning(f"Unknown error in title generation: {e}")
|
|
logger.warning(
|
|
f"Invalid title format '{text}', workflow not applied: {e}",
|
|
)
|
|
raise e
|
|
return None
|