Feature: Enhanced templating for filename format (#7836)

Co-authored-by: shamoon <4887959+shamoon@users.noreply.github.com>

src/documents/migrations/1012_fix_archive_files.py

@@ -4,6 +4,7 @@ import hashlib
 import logging
 import os
 import shutil
+from collections import defaultdict
 from time import sleep
 
 import pathvalidate
@@ -12,14 +13,41 @@ from django.db import migrations
 from django.db import models
 from django.template.defaultfilters import slugify
 
-from documents.file_handling import defaultdictNoStr
-from documents.file_handling import many_to_dictionary
-
 logger = logging.getLogger("paperless.migrations")
 
+
 ###############################################################################
 # This is code copied straight paperless before the change.
 ###############################################################################
+class defaultdictNoStr(defaultdict):
+    def __str__(self):  # pragma: no cover
+        raise ValueError("Don't use {tags} directly.")
+
+
+def many_to_dictionary(field):  # pragma: no cover
+    # Converts ManyToManyField to dictionary by assuming, that field
+    # entries contain an _ or - which will be used as a delimiter
+    mydictionary = dict()
+
+    for index, t in enumerate(field.all()):
+        # Populate tag names by index
+        mydictionary[index] = slugify(t.name)
+
+        # Find delimiter
+        delimiter = t.name.find("_")
+
+        if delimiter == -1:
+            delimiter = t.name.find("-")
+
+        if delimiter == -1:
+            continue
+
+        key = t.name[:delimiter]
+        value = t.name[delimiter + 1 :]
+
+        mydictionary[slugify(key)] = slugify(value)
+
+    return mydictionary
 
 
 def archive_name_from_filename(filename):

src/documents/migrations/1055_alter_storagepath_path.py

@@ -0,0 +1,36 @@
+# Generated by Django 5.1.1 on 2024-10-03 14:47
+
+from django.conf import settings
+from django.db import migrations
+from django.db import models
+from django.db import transaction
+from filelock import FileLock
+
+from documents.templating.utils import convert_format_str_to_template_format
+
+
+def convert_from_format_to_template(apps, schema_editor):
+    StoragePath = apps.get_model("documents", "StoragePath")
+
+    with transaction.atomic(), FileLock(settings.MEDIA_LOCK):
+        for storage_path in StoragePath.objects.all():
+            storage_path.path = convert_format_str_to_template_format(storage_path.path)
+            storage_path.save()
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("documents", "1054_customfieldinstance_value_monetary_amount_and_more"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="storagepath",
+            name="path",
+            field=models.CharField(max_length=2048, verbose_name="path"),
+        ),
+        migrations.RunPython(
+            convert_from_format_to_template,
+            migrations.RunPython.noop,
+        ),
+    ]