Merge pull request #26032 from frappe/mergify/bp/version-14-hotfix/pr…

…-25225

feat: let users unlock stuck documents (backport #24782) (backport #25225)

frappe/__init__.py

@@ -533,11 +533,18 @@ def throw(
 	is_minimizable: bool = False,
 	wide: bool = False,
 	as_list: bool = False,
+	primary_action=None,
 ) -> None:
 	"""Throw execption and show message (`msgprint`).
 
 	:param msg: Message.
-	:param exc: Exception class. Default `frappe.ValidationError`"""
+	:param exc: Exception class. Default `frappe.ValidationError`
+	:param title: [optional] Message title. Default: "Message".
+	:param is_minimizable: [optional] Allow users to minimize the modal
+	:param wide: [optional] Show wide modal
+	:param as_list: [optional] If `msg` is a list, render as un-ordered list.
+	:param primary_action: [optional] Bind a primary server/client side action.
+	"""
 	msgprint(
 		msg,
 		raise_exception=exc,
@@ -546,6 +553,7 @@ def throw(
 		is_minimizable=is_minimizable,
 		wide=wide,
 		as_list=as_list,
+		primary_action=primary_action,
 	)
 
 

frappe/model/document.py

@@ -22,6 +22,9 @@
 from frappe.utils.data import get_absolute_url, get_datetime, get_timedelta, getdate
 from frappe.utils.global_search import update_global_search
 
+DOCUMENT_LOCK_EXPIRTY = 12 * 60 * 60  # All locks expire in 12 hours automatically
+DOCUMENT_LOCK_SOFT_EXPIRY = 60 * 60  # Let users force-unlock after 60 minutes
+
 
 def get_doc(*args, **kwargs):
 	"""returns a frappe.model.Document object.
@@ -1411,8 +1414,8 @@ def log_error(self, title=None, message=None):
 		)
 
 	def get_signature(self):
-		"""Returns signature (hash) for private URL."""
-		return hashlib.sha224(get_datetime_str(self.creation).encode()).hexdigest()
+		"""Return signature (hash) for private URL."""
+		return hashlib.sha224(f"{self.doctype}:{self.name}".encode(), usedforsecurity=False).hexdigest()
 
 	def get_document_share_key(self, expires_on=None, no_expiry=False):
 		if no_expiry:
@@ -1470,9 +1473,25 @@ def queue_action(self, action, **kwargs):
 		try:
 			self.lock()
 		except frappe.DocumentLockedError:
+			# Allow unlocking if created more than 60 minutes ago
+			primary_action = None
+			if file_lock.lock_age(self.get_signature()) > DOCUMENT_LOCK_SOFT_EXPIRY:
+				primary_action = {
+					"label": "Force Unlock",
+					"server_action": "frappe.model.document.unlock_document",
+					"hide_on_success": True,
+					"args": {
+						"doctype": self.doctype,
+						"name": self.name,
+					},
+				}
+
 			frappe.throw(
-				_("This document is currently queued for execution. Please try again"),
+				_(
+					"This document is currently locked and queued for execution. Please try again after some time."
+				),
 				title=_("Document Queued"),
+				primary_action=primary_action,
 			)
 
 		enqueue_after_commit = kwargs.pop("enqueue_after_commit", None)
@@ -1496,6 +1515,9 @@ def lock(self, timeout=None):
 		signature = self.get_signature()
 		if file_lock.lock_exists(signature):
 			lock_exists = True
+			if file_lock.lock_age(signature) > DOCUMENT_LOCK_EXPIRTY:
+				file_lock.delete_lock(signature)
+				lock_exists = False
 			if timeout:
 				for _i in range(timeout):
 					time.sleep(1)
@@ -1601,3 +1623,13 @@ def execute_action(__doctype, __name, __action, **kwargs):
 
 		doc.add_comment("Comment", _("Action Failed") + "<br><br>" + msg)
 	doc.notify_update()
+
+
+@frappe.whitelist()
+def unlock_document(doctype: str | None = None, name: str | None = None, args=None):
+	if not doctype and not name and args:
+		# Backward compatibility
+		doctype = str(args["doctype"])
+		name = str(args["name"])
+	frappe.get_doc(doctype, name).unlock()
+	frappe.msgprint(frappe._("Document Unlocked"), alert=True)

frappe/tests/test_document_locks.py

@@ -2,6 +2,7 @@
 # License: MIT. See LICENSE
 import frappe
 from frappe.tests.utils import FrappeTestCase
+from frappe.utils.data import add_to_date, today
 
 
 class TestDocumentLocks(FrappeTestCase):
@@ -16,3 +17,12 @@ def test_locking(self):
 		todo_1.lock()
 		self.assertRaises(frappe.DocumentLockedError, todo.lock)
 		todo_1.unlock()
+
+	def test_locks_auto_expiry(self):
+		todo = frappe.get_doc(dict(doctype="ToDo", description=frappe.generate_hash())).insert()
+		todo.lock()
+
+		self.assertRaises(frappe.DocumentLockedError, todo.lock)
+
+		with self.freeze_time(add_to_date(today(), days=3)):
+			todo.lock()

frappe/utils/file_lock.py

@@ -9,6 +9,7 @@
 """
 
 import os
+from pathlib import Path
 from time import time
 
 import frappe
@@ -41,6 +42,11 @@ def lock_exists(name):
 	return os.path.exists(get_lock_path(name))
 
 
+def lock_age(name) -> float:
+	"""Return time in seconds since lock was created."""
+	return time() - Path(get_lock_path(name)).stat().st_mtime
+
+
 def check_lock(path, timeout=600):
 	if not os.path.exists(path):
 		return False