Merge pull request #917 from efeone/avish_aprl22

feat: sync vehicle return details with transaction log and auto-update on project completion

Author: MhmdSinanKT

beams/beams/custom_scripts/project/project.js

@@ -321,3 +321,46 @@ frappe.ui.form.on('Project', {
       }
     }
   });
+
+  frappe.ui.form.on('Allocated Vehicle Details', {
+      return: function(frm, cdt, cdn) {
+          let row = locals[cdt][cdn];
+          frappe.prompt([
+              {
+                  label: 'Return Date',
+                  fieldname: 'return_date',
+                  fieldtype: 'Datetime',
+                  reqd: 1
+              },
+              {
+                  label: 'Return Reason',
+                  fieldname: 'return_reason',
+                  fieldtype: 'Small Text',
+                  reqd: 1
+              }
+          ],
+          function(values) {
+              row.return_date = values.return_date;
+              row.return_reason = values.return_reason;
+              row.returned = 1;
+              frm.refresh_field('allocated_vehicle_details');
+              frappe.call({
+                  method: "beams.beams.custom_scripts.project.project.update_vehicle_return_details_in_log",
+                  args: {
+                      project: frm.doc.name,
+                      vehicle: row.vehicle,
+                      return_date: values.return_date,
+                      return_reason: values.return_reason
+                  },
+                  callback: function(r) {
+                      if (!r.exc) {
+                          frappe.msgprint("Vehicle Transaction Log updated.");
+                          frm.save();
+                      }
+                  }
+              });
+          },
+          'Return Vehicle',
+          'Submit');
+      }
+  });

beams/beams/custom_scripts/project/project.py

@@ -476,3 +476,113 @@ def on_update_project(doc, method):
     if updated:
         log_doc.save(ignore_permissions=True)
         frappe.msgprint(f"Unreturned manpower records marked as returned due to project {doc.status.lower()}.")
+
+def sync_vehicle_logs(doc, method):
+    """
+    Sync vehicle transaction logs from Project's allocated_vehicle_details to
+    Vehicle Transaction Log's vehicle_log_details, while preserving return data.
+    """
+
+    source_child_table = "allocated_vehicle_details"
+    target_child_table = "vehicle_log_details"
+
+    log_name = frappe.db.get_value("Vehicle Transaction Log", {"project": doc.name})
+
+    if log_name:
+        transaction_log = frappe.get_doc("Vehicle Transaction Log", log_name)
+    else:
+        transaction_log = frappe.new_doc("Vehicle Transaction Log")
+        transaction_log.project = doc.name
+        transaction_log.project_name = doc.project_name
+
+    if not transaction_log.meta.get_field(target_child_table):
+        frappe.throw(f"Child table field '{target_child_table}' not found in Vehicle Transaction Log")
+
+    existing_logs = {
+        row.vehicle: row
+        for row in transaction_log.get(target_child_table)
+    }
+
+    updated_rows = []
+
+    for row in doc.get(source_child_table) or []:
+        vehicle = row.vehicle
+        existing = existing_logs.get(vehicle)
+
+        from_location = frappe.db.get_value("Location", row.get("from"), "location_name") or row.get("from")
+        to_location = frappe.db.get_value("Location", row.get("to"), "location_name") or row.get("to")
+
+        log_data = {
+            "vehicle": vehicle,
+            "from": from_location,
+            "to": to_location,
+            "no_of_travellers": row.no_of_travellers,
+            "status": row.status,
+        }
+
+        if existing:
+            log_data["return_date"] = existing.return_date
+            log_data["return_reason"] = existing.return_reason
+
+        updated_rows.append(log_data)
+
+    transaction_log.set(target_child_table, [])
+    for data in updated_rows:
+        transaction_log.append(target_child_table, data)
+
+    transaction_log.save(ignore_permissions=True)
+
+@frappe.whitelist()
+def update_vehicle_return_details_in_log(project, vehicle, return_date, return_reason):
+    """
+    Updates the return details of a vehicle in the 'Vehicle Transaction Log' for the given project.
+    """
+    log_name = frappe.db.get_value("Vehicle Transaction Log", {"project": project})
+    if not log_name:
+        frappe.throw(_("No Vehicle Transaction Log found for this project."))
+
+    log_doc = frappe.get_doc("Vehicle Transaction Log", log_name)
+    updated = False
+
+    for row in log_doc.vehicle_log_details:
+        if row.vehicle == vehicle and not row.returned:
+            row.returned = True
+            row.return_date = return_date
+            row.return_reason = return_reason
+            updated = True
+    if updated:
+        log_doc.save(ignore_permissions=True)
+    else:
+        frappe.throw(_("No matching vehicle record found in the transaction log."))
+
+def auto_return_vehicles_on_project_completion(doc, method):
+    """
+    Automatically marks vehicles as returned in the 'Vehicle Transaction Log'
+    when the associated project is marked as 'Completed' or 'Cancelled'.
+    """
+    if doc.status not in ("Completed", "Cancelled"):
+        return
+
+    log_name = frappe.db.get_value("Vehicle Transaction Log", {"project": doc.name})
+    if not log_name:
+        return
+
+    log_doc = frappe.get_doc("Vehicle Transaction Log", log_name)
+    updated = False
+
+    for row in log_doc.vehicle_log_details:
+        if not row.returned and not row.return_date and not row.return_reason:
+            row.returned = True
+            row.return_date = frappe.utils.nowdate()
+            row.return_reason = "Project Completed" if doc.status == "Completed" else "Project Cancelled"
+            updated = True
+
+        elif row.return_reason and row.return_date:
+            row.returned = True
+            updated = True
+
+        else:
+            print(f" - Skipped (already returned or reason provided)")
+
+    if updated:
+        log_doc.save(ignore_permissions=True)

beams/beams/doctype/vehicle_log_detail/vehicle_log_detail.json

@@ -13,6 +13,7 @@
   "to",
   "no_of_travellers",
   "status",
+  "returned",
   "return_date",
   "return_reason"
  ],
@@ -65,12 +66,20 @@
    "fieldtype": "Small Text",
    "in_list_view": 1,
    "label": "Return Reason"
+  },
+  {
+   "allow_on_submit": 1,
+   "default": "0",
+   "fieldname": "returned",
+   "fieldtype": "Check",
+   "in_list_view": 1,
+   "label": "returned"
   }
  ],
  "index_web_pages_for_search": 1,
  "istable": 1,
  "links": [],
- "modified": "2025-04-19 11:51:05.520000",
+ "modified": "2025-04-23 16:29:53.868218",
  "modified_by": "Administrator",
  "module": "BEAMS",
  "name": "Vehicle Log Detail",

beams/beams/doctype/vehicle_transaction_log/vehicle_transaction_log.json

@@ -9,6 +9,10 @@
   "project",
   "transportation_request",
   "vehicle_hire_request",
+  "section_break_iztv",
+  "location",
+  "bureau",
+  "section_break_xcxm",
   "vehicle_log_details"
  ],
  "fields": [
@@ -35,11 +39,33 @@
    "fieldtype": "Table",
    "label": "Vehicle Log Details",
    "options": "Vehicle Log Detail"
+  },
+  {
+   "fieldname": "section_break_iztv",
+   "fieldtype": "Column Break"
+  },
+  {
+   "fetch_from": "project.location",
+   "fieldname": "location",
+   "fieldtype": "Link",
+   "label": "Location",
+   "options": "Location"
+  },
+  {
+   "fetch_from": "project.bureau",
+   "fieldname": "bureau",
+   "fieldtype": "Link",
+   "label": "Bureau",
+   "options": "Bureau"
+  },
+  {
+   "fieldname": "section_break_xcxm",
+   "fieldtype": "Section Break"
   }
  ],
  "index_web_pages_for_search": 1,
  "links": [],
- "modified": "2025-04-19 11:48:42.219763",
+ "modified": "2025-04-22 11:10:05.592968",
  "modified_by": "Administrator",
  "module": "BEAMS",
  "name": "Vehicle Transaction Log",

beams/hooks.py

@@ -324,7 +324,9 @@
             "beams.beams.custom_scripts.project.project.update_program_request_status_on_project_completion",
             "beams.beams.custom_scripts.project.project.validate_project",
             "beams.beams.custom_scripts.project.project.sync_manpower_logs",
-            "beams.beams.custom_scripts.project.project.on_update_project"
+            "beams.beams.custom_scripts.project.project.on_update_project",
+            "beams.beams.custom_scripts.project.project.sync_vehicle_logs",
+            "beams.beams.custom_scripts.project.project.auto_return_vehicles_on_project_completion"
         ],
          "validate": "beams.beams.custom_scripts.project.project.validate_employee_assignment",
          "validate": "beams.beams.custom_scripts.project.project.validate_employee_assignment_in_same_project"