feat: make the Attach To Field a (optional) setting (#66)

Co-authored-by: Raffael Meyer <14891507+barredterra@users.noreply.github.com>

Author: PatrickDEissler

README.md

@@ -25,10 +25,19 @@ To change the settings of this app, you can open **PDF on Submit Settings** via
 
 In the _Enabled For_ table, add a row for each DocType you want to enable PDF generation for.
 
-If you don't choose a different configuration, PDFs will be generated with the default **Print Format** and **Letter Head**. The PDF is named like the document name.
+If you don't choose a different configuration, PDFs will be generated with the default **Print Format** and **Letter Head**. By default, the PDF is named like the document name.
 
 Alternatively, you can choose a different **Print Format** and **Letter Head** for each DocType. You can also define a custom format for the PDF file name.
 
+If your transaction DocType has an attachment field, you can choose to attach the generated PDF to that field. Please note that the field needs to have the following properties:
+
+- Fieldtype: Attach
+- Read Only: Yes
+    This is to prevent users from adding an attachment that will be overwritten on submit.
+- No Copy: Yes
+    This is to prevent the attachment from being copied to other documents.
+- Is Virtual: No
+
 ![PDF on Submit Settings](docs/settings.gif)
 
 ### Filters and different PDFs for the same DocType

pdf_on_submit/attach_pdf.py

@@ -43,6 +43,7 @@ def process_enabled_doctype(doc, settings, in_background):
 	args = {
 		"doctype": doc.doctype,
 		"name": doc.name,
+		"to_field": settings.attach_to_field,
 		"title": doc.get_title() if doc.meta.title_field else None,
 		"lang": getattr(doc, "language", fallback_language),
 		"show_progress": not in_background,
@@ -67,6 +68,7 @@ def process_enabled_doctype(doc, settings, in_background):
 def execute(
 	doctype,
 	name,
+	to_field=None,
 	title=None,
 	lang=None,
 	show_progress=True,
@@ -120,7 +122,7 @@ def publish_progress(percent):
 	if show_progress:
 		publish_progress(66)
 
-	save_and_attach(pdf_data, doctype, name, target_folder, auto_name)
+	save_and_attach(pdf_data, doctype, name, target_folder, auto_name, to_field)
 
 	if show_progress:
 		publish_progress(100)
@@ -143,7 +145,7 @@ def get_pdf_data(doctype, name, print_format: None, letterhead: None):
 	return frappe.utils.pdf.get_pdf(html)
 
 
-def save_and_attach(content, to_doctype, to_name, folder, auto_name=None):
+def save_and_attach(content, to_doctype, to_name, folder, auto_name=None, to_field=None):
 	"""
 	Save content to disk and create a File document.
 
@@ -164,8 +166,12 @@ def save_and_attach(content, to_doctype, to_name, folder, auto_name=None):
 	file.is_private = 1
 	file.attached_to_doctype = to_doctype
 	file.attached_to_name = to_name
+	file.attached_to_field = to_field
 	file.save()
 
+	if to_field:
+		frappe.db.set_value(to_doctype, to_name, to_field, file.file_url)
+
 
 def set_name_from_naming_options(autoname, doc):
 	"""

pdf_on_submit/pdf_on_submit/doctype/enabled_doctype/enabled_doctype.json

@@ -6,6 +6,7 @@
  "engine": "InnoDB",
  "field_order": [
   "document_type",
+  "attach_to_field",
   "print_format",
   "letter_head",
   "auto_name",
@@ -65,17 +66,25 @@
    "fieldname": "filter_description",
    "fieldtype": "HTML",
    "options": "Optional: create PDF only if the submitted document matches these filters.<br><br>"
+  },
+  {
+   "description": "If set, the PDF will be stored in this specific Attach field. If not set, it will be attached to the document without a specific field.<br>\n<b>Note:</b> The Attach fields should be 'No Copy' and 'Read Only'. Otherwise they get overwritten on submit.",
+   "fieldname": "attach_to_field",
+   "fieldtype": "Select",
+   "label": "Attach To Field"
   }
  ],
+ "grid_page_length": 50,
  "istable": 1,
  "links": [],
- "modified": "2025-02-08 01:03:04.756526",
+ "modified": "2025-06-29 13:32:14.451432",
  "modified_by": "Administrator",
  "module": "PDF on Submit",
  "name": "Enabled DocType",
  "owner": "Administrator",
  "permissions": [],
  "quick_entry": 1,
+ "row_format": "Dynamic",
  "sort_field": "modified",
  "sort_order": "DESC",
  "states": [],

pdf_on_submit/pdf_on_submit/doctype/pdf_on_submit_settings/pdf_on_submit_settings.js

@@ -18,12 +18,20 @@ frappe.ui.form.on("PDF on Submit Settings", {
 				},
 			};
 		});
+
+		frm.doc.enabled_for.forEach((row) => {
+			set_attach_to_field_options(frm, row.doctype, row.name);
+		});
 	},
 	enabled_for_on_form_rendered(frm) {
 		const row = frm.cur_grid.doc;
 		const parent = frm.cur_grid.wrapper.find("[data-fieldname='filter_area']");
 		parent.empty();
 
+		if (!row.document_type) {
+			return;
+		}
+
 		const filters = row.filters && row.filters !== "[]" ? JSON.parse(row.filters) : [];
 
 		frappe.model.with_doctype(row.document_type, () => {
@@ -49,6 +57,7 @@ frappe.ui.form.on("Enabled DocType", {
 	document_type(frm, cdt, cdn) {
 		const row = locals[cdt][cdn];
 		frappe.model.set_value(row.doctype, row.name, "filters", "[]");
+		frappe.model.set_value(row.doctype, row.name, "attach_to_field", "");
 
 		if (row.print_format) {
 			// Check if the print format is valid for the document type
@@ -63,5 +72,67 @@ frappe.ui.form.on("Enabled DocType", {
 		if (frm.cur_grid) {
 			frm.events.enabled_for_on_form_rendered(frm);
 		}
+
+		set_attach_to_field_options(frm, cdt, cdn);
 	},
 });
+
+
+function set_attach_to_field_options(frm, cdt, cdn) {
+	const doc = frappe.get_doc(cdt, cdn);
+	const document_type = doc.document_type;
+	const grid = frm.fields_dict.enabled_for.grid;
+
+	if (!document_type) {
+		set_field_options(grid, cdn, "attach_to_field", [""]);
+		return;
+	}
+
+	// set options for `attach_to_field`
+	frappe.model.with_doctype(document_type, () => {
+		const meta = frappe.get_meta(document_type);
+		const fields = [
+			"",
+			...meta.fields
+				.filter(
+					(field) =>
+						field.fieldtype === "Attach" &&
+						field.is_virtual === 0 &&
+						field.read_only === 1 &&
+						field.no_copy === 1
+				)
+				.map((field) => {
+					return {
+						value: field.fieldname,
+						label: __(field.label),
+					};
+				})
+				.sort((a, b) => a.label.localeCompare(b.label)),
+		];
+
+		set_field_options(grid, cdn, "attach_to_field", fields);
+		grid.debounced_refresh();
+	});
+}
+
+/**
+ * Set the options for a field in a specific grid row
+ * @param {frappe.ui.form.Grid} grid - frm.fields_dict.[child_table_name].grid
+ * @param {string} row_name - The name of the grid row
+ * @param {string} fieldname - The fieldname to set the options for
+ * @param {any[]} options - The options to set for the field
+ */
+function set_field_options(grid, row_name, fieldname, options) {
+	for (const row of grid.grid_rows) {
+		if (row.doc.name !== row_name) {
+			continue;
+		}
+
+		let docfield = row?.docfields?.find((d) => d.fieldname === fieldname);
+		if (docfield) {
+			docfield.options = options;
+		} else {
+			throw `field ${fieldname} not found`;
+		}
+	}
+}

pdf_on_submit/pdf_on_submit/doctype/pdf_on_submit_settings/pdf_on_submit_settings.py

@@ -17,3 +17,40 @@ def validate(self):
 						enabled_doctype.idx, enabled_doctype.document_type, e
 					)
 				)
+
+		self.validate_attach_to_fields()
+
+	def validate_attach_to_fields(self):
+		"""
+		Validates:
+		1) attach_to_field is not processed multiple times in one document
+		2) that the `attach_to_field` is a valid field in the DocType.
+		Note: The 2nd validation would be more robust (but less performant), if done for each transaction.
+		"""
+		attach_to_fields = [
+			(enabled_doctype.document_type, enabled_doctype.attach_to_field) for enabled_doctype in self.enabled_for
+			if enabled_doctype.attach_to_field
+		]
+		if attach_to_fields:
+			_check_for_duplicate_fieldnames(attach_to_fields)
+			_check_if_attach_to_fields_are_valid(attach_to_fields)
+
+
+def _check_for_duplicate_fieldnames(attach_to_fields):
+	"""Ensure only one PDF file will be attached to a specific field."""
+	seen_fields = set()
+	for pair in attach_to_fields:
+		if pair in seen_fields:
+			frappe.throw(
+				_("It is not allowed to set the attach field {0} in the DocType {1} multiple times.").format(pair[1], pair[0])
+			)
+		seen_fields.add(pair)
+
+
+def _check_if_attach_to_fields_are_valid(attach_to_fields):
+	for doctype, fieldname in attach_to_fields:
+		meta = frappe.get_meta(doctype)
+		if not meta.get("fields", {"fieldtype": "Attach", "fieldname": fieldname}):
+			frappe.throw(
+				_("{0} is not a valid field for DocType {1}.").format(fieldname, _(doctype))
+			)