frappe/frappe/desk/form/assign_to.py

# Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors
# License: MIT. See LICENSE

"""assign/unassign to ToDo"""

import frappe
from frappe import _
from frappe.desk.form.document_follow import follow_document
from frappe.desk.doctype.notification_log.notification_log import enqueue_create_notification,\
	get_title, get_title_html
import frappe.utils
import frappe.share
import json

class DuplicateToDoError(frappe.ValidationError): pass

def get(args=None):
	"""get assigned to"""
	if not args:
		args = frappe.local.form_dict

	return frappe.get_all("ToDo", fields=["allocated_to as owner", "name"], filters={
		"reference_type": args.get("doctype"),
		"reference_name": args.get("name"),
		"status": ("!=", "Cancelled")
	}, limit=5)

@frappe.whitelist()
def add(args=None):
	"""add in someone's to do list
		args = {
			"assign_to": [],
			"doctype": ,
			"name": ,
			"description": ,
			"assignment_rule":
		}

	"""
	if not args:
		args = frappe.local.form_dict

	users_with_duplicate_todo = []
	shared_with_users = []

	for assign_to in frappe.parse_json(args.get("assign_to")):
		filters = {
			"reference_type": args['doctype'],
			"reference_name": args['name'],
			"status": "Open",
			"allocated_to": assign_to
		}

		if frappe.get_all("ToDo", filters=filters):
			users_with_duplicate_todo.append(assign_to)
		else:
			from frappe.utils import nowdate

			if not args.get('description'):
				args['description'] = _('Assignment for {0} {1}').format(args['doctype'], args['name'])

			d = frappe.get_doc({
				"doctype": "ToDo",
				"allocated_to": assign_to,
				"reference_type": args['doctype'],
				"reference_name": args['name'],
				"description": args.get('description'),
				"priority": args.get("priority", "Medium"),
				"status": "Open",
				"date": args.get('date', nowdate()),
				"assigned_by": args.get('assigned_by', frappe.session.user),
				'assignment_rule': args.get('assignment_rule')
			}).insert(ignore_permissions=True)

			# set assigned_to if field exists
			if frappe.get_meta(args['doctype']).get_field("assigned_to"):
				frappe.db.set_value(args['doctype'], args['name'], "assigned_to", assign_to)

			doc = frappe.get_doc(args['doctype'], args['name'])

			# if assignee does not have permissions, share
			if not frappe.has_permission(doc=doc, user=assign_to):
				frappe.share.add(doc.doctype, doc.name, assign_to)
				shared_with_users.append(assign_to)

			# make this document followed by assigned user
			if frappe.get_cached_value("User", assign_to, "follow_assigned_documents"):
				follow_document(args['doctype'], args['name'], assign_to)

			# notify
			notify_assignment(d.assigned_by, d.allocated_to, d.reference_type, d.reference_name, action='ASSIGN',
				description=args.get("description"))

	if shared_with_users:
		user_list = format_message_for_assign_to(shared_with_users)
		frappe.msgprint(_("Shared with the following Users with Read access:{0}").format(user_list, alert=True))

	if users_with_duplicate_todo:
		user_list = format_message_for_assign_to(users_with_duplicate_todo)
		frappe.msgprint(_("Already in the following Users ToDo list:{0}").format(user_list, alert=True))

	return get(args)

@frappe.whitelist()
def add_multiple(args=None):
	if not args:
		args = frappe.local.form_dict

	docname_list = json.loads(args['name'])

	for docname in docname_list:
		args.update({"name": docname})
		add(args)

def close_all_assignments(doctype, name):
	assignments = frappe.db.get_all('ToDo', fields=['allocated_to'], filters =
		dict(reference_type = doctype, reference_name = name, status=('!=', 'Cancelled')))
	if not assignments:
		return False

	for assign_to in assignments:
		set_status(doctype, name, assign_to.allocated_to, status="Closed")

	return True

@frappe.whitelist()
def remove(doctype, name, assign_to):
	return set_status(doctype, name, assign_to, status="Cancelled")

def set_status(doctype, name, assign_to, status="Cancelled"):
	"""remove from todo"""
	try:
		todo = frappe.db.get_value("ToDo", {"reference_type":doctype,
		"reference_name":name, "allocated_to":assign_to, "status": ('!=', status)})
		if todo:
			todo = frappe.get_doc("ToDo", todo)
			todo.status = status
			todo.save(ignore_permissions=True)

			notify_assignment(todo.assigned_by, todo.allocated_to, todo.reference_type, todo.reference_name)
	except frappe.DoesNotExistError:
		pass

	# clear assigned_to if field exists
	if frappe.get_meta(doctype).get_field("assigned_to") and status=="Cancelled":
		frappe.db.set_value(doctype, name, "assigned_to", None)

	return get({"doctype": doctype, "name": name})

def clear(doctype, name):
	'''
	Clears assignments, return False if not assigned.
	'''
	assignments = frappe.db.get_all('ToDo', fields=['allocated_to'], filters =
		dict(reference_type = doctype, reference_name = name))
	if not assignments:
		return False

	for assign_to in assignments:
		set_status(doctype, name, assign_to.allocated_to, "Cancelled")

	return True

def notify_assignment(assigned_by, allocated_to, doc_type, doc_name, action='CLOSE',
	description=None):
	"""
		Notify assignee that there is a change in assignment
	"""
	if not (assigned_by and allocated_to and doc_type and doc_name):
		return

	# return if self assigned or user disabled
	if assigned_by == allocated_to or not frappe.db.get_value('User', allocated_to, 'enabled'):
		return

	# Search for email address in description -- i.e. assignee
	user_name = frappe.get_cached_value('User', frappe.session.user, 'full_name')
	title = get_title(doc_type, doc_name)
	description_html =  "<div>{0}</div>".format(description) if description else None

	if action == 'CLOSE':
		subject = _('Your assignment on {0} {1} has been removed by {2}')\
			.format(frappe.bold(doc_type), get_title_html(title), frappe.bold(user_name))
	else:
		user_name = frappe.bold(user_name)
		document_type = frappe.bold(doc_type)
		title = get_title_html(title)
		subject = _('{0} assigned a new task {1} {2} to you').format(user_name, document_type, title)

	notification_doc = {
		'type': 'Assignment',
		'document_type': doc_type,
		'subject': subject,
		'document_name': doc_name,
		'from_user': frappe.session.user,
		'email_content': description_html
	}

	enqueue_create_notification(allocated_to, notification_doc)

def format_message_for_assign_to(users):
	return "<br><br>" + "<br>".join(users)