Added file_metadata parameter to import_one and createDocument to set mainfile metadata

Author: chris-adam

CHANGES.rst

@@ -4,7 +4,8 @@ Changelog
 1.3.2 (unreleased)
 ------------------
 
-- Nothing changed yet.
+- Added file_metadata parameter to import_one and createDocument to set mainfile metadata.
+  [chris-adam]
 
 
 1.3.1 (2024-06-06)

src/collective/dms/batchimport/batchimport.py

@@ -88,12 +88,17 @@ def __call__(self):
                 foldername = basename[len(self.fs_root_directory) :]
 
                 metadata = json.load(file(metadata_filepath))
+                file_metadata = {}
+                for md in metadata:
+                    if md.startswith("file_"):
+                        file_metadata[md[5:]] = metadata[md]
+                        del metadata[md]
 
                 imported_filename = os.path.splitext(filename)[0]
                 filepath = os.path.join(basename, imported_filename)
 
                 try:
-                    self.import_one(filepath, foldername, metadata)
+                    self.import_one(filepath, foldername, metadata, file_metadata)
                 except BatchImportError as e:
                     log.warning("error importing %s (%s)" % (os.path.join(foldername, filename), str(e)))
                     nb_errors += 1
@@ -142,7 +147,7 @@ def convertTitleToId(self, title):
         newid = queryUtility(IIDNormalizer).normalize(title)
         return newid
 
-    def import_one(self, filepath, foldername, metadata=None):
+    def import_one(self, filepath, foldername, metadata=None, file_metadata=None):
         try:
             folder = self.get_folder(foldername)
         except AttributeError:
@@ -163,7 +168,15 @@ def import_one(self, filepath, foldername, metadata=None):
             raise BatchImportError("document already exists")
 
         document_file = NamedBlobFile(file(filepath).read(), filename=unicode(filename))
-        utils.createDocument(self, folder, portal_type, document_id, document_file, metadata=metadata)
+        utils.createDocument(
+            self,
+            folder,
+            portal_type,
+            document_id,
+            document_file,
+            metadata=metadata,
+            file_metadata=file_metadata,
+        )
 
 
 class ControlPanelEditForm(controlpanel.RegistryEditForm):

src/collective/dms/batchimport/utils.py

@@ -22,7 +22,15 @@
 
 
 def createDocument(
-    context, folder, portal_type, title, file_object, mainfile_type="dmsmainfile", owner=None, metadata=None
+    context,
+    folder,
+    portal_type,
+    title,
+    file_object,
+    mainfile_type="dmsmainfile",
+    owner=None,
+    metadata=None,
+    file_metadata=None,
 ):
     if owner is None:
         owner = api.user.get_current().id
@@ -55,10 +63,21 @@ def createDocument(
                 )
             )
 
-    file_title = _("Scanned Mail")
+    if not file_metadata:
+        file_metadata = {}
+    # title
     if "file_title" in metadata:
         file_title = metadata["file_title"]
         del metadata["file_title"]
+    if "title" not in file_metadata:
+        file_title = _("Scanned Mail")
+    file_metadata["title"] = file_title
+    # portal_type
+    if mainfile_type:
+        file_metadata["portal_type"] = mainfile_type
+    # file
+    if file_object:
+        file_metadata["file"] = file_object
 
     with api.env.adopt_user(username=owner):
         document = createContentInContainer(folder, portal_type, **metadata)
@@ -67,6 +86,6 @@ def createDocument(
         if IDeadline and IDeadline.providedBy(document):
             document.deadline = deadlineDefaultValue(None)
 
-        version = createContentInContainer(document, mainfile_type, title=file_title, file=file_object)
+        version = createContentInContainer(document, **file_metadata)
         log.info("file document has been created (id: %s)" % version.id)
         return (document, version)